uproot.AsStrings
Defined in uproot.interpretation.strings on line 27.
Inheritance order: |
---|
- class uproot.interpretation.strings.AsStrings(header_bytes=0, length_bytes='1-5', typename=None, original=None)
- Parameters:
header_bytes (int) – Number of bytes to skip at the beginning of each entry.
length_bytes ("1-5" or "4") – Method used to determine the length of a string: “1-5” means one byte if the length is less than 256, otherwise the true length is in the next four bytes; “4” means always four bytes.
typename (None or str) – If None, construct a plausible C++ typename. Otherwise, take the suggestion as given.
original (None, uproot.Model, or uproot.containers.Container) – If this interpretation is derived from simplify, this is a reminder of the original model.
An uproot.interpretation.Interpretation for an array of strings.
This cannot be nested within other uproot.interpretation.Interpretation objects; it can only represent a
TBranch
that only contains strings (not strings withinstd::vector
, for instance).Note that the uproot.AsString class is for strings nested within other objects.
(simplify converts an uproot.AsObjects of uproot.AsString into a uproot.AsStrings.)
header_bytes
- AsStrings.header_bytes
The number of bytes to skip at the beginning of each entry.
length_bytes
- AsStrings.length_bytes
“1-5” means one byte if the length is less than 256, otherwise the true length is in the next four bytes; “4” means always four bytes.
- Type:
Method used to determine the length of a string
original
- AsStrings.original
If not None, this was the original model from an uproot.AsObjects that was simplified into this uproot.AsJagged.
cache_key
Inherited from uproot.interpretation.Interpretation.
- AsStrings.cache_key
typename
Inherited from uproot.interpretation.Interpretation.
- AsStrings.typename
numpy_dtype
Inherited from uproot.interpretation.Interpretation.
- AsStrings.numpy_dtype
awkward_form
Inherited from uproot.interpretation.Interpretation.
- AsStrings.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.
- AsStrings.basket_array(data, byte_offsets, basket, branch, context, cursor_offset, library, 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
Inherited from uproot.interpretation.Interpretation.
- AsStrings.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 thelibrary
.
hook_before_basket_array
Inherited from uproot.interpretation.Interpretation.
- AsStrings.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.
- AsStrings.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.
- AsStrings.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.
- AsStrings.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.
- AsStrings.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.