Jet

Symbolica documentation for getting started, symbolic expressions, numerical evaluation, pattern matching, and APIs in Python and Rust.

`Jet`

class Jet

A reconstructed collider jet and its input-particle constituents.

Jets are returned by JetDefinition.cluster and expose the recombined four-momentum together with the indices of their original inputs.

Examples

from symbolica import S, E
from symbolica.community import hepkit as hep
particles = [hep.FourMomentum(50.0, 30.0, 40.0, 0.0),
             hep.FourMomentum(25.0, -15.0, -20.0, 0.0)]
definition = hep.JetDefinition.anti_kt(radius=0.4, minimum_pt=20.0)
clustering = definition.cluster(particles)
jets = clustering.jets
leading_jet = jets[0]
assert leading_jet.pt == 50.0
inputs = [particles[i] for i in leading_jet.constituent_indices]

Attributes

Name	Description
`constituent_indices`	Return sorted positions of the input momenta assigned to this jet.
`momentum`	Return the recombined four-momentum of this jet.
`phi`	Return the jet azimuthal angle in radians.
`pt`	Return the jet transverse momentum.
`rapidity`	Return the jet rapidity.

`constituent_indices`

Jet.constituent_indices: builtins.list[builtins.int]

Return sorted positions of the input momenta assigned to this jet.

Examples

Using the setup in the Jet class example:

inputs = [particles[i] for i in leading_jet.constituent_indices]

`momentum`

Jet.momentum: FourMomentum

Return the recombined four-momentum of this jet.

Examples

Using the setup in the Jet class example:

assert leading_jet.momentum.pt == leading_jet.pt

`phi`

Jet.phi: builtins.float

Return the jet azimuthal angle in radians.

Examples

Using the setup in the Jet class example:

azimuth = leading_jet.phi

`pt`

Jet.pt: builtins.float

Return the jet transverse momentum.

Examples

Using the setup in the Jet class example:

assert leading_jet.pt == 50.0

`rapidity`

Jet.rapidity: builtins.float

Return the jet rapidity.

Examples

Using the setup in the Jet class example:

assert leading_jet.rapidity == 0.0

Methods

Name	Description
`__repr__`	Return a concise jet summary with its kinematics and constituent count.
`_repr_html_`	Render the jet kinematics as a compact notebook table.
`_repr_pretty_`	Write the concise jet summary to an IPython pretty printer.

`repr`

Jet.__repr__() -> builtins.str

Return a concise jet summary with its kinematics and constituent count.

Examples

Using the setup in the Jet class example:

summary = repr(leading_jet)

`_repr_html_`

Jet._repr_html_() -> builtins.str

Render the jet kinematics as a compact notebook table.

Examples

Using the setup in the Jet class example:

from IPython.display import display
display(leading_jet)

`_repr_pretty_`

Jet._repr_pretty_(pretty: typing.Any, cycle: builtins.bool) -> None

Write the concise jet summary to an IPython pretty printer.

Examples

Using the setup in the Jet class example:

from IPython.lib.pretty import pretty
text = pretty(leading_jet)

Parameters

pretty (object) The IPython pretty-printer object.
cycle (bool) Whether this object is part of a recursive formatting cycle.