uproot.AsObjects

Defined in uproot.interpretation.objects on line 33.

Inheritance order:

  1. uproot.interpretation.Interpretation

class uproot.interpretation.objects.AsObjects(model, branch=None)
Parameters:

Integerpretation for arrays of any kind of data that might reside in a ROOT TTree. This interpretation prescribes the full (slow) deserialization process.

simplify attempts to replace this interpretation with a faster-to-read equivalent, but not all data types can be simplified.

model

AsObjects.model

The full Uproot deserialization model for the data (uproot.Model or uproot.containers.AsContainer).

branch

AsObjects.branch

The TBranch from which the data are drawn. May be None.

basket_array_forth

AsObjects.basket_array_forth(data, byte_offsets, basket, branch, context, cursor_offset, library, options)

simplify

AsObjects.simplify()

Attempts to replace this uproot.AsObjects with an interpretation that can be executed more quickly.

If there isn’t a simpler interpretation, then this method returns self.

cache_key

Inherited from uproot.interpretation.Interpretation.

AsObjects.cache_key

typename

Inherited from uproot.interpretation.Interpretation.

AsObjects.typename

numpy_dtype

Inherited from uproot.interpretation.Interpretation.

AsObjects.numpy_dtype

awkward_form

Inherited from uproot.interpretation.Interpretation.

AsObjects.awkward_form(file, context=None, index_format='i64', header=False, tobject_header=False, breadcrumbs=())
Parameters:
  • file (uproot.ReadOnlyFile) – File to use to generate uproot.Model classes from its streamers and file_path for error messages.

  • context (dict) – Context for the Form-generation; defaults are the remaining arguments below.

  • index_format (str) – Format to use for indexes of the awkward.forms.Form; may be "i32", "u32", or "i64".

  • header (bool) – If True, include header fields of each C++ class.

  • tobject_header (bool) – If True, include header fields of each TObject base class.

  • breadcrumbs (tuple of class objects) – Used to check for recursion. Types that contain themselves cannot be Awkward Arrays because the depth of instances is unknown.

The awkward.forms.Form to use to put objects of type type in an Awkward Array.

basket_array

Inherited from uproot.interpretation.Interpretation.

AsObjects.basket_array(data, byte_offsets, basket, branch, context, cursor_offset, library, options)
Parameters:
  • data (array of numpy.uint8) – Raw but uncompressed data from the TBasket. If the TBasket has offsets and navigational metadata, it is not included in this array.

  • byte_offsets (array of numpy.int32) – Index where each entry of the TBasket starts and stops. The header is not included (i.e. the first offset is 0), and the length of this array is one greater than the number of entries in the TBasket.

  • basket (uproot.models.TBasket.Model_TBasket) – The TBasket object.

  • context (dict) – Auxiliary data used in deserialization.

  • cursor_offset (int) – Correction to the integer keys used in refs for objects deserialized by reference (uproot.deserialization.read_object_any).

  • library (uproot.interpretation.library.Library) – The requested library for output.

  • interp_options (dict) – Flags and other options passed through the interpretation process.

Performs the first step of interpretation, from uncompressed TBasket data to a temporary array.

final_array

Inherited from uproot.interpretation.Interpretation.

AsObjects.final_array(basket_arrays, entry_start, entry_stop, entry_offsets, library, branch, options)
Parameters:
  • basket_arrays (dict of int → array) – Mapping from TBasket number to the temporary array returned by basket_array.

  • entry_start (int) – First entry to include when trimming any excess entries from the first TBasket.

  • entry_stop (int) – FIrst entry to exclude (one greater than the last entry to include) when trimming any excess entries from the last TBasket.

  • entry_offsets (list of int) – The entry_offsets for this TBranch.

  • library (uproot.interpretation.library.Library) – The requested library for output.

  • branch (uproot.TBranch) – The TBranch that is being interpreted.

  • interp_options (dict) – Flags and other options passed through the interpretation process.

Performs the last steps of interpretation, from a collection of temporary arrays, one for each TBasket, to a trimmed, finalized, grouped array, produced by the library.

hook_before_basket_array

Inherited from uproot.interpretation.Interpretation.

AsObjects.hook_before_basket_array(*args, **kwargs)

Called in basket_array, before any interpretation.

This is the first hook called in basket_array.

hook_after_basket_array

Inherited from uproot.interpretation.Interpretation.

AsObjects.hook_after_basket_array(*args, **kwargs)

Called in basket_array, after all interpretation.

This is the last hook called in basket_array.

hook_before_final_array

Inherited from uproot.interpretation.Interpretation.

AsObjects.hook_before_final_array(*args, **kwargs)

Called in final_array, before any trimming, finalization, or grouping.

This is the first hook called in final_array.

hook_before_library_finalize

Inherited from uproot.interpretation.Interpretation.

AsObjects.hook_before_library_finalize(*args, **kwargs)

Called in final_array, after trimming but before calling the finalize routine.

hook_after_final_array

Inherited from uproot.interpretation.Interpretation.

AsObjects.hook_after_final_array(*args, **kwargs)

Called in final_array, after all trimming, finalization, and grouping.

This is the last hook called in final_array.