graphicle.calculate.spherocity(pmu: MomentumArray, return_axis: False, rng_seed: int | None) → float[source]
graphicle.calculate.spherocity(pmu: MomentumArray, return_axis: False) → float
graphicle.calculate.spherocity(pmu: MomentumArray, rng_seed: int | None) → float
graphicle.calculate.spherocity(pmu: MomentumArray) → float
graphicle.calculate.spherocity(pmu: MomentumArray, return_axis: True, rng_seed: int | None) → tuple[float, ndarray[Any, dtype[float64]]]
graphicle.calculate.spherocity(pmu: MomentumArray, return_axis: True) → tuple[float, ndarray[Any, dtype[float64]]]

Computes the spherocity of an event, from final-state momenta.

New in version 0.3.8.

Parameters:
pmu : MomentumArray

Momentum of hadronised particles in the final state of the event record.

return_axis : bool

If True, will return a tuple with the spherocity, and the axis unit vector which was found to minimize spherocity.

rng_seed : int, optional

Initial guess for the axis unit vector is sampled from a uniform random distribution, over the surface of a sphere. If passed, will initialise the random number generator with the provided seed, enabling reproducible results.

Returns:

  • spherocity (float) – The spherocity of the event.

  • axis (ndarray[float64], optional) – The x, y, and z components of the spherocity axis, respectively.

See also

thrust

Computes the thrust from final state momenta.

c_parameter

Computes the C-parameter from the final state momenta.

Last update: Jun 27, 2025