uproot.interpretation.custom.CustomInterpretation

Inheritance order:
uproot.interpretation.Interpretation

class uproot.interpretation.custom.CustomInterpretation(branch: TBranch, context: dict, simplify: bool)

match_branch

classmethod CustomInterpretation.match_branch(branch: TBranch, context: dict, simplify: bool) → bool

Parameters:

branch (uproot.TBranch) – The TBranch to interpret as an array.
context (dict) – Auxiliary data used in deserialization.
simplify (bool) – If True, call simplify on any uproot.AsObjects to try to get a more efficient interpretation.

Accept arguments from uproot.interpretation.identify.interpretation_of, determine whether this interpretation can be applied to the given branch.

CustomInterpretation.numpy_dtype: The numpy.dtype to use to put objects of this type in a NumPy array.

CustomInterpretation.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.

CustomInterpretation.basket_array(data, byte_offsets, basket, branch, context, cursor_offset, library, interp_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.

CustomInterpretation.final_array(basket_arrays, entry_start, entry_stop, entry_offsets, library, branch, options): Concatenate the arrays from the baskets and return the final array.