uproot.AsDtype — Uproot documentation

# uproot.AsDtype

Defined in uproot.interpretation.numerical on line 161.

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

class uproot.interpretation.numerical.AsDtype(from_dtype, to_dtype=None)
  Parameters:

    - from_dtype (`numpy.dtype` or its constructor argument) – Data type to assume of the raw but uncompressed bytes in the `TBasket`. Usually big-endian; may include named fields and a shape.

    - to_dtype (None, `numpy.dtype`, or its constructor argument) – Data type to convert the data into. Usually native-endian; may include named fields and a shape. If None, `to_dtype` will be set to the native-endian equivalent of `from_dtype`.

  Interpretation for any array that can be fully described as a `numpy.dtype`.

## from_dtype

AsDtype.from_dtype

  Data type to expect of the raw but uncompressed bytes in the `TBasket` data. Usually big-endian; may include named fields and a shape.

  Named fields (`dtype.names`) can be used to construct a NumPy structured array.

  A shape (`dtype.shape`) can be used to construct a fixed-size array for each entry. (Not applicable to variable-length lists! See uproot.AsJagged.) The finalized array’s `array.shape[1:] == dtype.shape`.

## to_dtype

AsDtype.to_dtype

  Data type to convert the data into. Usually the native-endian equivalent of from_dtype; may include named fields and a shape.

  Named fields (`dtype.names`) can be used to construct a NumPy structured array.

  A shape (`dtype.shape`) can be used to construct a fixed-size array for each entry. (Not applicable to variable-length lists! See uproot.AsJagged.) The finalized array’s `array.shape[1:] == dtype.shape`.

## itemsize

AsDtype.itemsize

  Number of bytes per item of from_dtype.

  This number of bytes includes the fields and shape, like `dtype.itemsize` in NumPy.

## inner_shape

AsDtype.inner_shape

## reshape

AsDtype.reshape(shape)

## inplace

AsDtype.inplace(array)

  Returns a AsDtypeInPlace version of self in order to fill the given array in place.

  Example usage : `` var = np.zeros(N, dtype=np.float32) b = uproot.openn('afile.root')['treename']['varname'] b.array(library='np', interpretation=b.interpretation.inplace(var) ) ``

## cache_key

Inherited from uproot.interpretation.Interpretation.

AsDtype.cache_key

## typename

Inherited from uproot.interpretation.Interpretation.

AsDtype.typename

## numpy_dtype

Inherited from uproot.interpretation.Interpretation.

AsDtype.numpy_dtype

## awkward_form

Inherited from uproot.interpretation.Interpretation.

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

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

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

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

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

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

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

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