Composite object, combining particle set data with relational information between particles.

Parameters:¶

particles : ParticleSet

The point cloud data for the particles in the dataset.

adj : AdjacencyList

The connectivity of the particles in the point cloud, forming a graph.

particles[source]¶

Data describing the particles in the set.

Type:¶

ParticleSet

adj[source]¶

Connectivity between the particles, to form a graph.

Type:¶

AdjacencyList

Public members¶

__getitem__(key) → Graphicle[source]

__str__() → str[source]

Return str(self).

copy() → Graphicle[source]

Copies the underlying data into a new Graphicle instance.

classmethod from_event(event: EventInterface) → Graphicle[source]

Instantiates a Graphicle object from a generic event object, whose attribute structure is compatible with EventInterface.

classmethod from_numpy(...) → Graphicle[source]

Instantiates a Graphicle object from an optional collection of numpy arrays.

property pdg : PdgArray[source]

PDG codes.

property pmu : MomentumArray[source]

Four momenta, \(p_\mu\).

property color : ColorArray[source]

Color / anti-color pairs.

property helicity : HelicityArray[source]

Helicity values.

property status : StatusArray[source]

Status codes from Monte-Carlo event generator.

property hard_mask : MaskGroup[source]

Identifies which particles participate in the hard process. For Pythia, this is split into four categories: 'incoming', 'intermediate', 'outgoing', and 'outgoing_nonperturbative_diffraction'.

property final : MaskArray[source]

Boolean array indicating final state in particle set.

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

COO edge list, with field names ('src', 'dst').

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

Vertex ids of each particle with at least one edge.

serialize() → GraphicleSerialized[source]

Returns serialized data as a dictionary.

__repr__()[source]

Method generated by attrs for class Graphicle.

__eq__(other)[source]

Method generated by attrs for class Graphicle.

__ne__(other)[source]

Method generated by attrs for class Graphicle.

Graphicle(particles: ParticleSet = NOTHING, ...)[source]

Method generated by attrs for class Graphicle.

adj : AdjacencyList[source]

particles : ParticleSet[source]