A heparchy event reader object.

name[source]¶

The string representation of the event’s name.

Type¶

str

count[source]¶

The number of particles within the event.

Type¶

int

edges[source]¶

A structured array providing edges for a graph representation, with fields “in” and “out”.

Type¶

numpy.ndarray[int]

edge_weights[source]¶

Weights attributed to each edge.

Type¶

numpy.ndarray[double]

pmu[source]¶

A structured array providing particle 4-momenta, with fields “x”, “y”, “z”, “e”

Type¶

numpy.ndarray[double]

color[source]¶

A structured array with fields “color” and “anti-color”.

Type¶

numpy.ndarray[int]

pdg[source]¶

PDG codes providing the identity of every particle in the event.

Type¶

numpy.ndarray[int]

status[source]¶

Status codes, describing the reason for the generation of each particle in the event.

Type¶

numpy.ndarray[int]

helicity[source]¶

Spin polarisations of every particle in the event.

Type¶

numpy.ndarray[int]

final[source]¶

Boolean mask over the data identifying particles in final state. Deprecated, simply use masks attribute with “final” subscript.

Type¶

numpy.ndarray[bool], deprecated

available[source]¶

Names of the datasets stored within the event.

Type¶

list[str]

masks[source]¶

Read-only dictionary-like interface to access boolean masks over the particle datasets.

Type¶

MapReader[numpy.ndarray[bool]]

custom[source]¶

Read-only dictionary-like interface to access user-defined custom datasets.

Type¶

MapReader[numpy.ndarray]

custom_meta[source]¶

Read-only dictionary-like interface to access user-defined metadata on the event.

Type¶

MapReader

Public members¶

HdfEventReader()[source]

Initialize self. See help(type(self)) for accurate signature.

property name : str[source]

Getter for event name

property count : int[source]

Getter for number of particles in event

property edges : ndarray[Any, dtype[Any]][source]

Getter for edges in event generation DAG.

property edge_weights : ndarray[Any, dtype[float64]][source]

property pmu : ndarray[Any, dtype[Any]][source]

Getter for 4-momentum of all particles in event.

property color : ndarray[Any, dtype[Any]][source]

Getter for color pairs of all particles in event.

property pdg : ndarray[Any, dtype[int32]][source]

Getter for pdg codes of all particles in event.

property status : ndarray[Any, dtype[int16]][source]

property helicity : ndarray[Any, dtype[int16]][source]

property final : ndarray[Any, dtype[bool_]][source]

Getter for mask identifying final state particles.

property available : list[str][source]

Provides list of all dataset names in event.

mask(name: str) → ndarray[Any, dtype[bool_]][source]

Returns a boolean mask stored with the provided name.

property masks : MapReader[ndarray[Any, dtype[bool_]]][source]

get_custom(name: str) → ndarray[Any, dtype[Any]][source]

Returns a custom dataset stored with the provided name.

property custom : MapReader[ndarray[Any, dtype[Any]]][source]

get_custom_meta(name: str) → Any[source]

Returns custom metadata stored with the provided name.

property custom_meta : MapReader[Any][source]

copy() → HdfEventReader[source]

Returns a deep copy of the event object.