uproot.AsPointer

Defined in uproot.containers on line 545.

Inheritance order:

  1. uproot.containers.AsContainer

class uproot.containers.AsPointer(pointee=None)
Parameters:

pointee (None, uproot.Model, or uproot.containers.Container) – Optional description of the data, used in awkward_form but ignored in read.

A uproot.containers.AsContainer for an object referred to by pointer, meaning that it could be None (nullptr) or identical to an already-read object.

The deserialization procedure calls uproot.deserialization.read_object_any.

pointee

AsPointer.pointee

Optional description of the data, used in awkward_form but ignored in read.

cache_key

Inherited from uproot.containers.AsContainer.

AsPointer.cache_key

typename

Inherited from uproot.containers.AsContainer.

AsPointer.typename

awkward_form

Inherited from uproot.containers.AsContainer.

AsPointer.awkward_form(file, context)
Parameters:
  • file (uproot.reading.CommonFileMethods) – The file associated with this interpretation’s TBranch.

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

strided_interpretation

Inherited from uproot.containers.AsContainer.

AsPointer.strided_interpretation(file, header=False, tobject_header=True, breadcrumbs=(), original=None)
Parameters:
  • file (uproot.ReadOnlyFile) – File to use to generate uproot.Model classes from its streamers and file_path for error messages.

  • header (bool) – If True, assume the outermost object has a header.

  • tobject_header (bool) – If True, assume that TObjects have headers.

  • breadcrumbs (tuple of class objects) – Used to check for recursion. Types that contain themselves cannot be strided because the depth of instances is unknown.

  • original (None, uproot.Model, or uproot.containers.Container) – The original, non-strided model or container.

Returns a list of (str, numpy.dtype) pairs to build a uproot.AsStridedObjects interpretation.

read

Inherited from uproot.containers.AsContainer.

AsPointer.read(chunk, cursor, context, file, selffile, parent, header=True)
Parameters:

Read one object as part of a recursive descent.