JetDefinition

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

`JetDefinition`

class JetDefinition

A generalized-kT jet definition for sequential recombination.

The definition selects the distance measure, jet radius, and transverse- momentum threshold used to reconstruct jets from final-state momenta.

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)
assert definition.radius == 0.4
assert len(clustering.jets) == 2

Parameters

algorithm (JetAlgorithm) Generalized-kT algorithm to use.
radius (float) Jet-radius parameter.
minimum_pt (float, optional) Minimum transverse momentum of returned jets.

Attributes

Name	Description
`algorithm`	Return the selected clustering algorithm.
`minimum_pt`	Return the minimum transverse momentum for retained jets.
`radius`	Return the jet-radius parameter.

`algorithm`

JetDefinition.algorithm: JetAlgorithm

Return the selected clustering algorithm.

Examples

Using the setup in the JetDefinition class example:

assert definition.algorithm == hep.JetAlgorithm.AntiKt

`minimum_pt`

JetDefinition.minimum_pt: builtins.float

Return the minimum transverse momentum for retained jets.

Examples

Using the setup in the JetDefinition class example:

assert definition.minimum_pt == 20.0

`radius`

JetDefinition.radius: builtins.float

Return the jet-radius parameter.

Examples

Using the setup in the JetDefinition class example:

assert definition.radius == 0.4

Methods

Name	Description
`__new__`	Construct a generalized-kT jet definition.
`anti_kt`	Construct an anti-kT jet definition.
`cambridge_aachen`	Construct a Cambridge-Aachen jet definition.
`cluster`	Cluster four-momenta with this sequential-recombination definition.
`kt`	Construct a kT jet definition.

`new`

JetDefinition.__new__(
    algorithm: JetAlgorithm,
    radius: builtins.float,
    minimum_pt: builtins.float = 0.0,
) -> JetDefinition

Construct a generalized-kT jet definition.

Examples

Using the setup in the JetDefinition class example:

definition = hep.JetDefinition(hep.JetAlgorithm.AntiKt, 0.4, 20.0)

Parameters

algorithm (JetAlgorithm) Generalized-kT algorithm.
radius (float) Jet-radius parameter.
minimum_pt (float, optional) Minimum transverse momentum for returned jets.

`anti_kt`

JetDefinition.anti_kt(radius: builtins.float, minimum_pt: builtins.float = 0.0) -> JetDefinition

Construct an anti-kT jet definition.

Examples

Using the setup in the JetDefinition class example:

definition = hep.JetDefinition.anti_kt(0.4, minimum_pt=20.0)

Parameters

radius (float) Jet-radius parameter.
minimum_pt (float, optional) Minimum transverse momentum for returned jets.

`cambridge_aachen`

JetDefinition.cambridge_aachen(
    radius: builtins.float,
    minimum_pt: builtins.float = 0.0,
) -> JetDefinition

Construct a Cambridge-Aachen jet definition.

Examples

Using the setup in the JetDefinition class example:

definition = hep.JetDefinition.cambridge_aachen(0.4)

Parameters

radius (float) Jet-radius parameter.
minimum_pt (float, optional) Minimum transverse momentum for returned jets.

`cluster`

JetDefinition.cluster(momenta: typing.Sequence[FourMomentum]) -> ClusteringResult

Cluster four-momenta with this sequential-recombination definition.

Examples

Using the setup in the JetDefinition class example:

result = definition.cluster(particles)
assert len(result.jets) == 2

Parameters

momenta (sequence of FourMomentum) Input four-momenta to cluster.

`kt`

JetDefinition.kt(radius: builtins.float, minimum_pt: builtins.float = 0.0) -> JetDefinition

Construct a kT jet definition.

Examples

Using the setup in the JetDefinition class example:

definition = hep.JetDefinition.kt(0.4)

Parameters

radius (float) Jet-radius parameter.
minimum_pt (float, optional) Minimum transverse momentum for returned jets.