uproot.streamers.Model_TStreamerElement — Uproot documentation

# uproot.streamers.Model_TStreamerElement

Defined in uproot.streamers on line 455.

Inheritance order:
uproot.Model

class uproot.streamers.Model_TStreamerElement

  A versionless uproot.Model for `TStreamerElement`.

  Since this model is versionless and most of its functionality is internal (not to be directly accessed by most users), it is defined on the model instead of creating a behavior class to mix in functionality.

## show

Model_TStreamerElement.show(stream=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'>)
  Parameters:

    stream (object with a `write(str)` method) – Stream to write the output to.

  Interactively display a `TStreamerElement`.

## name

Model_TStreamerElement.name

  The name (`fName`) of this `TStreamerElement`.

## title

Model_TStreamerElement.title

  The title (`fTitle`) of this `TStreamerElement`.

## typename

Model_TStreamerElement.typename

  The typename (`fTypeName`) of this `TStreamerElement`.

## array_length

Model_TStreamerElement.array_length

  The array length (`fArrayLength`) of this `TStreamerElement`.

## file_uuid

Model_TStreamerElement.file_uuid

  The unique identifier (uproot.ReadOnlyFile) of the file from which this `TStreamerElement` was extracted.

## fType

Model_TStreamerElement.fType

  The type code (`fType`) of this `TStreamerElement`.

## classname

Inherited from uproot.Model.

Model_TStreamerElement.classname

  The C++ (decoded) classname of the modeled class.

  See uproot.classname_decode, uproot.classname_encode, and uproot.model.classname_version.

## encoded_classname

Inherited from uproot.Model.

Model_TStreamerElement.encoded_classname

  The Python (encoded) classname of the modeled class. May or may not include version.

  See uproot.classname_decode, uproot.classname_encode, and uproot.model.classname_version.

## class_version

Inherited from uproot.Model.

Model_TStreamerElement.class_version

  The version number of the modeled class (int) if any; None otherwise.

  See uproot.classname_decode, uproot.classname_encode, and uproot.model.classname_version.

## cursor

Inherited from uproot.Model.

Model_TStreamerElement.cursor

  A cursor pointing to the start of this instance in the byte stream (before read_numbytes_version).

## file

Inherited from uproot.Model.

Model_TStreamerElement.file

  A uproot.ReadOnlyFile, which may be open and readable, or a uproot.reading.DetachedFile, which only contains information about the original file (not an open file handle).

## close

Inherited from uproot.Model.

Model_TStreamerElement.close()

  Closes the file from which this object is derived, if such a file is still attached (i.e. not uproot.reading.DetachedFile).

## closed

Inherited from uproot.Model.

Model_TStreamerElement.closed

  True if the associated file is known to be closed; False if it is known to be open. If the associated file is detached (uproot.reading.DetachedFile), then the value is None.

## parent

Inherited from uproot.Model.

Model_TStreamerElement.parent

  The object that was deserialized before this one in recursive descent, usually the containing object (or the container’s container).

## concrete

Inherited from uproot.Model.

Model_TStreamerElement.concrete

  The Python instance corresponding to the concrete (instantiated) class in C++, which is `self` if this is the concrete class or another object if this is actually a holder of superclass members for that other object (i.e. if this object is in the other’s bases).

## members

Inherited from uproot.Model.

Model_TStreamerElement.members

  A dict of C++ member data directly associated with this class (i.e. not its superclasses). For all members, see all_members.

## all_members

Inherited from uproot.Model.

Model_TStreamerElement.all_members

  A dict of C++ member data for this class and its superclasses. For only direct members, see members.

## has_member

Inherited from uproot.Model.

Model_TStreamerElement.has_member(name, all=True)

  Returns True if calling member with the same arguments would return a value; False if the member is missing.

## member

Inherited from uproot.Model.

Model_TStreamerElement.member(name, all=True, none_if_missing=False)
  Parameters:

    - name (str) – The name of the member datum to retrieve.

    - all (bool) – If True, recursively search all superclasses in bases. Otherwise, search the direct class only.

    - none_if_missing (bool) – If a member datum doesn’t exist in the search path, `none_if_missing=True` has this function return None, but `none_if_missing=False` would have it raise an exception. Note that None is a possible value for some member data.

  Returns a C++ member datum by name.

## bases

Inherited from uproot.Model.

Model_TStreamerElement.bases

  List of uproot.Model objects representing superclass data for this object in the order given in C++ (opposite method resolution order).

  - If this object has no superclasses, `bases` is empty.

  - If it has one superclass, which itself might have superclasses, `bases` has length 1.

  - Only if this object multiply inherits from more than one superclass at the same level does `bases` have length greater than 1.

  Since multiple inheritance is usually avoided, `bases` rarely has length greater than 1. A linear chain of superclasses deriving from super-superclasses is represented by `bases` containing an object whose `bases` contains objects.

## base

Inherited from uproot.Model.

Model_TStreamerElement.base(*cls)

  Extracts instances from bases by Python class type.

  The `cls` arguments may be Python classes or C++ classname strings to match.

## is_instance

Inherited from uproot.Model.

Model_TStreamerElement.is_instance(*cls)

  Returns True if this object matches a given type in the C++ class hierarchy.

  The `cls` arguments may be Python classes or C++ classname strings to match.

## num_bytes

Inherited from uproot.Model.

Model_TStreamerElement.num_bytes

  Number of bytes expected in the (uncompressed) serialization of this instance.

  This value may be None (unknown before reading) or an integer.

  If the value is an integer and the object exists (no exceptions in read), then the expected number of bytes agreed with the actual number of bytes, and this numer is reliable.

  If this object is re-serialized, it won’t necessarily occupy the same number of bytes.

## instance_version

Inherited from uproot.Model.

Model_TStreamerElement.instance_version

  Version of this instance as read from the byte stream.

  If this model is versioned (uproot.model.VersionedModel), the `instance_version` ought to be equal to the class_version.

  If this model is versionless, the `instance_version` contains new information about the actual version deserialized.

## is_memberwise

Inherited from uproot.Model.

Model_TStreamerElement.is_memberwise

  True if the object was serialized in ROOT’s memberwise format; False otherwise.

## awkward_form

Inherited from uproot.Model.

classmethod Model_TStreamerElement.awkward_form(file, context)
  Parameters:

    - cls (subclass of uproot.Model) – This class.

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

## strided_interpretation

Inherited from uproot.Model.

classmethod Model_TStreamerElement.strided_interpretation(file, header=False, tobject_header=True, breadcrumbs=(), original=None)
  Parameters:

    - cls (subclass of uproot.Model) – This class.

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

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

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

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

## tojson

Inherited from uproot.Model.

Model_TStreamerElement.tojson()

  Serializes this object in its ROOT JSON form (as Python lists and dicts, which can be passed to `json.dump` or `json.dumps`).

## empty

Inherited from uproot.Model.

classmethod Model_TStreamerElement.empty()

  Creates a model instance (of subclass `cls`) with no data; all required attributes are None or empty.

## read

Inherited from uproot.Model.

classmethod Model_TStreamerElement.read(chunk, cursor, context, file, selffile, parent, concrete=None)
  Parameters:

    - cls (subclass of uproot.Model) – Class to instantiate.

    - chunk (uproot.source.chunk.Chunk) – Buffer of contiguous data from the file uproot.source.chunk.Source.

    - cursor (uproot.Cursor) – Current position in that `chunk`.

    - context (dict) – Auxiliary data used in deserialization.

    - file (uproot.ReadOnlyFile) – An open file object, capable of generating new uproot.Model classes from its streamers.

    - selffile (uproot.reading.CommonFileMethods) – A possibly uproot.reading.DetachedFile associated with this object.

    - parent (None or calling object) – The previous `read` in the recursive descent.

    - concrete (None or uproot.Model instance) – If None, this model corresponds to the concrete (instantiated) class in C++. Otherwise, this model represents a superclass part of the object, and `concrete` points to the concrete instance.

  Creates a model instance by reading data from a file.

## read_numbytes_version

Inherited from uproot.Model.

Model_TStreamerElement.read_numbytes_version(chunk, cursor, context)
  Parameters:

    - chunk (uproot.source.chunk.Chunk) – Buffer of contiguous data from the file uproot.source.chunk.Source.

    - cursor (uproot.Cursor) – Current position in that `chunk`.

    - context (dict) – Auxiliary data used in deserialization.

  Reads the number of bytes and instance version from the byte stream, which is usually 6 bytes (4 + 2). Bits with special meanings are appropriately masked out.

  Some types don’t have a 6-byte header or handle it differently; in those cases, this method should be overridden.

## read_members

Inherited from uproot.Model.

Model_TStreamerElement.read_members(chunk, cursor, context, file)
  Parameters:

    - chunk (uproot.source.chunk.Chunk) – Buffer of contiguous data from the file uproot.source.chunk.Source.

    - cursor (uproot.Cursor) – Current position in that `chunk`.

    - context (dict) – Auxiliary data used in deserialization.

    - file (uproot.ReadOnlyFile) – An open file object, capable of generating new uproot.Model classes from its streamers.

  Reads the member data for this class. The abstract class uproot.Model has an empty `read_members` method; this must be overridden by subclasses.

## check_numbytes

Inherited from uproot.Model.

Model_TStreamerElement.check_numbytes(chunk, cursor, context)
  Parameters:

    - chunk (uproot.source.chunk.Chunk) – Buffer of contiguous data from the file uproot.source.chunk.Source.

    - cursor (uproot.Cursor) – Current position in that `chunk`.

    - context (dict) – Auxiliary data used in deserialization.

  Reads nothing; checks the expected number of bytes against the actual movement of the `cursor` at the end of the object, possibly raising a uproot.DeserializationError exception.

  If num_bytes is None, this method does nothing.

  It is possible that a subclass would override this method, but not likely.

## postprocess

Inherited from uproot.Model.

Model_TStreamerElement.postprocess(chunk, cursor, context, file)
  Parameters:

    - chunk (uproot.source.chunk.Chunk) – Buffer of contiguous data from the file uproot.source.chunk.Source.

    - cursor (uproot.Cursor) – Current position in that `chunk`.

    - context (dict) – Auxiliary data used in deserialization.

    - file (uproot.ReadOnlyFile) – An open file object, capable of generating new uproot.Model classes from its streamers.

  Called for any additional processing after the object has been fully read.

  The return value from this method is the object that actually represents the ROOT data, which might be a different instance or even a different type from this class. The default in uproot.Model is to return `self`.

  Note that for versioned models, postprocess is called first, then postprocess is called on its output, allowing a uproot.model.DispatchByVersion to refine all data of its type, regardless of version.

## hook_before_read

Inherited from uproot.Model.

Model_TStreamerElement.hook_before_read(**kwargs)

  Called in read, before any data have been read.

## hook_before_read_members

Inherited from uproot.Model.

Model_TStreamerElement.hook_before_read_members(**kwargs)

  Called in read, after read_numbytes_version and before read_members.

## hook_after_read_members

Inherited from uproot.Model.

Model_TStreamerElement.hook_after_read_members(**kwargs)

  Called in read, after read_members and before check_numbytes.

## hook_before_postprocess

Inherited from uproot.Model.

Model_TStreamerElement.hook_before_postprocess(**kwargs)

  Called in read, after check_numbytes and before postprocess.

## to_writable

Inherited from uproot.Model.

Model_TStreamerElement.to_writable()
  Parameters:

    obj (uproot.Model instance of the same C++ class) – The object to convert to this class version.

  Returns a writable version of this object or raises a NotImplementedError if no writable version exists.

## serialize

Inherited from uproot.Model.

Model_TStreamerElement.serialize(name=None)

  Serialize a object (from num_bytes and version onward) for writing into an output ROOT file.

  If a `name` is given, override the object’s current name.

  This method has not been implemented on all classes (raises NotImplementedError).

## to_pyroot

Inherited from uproot.Model.

Model_TStreamerElement.to_pyroot(name=None)
  Parameters:

    name (str or None) – A name for the new PyROOT object.

  Converts this uproot.Model into a PyROOT object if it is writable. A minority of Uproot models are writable, mostly just histograms. Writability is necessary for conversion to PyROOT because it is serialized through a ROOT TMessage.