spine.data.larcv.RunInfo

class spine.data.larcv.RunInfo(run: int = -1, subrun: int = -1, event: int = -1)

Run information related to a specific event.

run

Run ID

Type:

int

subrun

Sub-run ID

Type:

int

event

Event ID

Type:

int

Attributes:

enum_attrs

Fetches HDF5-friendly enumerator descriptors for enum-backed fields.

enum_dicts

Fetches the dictionary of enumerated attributes and their enumerator descriptors.

enum_values

Fetches reverse enum lookups from stored values to symbolic names.

field_units

Fetches the documented units for each field.

index_attrs

Return the tuple of index-bearing attributes.

Methods

as_dict([lite, include_derived])	Returns the data class as dictionary of (key, value) pairs.
attr_names([include_derived, ...])	Return the names of valid attributes on this data class.
from_dict(cls_dict)	Builds and returns an object of the class from a dictionary of attributes.
from_larcv(larcv_event)	Builds and returns a Meta object from a LArCV 2D metadata object
scalar_dict([attrs, lengths, lite])	Returns the data class attributes as a dictionary of scalars.
set_precision([precision])	Casts all the vector attributes to a different precision.
shift_indexes(shifts)	Apply offsets to index attributes in place.
value_with_units(attr)	Fetch an attribute value with its documented units.

__init__(run: int = -1, subrun: int = -1, event: int = -1) → None

Methods

__init__([run, subrun, event])
as_dict([lite, include_derived])	Returns the data class as dictionary of (key, value) pairs.
attr_names([include_derived, ...])	Return the names of valid attributes on this data class.
from_dict(cls_dict)	Builds and returns an object of the class from a dictionary of attributes.
from_larcv(larcv_event)	Builds and returns a Meta object from a LArCV 2D metadata object
scalar_dict([attrs, lengths, lite])	Returns the data class attributes as a dictionary of scalars.
set_precision([precision])	Casts all the vector attributes to a different precision.
shift_indexes(shifts)	Apply offsets to index attributes in place.
value_with_units(attr)	Fetch an attribute value with its documented units.

Attributes

enum_attrs	Fetches HDF5-friendly enumerator descriptors for enum-backed fields.
enum_dicts	Fetches the dictionary of enumerated attributes and their enumerator descriptors.
enum_values	Fetches reverse enum lookups from stored values to symbolic names.
event
field_units	Fetches the documented units for each field.
index_attrs	Return the tuple of index-bearing attributes.
run
subrun

run: int = -1

subrun: int = -1

event: int = -1

classmethod from_larcv(larcv_event) → RunInfo

Builds and returns a Meta object from a LArCV 2D metadata object

Parameters:

larcv_event (larcv.EventBase) – LArCV event object which contains the run information as attributes

Returns:

Metadata object

Return type:

Meta