uproot.interpretation.Interpretation
Defined in uproot.interpretation on line 16.
- class uproot.interpretation.Interpretation
Abstract class for all interpretations of
TBranch
data as arrays.The interpretation cycle consists of:
Producing temporary arrays from each uncompressed
TBasket
.Combining those temporary arrays for the whole range of entries requested between
entry_start
andentry_stop
in arrays or array, or byentry_step
in iterate.Trimming the combined array to the exact entry range requested. (
TBasket
boundaries might not align with the requested entry range.)Passing the combined, trimmed temporary array to a selected uproot.interpretation.library.Library for finalization and possibly grouping.
cache_key
- Interpretation.cache_key
String that uniquely specifies this interpretation, to use as part of an array’s cache key.
typename
- Interpretation.typename
String that describes this interpretation as a C++ type.
This type might not exactly correspond to the type in C++, but it would have equivalent meaning.
numpy_dtype
- Interpretation.numpy_dtype
The
numpy.dtype
to use to put objects of this type in a NumPy array.
awkward_form
- Interpretation.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
- Interpretation.basket_array(data, byte_offsets, basket, branch, context, cursor_offset, library, interp_options)
- Parameters:
data (array of
numpy.uint8
) – Raw but uncompressed data from theTBasket
. If theTBasket
has offsets and navigational metadata, it is not included in this array.byte_offsets (array of
numpy.int32
) – Index where each entry of theTBasket
starts and stops. The header is not included (i.e. the first offset is0
), and the length of this array is one greater than the number of entries in theTBasket
.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
- Interpretation.final_array(basket_arrays, entry_start, entry_stop, entry_offsets, library, branch, interp_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 thelibrary
.
hook_before_basket_array
- Interpretation.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
- Interpretation.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
- Interpretation.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
- Interpretation.hook_before_library_finalize(*args, **kwargs)
Called in final_array, after trimming but before calling the finalize routine.
hook_after_final_array
- Interpretation.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.