Data structure containing status values for particle set.

Parameters:¶

data : sequence[int]

Data representing the Monte-Carlo event generator’s status for each particle in the point cloud.

Notes

These codes are specific to the Monte-Carlo event generators (MCEGs) which produced the data. Currently, functionality has only been developed with pythia8, using data from other MCEGs may yield unexpected results.

Public members¶

__array__() → ndarray[Any, dtype[int16]][source]

Numpy array representation of the data.

__repr__() → str[source]

Return repr(self).

__iter__() → Iterator[int][source]

Iterator exposing contained data as Python native.

__getitem__(key) → StatusArray[source]

__bool__() → bool[source]

Truthy returns False if no elements, True otherwise.

__eq__(other: ArrayBase | ndarray[Any, dtype[Any]]) → MaskArray[source]

Equality comparison.

__ne__(other: ArrayBase | ndarray[Any, dtype[Any]]) → MaskArray[source]

Non equality comparison.

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

Array containing the status codes for the particle record.

copy() → StatusArray[source]

Copies the underlying data into a new StatusArray instance.

in_range(min_status: int = 0, ...) → MaskArray[source]

Returns a boolean mask over particles with status codes sitting within passed (inclusive) range.

property hard_mask : MaskGroup[source]

Mask over the particle record, identifying the particles participating in the hard process.

serialize() → tuple[int, ...][source]

Provides a serialized version of the underlying data.

__setattr__(name, val)[source]

Method generated by attrs for class StatusArray.

StatusArray(...)[source]

Method generated by attrs for class StatusArray.

dtype : dtype[source]

index(value, ...) → integer -- return first index of value.[source]

Raises ValueError if the value is not present.

count(value) → integer -- return number of occurrences of value[source]

classmethod __subclasshook__(C)[source]

Abstract classes can override this to customize issubclass().

StatusArray = <bound method GenericAlias of <class 'collections.abc.Iterable'>>[source]

__lt__(other)[source]

Return self<value.

__le__(other)[source]

Return self<=value.

__gt__(other)[source]

Return self>value.

__ge__(other)[source]

Return self>=value.

__or__(other)[source]

Return self|value.

__ror__(other)[source]

Return value|self.