uproot.AsSTLBits — Uproot documentation

# uproot.AsSTLBits

Defined in uproot.interpretation.numerical on line 422.

Inheritance order:
uproot.interpretation.numerical.Numerical uproot.interpretation.Interpretation

class uproot.interpretation.numerical.AsSTLBits

  Interpretation for `std::bitset`.

## itemsize

AsSTLBits.itemsize

## cache_key

Inherited from uproot.interpretation.Interpretation.

AsSTLBits.cache_key

  String that uniquely specifies this interpretation, to use as part of an array’s cache key.

## typename

Inherited from uproot.interpretation.Interpretation.

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

Inherited from uproot.interpretation.Interpretation.

AsSTLBits.numpy_dtype

  The `numpy.dtype` to use to put objects of this type in a NumPy array.

## awkward_form

Inherited from uproot.interpretation.Interpretation.

AsSTLBits.awkward_form(file, context=None, index_format='i64', header=False, tobject_header=True, 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 headers in the Form’s `"uproot"` parameters.

    - tobject_header (bool) – If True, include headers for `TObject` classes in the Form’s `"uproot"` parameters.

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

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

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

## final_array

Inherited from uproot.interpretation.Interpretation.

AsSTLBits.final_array(basket_arrays, entry_start, entry_stop, entry_offsets, library, branch)
  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.

  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.

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

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

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

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

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