diff --git a/previews/PR97/.documenter-siteinfo.json b/previews/PR97/.documenter-siteinfo.json index accf535..0c44c34 100644 --- a/previews/PR97/.documenter-siteinfo.json +++ b/previews/PR97/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.11.2","generation_timestamp":"2024-12-06T15:56:34","documenter_version":"1.8.0"}} \ No newline at end of file +{"documenter":{"julia_version":"1.11.2","generation_timestamp":"2024-12-16T04:02:46","documenter_version":"1.8.0"}} \ No newline at end of file diff --git a/previews/PR97/EDM4hep/index.html b/previews/PR97/EDM4hep/index.html index 4257c88..a86e755 100644 --- a/previews/PR97/EDM4hep/index.html +++ b/previews/PR97/EDM4hep/index.html @@ -12,4 +12,4 @@ recps = RootIO.get(reader, evt, "ReconstructedParticles") -cs = jet_reconstruct(recps; algorithm = JetAlgorithm.Durham)

Function Index

EDM4hep Interfaces

JetReconstruction.energy — Method
JetReconstruction.energy(recoparticle::ReconstructedParticle)

Return the energy component of a ReconstructedParticle's four vector.

source
JetReconstruction.px — Method
JetReconstruction.px(recoparticle::ReconstructedParticle)

Return the x component of the momentum of a ReconstructedParticle.

source
JetReconstruction.py — Method
JetReconstruction.py(recoparticle::ReconstructedParticle)

Return the y component of the momentum of a ReconstructedParticle.

source
JetReconstruction.pz — Method
JetReconstruction.pz(recoparticle::ReconstructedParticle)

Return the z component of the momentum of a ReconstructedParticle.

source
+cs = jet_reconstruct(recps; algorithm = JetAlgorithm.Durham)

Function Index

EDM4hep Interfaces

JetReconstruction.energy — Method
JetReconstruction.energy(recoparticle::ReconstructedParticle)

Return the energy component of a ReconstructedParticle's four vector.

source
JetReconstruction.px — Method
JetReconstruction.px(recoparticle::ReconstructedParticle)

Return the x component of the momentum of a ReconstructedParticle.

source
JetReconstruction.py — Method
JetReconstruction.py(recoparticle::ReconstructedParticle)

Return the y component of the momentum of a ReconstructedParticle.

source
JetReconstruction.pz — Method
JetReconstruction.pz(recoparticle::ReconstructedParticle)

Return the z component of the momentum of a ReconstructedParticle.

source
diff --git a/previews/PR97/examples/index.html b/previews/PR97/examples/index.html index 940f543..8e8e70f 100644 --- a/previews/PR97/examples/index.html +++ b/previews/PR97/examples/index.html @@ -4,4 +4,4 @@ julia --project=examples examples/jetreco.jl --algorithm=Durham test/data/events.eeH.hepmc3.gz ... julia --project=examples examples/jetreco.jl --maxevents=10 --strategy=N2Plain --algorithm=Kt --exclusive-njets=3 test/data/events.pp13TeV.hepmc3.gz -...

There are options to explicitly set the algorithm (use --help to see these).

instrumented-jetreco.jl

This is a more sophisticated example that allows performance measurements to be made of the reconstruction, as well as profiling (flamegraphs and memory profiling). Use the --help option to see usage. e.g., to extract timing performance for the AntiKt algorithm using the tiled strategy:

julia --project instrumented-jetreco.jl -S N2Tiled -A AntiKt --nsamples 100 ../test/data/events.hepmc3

visualise-jets.jl

This script will produce a PNG/PDF showing the results of a jet reconstruction. This is a 3D plot where all the initial energy deposits are visualised, with colours that indicate in which final cluster the deposit ended up in.

visualise-jets.ipynb

Similar to visualise-jets.jl this notebook will produce a visualisation of jet reconstruction in the browser. This is a 3D plot where all the initial energy deposits are visualised, with colours that indicate in which final cluster the deposit ended up in.

animate-reconstruction.jl

Performs jet reconstruction and then produces and animation of the process, showing how the jets merge from their different constituents.

EDM4hep

The examples/EDM4hep folder contains examples of using EDM4hep reconstructed particles as input to jet reconstruction. See the specific README.md file in that directory as well as EDM4hep Inputs.

Jet Constituents

The examples/constituents folder shows an example of the two mechanisms to retrieve jet constituents.

+...

There are options to explicitly set the algorithm (use --help to see these).

instrumented-jetreco.jl

This is a more sophisticated example that allows performance measurements to be made of the reconstruction, as well as profiling (flamegraphs and memory profiling). Use the --help option to see usage. e.g., to extract timing performance for the AntiKt algorithm using the tiled strategy:

julia --project instrumented-jetreco.jl -S N2Tiled -A AntiKt --nsamples 100 ../test/data/events.hepmc3

visualise-jets.jl

This script will produce a PNG/PDF showing the results of a jet reconstruction. This is a 3D plot where all the initial energy deposits are visualised, with colours that indicate in which final cluster the deposit ended up in.

visualise-jets.ipynb

Similar to visualise-jets.jl this notebook will produce a visualisation of jet reconstruction in the browser. This is a 3D plot where all the initial energy deposits are visualised, with colours that indicate in which final cluster the deposit ended up in.

animate-reconstruction.jl

Performs jet reconstruction and then produces and animation of the process, showing how the jets merge from their different constituents.

EDM4hep

The examples/EDM4hep folder contains examples of using EDM4hep reconstructed particles as input to jet reconstruction. See the specific README.md file in that directory as well as EDM4hep Inputs.

Jet Constituents

The examples/constituents folder shows an example of the two mechanisms to retrieve jet constituents.

diff --git a/previews/PR97/extras/serialisation/index.html b/previews/PR97/extras/serialisation/index.html index e418a76..00e0fb9 100644 --- a/previews/PR97/extras/serialisation/index.html +++ b/previews/PR97/extras/serialisation/index.html @@ -1,2 +1,2 @@ -Serialisation · JetReconstruction.jl
GitHub

Jet Serialisation

The package provides methods such as loadjets, loadjets!, and savejets that one can use to save and load objects on/from disk easily in a very flexible format. See documentation for more.

+Serialisation · JetReconstruction.jl
GitHub

Jet Serialisation

The package provides methods such as loadjets, loadjets!, and savejets that one can use to save and load objects on/from disk easily in a very flexible format. See documentation for more.

diff --git a/previews/PR97/index.html b/previews/PR97/index.html index bee109a..c7d1376 100644 --- a/previews/PR97/index.html +++ b/previews/PR97/index.html @@ -20,4 +20,4 @@ eprint={2309.17309}, archivePrefix={arXiv}, primaryClass={hep-ex} -}

Code in this package is authored by:

and is Copyright 2022-2024 The Authors, CERN.

The code is under the MIT License.

+}

Code in this package is authored by:

and is Copyright 2022-2024 The Authors, CERN.

The code is under the MIT License.

diff --git a/previews/PR97/lib/internal/index.html b/previews/PR97/lib/internal/index.html index c5208dc..eb56eae 100644 --- a/previews/PR97/lib/internal/index.html +++ b/previews/PR97/lib/internal/index.html @@ -1,9 +1,9 @@ -Internal API · JetReconstruction.jl
GitHub

Jet Reconstruction Internal Documentation

Documentation for JetReconstruction.jl's internal methods and types.

N.B. no guarantee is made of stability of these interfaces or types.

Index

Internal Methods and Types

Base.:+ — Method
+(j1::PseudoJet, j2::PseudoJet)

Addition operator for PseudoJet objects.

Arguments

  • j1::PseudoJet: The first PseudoJet object.
  • j2::PseudoJet: The second PseudoJet object.

Returns

A new PseudoJet object with the sum of the momenta and energy of j1 and j2.

source
Base.copy — Method
copy(j::TiledJet)

Create a copy of a TiledJet object.

Arguments

  • j::TiledJet: The TiledJet object to be copied.

Returns

A new TiledJet object with the same attributes as the input object.

source
Base.eltype — Method
Base.eltype(::Type{EEjet{T}}) where T

Return the element type of the EEjet struct.

source
Base.eltype — Method
Base.eltype(::Type{PseudoJet{T}}) where T

Return the element type of the PseudoJet struct.

source
Base.iterate — Function
Base.iterate(t::neighbour_tiles, state=1)

Iterate over the neighbour_tiles object, returning all the neighbour tiles for a given Cartesian tile index.

source
Base.iterate — Function
Base.iterate(t::rightmost_tiles, state=1)

Iterate over the rightmost_tiles object, returning all the rightmost tiles for a given Cartesian tile index.

source
Base.iterate — Method
Base.iterate(tj::TiledJet)

Iterate over a TiledJet object's linked list, walking over all jets until the end (then the next jet is invalid).

Arguments

  • tj::TiledJet: The TiledJet object to start to iterate over.
source
Base.show — Method
show(io::IO, jet::PseudoJet)

Print a PseudoJet object to the specified IO stream.

Arguments

  • io::IO: The IO stream to which the information will be printed.
  • jet::PseudoJet: The PseudoJet object whose information will be printed.
source
Base.tryparse — Method
Base.tryparse(E::Type{<:Enum}, str::String)

Parser that converts a string to an enum value if it exists, otherwise returns nothing.

source
JetReconstruction.CosTheta — Method
CosTheta(p::PseudoJet)

Compute the cosine of the angle between the momentum vector p and the z-axis.

Arguments

  • p::PseudoJet: The PseudoJet object representing the momentum vector.

Returns

  • The cosine of the angle between p and the z-axis.
source
JetReconstruction._ee_genkt_algorithm — Method
_ee_genkt_algorithm(; particles::Vector{EEjet}, p = 1, R = 4.0,
+Internal API · JetReconstruction.jl
GitHub
Jet Reconstruction Internal Documentation
Documentation for JetReconstruction.jl's internal methods and types.
N.B. no guarantee is made of stability of these interfaces or types.
Index
Internal Methods and Types
Base.:+ — Method
+(j1::PseudoJet, j2::PseudoJet)
Addition operator for PseudoJet objects.
Arguments
  • j1::PseudoJet: The first PseudoJet object.
  • j2::PseudoJet: The second PseudoJet object.
Returns
A new PseudoJet object with the sum of the momenta and energy of j1 and j2.
source
Base.copy — Method
copy(j::TiledJet)
Create a copy of a TiledJet object.
Arguments
  • j::TiledJet: The TiledJet object to be copied.
Returns
A new TiledJet object with the same attributes as the input object.
source
Base.eltype — Method
Base.eltype(::Type{EEjet{T}}) where T
Return the element type of the EEjet struct.
source
Base.eltype — Method
Base.eltype(::Type{PseudoJet{T}}) where T
Return the element type of the PseudoJet struct.
source
Base.iterate — Function
Base.iterate(t::neighbour_tiles, state=1)
Iterate over the neighbour_tiles object, returning all the neighbour tiles for a given Cartesian tile index.
source
Base.iterate — Function
Base.iterate(t::rightmost_tiles, state=1)
Iterate over the rightmost_tiles object, returning all the rightmost tiles for a given Cartesian tile index.
source
Base.iterate — Method
Base.iterate(tj::TiledJet)
Iterate over a TiledJet object's linked list, walking over all jets until the end (then the next jet is invalid).
Arguments
  • tj::TiledJet: The TiledJet object to start to iterate over.
source
Base.show — Method
show(io::IO, jet::PseudoJet)
Print a PseudoJet object to the specified IO stream.
Arguments
  • io::IO: The IO stream to which the information will be printed.
  • jet::PseudoJet: The PseudoJet object whose information will be printed.
source
Base.tryparse — Method
Base.tryparse(E::Type{<:Enum}, str::String)
Parser that converts a string to an enum value if it exists, otherwise returns nothing.
source
JetReconstruction.CosTheta — Method
CosTheta(p::PseudoJet)
Compute the cosine of the angle between the momentum vector p and the z-axis.
Arguments
  • p::PseudoJet: The PseudoJet object representing the momentum vector.
Returns
  • The cosine of the angle between p and the z-axis.
source
JetReconstruction._ee_genkt_algorithm — Method
_ee_genkt_algorithm(; particles::Vector{EEjet}, p = 1, R = 4.0,
                    algorithm::JetAlgorithm.Algorithm = JetAlgorithm.Durham,
-                   recombine = +)
This function is the actual implementation of the e+e- jet clustering algorithm.
source
JetReconstruction._ensure_valid_rap_phi — Method
_ensure_valid_rap_phi(p::PseudoJet)
Ensure that the rapidity and azimuthal angle of the PseudoJet p are valid. If the azimuthal angle is invalid (used as a proxy for both variables), they are set to a valid value using _set_rap_phi!.
Arguments
  • p::PseudoJet: The PseudoJet object to ensure valid rapidity and azimuthal angle for.
source
JetReconstruction._plain_jet_reconstruct — Method
_plain_jet_reconstruct(; particles::Vector{PseudoJet}, p = -1, R = 1.0, recombine = +)
This is the internal implementation of jet reconstruction using the plain algorithm. It takes a vector of particles representing the input particles and reconstructs jets based on the specified parameters. Here the particles must be of type PseudoJet.
Users of the package should use the plain_jet_reconstruct function as their entry point to this jet reconstruction.
The power value maps to specific pp jet reconstruction algorithms: -1 = AntiKt, 0 = Cambridge/Aachen, 1 = Inclusive Kt. Floating point values are allowed for generalised k_t algorithm.
Arguments
  • particles: A vector of PseudoJet objects representing the input particles.
  • p=-1: The power to which the transverse momentum (pt) of each particle is raised.
  • R=1.0: The jet radius parameter.
  • recombine: The recombination function used to merge two jets. Default is + (additive recombination).
Returns
  • clusterseq: The resulting ClusterSequence object representing the reconstructed jets.
source
JetReconstruction._set_rap_phi! — Method
setrap_phi!(p::PseudoJet)
Set the rapidity and azimuthal angle of the PseudoJet p.
Arguments
  • p::PseudoJet: The PseudoJet object for which to set the rapidity and azimuthal angle.
Description
This function calculates and sets the rapidity and azimuthal angle of the PseudoJet p based on its momentum components. The rapidity is calculated in a way that is insensitive to roundoff errors when the momentum components are large. If the PseudoJet represents a point with infinite rapidity, a large number is assigned to the rapidity in order to lift the degeneracy between different zero-pt momenta.
Note - the ϕ angle is calculated in the range [0, 2π).
source
JetReconstruction._tiled_jet_reconstruct — Method
_tiled_jet_reconstruct(particles::Vector{PseudoJet}; p = -1, R = 1.0, recombine = +) where {T}
Main jet reconstruction algorithm entry point for reconstructing jets once preprocessing of data types are done.
Arguments
  • particles::Vector{PseudoJet}: A vector of PseudoJet particles used as input for jet reconstruction.
  • p::Int = -1: The power parameter for the jet reconstruction algorithm, thus switching between different algorithms.
  • R::Float64 = 1.0: The jet radius parameter for the jet reconstruction algorithm.
  • recombine::Function = +: The recombination function used for combining pseudojets.
Returns
  • Vector{PseudoJet}: A vector of reconstructed jets.
Example
tiled_jet_reconstruct(particles::Vector{PseudoJet}; p = 1, R = 1.0, recombine = +)
source
JetReconstruction._tj_diJ — Method
_tj_diJ(jet)
Compute the dij metric value for a given jet.
Arguments
  • jet: The input jet.
Returns
  • The dij value for the jet.
Example
source
JetReconstruction._tj_dist — Method
_tj_dist(jetA, jetB)
Compute the geometric distance in the (y, ϕ)-plane between two jets in the TiledAlgoLL module.
Arguments
  • jetA: The first jet.
  • jetB: The second jet.
Returns
The squared distance between jetA and jetB.
Examples
source
JetReconstruction.add_step_to_history! — Method
add_step_to_history!(clusterseq::ClusterSequence, parent1, parent2, jetp_index, dij)
Add a new jet's history into the recombination sequence.
Arguments:
  • clusterseq::ClusterSequence: The cluster sequence object.
  • parent1: The index of the first parent.
  • parent2: The index of the second parent.
  • jetp_index: The index of the jet.
  • dij: The dij value.
This function adds a new HistoryElement to the history vector of the clusterseq object. The HistoryElement contains information about the parents, child, jet index, dij value, and the maximum dij value so far. It also updates the child index of the parent elements.
If the parent1 or parent2 have already been recombined, an InternalError is thrown. The jetp_index is used to update the _cluster_hist_index of the corresponding PseudoJet object.
source
JetReconstruction.add_untagged_neighbours_to_tile_union — Method
add_untagged_neighbours_to_tile_union(center_index, tile_union, n_near_tiles, tiling)
Adds to the vector tileunion the tiles that are in the neighbourhood of the specified centerindex, including itself and whose tagged status are false - start adding from position nneartiles-1, and increase nneartiles. When a neighbour is added its tagged status is set to true.
Arguments
  • center_index: The index of the center tile.
  • tile_union: An array to store the indices of neighbouring tiles.
  • n_near_tiles: The number of neighbouring tiles.
  • tiling: The tiling object containing the tile tags.
Returns
The updated number of near tiles.
source
JetReconstruction.angular_distance — Method
angular_distance(eereco, i, j) -> Float64
Calculate the angular distance between two jets i and j using the formula $1 - cos(θ_{ij})$.
Arguments
  • eereco: The array of EERecoJet objects.
  • i: The first jet.
  • j: The second jet.
Returns
  • Float64: The angular distance between i and j, which is $1 - cos	heta$.
source
JetReconstruction.detach! — Method
detach!(jet::TiledJet)
Detach a TiledJet from its linked list by updating the previous and next pointers.
Arguments
  • jet::TiledJet: The TiledJet object to detach.
source
JetReconstruction.determine_rapidity_extent — Method
determine_rapidity_extent(eta::Vector{T}) where T <: AbstractFloat
Calculate the minimum and maximum rapidities based on the input vector eta. The function determines the rapidity extent by binning the multiplicities as a function of rapidity and finding the minimum and maximum rapidities such that the edge bins contain a certain fraction (~1/4) of the busiest bin and a minimum number of particles.
This is the heuristic which is used by FastJet (inline comments are from FastJet).
Arguments
  • eta::Vector{T}: A vector of rapidity values.
Returns
  • minrap::T: The minimum rapidity value.
  • maxrap::T: The maximum rapidity value.
source
JetReconstruction.dij — Method
dij(i, kt2_array, nn, nndist)
Compute the dij value for a given index i to its nearest neighbor. The nearest neighbor is determined from nn[i], and the metric distance to the nearest neighbor is given by the distance nndist[i] applying the lower of the kt2_array values for the two particles.ßß
Arguments
  • i: The index of the element.
  • kt2_array: An array of kt2 values.
  • nn: An array of nearest neighbors.
  • nndist: An array of nearest neighbor distances.
Returns
  • The computed dij value.
source
JetReconstruction.dij_dist — Method
dij_dist(eereco, i, j, dij_factor)
Calculate the dij distance between two $e^+e^-$jets.
Arguments
  • eereco: The array of EERecoJet objects.
  • i: The first jet.
  • j: The second jet.
  • dij_factor: The scaling factor to multiply the dij distance by.
Returns
  • The dij distance between i and j.
source
JetReconstruction.dist — Method
dist(i, j, rapidity_array, phi_array)
Compute the distance between points in a 2D space defined by rapidity and phi coordinates.
Arguments
  • i::Int: Index of the first point to consider (indexes into rapidity_array and phi_array).
  • j::Int: Index of the second point to consider (indexes into rapidity_array and phi_array).
  • rapidity_array::Vector{Float64}: Array of rapidity coordinates.
  • phi_array::Vector{Float64}: Array of phi coordinates.
Returns
  • distance::Float64: The distance between the two points.
source
JetReconstruction.do_iB_recombination_step! — Method
do_iB_recombination_step!(clusterseq::ClusterSequence, jet_i, diB)
Bookkeeping for recombining a jet with the beam (i.e., finalising the jet) by adding a step to the history of the cluster sequence.
Arguments
  • clusterseq::ClusterSequence: The cluster sequence object.
  • jet_i: The index of the jet.
  • diB: The diB value.
source
JetReconstruction.do_ij_recombination_step! — Function
do_ij_recombination_step!(clusterseq::ClusterSequence, jet_i, jet_j, dij, recombine=+)
Perform the bookkeeping associated with the step of recombining jeti and jetj (assuming a distance dij).
Arguments
  • clusterseq::ClusterSequence: The cluster sequence object.
  • jet_i: The index of the first jet to be recombined.
  • jet_j: The index of the second jet to be recombined.
  • dij: The distance between the two jets.
  • recombine=+: The recombination function to be used. Default is addition.
Returns
  • newjet_k: The index of the newly created jet.
Description
This function performs the i-j recombination step in the cluster sequence. It creates a new jet by recombining the first two jets using the specified recombination function. The new jet is then added to the cluster sequence. The function also updates the indices and history information of the new jet and sorts out the history.
source
JetReconstruction.energy — Method
energy(p::PseudoJet)
Return the energy of a PseudoJet.
Arguments
  • p::PseudoJet: The PseudoJet object.
Returns
  • The energy of the PseudoJet.
source
JetReconstruction.eta — Method
eta(p::PseudoJet)
Compute the pseudorapidity (η) of a PseudoJet.
Arguments
  • p::PseudoJet: The PseudoJet object for which to compute the pseudorapidity.
Returns
  • The pseudorapidity (η) of the PseudoJet.
source
JetReconstruction.fast_findmin — Method
fast_findmin(dij, n)
Find the minimum value and its index in the first n elements of the dij array. The use of @turbo macro gives a significant performance boost.
Arguments
  • dij: An array of values.
  • n: The number of elements to consider in the dij array.
Returns
  • dij_min: The minimum value in the first n elements of the dij array.
  • best: The index of the minimum value in the dij array.
source
JetReconstruction.find_tile_neighbours! — Method
find_tile_neighbours!(tile_union, jetA, jetB, oldB, tiling)
Find the union of neighbouring tiles of jetA, jetB, and oldB and add them to the tile_union. This established the set of tiles over which searches for updated and new nearest-neighbours must be run
Arguments
  • tile_union: The tile union to which the neighbouring tiles will be added.
  • jetA: The first jet.
  • jetB: The second jet.
  • oldB: The old second jet.
  • tiling: The tiling information.
Returns
The number of neighbouring tiles added to the tile_union.
source
JetReconstruction.geometric_distance — Method
geometric_distance(eta1::AbstractFloat, phi1::AbstractFloat, eta2::AbstractFloat, phi2::AbstractFloat)
Compute the geometric distance between two points in the rap-phi plane.
Arguments
  • eta1::AbstractFloat: The eta coordinate of the first point.
  • phi1::AbstractFloat: The phi coordinate of the first point.
  • eta2::AbstractFloat: The eta coordinate of the second point.
  • phi2::AbstractFloat: The phi coordinate of the second point.
Returns
  • distance::Float64: The geometric distance between the two points.
source
JetReconstruction.get_algorithm_power_consistency — Method
get_algorithm_power_consistency(; p::Union{Real, Nothing}, algorithm::Union{JetAlgorithm, Nothing})
Get the algorithm and power consistency correct
This function checks the consistency between the algorithm and power parameters. If the algorithm is specified, it checks if the power parameter is consistent with the algorithm's known power. If the power parameter is not specified, it sets the power parameter based on the algorithm. If neither the algorithm nor the power parameter is specified, it throws an ArgumentError.
Arguments
  • p::Union{Real, Nothing}: The power value.
  • algorithm::Union{JetAlgorithm, Nothing}: The algorithm.
Returns
A named tuple of the consistent power and algorithm values.
Throws
  • ArgumentError: If the algorithm and power are inconsistent or if neither the algorithm nor the power is specified.
source
JetReconstruction.get_all_ancestors — Method
get_all_ancestors(idx, cs::ClusterSequence)
Recursively finds all ancestors of a given index in a ClusterSequence object.
Arguments
  • idx: The index of the jet for which to find ancestors.
  • cs: The ClusterSequence object containing the jet history.
Returns
An array of indices representing the ancestors of the given jet.
source
JetReconstruction.get_dij_dist — Method
get_dij_dist(nn_dist, kt2_1, kt2_2, R2)
Compute the dij metric distance between two jets.
Arguments
  • nn_dist: The nearest-neighbor distance between two jets.
  • kt2_1: The squared momentum metric value of the first jet.
  • kt2_2: The squared momentum metric value of the second jet.
  • R2: The jet radius parameter squared.
Returns
The distance between the two jets.
If kt2_2 is equal to 0.0, then the first jet doesn't actually have a valid  neighbour, so it's treated as a single jet adjacent to the beam.
source
JetReconstruction.get_tile — Method
get_tile(tiling_setup::TilingDef, eta::AbstractFloat, phi::AbstractFloat)
Given a tiling_setup object, eta and phi values, this function calculates the tile indices for the given eta and phi values.
Arguments
  • tiling_setup: A TilingDef object that contains the tiling setup parameters.
  • eta: The eta value for which to calculate the tile index.
  • phi: The phi value for which to calculate the tile index.
Returns
  • ieta: The tile index along the eta direction.
  • iphi: The tile index along the phi direction.
source
JetReconstruction.get_tile_cartesian_indices — Method
get_tile_linear_index(tiling_setup::TilingDef, i_η::Int, i_ϕ::Int)
Compute the linear index of a tile in a tiled setup. This is much faster in this function than using the LinearIndices construct (like x100, which is bonkers, but there you go...)
Arguments
  • tiling_setup::TilingDef: The tiling setup defining the number of tiles in each dimension.
  • i_η::Int: The index of the tile in the η dimension.
  • i_ϕ::Int: The index of the tile in the ϕ dimension.
Returns
  • The linear index of the tile.
source
JetReconstruction.initial_history — Method
initial_history(particles)
Create an initial history for the given particles.
Arguments
  • particles: The initial vector of stable particles.
Returns
  • history: An array of HistoryElement objects.
  • Qtot: The total energy in the event.
source
JetReconstruction.insert! — Method
insert!(nextjet::TiledJet, jettomove::TiledJet)
Inserts a TiledJet object into the linked list of TiledJet objects, before the nextjet object. The jet to move can be an isolated jet, a jet from another list or a jet from the same list
Arguments
  • nextjet::TiledJet: The TiledJet object after which jettomove should be inserted.
  • jettomove::TiledJet: The TiledJet object to be inserted.
Example
source
JetReconstruction.is_ee — Method
is_ee(algorithm::JetAlgorithm.Algorithm)
Check if the algorithm is a e+e- reconstruction algorithm.
Returns
true if the algorithm is a e+e- reconstruction algorithm, false otherwise.
source
JetReconstruction.is_pp — Method
is_pp(algorithm::JetAlgorithm.Algorithm)
Check if the algorithm is a pp reconstruction algorithm.
Returns
true if the algorithm is a pp reconstruction algorithm, false otherwise.
source
JetReconstruction.isvalid — Method
isvalid(t::TiledJet)
Check if a TiledJet is valid, by seeing if it is not the noTiledJet object.
Arguments
  • t::TiledJet: The TiledJet object to check.
Returns
  • Bool: true if the TiledJet object is valid, false otherwise.
source
JetReconstruction.jet_ranks — Method
jet_ranks(clusterseq::ClusterSequence; compare_fn = JetReconstruction.pt)
Compute the ranks of jets in a given ClusterSequence object based on a specified comparison function.
Arguments
  • clusterseq::ClusterSequence: The ClusterSequence object containing the jets to rank.
  • compare_fn = JetReconstruction.pt: The comparison function used to determine the order of the jets. Defaults to JetReconstruction.pt, which compares jets based on their transverse momentum.
Returns
A dictionary mapping each jet index to its rank.
Note
This is a utility function that can be used to rank initial clusters based on a specified jet property. It can be used to assign a consistent "rank" to each reconstructed jet in the cluster sequence, which is useful for stable plotting of jet outputs.
source
JetReconstruction.m — Method
m(p::PseudoJet)
Compute the invariant mass of a PseudoJet object. By convention if m^2 < 0, then -sqrt{(-m^2)} is returned.
Arguments
  • p::PseudoJet: The PseudoJet object for which to compute the invariant mass.
Returns
The invariant mass of the PseudoJet object.
source
JetReconstruction.m2 — Method
m2(p::PseudoJet)
Calculate the invariant mass squared (m^2) of a PseudoJet.
Arguments
  • p::PseudoJet: The PseudoJet object for which to calculate the invariant mass squared.
Returns
  • The invariant mass squared (m^2) of the PseudoJet.
source
JetReconstruction.mag — Method
mag(p::PseudoJet)
Return the magnitude of the momentum of a PseudoJet, |p|.
Arguments
  • p::PseudoJet: The PseudoJet object for which to compute the magnitude.
Returns
The magnitude of the PseudoJet object.
source
JetReconstruction.mass — Method
mass(p::PseudoJet)
Compute the invariant mass (alias for m(p)).
Arguments
  • p::PseudoJet: The PseudoJet object for which to compute the mass.
Returns
  • The mass of the PseudoJet.
source
JetReconstruction.merge_steps — Method
merge_steps(clusterseq::ClusterSequence)
Compute the number of jet-jet merge steps in a cluster sequence. This is useful to give the number of meaningful recombination steps in a jet reconstruction sequence (beam merge steps are not counted).
Arguments
  • clusterseq::ClusterSequence: The cluster sequence object.
Returns
  • merge_steps::Int: The number of merge steps.
source
JetReconstruction.phi — Method
phi(p::PseudoJet)
Compute the ϕ angle of a PseudoJet object p.
Note this function is a wrapper for phi_02pi(p).
Arguments
  • p::PseudoJet: The PseudoJet object for which to compute the azimuthal angle.
Returns
  • The azimuthal angle of p in the range [0, 2π).
source
JetReconstruction.phi_02pi — Method
phi_02pi(p::PseudoJet)
Compute the azimuthal angle of a PseudoJet object p in the range [0, 2π).
Arguments
  • p::PseudoJet: The PseudoJet object for which to compute the azimuthal angle.
Returns
  • The azimuthal angle of p in the range [0, 2π).
source
JetReconstruction.pt — Method
pt(p::PseudoJet)
Compute the scalar transverse momentum (pt) of a PseudoJet.
Arguments
  • p::PseudoJet: The PseudoJet object for which to compute the transverse momentum.
Returns
  • The transverse momentum (pt) of the PseudoJet.
source
JetReconstruction.pt2 — Method
pt2(p::PseudoJet)
Get the squared transverse momentum of a PseudoJet.
Arguments
  • p::PseudoJet: The PseudoJet object.
Returns
  • The squared transverse momentum of the PseudoJet.
source
JetReconstruction.px — Method
px(p::PseudoJet)
Return the x-component of the momentum of a PseudoJet.
Arguments
  • p::PseudoJet: The PseudoJet object.
Returns
  • The x-component of the momentum of the PseudoJet.
source
JetReconstruction.py — Method
py(p::PseudoJet)
Return the y-component of the momentum of a PseudoJet.
Arguments
  • p::PseudoJet: The PseudoJet object.
Returns
  • The y-component of the momentum of the PseudoJet.
source
JetReconstruction.pz — Method
pz(p::PseudoJet)
Return the z-component of the momentum of a PseudoJet.
Arguments
  • p::PseudoJet: The PseudoJet object.
Returns
  • The z-component of the momentum of the PseudoJet.
source
JetReconstruction.rapidity — Method
rapidity(p::PseudoJet)
Compute the rapidity of a PseudoJet object.
Arguments
  • p::PseudoJet: The PseudoJet object for which to compute the rapidity.
Returns
The rapidity of the PseudoJet object.
source
JetReconstruction.reco_state — Method
reco_state(cs::ClusterSequence, pt_ranks; iteration=0)
This function returns the reconstruction state of a ClusterSequence object based on a given iteration number in the reconstruction.
Arguments
  • cs::ClusterSequence: The ClusterSequence object to update.
  • ranks: The ranks of the original clusters, that are inherited by pseudojets
during the reconstruction process.
  • iteration=0: The iteration number to consider for updating the reconstruction state (0 represents the initial state).
  • ignore_beam_merge=true: Ignore beam merging steps in the reconstruction (which produce no change in status).
Returns
A dictionary representing a snapshot of the reconstruction state.
Details
The function starts by initializing the reconstruction state with the initial particles. Then, it walks over the iteration sequence and updates the reconstruction state based on the history of recombination and finalization/beam merger steps.
source
JetReconstruction.rightneighbours — Method
rightneighbours(center::Int, tiling::Tiling)
Compute the indices of the right neighbors of a given center index in a tiling. This is used in the initial sweep to calculate the nearest neighbors, where the search between jets for the nearest neighbour is bi-directional, thus when a tile is considered only the right neighbours are needed to compare jet distances as the left-hand tiles have been done from that tile already.
Arguments
  • center::Int: The center index.
  • tiling::Tiling: The tiling object.
Returns
  • Surrounding: An object containing the indices of the right neighbors.
source
JetReconstruction.set_momentum! — Method
set_momentum!(j::PseudoJet, px, py, pz, E)
Set the momentum components and energy of a PseudoJet object.
Arguments
  • j::PseudoJet: The PseudoJet object to set the momentum for.
  • px: The x-component of the momentum.
  • py: The y-component of the momentum.
  • pz: The z-component of the momentum.
  • E: The energy of the particle.
source
JetReconstruction.set_nearest_neighbours! — Method
set_nearest_neighbours!(clusterseq::ClusterSequence, tiling::Tiling, tiledjets::Vector{TiledJet})
This function sets the nearest neighbor information for all jets in the tiledjets vector.
Arguments
  • clusterseq::ClusterSequence: The cluster sequence object.
  • tiling::Tiling: The tiling object.
  • tiledjets::Vector{TiledJet}: The vector of tiled jets.
Returns
  • NNs::Vector{TiledJet}: The vector of nearest neighbor jets.
  • diJ::Vector{Float64}: The vector of diJ values.
The function iterates over each tile in the tiling and sets the nearest neighbor information for each jet in the tile. It then looks for neighbor jets in the neighboring tiles and updates the nearest neighbor information accordingly. Finally, it creates the diJ table and returns the vectors of nearest neighbor jets and diJ values.
Note: The diJ values are calculated as the kt distance multiplied by R^2.
source
JetReconstruction.setup_tiling — Method
setup_tiling(eta::Vector{T}, Rparam::AbstractFloat) where T <: AbstractFloat
This function sets up the tiling parameters for a reconstruction given a vector of rapidities eta and a radius parameter Rparam.
Arguments
  • eta::Vector{T}: A vector of rapidities.
  • Rparam::AbstractFloat: The jet radius parameter.
Returns
  • tiling_setup: A TilingDef object containing the tiling setup parameters.
Description
The function first decides the tile sizes based on the Rparam value. It then determines the number of tiles in the phi direction (n_tiles_phi) based on the tile size. Next, it determines the rapidity extent of the input eta vector and adjusts the values accordingly. Finally, it creates a TilingDef object with the calculated tiling parameters and returns it.
source
JetReconstruction.surrounding — Method
surrounding(center::Int, tiling::Tiling)
Compute the surrounding indices of a given center index in a tiling.
Arguments
  • center::Int: The center index.
  • tiling::Tiling: The tiling object.
Returns
  • Surrounding: An object containing the surrounding indices.
source
JetReconstruction.tile_index — Method
tile_index(tiling_setup, eta::Float64, phi::Float64)
Compute the tile index for a given (eta, phi) coordinate.
Arguments
  • tiling_setup: The tiling setup object containing the tile size and number of tiles.
  • eta::Float64: The eta coordinate.
  • phi::Float64: The phi coordinate.
Returns
The tile index corresponding to the (eta, phi) coordinate.
source
JetReconstruction.tiledjet_remove_from_tiles! — Method
tiledjet_remove_from_tiles!(tiling, jet)
Remove a jet from the given tiling structure.
Arguments
  • tiling: The tiling structure from which the jet will be removed.
  • jet: The jet to be removed from the tiling structure.
Description
This function removes a jet from the tiling structure. It adjusts the linked list to be consistent with the removal of the jet.
source
JetReconstruction.tiledjet_set_jetinfo! — Method
tiledjet_set_jetinfo!(jet::TiledJet, clusterseq::ClusterSequence, tiling::Tiling, jets_index, R2, p)
Initialise a tiled jet from a PseudoJet (using an index into our ClusterSequence)
Arguments:
  • jet::TiledJet: The TiledJet object to set the information for.
  • clusterseq::ClusterSequence: The ClusterSequence object containing the jets.
  • tiling::Tiling: The Tiling object containing the tile information.
  • jets_index: The index of the jet in the ClusterSequence.
  • R2: The jet radius parameter squared.
  • p: The power to raise the pt2 value to.
This function sets the eta, phi, kt2, jetsindex, NNdist, NN, tile_index, previous, and next fields of the TiledJet object.
Returns:
  • nothing
source
JetReconstruction.upd_nn_crosscheck! — Method
upd_nn_crosscheck!(i, from, to, rapidity_array, phi_array, R2, nndist, nn)
Update the nearest neighbor information for a given particle index i against all particles in the range indexes from to to. The function updates the nndist and nn arrays with the nearest neighbor distance and index respectively, both for particle i and the checked particles [from:to] (hence crosscheck).
Arguments
  • i::Int: The index of the particle to update and check against.
  • from::Int: The starting index of the range of particles to check against.
  • to::Int: The ending index of the range of particles to check against.
  • rapidity_array: An array containing the rapidity values of all particles.
  • phi_array: An array containing the phi values of the all particles.
  • R2: The squared jet distance threshold for considering a particle as a neighbour.
  • nndist: The array that stores the nearest neighbor distances.
  • nn: The array that stores the nearest neighbor indices.
source
JetReconstruction.upd_nn_nocross! — Method
upd_nn_nocross!(i, from, to, rapidity_array, phi_array, R2, nndist, nn)
Update the nearest neighbor information for a given particle index i against all particles in the range indexes from to to. The function updates the nndist and nn arrays with the nearest neighbor distance and index respectively, only for particle i (hence nocross).
Arguments
  • i::Int: The index of the particle to update and check against.
  • from::Int: The starting index of the range of particles to check against.
  • to::Int: The ending index of the range of particles to check against.
  • rapidity_array: An array containing the rapidity values of all particles.
  • phi_array: An array containing the phi values of the all particles.
  • R2: The squared jet distance threshold for considering a particle as a neighbour.
  • nndist: The array that stores the nearest neighbor distances.
  • nn: The array that stores the nearest neighbor indices.
source
JetReconstruction.upd_nn_step! — Method
upd_nn_step!(i, j, k, N, Nn, kt2_array, rapidity_array, phi_array, R2, nndist, nn, nndij)
Update the nearest neighbor information after a jet merge step.
Arguments:
  • i: Index of the first particle in the last merge step.
  • j: Index of the second particle in the last merge step.
  • k: Index of the current particle for which the nearest neighbour will be updated.
  • N: Total number of particles (currently valid array indexes are [1:N]).
  • Nn: Number of nearest neighbors to consider.
  • kt2_array: Array of transverse momentum squared values.
  • rapidity_array: Array of rapidity values.
  • phi_array: Array of azimuthal angle values.
  • R2: Distance threshold squared for nearest neighbors.
  • nndist: Array of nearest neighbor geometric distances.
  • nn: Array of nearest neighbor indices.
  • nndij: Array of metric distances between particles.
This function updates the nearest neighbor information for the current particle k by considering the distances to particles i and j. It checks if the distance between k and i is smaller than the current nearest neighbor distance for k, and updates the nearest neighbor information accordingly. It also updates the nearest neighbor information for i if the distance between k and i is smaller than the current nearest neighbor distance for i. Finally, it checks if the nearest neighbor of k is the total number of particles Nn and updates it to j if necessary.
source
JetReconstruction.EERecoJet — Type
mutable struct EERecoJet{T <: Real}
Optimised struct for e+e jets reconstruction, to be used with StructArrays.
Fields
  • index::Int: The index of the jet.
  • nni::Int: The nearest neighbour index.
  • nndist::T: The distance to the nearest neighbour.
  • dijdist::T: The distance between jets.
  • nx::T: The x-component of the jet's momentum.
  • ny::T: The y-component of the jet's momentum.
  • nz::T: The z-component of the jet's momentum.
  • E2p::T: The energy raised to the power of 2p for this jet.
Type Parameters
  • T <: Real: The type of the numerical values.
source
JetReconstruction.HistoryElement — Type
struct HistoryElement
A struct holding a record of jet mergers and finalisations
Fields:
  • parent1: Index in history where first parent of this jet was created (NonexistentParent if this jet is an original particle)
  • parent2: Index in history where second parent of this jet was created (NonexistentParent if this jet is an original particle); BeamJet if this history entry just labels the fact that the jet has recombined with the beam)
  • child: Index in history where the current jet is recombined with another jet to form its child. It is Invalid if this jet does not further recombine.
  • jetp_index: Index in the jets vector where we will find the PseudoJet object corresponding to this jet (i.e. the jet created at this entry of the history). NB: if this element of the history corresponds to a beam recombination, then jetp_index=Invalid.
  • dij: The distance corresponding to the recombination at this stage of the clustering.
  • max_dij_so_far: The largest recombination distance seen so far in the clustering history.
source
JetReconstruction.HistoryElement — Method
HistoryElement(jetp_index)
Constructs a HistoryElement object with the given jetp_index, used for initialising the history with original particles.
Arguments
  • jetp_index: The index of the jetp.
Returns
A HistoryElement object.
source
JetReconstruction.JetWithAncestors — Type
struct JetWithAncestors
A struct representing a jet with its origin ancestors.
Fields
  • self::PseudoJet: The PseudoJet object for this jet.
  • jetp_index::Int: The index of the jet in the corresponding cluster sequence.
  • ancestors::Set{Int}: A set of indices representing the jetp_indexes of ancestors of the jet (in the cluster sequence).
  • jet_rank::Int: The rank of the jet based on a comparison of all of the jet's ancestors
Note
This structure needs its associated cluster sequence origin to be useful.
source
JetReconstruction.Surrounding — Type
struct Surrounding{N}
Structure used for iterating over neighbour tiles.
Fields
  • indices::NTuple{N, Int}: A tuple of N integers representing the indices.
source
JetReconstruction.TiledJet — Type
struct TiledJet
TiledJet represents a jet in a tiled algorithm for jet reconstruction, with additional information to track the jet's position in the tiled structures.
Fields
  • id::Int: The ID of the jet.
  • eta::Float64: The rapidity of the jet.
  • phi::Float64: The azimuthal angle of the jet.
  • kt2::Float64: The transverse momentum squared of the jet.
  • NN_dist::Float64: The distance to the nearest neighbor.
  • jets_index::Int: The index of the jet in the jet array.
  • tile_index::Int: The index of the tile in the tile array.
  • dij_posn::Int: The position of this jet in the dij compact array.
  • NN::TiledJet: The nearest neighbor.
  • previous::TiledJet: The previous jet.
  • next::TiledJet: The next jet.
source
JetReconstruction.TiledJet — Method
TiledJet(id)
Constructs a TiledJet object with the given id and initializes its properties to zero.
Arguments
  • id: The ID of the TiledJet object.
Returns
A TiledJet object with the specified id and values set to zero or noTiledJet.
source
JetReconstruction.Tiling — Type
struct Tiling
The Tiling struct represents a tiling configuration for jet reconstruction.
Fields
  • setup::TilingDef: The tiling definition used for the configuration.
  • tiles::Matrix{TiledJet}: A matrix of tiled jets, containing the first jet in each tile (then the linked list of the first jet is followed to get access to all jets in this tile).
  • positions::Matrix{Int}: Used to track tiles that are on the edge of ϕ array, where neighbours need to be wrapped around.
  • tags::Matrix{Bool}: The matrix of tags indicating whether a tile is valid or not (set to false initially, then true when the tile has been setup properly).
source
JetReconstruction.Tiling — Method
Tiling(setup::TilingDef)
Constructs a initial Tiling object based on the provided setup parameters.
Arguments
  • setup::TilingDef: The setup parameters for the tiling.
Returns
A Tiling object.
source
JetReconstruction.TilingDef — Type
struct TilingDef
A struct representing the definition of a specific tiling scheme.
Fields
  • _tiles_eta_min::Float64: The minimum rapidity of the tiles.
  • _tiles_eta_max::Float64: The maximum rapidity of the tiles.
  • _tile_size_eta::Float64: The size of a tile in rapidity (usually R^2).
  • _tile_size_phi::Float64: The size of a tile in phi (usually a bit more than R^2).
  • _n_tiles_eta::Int: The number of tiles across rapidity.
  • _n_tiles_phi::Int: The number of tiles across phi.
  • _n_tiles::Int: The total number of tiles.
  • _tiles_ieta_min::Int: The minimum rapidity tile index.
  • _tiles_ieta_max::Int: The maximum rapidity tile index.
Constructor
TilingDef(_tiles_eta_min, _tiles_eta_max, _tile_size_eta, _tile_size_phi,
-	_n_tiles_eta, _n_tiles_phi, _tiles_ieta_min, _tiles_ieta_max)
Constructs a TilingDef object with the given parameters.
source
JetReconstruction.neighbour_tiles — Type
struct neighbour_tiles
A struct representing the neighbouring tiles.
A struct for iterating over all neighbour tiles for a given Cartesian tile index. These are the tiles above and to the right of the given tile (X=included, O=not included):
XXX
+                   recombine = +)
This function is the actual implementation of the e+e- jet clustering algorithm.
source
JetReconstruction._ensure_valid_rap_phi — Method
_ensure_valid_rap_phi(p::PseudoJet)
Ensure that the rapidity and azimuthal angle of the PseudoJet p are valid. If the azimuthal angle is invalid (used as a proxy for both variables), they are set to a valid value using _set_rap_phi!.
Arguments
  • p::PseudoJet: The PseudoJet object to ensure valid rapidity and azimuthal angle for.
source
JetReconstruction._plain_jet_reconstruct — Method
_plain_jet_reconstruct(; particles::Vector{PseudoJet}, p = -1, R = 1.0, recombine = +)
This is the internal implementation of jet reconstruction using the plain algorithm. It takes a vector of particles representing the input particles and reconstructs jets based on the specified parameters. Here the particles must be of type PseudoJet.
Users of the package should use the plain_jet_reconstruct function as their entry point to this jet reconstruction.
The power value maps to specific pp jet reconstruction algorithms: -1 = AntiKt, 0 = Cambridge/Aachen, 1 = Inclusive Kt. Floating point values are allowed for generalised k_t algorithm.
Arguments
  • particles: A vector of PseudoJet objects representing the input particles.
  • p=-1: The power to which the transverse momentum (pt) of each particle is raised.
  • R=1.0: The jet radius parameter.
  • recombine: The recombination function used to merge two jets. Default is + (additive recombination).
Returns
  • clusterseq: The resulting ClusterSequence object representing the reconstructed jets.
source
JetReconstruction._set_rap_phi! — Method
setrap_phi!(p::PseudoJet)
Set the rapidity and azimuthal angle of the PseudoJet p.
Arguments
  • p::PseudoJet: The PseudoJet object for which to set the rapidity and azimuthal angle.
Description
This function calculates and sets the rapidity and azimuthal angle of the PseudoJet p based on its momentum components. The rapidity is calculated in a way that is insensitive to roundoff errors when the momentum components are large. If the PseudoJet represents a point with infinite rapidity, a large number is assigned to the rapidity in order to lift the degeneracy between different zero-pt momenta.
Note - the ϕ angle is calculated in the range [0, 2π).
source
JetReconstruction._tiled_jet_reconstruct — Method
_tiled_jet_reconstruct(particles::Vector{PseudoJet}; p = -1, R = 1.0, recombine = +) where {T}
Main jet reconstruction algorithm entry point for reconstructing jets once preprocessing of data types are done.
Arguments
  • particles::Vector{PseudoJet}: A vector of PseudoJet particles used as input for jet reconstruction.
  • p::Int = -1: The power parameter for the jet reconstruction algorithm, thus switching between different algorithms.
  • R::Float64 = 1.0: The jet radius parameter for the jet reconstruction algorithm.
  • recombine::Function = +: The recombination function used for combining pseudojets.
Returns
  • Vector{PseudoJet}: A vector of reconstructed jets.
Example
tiled_jet_reconstruct(particles::Vector{PseudoJet}; p = 1, R = 1.0, recombine = +)
source
JetReconstruction._tj_diJ — Method
_tj_diJ(jet)
Compute the dij metric value for a given jet.
Arguments
  • jet: The input jet.
Returns
  • The dij value for the jet.
Example
source
JetReconstruction._tj_dist — Method
_tj_dist(jetA, jetB)
Compute the geometric distance in the (y, ϕ)-plane between two jets in the TiledAlgoLL module.
Arguments
  • jetA: The first jet.
  • jetB: The second jet.
Returns
The squared distance between jetA and jetB.
Examples
source
JetReconstruction.add_step_to_history! — Method
add_step_to_history!(clusterseq::ClusterSequence, parent1, parent2, jetp_index, dij)
Add a new jet's history into the recombination sequence.
Arguments:
  • clusterseq::ClusterSequence: The cluster sequence object.
  • parent1: The index of the first parent.
  • parent2: The index of the second parent.
  • jetp_index: The index of the jet.
  • dij: The dij value.
This function adds a new HistoryElement to the history vector of the clusterseq object. The HistoryElement contains information about the parents, child, jet index, dij value, and the maximum dij value so far. It also updates the child index of the parent elements.
If the parent1 or parent2 have already been recombined, an InternalError is thrown. The jetp_index is used to update the _cluster_hist_index of the corresponding PseudoJet object.
source
JetReconstruction.add_untagged_neighbours_to_tile_union — Method
add_untagged_neighbours_to_tile_union(center_index, tile_union, n_near_tiles, tiling)
Adds to the vector tileunion the tiles that are in the neighbourhood of the specified centerindex, including itself and whose tagged status are false - start adding from position nneartiles-1, and increase nneartiles. When a neighbour is added its tagged status is set to true.
Arguments
  • center_index: The index of the center tile.
  • tile_union: An array to store the indices of neighbouring tiles.
  • n_near_tiles: The number of neighbouring tiles.
  • tiling: The tiling object containing the tile tags.
Returns
The updated number of near tiles.
source
JetReconstruction.angular_distance — Method
angular_distance(eereco, i, j) -> Float64
Calculate the angular distance between two jets i and j using the formula $1 - cos(θ_{ij})$.
Arguments
  • eereco: The array of EERecoJet objects.
  • i: The first jet.
  • j: The second jet.
Returns
  • Float64: The angular distance between i and j, which is $1 - cos	heta$.
source
JetReconstruction.detach! — Method
detach!(jet::TiledJet)
Detach a TiledJet from its linked list by updating the previous and next pointers.
Arguments
  • jet::TiledJet: The TiledJet object to detach.
source
JetReconstruction.determine_rapidity_extent — Method
determine_rapidity_extent(eta::Vector{T}) where T <: AbstractFloat
Calculate the minimum and maximum rapidities based on the input vector eta. The function determines the rapidity extent by binning the multiplicities as a function of rapidity and finding the minimum and maximum rapidities such that the edge bins contain a certain fraction (~1/4) of the busiest bin and a minimum number of particles.
This is the heuristic which is used by FastJet (inline comments are from FastJet).
Arguments
  • eta::Vector{T}: A vector of rapidity values.
Returns
  • minrap::T: The minimum rapidity value.
  • maxrap::T: The maximum rapidity value.
source
JetReconstruction.dij — Method
dij(i, kt2_array, nn, nndist)
Compute the dij value for a given index i to its nearest neighbor. The nearest neighbor is determined from nn[i], and the metric distance to the nearest neighbor is given by the distance nndist[i] applying the lower of the kt2_array values for the two particles.ßß
Arguments
  • i: The index of the element.
  • kt2_array: An array of kt2 values.
  • nn: An array of nearest neighbors.
  • nndist: An array of nearest neighbor distances.
Returns
  • The computed dij value.
source
JetReconstruction.dij_dist — Method
dij_dist(eereco, i, j, dij_factor)
Calculate the dij distance between two $e^+e^-$jets.
Arguments
  • eereco: The array of EERecoJet objects.
  • i: The first jet.
  • j: The second jet.
  • dij_factor: The scaling factor to multiply the dij distance by.
Returns
  • The dij distance between i and j.
source
JetReconstruction.dist — Method
dist(i, j, rapidity_array, phi_array)
Compute the distance between points in a 2D space defined by rapidity and phi coordinates.
Arguments
  • i::Int: Index of the first point to consider (indexes into rapidity_array and phi_array).
  • j::Int: Index of the second point to consider (indexes into rapidity_array and phi_array).
  • rapidity_array::Vector{Float64}: Array of rapidity coordinates.
  • phi_array::Vector{Float64}: Array of phi coordinates.
Returns
  • distance::Float64: The distance between the two points.
source
JetReconstruction.do_iB_recombination_step! — Method
do_iB_recombination_step!(clusterseq::ClusterSequence, jet_i, diB)
Bookkeeping for recombining a jet with the beam (i.e., finalising the jet) by adding a step to the history of the cluster sequence.
Arguments
  • clusterseq::ClusterSequence: The cluster sequence object.
  • jet_i: The index of the jet.
  • diB: The diB value.
source
JetReconstruction.do_ij_recombination_step! — Function
do_ij_recombination_step!(clusterseq::ClusterSequence, jet_i, jet_j, dij, recombine=+)
Perform the bookkeeping associated with the step of recombining jeti and jetj (assuming a distance dij).
Arguments
  • clusterseq::ClusterSequence: The cluster sequence object.
  • jet_i: The index of the first jet to be recombined.
  • jet_j: The index of the second jet to be recombined.
  • dij: The distance between the two jets.
  • recombine=+: The recombination function to be used. Default is addition.
Returns
  • newjet_k: The index of the newly created jet.
Description
This function performs the i-j recombination step in the cluster sequence. It creates a new jet by recombining the first two jets using the specified recombination function. The new jet is then added to the cluster sequence. The function also updates the indices and history information of the new jet and sorts out the history.
source
JetReconstruction.energy — Method
energy(p::PseudoJet)
Return the energy of a PseudoJet.
Arguments
  • p::PseudoJet: The PseudoJet object.
Returns
  • The energy of the PseudoJet.
source
JetReconstruction.eta — Method
eta(p::PseudoJet)
Compute the pseudorapidity (η) of a PseudoJet.
Arguments
  • p::PseudoJet: The PseudoJet object for which to compute the pseudorapidity.
Returns
  • The pseudorapidity (η) of the PseudoJet.
source
JetReconstruction.fast_findmin — Method
fast_findmin(dij, n)
Find the minimum value and its index in the first n elements of the dij array. The use of @turbo macro gives a significant performance boost.
Arguments
  • dij: An array of values.
  • n: The number of elements to consider in the dij array.
Returns
  • dij_min: The minimum value in the first n elements of the dij array.
  • best: The index of the minimum value in the dij array.
source
JetReconstruction.find_tile_neighbours! — Method
find_tile_neighbours!(tile_union, jetA, jetB, oldB, tiling)
Find the union of neighbouring tiles of jetA, jetB, and oldB and add them to the tile_union. This established the set of tiles over which searches for updated and new nearest-neighbours must be run
Arguments
  • tile_union: The tile union to which the neighbouring tiles will be added.
  • jetA: The first jet.
  • jetB: The second jet.
  • oldB: The old second jet.
  • tiling: The tiling information.
Returns
The number of neighbouring tiles added to the tile_union.
source
JetReconstruction.geometric_distance — Method
geometric_distance(eta1::AbstractFloat, phi1::AbstractFloat, eta2::AbstractFloat, phi2::AbstractFloat)
Compute the geometric distance between two points in the rap-phi plane.
Arguments
  • eta1::AbstractFloat: The eta coordinate of the first point.
  • phi1::AbstractFloat: The phi coordinate of the first point.
  • eta2::AbstractFloat: The eta coordinate of the second point.
  • phi2::AbstractFloat: The phi coordinate of the second point.
Returns
  • distance::Float64: The geometric distance between the two points.
source
JetReconstruction.get_algorithm_power_consistency — Method
get_algorithm_power_consistency(; p::Union{Real, Nothing}, algorithm::Union{JetAlgorithm, Nothing})
Get the algorithm and power consistency correct
This function checks the consistency between the algorithm and power parameters. If the algorithm is specified, it checks if the power parameter is consistent with the algorithm's known power. If the power parameter is not specified, it sets the power parameter based on the algorithm. If neither the algorithm nor the power parameter is specified, it throws an ArgumentError.
Arguments
  • p::Union{Real, Nothing}: The power value.
  • algorithm::Union{JetAlgorithm, Nothing}: The algorithm.
Returns
A named tuple of the consistent power and algorithm values.
Throws
  • ArgumentError: If the algorithm and power are inconsistent or if neither the algorithm nor the power is specified.
source
JetReconstruction.get_all_ancestors — Method
get_all_ancestors(idx, cs::ClusterSequence)
Recursively finds all ancestors of a given index in a ClusterSequence object.
Arguments
  • idx: The index of the jet for which to find ancestors.
  • cs: The ClusterSequence object containing the jet history.
Returns
An array of indices representing the ancestors of the given jet.
source
JetReconstruction.get_dij_dist — Method
get_dij_dist(nn_dist, kt2_1, kt2_2, R2)
Compute the dij metric distance between two jets.
Arguments
  • nn_dist: The nearest-neighbor distance between two jets.
  • kt2_1: The squared momentum metric value of the first jet.
  • kt2_2: The squared momentum metric value of the second jet.
  • R2: The jet radius parameter squared.
Returns
The distance between the two jets.
If kt2_2 is equal to 0.0, then the first jet doesn't actually have a valid  neighbour, so it's treated as a single jet adjacent to the beam.
source
JetReconstruction.get_tile — Method
get_tile(tiling_setup::TilingDef, eta::AbstractFloat, phi::AbstractFloat)
Given a tiling_setup object, eta and phi values, this function calculates the tile indices for the given eta and phi values.
Arguments
  • tiling_setup: A TilingDef object that contains the tiling setup parameters.
  • eta: The eta value for which to calculate the tile index.
  • phi: The phi value for which to calculate the tile index.
Returns
  • ieta: The tile index along the eta direction.
  • iphi: The tile index along the phi direction.
source
JetReconstruction.get_tile_cartesian_indices — Method
get_tile_linear_index(tiling_setup::TilingDef, i_η::Int, i_ϕ::Int)
Compute the linear index of a tile in a tiled setup. This is much faster in this function than using the LinearIndices construct (like x100, which is bonkers, but there you go...)
Arguments
  • tiling_setup::TilingDef: The tiling setup defining the number of tiles in each dimension.
  • i_η::Int: The index of the tile in the η dimension.
  • i_ϕ::Int: The index of the tile in the ϕ dimension.
Returns
  • The linear index of the tile.
source
JetReconstruction.initial_history — Method
initial_history(particles)
Create an initial history for the given particles.
Arguments
  • particles: The initial vector of stable particles.
Returns
  • history: An array of HistoryElement objects.
  • Qtot: The total energy in the event.
source
JetReconstruction.insert! — Method
insert!(nextjet::TiledJet, jettomove::TiledJet)
Inserts a TiledJet object into the linked list of TiledJet objects, before the nextjet object. The jet to move can be an isolated jet, a jet from another list or a jet from the same list
Arguments
  • nextjet::TiledJet: The TiledJet object after which jettomove should be inserted.
  • jettomove::TiledJet: The TiledJet object to be inserted.
Example
source
JetReconstruction.is_ee — Method
is_ee(algorithm::JetAlgorithm.Algorithm)
Check if the algorithm is a e+e- reconstruction algorithm.
Returns
true if the algorithm is a e+e- reconstruction algorithm, false otherwise.
source
JetReconstruction.is_pp — Method
is_pp(algorithm::JetAlgorithm.Algorithm)
Check if the algorithm is a pp reconstruction algorithm.
Returns
true if the algorithm is a pp reconstruction algorithm, false otherwise.
source
JetReconstruction.isvalid — Method
isvalid(t::TiledJet)
Check if a TiledJet is valid, by seeing if it is not the noTiledJet object.
Arguments
  • t::TiledJet: The TiledJet object to check.
Returns
  • Bool: true if the TiledJet object is valid, false otherwise.
source
JetReconstruction.jet_ranks — Method
jet_ranks(clusterseq::ClusterSequence; compare_fn = JetReconstruction.pt)
Compute the ranks of jets in a given ClusterSequence object based on a specified comparison function.
Arguments
  • clusterseq::ClusterSequence: The ClusterSequence object containing the jets to rank.
  • compare_fn = JetReconstruction.pt: The comparison function used to determine the order of the jets. Defaults to JetReconstruction.pt, which compares jets based on their transverse momentum.
Returns
A dictionary mapping each jet index to its rank.
Note
This is a utility function that can be used to rank initial clusters based on a specified jet property. It can be used to assign a consistent "rank" to each reconstructed jet in the cluster sequence, which is useful for stable plotting of jet outputs.
source
JetReconstruction.m — Method
m(p::PseudoJet)
Compute the invariant mass of a PseudoJet object. By convention if m^2 < 0, then -sqrt{(-m^2)} is returned.
Arguments
  • p::PseudoJet: The PseudoJet object for which to compute the invariant mass.
Returns
The invariant mass of the PseudoJet object.
source
JetReconstruction.m2 — Method
m2(p::PseudoJet)
Calculate the invariant mass squared (m^2) of a PseudoJet.
Arguments
  • p::PseudoJet: The PseudoJet object for which to calculate the invariant mass squared.
Returns
  • The invariant mass squared (m^2) of the PseudoJet.
source
JetReconstruction.mag — Method
mag(p::PseudoJet)
Return the magnitude of the momentum of a PseudoJet, |p|.
Arguments
  • p::PseudoJet: The PseudoJet object for which to compute the magnitude.
Returns
The magnitude of the PseudoJet object.
source
JetReconstruction.mass — Method
mass(p::PseudoJet)
Compute the invariant mass (alias for m(p)).
Arguments
  • p::PseudoJet: The PseudoJet object for which to compute the mass.
Returns
  • The mass of the PseudoJet.
source
JetReconstruction.merge_steps — Method
merge_steps(clusterseq::ClusterSequence)
Compute the number of jet-jet merge steps in a cluster sequence. This is useful to give the number of meaningful recombination steps in a jet reconstruction sequence (beam merge steps are not counted).
Arguments
  • clusterseq::ClusterSequence: The cluster sequence object.
Returns
  • merge_steps::Int: The number of merge steps.
source
JetReconstruction.phi — Method
phi(p::PseudoJet)
Compute the ϕ angle of a PseudoJet object p.
Note this function is a wrapper for phi_02pi(p).
Arguments
  • p::PseudoJet: The PseudoJet object for which to compute the azimuthal angle.
Returns
  • The azimuthal angle of p in the range [0, 2π).
source
JetReconstruction.phi_02pi — Method
phi_02pi(p::PseudoJet)
Compute the azimuthal angle of a PseudoJet object p in the range [0, 2π).
Arguments
  • p::PseudoJet: The PseudoJet object for which to compute the azimuthal angle.
Returns
  • The azimuthal angle of p in the range [0, 2π).
source
JetReconstruction.pt — Method
pt(p::PseudoJet)
Compute the scalar transverse momentum (pt) of a PseudoJet.
Arguments
  • p::PseudoJet: The PseudoJet object for which to compute the transverse momentum.
Returns
  • The transverse momentum (pt) of the PseudoJet.
source
JetReconstruction.pt2 — Method
pt2(p::PseudoJet)
Get the squared transverse momentum of a PseudoJet.
Arguments
  • p::PseudoJet: The PseudoJet object.
Returns
  • The squared transverse momentum of the PseudoJet.
source
JetReconstruction.px — Method
px(p::PseudoJet)
Return the x-component of the momentum of a PseudoJet.
Arguments
  • p::PseudoJet: The PseudoJet object.
Returns
  • The x-component of the momentum of the PseudoJet.
source
JetReconstruction.py — Method
py(p::PseudoJet)
Return the y-component of the momentum of a PseudoJet.
Arguments
  • p::PseudoJet: The PseudoJet object.
Returns
  • The y-component of the momentum of the PseudoJet.
source
JetReconstruction.pz — Method
pz(p::PseudoJet)
Return the z-component of the momentum of a PseudoJet.
Arguments
  • p::PseudoJet: The PseudoJet object.
Returns
  • The z-component of the momentum of the PseudoJet.
source
JetReconstruction.rapidity — Method
rapidity(p::PseudoJet)
Compute the rapidity of a PseudoJet object.
Arguments
  • p::PseudoJet: The PseudoJet object for which to compute the rapidity.
Returns
The rapidity of the PseudoJet object.
source
JetReconstruction.reco_state — Method
reco_state(cs::ClusterSequence, pt_ranks; iteration=0)
This function returns the reconstruction state of a ClusterSequence object based on a given iteration number in the reconstruction.
Arguments
  • cs::ClusterSequence: The ClusterSequence object to update.
  • ranks: The ranks of the original clusters, that are inherited by pseudojets
during the reconstruction process.
  • iteration=0: The iteration number to consider for updating the reconstruction state (0 represents the initial state).
  • ignore_beam_merge=true: Ignore beam merging steps in the reconstruction (which produce no change in status).
Returns
A dictionary representing a snapshot of the reconstruction state.
Details
The function starts by initializing the reconstruction state with the initial particles. Then, it walks over the iteration sequence and updates the reconstruction state based on the history of recombination and finalization/beam merger steps.
source
JetReconstruction.rightneighbours — Method
rightneighbours(center::Int, tiling::Tiling)
Compute the indices of the right neighbors of a given center index in a tiling. This is used in the initial sweep to calculate the nearest neighbors, where the search between jets for the nearest neighbour is bi-directional, thus when a tile is considered only the right neighbours are needed to compare jet distances as the left-hand tiles have been done from that tile already.
Arguments
  • center::Int: The center index.
  • tiling::Tiling: The tiling object.
Returns
  • Surrounding: An object containing the indices of the right neighbors.
source
JetReconstruction.set_momentum! — Method
set_momentum!(j::PseudoJet, px, py, pz, E)
Set the momentum components and energy of a PseudoJet object.
Arguments
  • j::PseudoJet: The PseudoJet object to set the momentum for.
  • px: The x-component of the momentum.
  • py: The y-component of the momentum.
  • pz: The z-component of the momentum.
  • E: The energy of the particle.
source
JetReconstruction.set_nearest_neighbours! — Method
set_nearest_neighbours!(clusterseq::ClusterSequence, tiling::Tiling, tiledjets::Vector{TiledJet})
This function sets the nearest neighbor information for all jets in the tiledjets vector.
Arguments
  • clusterseq::ClusterSequence: The cluster sequence object.
  • tiling::Tiling: The tiling object.
  • tiledjets::Vector{TiledJet}: The vector of tiled jets.
Returns
  • NNs::Vector{TiledJet}: The vector of nearest neighbor jets.
  • diJ::Vector{Float64}: The vector of diJ values.
The function iterates over each tile in the tiling and sets the nearest neighbor information for each jet in the tile. It then looks for neighbor jets in the neighboring tiles and updates the nearest neighbor information accordingly. Finally, it creates the diJ table and returns the vectors of nearest neighbor jets and diJ values.
Note: The diJ values are calculated as the kt distance multiplied by R^2.
source
JetReconstruction.setup_tiling — Method
setup_tiling(eta::Vector{T}, Rparam::AbstractFloat) where T <: AbstractFloat
This function sets up the tiling parameters for a reconstruction given a vector of rapidities eta and a radius parameter Rparam.
Arguments
  • eta::Vector{T}: A vector of rapidities.
  • Rparam::AbstractFloat: The jet radius parameter.
Returns
  • tiling_setup: A TilingDef object containing the tiling setup parameters.
Description
The function first decides the tile sizes based on the Rparam value. It then determines the number of tiles in the phi direction (n_tiles_phi) based on the tile size. Next, it determines the rapidity extent of the input eta vector and adjusts the values accordingly. Finally, it creates a TilingDef object with the calculated tiling parameters and returns it.
source
JetReconstruction.surrounding — Method
surrounding(center::Int, tiling::Tiling)
Compute the surrounding indices of a given center index in a tiling.
Arguments
  • center::Int: The center index.
  • tiling::Tiling: The tiling object.
Returns
  • Surrounding: An object containing the surrounding indices.
source
JetReconstruction.tile_index — Method
tile_index(tiling_setup, eta::Float64, phi::Float64)
Compute the tile index for a given (eta, phi) coordinate.
Arguments
  • tiling_setup: The tiling setup object containing the tile size and number of tiles.
  • eta::Float64: The eta coordinate.
  • phi::Float64: The phi coordinate.
Returns
The tile index corresponding to the (eta, phi) coordinate.
source
JetReconstruction.tiledjet_remove_from_tiles! — Method
tiledjet_remove_from_tiles!(tiling, jet)
Remove a jet from the given tiling structure.
Arguments
  • tiling: The tiling structure from which the jet will be removed.
  • jet: The jet to be removed from the tiling structure.
Description
This function removes a jet from the tiling structure. It adjusts the linked list to be consistent with the removal of the jet.
source
JetReconstruction.tiledjet_set_jetinfo! — Method
tiledjet_set_jetinfo!(jet::TiledJet, clusterseq::ClusterSequence, tiling::Tiling, jets_index, R2, p)
Initialise a tiled jet from a PseudoJet (using an index into our ClusterSequence)
Arguments:
  • jet::TiledJet: The TiledJet object to set the information for.
  • clusterseq::ClusterSequence: The ClusterSequence object containing the jets.
  • tiling::Tiling: The Tiling object containing the tile information.
  • jets_index: The index of the jet in the ClusterSequence.
  • R2: The jet radius parameter squared.
  • p: The power to raise the pt2 value to.
This function sets the eta, phi, kt2, jetsindex, NNdist, NN, tile_index, previous, and next fields of the TiledJet object.
Returns:
  • nothing
source
JetReconstruction.upd_nn_crosscheck! — Method
upd_nn_crosscheck!(i, from, to, rapidity_array, phi_array, R2, nndist, nn)
Update the nearest neighbor information for a given particle index i against all particles in the range indexes from to to. The function updates the nndist and nn arrays with the nearest neighbor distance and index respectively, both for particle i and the checked particles [from:to] (hence crosscheck).
Arguments
  • i::Int: The index of the particle to update and check against.
  • from::Int: The starting index of the range of particles to check against.
  • to::Int: The ending index of the range of particles to check against.
  • rapidity_array: An array containing the rapidity values of all particles.
  • phi_array: An array containing the phi values of the all particles.
  • R2: The squared jet distance threshold for considering a particle as a neighbour.
  • nndist: The array that stores the nearest neighbor distances.
  • nn: The array that stores the nearest neighbor indices.
source
JetReconstruction.upd_nn_nocross! — Method
upd_nn_nocross!(i, from, to, rapidity_array, phi_array, R2, nndist, nn)
Update the nearest neighbor information for a given particle index i against all particles in the range indexes from to to. The function updates the nndist and nn arrays with the nearest neighbor distance and index respectively, only for particle i (hence nocross).
Arguments
  • i::Int: The index of the particle to update and check against.
  • from::Int: The starting index of the range of particles to check against.
  • to::Int: The ending index of the range of particles to check against.
  • rapidity_array: An array containing the rapidity values of all particles.
  • phi_array: An array containing the phi values of the all particles.
  • R2: The squared jet distance threshold for considering a particle as a neighbour.
  • nndist: The array that stores the nearest neighbor distances.
  • nn: The array that stores the nearest neighbor indices.
source
JetReconstruction.upd_nn_step! — Method
upd_nn_step!(i, j, k, N, Nn, kt2_array, rapidity_array, phi_array, R2, nndist, nn, nndij)
Update the nearest neighbor information after a jet merge step.
Arguments:
  • i: Index of the first particle in the last merge step.
  • j: Index of the second particle in the last merge step.
  • k: Index of the current particle for which the nearest neighbour will be updated.
  • N: Total number of particles (currently valid array indexes are [1:N]).
  • Nn: Number of nearest neighbors to consider.
  • kt2_array: Array of transverse momentum squared values.
  • rapidity_array: Array of rapidity values.
  • phi_array: Array of azimuthal angle values.
  • R2: Distance threshold squared for nearest neighbors.
  • nndist: Array of nearest neighbor geometric distances.
  • nn: Array of nearest neighbor indices.
  • nndij: Array of metric distances between particles.
This function updates the nearest neighbor information for the current particle k by considering the distances to particles i and j. It checks if the distance between k and i is smaller than the current nearest neighbor distance for k, and updates the nearest neighbor information accordingly. It also updates the nearest neighbor information for i if the distance between k and i is smaller than the current nearest neighbor distance for i. Finally, it checks if the nearest neighbor of k is the total number of particles Nn and updates it to j if necessary.
source
JetReconstruction.EERecoJet — Type
mutable struct EERecoJet{T <: Real}
Optimised struct for e+e jets reconstruction, to be used with StructArrays.
Fields
  • index::Int: The index of the jet.
  • nni::Int: The nearest neighbour index.
  • nndist::T: The distance to the nearest neighbour.
  • dijdist::T: The distance between jets.
  • nx::T: The x-component of the jet's momentum.
  • ny::T: The y-component of the jet's momentum.
  • nz::T: The z-component of the jet's momentum.
  • E2p::T: The energy raised to the power of 2p for this jet.
Type Parameters
  • T <: Real: The type of the numerical values.
source
JetReconstruction.HistoryElement — Type
struct HistoryElement
A struct holding a record of jet mergers and finalisations
Fields:
  • parent1: Index in history where first parent of this jet was created (NonexistentParent if this jet is an original particle)
  • parent2: Index in history where second parent of this jet was created (NonexistentParent if this jet is an original particle); BeamJet if this history entry just labels the fact that the jet has recombined with the beam)
  • child: Index in history where the current jet is recombined with another jet to form its child. It is Invalid if this jet does not further recombine.
  • jetp_index: Index in the jets vector where we will find the PseudoJet object corresponding to this jet (i.e. the jet created at this entry of the history). NB: if this element of the history corresponds to a beam recombination, then jetp_index=Invalid.
  • dij: The distance corresponding to the recombination at this stage of the clustering.
  • max_dij_so_far: The largest recombination distance seen so far in the clustering history.
source
JetReconstruction.HistoryElement — Method
HistoryElement(jetp_index)
Constructs a HistoryElement object with the given jetp_index, used for initialising the history with original particles.
Arguments
  • jetp_index: The index of the jetp.
Returns
A HistoryElement object.
source
JetReconstruction.JetWithAncestors — Type
struct JetWithAncestors
A struct representing a jet with its origin ancestors.
Fields
  • self::PseudoJet: The PseudoJet object for this jet.
  • jetp_index::Int: The index of the jet in the corresponding cluster sequence.
  • ancestors::Set{Int}: A set of indices representing the jetp_indexes of ancestors of the jet (in the cluster sequence).
  • jet_rank::Int: The rank of the jet based on a comparison of all of the jet's ancestors
Note
This structure needs its associated cluster sequence origin to be useful.
source
JetReconstruction.Surrounding — Type
struct Surrounding{N}
Structure used for iterating over neighbour tiles.
Fields
  • indices::NTuple{N, Int}: A tuple of N integers representing the indices.
source
JetReconstruction.TiledJet — Type
struct TiledJet
TiledJet represents a jet in a tiled algorithm for jet reconstruction, with additional information to track the jet's position in the tiled structures.
Fields
  • id::Int: The ID of the jet.
  • eta::Float64: The rapidity of the jet.
  • phi::Float64: The azimuthal angle of the jet.
  • kt2::Float64: The transverse momentum squared of the jet.
  • NN_dist::Float64: The distance to the nearest neighbor.
  • jets_index::Int: The index of the jet in the jet array.
  • tile_index::Int: The index of the tile in the tile array.
  • dij_posn::Int: The position of this jet in the dij compact array.
  • NN::TiledJet: The nearest neighbor.
  • previous::TiledJet: The previous jet.
  • next::TiledJet: The next jet.
source
JetReconstruction.TiledJet — Method
TiledJet(id)
Constructs a TiledJet object with the given id and initializes its properties to zero.
Arguments
  • id: The ID of the TiledJet object.
Returns
A TiledJet object with the specified id and values set to zero or noTiledJet.
source
JetReconstruction.Tiling — Type
struct Tiling
The Tiling struct represents a tiling configuration for jet reconstruction.
Fields
  • setup::TilingDef: The tiling definition used for the configuration.
  • tiles::Matrix{TiledJet}: A matrix of tiled jets, containing the first jet in each tile (then the linked list of the first jet is followed to get access to all jets in this tile).
  • positions::Matrix{Int}: Used to track tiles that are on the edge of ϕ array, where neighbours need to be wrapped around.
  • tags::Matrix{Bool}: The matrix of tags indicating whether a tile is valid or not (set to false initially, then true when the tile has been setup properly).
source
JetReconstruction.Tiling — Method
Tiling(setup::TilingDef)
Constructs a initial Tiling object based on the provided setup parameters.
Arguments
  • setup::TilingDef: The setup parameters for the tiling.
Returns
A Tiling object.
source
JetReconstruction.TilingDef — Type
struct TilingDef
A struct representing the definition of a specific tiling scheme.
Fields
  • _tiles_eta_min::Float64: The minimum rapidity of the tiles.
  • _tiles_eta_max::Float64: The maximum rapidity of the tiles.
  • _tile_size_eta::Float64: The size of a tile in rapidity (usually R^2).
  • _tile_size_phi::Float64: The size of a tile in phi (usually a bit more than R^2).
  • _n_tiles_eta::Int: The number of tiles across rapidity.
  • _n_tiles_phi::Int: The number of tiles across phi.
  • _n_tiles::Int: The total number of tiles.
  • _tiles_ieta_min::Int: The minimum rapidity tile index.
  • _tiles_ieta_max::Int: The maximum rapidity tile index.
Constructor
TilingDef(_tiles_eta_min, _tiles_eta_max, _tile_size_eta, _tile_size_phi,
+	_n_tiles_eta, _n_tiles_phi, _tiles_ieta_min, _tiles_ieta_max)
Constructs a TilingDef object with the given parameters.
source
JetReconstruction.neighbour_tiles — Type
struct neighbour_tiles
A struct representing the neighbouring tiles.
A struct for iterating over all neighbour tiles for a given Cartesian tile index. These are the tiles above and to the right of the given tile (X=included, O=not included):
XXX
 X.X
-XXX
Note, rapidity coordinate must be in range, ϕ coordinate wraps
Fields
  • n_η::Int: Number of η tiles
  • n_ϕ::Int: Number of ϕ tiles
  • start_η::Int: Centre η tile coordinate
  • start_ϕ::Int: Centre ϕ tile coordinate
source
JetReconstruction.rightmost_tiles — Type
struct rightmost_tiles
A struct for iterating over rightmost tiles for a given Cartesian tile index. These are the tiles above and to the right of the given tile (X=included, O=not included):
XXX
+XXX
Note, rapidity coordinate must be in range, ϕ coordinate wraps
Fields
  • n_η::Int: Number of η tiles
  • n_ϕ::Int: Number of ϕ tiles
  • start_η::Int: Centre η tile coordinate
  • start_ϕ::Int: Centre ϕ tile coordinate
source
JetReconstruction.rightmost_tiles — Type
struct rightmost_tiles
A struct for iterating over rightmost tiles for a given Cartesian tile index. These are the tiles above and to the right of the given tile (X=included, O=not included):
XXX
 O.X
-OOO
Note, rapidity coordinate must be in range, ϕ coordinate wraps
Fields
  • n_η::Int: Number of η tiles
  • n_ϕ::Int: Number of ϕ tiles
  • start_η::Int: Centre η tile coordinate
  • start_ϕ::Int: Centre ϕ tile coordinate
source

+OOO

Note, rapidity coordinate must be in range, ϕ coordinate wraps

Fields

  • n_η::Int: Number of η tiles
  • n_ϕ::Int: Number of ϕ tiles
  • start_η::Int: Centre η tile coordinate
  • start_ϕ::Int: Centre ϕ tile coordinate
source
diff --git a/previews/PR97/lib/public/index.html b/previews/PR97/lib/public/index.html index 422536d..a86d3d6 100644 --- a/previews/PR97/lib/public/index.html +++ b/previews/PR97/lib/public/index.html @@ -1,14 +1,14 @@ -Public API · JetReconstruction.jl
GitHub

Jet Reconstruction Public Documentation

Documentation for JetReconstruction.jl's public interfaces.

Index

Public Methods and Types

JetReconstruction.constituent_indexes — Method
constituent_indexes(jet::T, cs::ClusterSequence{T}) where T <: FourMomentum

Return the indexes of the original particles which are the constituents of the given jet.

Arguments

  • jet::T: The jet for which to retrieve the constituents.
  • cs::ClusterSequence{T}: The cluster sequence object.

Returns

An vector of indices representing the original constituents of the given jet.

source
JetReconstruction.constituents — Method
constituents(jet::T, cs::ClusterSequence{T}) where T <: FourMomentum

Get the constituents of a given jet in a cluster sequence.

Arguments

  • cs::ClusterSequence{T}: The cluster sequence object.
  • jet::T: The jet for which to retrieve the constituents.

Returns

An array of jet objects (which are of the same type as the input jet) representing the constituents of the given jet,

source
JetReconstruction.ee_genkt_algorithm — Method
ee_genkt_algorithm(particles::Vector{T}; p = -1, R = 4.0,
+Public API · JetReconstruction.jl
GitHub
Jet Reconstruction Public Documentation
Documentation for JetReconstruction.jl's public interfaces.
Index
Public Methods and Types
JetReconstruction.constituent_indexes — Method
constituent_indexes(jet::T, cs::ClusterSequence{T}) where T <: FourMomentum
Return the indexes of the original particles which are the constituents of the given jet.
Arguments
  • jet::T: The jet for which to retrieve the constituents.
  • cs::ClusterSequence{T}: The cluster sequence object.
Returns
An vector of indices representing the original constituents of the given jet.
source
JetReconstruction.constituents — Method
constituents(jet::T, cs::ClusterSequence{T}) where T <: FourMomentum
Get the constituents of a given jet in a cluster sequence.
Arguments
  • cs::ClusterSequence{T}: The cluster sequence object.
  • jet::T: The jet for which to retrieve the constituents.
Returns
An array of jet objects (which are of the same type as the input jet) representing the constituents of the given jet,  
source
JetReconstruction.ee_genkt_algorithm — Method
ee_genkt_algorithm(particles::Vector{T}; p = -1, R = 4.0,
                    algorithm::JetAlgorithm.Algorithm = JetAlgorithm.Durham,
-                   recombine = +) where {T}
Run an e+e- reconstruction algorithm on a set of initial particles.
Arguments
  • particles::Vector{T}: A vector of particles to be clustered.
  • p = 1: The power parameter for the algorithm. Not required / ignored for the Durham algorithm when it is set to 1.
  • R = 4.0: The jet radius parameter. Not required / ignored for the Durham algorithm.
  • algorithm::JetAlgorithm.Algorithm = JetAlgorithm.Durham: The specific jet algorithm to use.
  • recombine: The recombination scheme to use. Defaults to +.
Returns
  • The result of the jet clustering as a ClusterSequence object.
Notes
This is the public interface to the e+e- jet clustering algorithm. The function will check for consistency between the algorithm and the power parameter as needed. It will then prepare the internal EDM particles for the clustering itself, and call the actual reconstruction method _ee_genkt_algorithm.
If the algorithm is Durham, p is set to 1 and R is nominally set to 4.
Note that unlike pp reconstruction the algorithm has to be specified explicitly.
source
JetReconstruction.exclusive_jets — Method
exclusive_jets(clusterseq::ClusterSequence; dcut = nothing, njets = nothing, T = LorentzVectorCyl)
Return all exclusive jets of a ClusterSequence, with either a specific number of jets or a cut on the maximum distance parameter.
Arguments
  • clusterseq::ClusterSequence: The ClusterSequence object containing the clustering history and jets.
  • dcut::Union{Nothing, Real}: The distance parameter used to define the exclusive jets. If dcut is provided, the number of exclusive jets will be calculated based on this parameter.
  • njets::Union{Nothing, Integer}: The number of exclusive jets to be calculated. If njets is provided, the distance parameter dcut will be calculated based on this number.
  • T = LorentzVectorCyl: The return type used for the selected jets.
Note: Either dcut or njets must be provided (but not both).
Returns
  • An array of T objects representing the exclusive jets.
Valid return types are LorentzVectorCyl and PseudoJet (N.B. this will evolve in the future to be any subtype of FourMomemntumBase; currently unrecognised types will return LorentzVectorCyl)
Exceptions
  • ArgumentError: If neither dcut nor njets is provided.
  • ArgumentError: If the algorithm used in the ClusterSequence object is not suitable for exclusive jets.
  • ErrorException: If the cluster sequence is incomplete and exclusive jets are unavailable.
Examples
exclusive_jets(clusterseq, dcut = 20.0)
-exclusive_jets(clusterseq, njets = 3, T = PseudoJet)
source
JetReconstruction.final_jets — Function
final_jets(jets::Vector{PseudoJet}, ptmin::AbstractFloat=0.0)
This function takes a vector of PseudoJet objects and a minimum transverse momentum ptmin as input. It returns a vector of FinalJet objects that satisfy the transverse momentum condition.
Arguments
  • jets::Vector{PseudoJet}: A vector of PseudoJet objects representing the input jets.
  • ptmin::AbstractFloat=0.0: The minimum transverse momentum required for a jet to be included in the final jets vector.
Returns
A vector of FinalJet objects that satisfy the transverse momentum condition.
source
JetReconstruction.inclusive_jets — Method
inclusive_jets(clusterseq::ClusterSequence; ptmin = 0.0, T = LorentzVectorCyl)
Return all inclusive jets of a ClusterSequence with pt > ptmin.
Arguments
  • clusterseq::ClusterSequence: The ClusterSequence object containing the clustering history and jets.
  • ptmin::Float64 = 0.0: The minimum transverse momentum (pt) threshold for the inclusive jets.
  • T = LorentzVectorCyl: The return type used for the selected jets.
Returns
An array of T objects representing the inclusive jets.
Description
This function computes the inclusive jets from a given ClusterSequence object. It iterates over the clustering history and checks the transverse momentum of each parent jet. If the transverse momentum is greater than or equal to ptmin, the jet is added to the array of inclusive jets.
Valid return types are LorentzVectorCyl and PseudoJet (N.B. this will evolve in the future to be any subtype of FourMomemntumBase; currently unrecognised types will return LorentzVectorCyl).
Example
inclusive_jets(clusterseq; ptmin = 10.0)
source
JetReconstruction.jet_reconstruct — Method
jet_reconstruct(particles; p = -1, algorithm = nothing, R = 1.0, recombine = +, strategy = RecoStrategy.Best)
Reconstructs jets from a collection of particles using a specified algorithm and strategy
Arguments
  • particles: A collection of particles used for jet reconstruction. 
  • p::Union{Real, Nothing} = -1: The power value used for the distance measure for generalised k_T, which maps to a particular reconstruction algorithm (-1 = AntiKt, 0 = Cambridge/Aachen, 1 = Kt).
  • algorithm::Union{JetAlgorithm.Algorithm, Nothing} = nothing: The algorithm to use for jet reconstruction.
  • R=1.0: The jet radius parameter.
  • recombine=+: The recombination scheme used for combining particles.
  • strategy=RecoStrategy.Best: The jet reconstruction strategy to use. RecoStrategy.Best makes a dynamic decision based on the number of starting particles.
Returns
A cluster sequence object containing the reconstructed jets and the merging history.
Details
particles argument
Any type that supplies the methods pt2(), phi(), rapidity(), px(), py(), pz(), energy() (in the JetReconstruction namespace) can be used. This includes LorentzVector, LorentzVectorCyl, and PseudoJet, for which these methods are already predefined in the JetReconstruction namespace.
recombine argument
The recombine argument is the function used to merge pairs of particles. The default is simply +(jet1,jet2), i.e. 4-momenta addition or the E-scheme.
Consistency of p, algorithm and R arguments
If an algorithm is explicitly specified the p value should be consistent with it or nothing. If the algorithm is one where p can vary, then it has to be given, along with the algorithm.
If the p parameter is passed and algorithm=nothing, then pp-type reconstruction is implied (i.e., AntiKt, CA, Kt or GenKt will be used, depending on the value of p).
When an algorithm has no R dependence the R parameter is ignored.
Example
jet_reconstruct(particles; p = -1, R = 0.4)
+                   recombine = +) where {T}
Run an e+e- reconstruction algorithm on a set of initial particles.
Arguments
  • particles::Vector{T}: A vector of particles to be clustered.
  • p = 1: The power parameter for the algorithm. Not required / ignored for the Durham algorithm when it is set to 1.
  • R = 4.0: The jet radius parameter. Not required / ignored for the Durham algorithm.
  • algorithm::JetAlgorithm.Algorithm = JetAlgorithm.Durham: The specific jet algorithm to use.
  • recombine: The recombination scheme to use. Defaults to +.
Returns
  • The result of the jet clustering as a ClusterSequence object.
Notes
This is the public interface to the e+e- jet clustering algorithm. The function will check for consistency between the algorithm and the power parameter as needed. It will then prepare the internal EDM particles for the clustering itself, and call the actual reconstruction method _ee_genkt_algorithm.
If the algorithm is Durham, p is set to 1 and R is nominally set to 4.
Note that unlike pp reconstruction the algorithm has to be specified explicitly.
source
JetReconstruction.exclusive_jets — Method
exclusive_jets(clusterseq::ClusterSequence; dcut = nothing, njets = nothing, T = LorentzVectorCyl)
Return all exclusive jets of a ClusterSequence, with either a specific number of jets or a cut on the maximum distance parameter.
Arguments
  • clusterseq::ClusterSequence: The ClusterSequence object containing the clustering history and jets.
  • dcut::Union{Nothing, Real}: The distance parameter used to define the exclusive jets. If dcut is provided, the number of exclusive jets will be calculated based on this parameter.
  • njets::Union{Nothing, Integer}: The number of exclusive jets to be calculated. If njets is provided, the distance parameter dcut will be calculated based on this number.
  • T = LorentzVectorCyl: The return type used for the selected jets.
Note: Either dcut or njets must be provided (but not both).
Returns
  • An array of T objects representing the exclusive jets.
Valid return types are LorentzVectorCyl and PseudoJet (N.B. this will evolve in the future to be any subtype of FourMomemntumBase; currently unrecognised types will return LorentzVectorCyl)
Exceptions
  • ArgumentError: If neither dcut nor njets is provided.
  • ArgumentError: If the algorithm used in the ClusterSequence object is not suitable for exclusive jets.
  • ErrorException: If the cluster sequence is incomplete and exclusive jets are unavailable.
Examples
exclusive_jets(clusterseq, dcut = 20.0)
+exclusive_jets(clusterseq, njets = 3, T = PseudoJet)
source
JetReconstruction.final_jets — Function
final_jets(jets::Vector{PseudoJet}, ptmin::AbstractFloat=0.0)
This function takes a vector of PseudoJet objects and a minimum transverse momentum ptmin as input. It returns a vector of FinalJet objects that satisfy the transverse momentum condition.
Arguments
  • jets::Vector{PseudoJet}: A vector of PseudoJet objects representing the input jets.
  • ptmin::AbstractFloat=0.0: The minimum transverse momentum required for a jet to be included in the final jets vector.
Returns
A vector of FinalJet objects that satisfy the transverse momentum condition.
source
JetReconstruction.inclusive_jets — Method
inclusive_jets(clusterseq::ClusterSequence; ptmin = 0.0, T = LorentzVectorCyl)
Return all inclusive jets of a ClusterSequence with pt > ptmin.
Arguments
  • clusterseq::ClusterSequence: The ClusterSequence object containing the clustering history and jets.
  • ptmin::Float64 = 0.0: The minimum transverse momentum (pt) threshold for the inclusive jets.
  • T = LorentzVectorCyl: The return type used for the selected jets.
Returns
An array of T objects representing the inclusive jets.
Description
This function computes the inclusive jets from a given ClusterSequence object. It iterates over the clustering history and checks the transverse momentum of each parent jet. If the transverse momentum is greater than or equal to ptmin, the jet is added to the array of inclusive jets.
Valid return types are LorentzVectorCyl and PseudoJet (N.B. this will evolve in the future to be any subtype of FourMomemntumBase; currently unrecognised types will return LorentzVectorCyl).
Example
inclusive_jets(clusterseq; ptmin = 10.0)
source
JetReconstruction.jet_reconstruct — Method
jet_reconstruct(particles; p = -1, algorithm = nothing, R = 1.0, recombine = +, strategy = RecoStrategy.Best)
Reconstructs jets from a collection of particles using a specified algorithm and strategy
Arguments
  • particles: A collection of particles used for jet reconstruction. 
  • p::Union{Real, Nothing} = -1: The power value used for the distance measure for generalised k_T, which maps to a particular reconstruction algorithm (-1 = AntiKt, 0 = Cambridge/Aachen, 1 = Kt).
  • algorithm::Union{JetAlgorithm.Algorithm, Nothing} = nothing: The algorithm to use for jet reconstruction.
  • R=1.0: The jet radius parameter.
  • recombine=+: The recombination scheme used for combining particles.
  • strategy=RecoStrategy.Best: The jet reconstruction strategy to use. RecoStrategy.Best makes a dynamic decision based on the number of starting particles.
Returns
A cluster sequence object containing the reconstructed jets and the merging history.
Details
particles argument
Any type that supplies the methods pt2(), phi(), rapidity(), px(), py(), pz(), energy() (in the JetReconstruction namespace) can be used. This includes LorentzVector, LorentzVectorCyl, and PseudoJet, for which these methods are already predefined in the JetReconstruction namespace.
recombine argument
The recombine argument is the function used to merge pairs of particles. The default is simply +(jet1,jet2), i.e. 4-momenta addition or the E-scheme.
Consistency of p, algorithm and R arguments
If an algorithm is explicitly specified the p value should be consistent with it or nothing. If the algorithm is one where p can vary, then it has to be given, along with the algorithm.
If the p parameter is passed and algorithm=nothing, then pp-type reconstruction is implied (i.e., AntiKt, CA, Kt or GenKt will be used, depending on the value of p).
When an algorithm has no R dependence the R parameter is ignored.
Example
jet_reconstruct(particles; p = -1, R = 0.4)
 jet_reconstruct(particles; algorithm = JetAlgorithm.Kt, R = 1.0)
 jet_reconstruct(particles; algorithm = JetAlgorithm.Durham)
-jet_reconstruct(particles; algorithm = JetAlgorithm.GenKt, p = 0.5, R = 1.0)
source
JetReconstruction.loadjets! — Method
loadjets!(filename, jets; splitby=isspace, constructor=(px,py,pz,E)->LorentzVectorHEP(E,px,py,pz), dtype=Float64)
Loads the jets from a file. Ignores lines that start with '#'. Each line gets processed in the following way: the line is split using split(line, splitby) or simply split(line) by default. Every value in this line is then converted to the dtype (which is Float64 by default). These values are then used as arguments for the constructor function which should produce individual jets. By default, the constructor constructs Lorentz vectors.
Everything that was already in jets is not affected as we only use push! on it.
Example
# Load jets from two files into one array
+jet_reconstruct(particles; algorithm = JetAlgorithm.GenKt, p = 0.5, R = 1.0)
source
JetReconstruction.loadjets! — Method
loadjets!(filename, jets; splitby=isspace, constructor=(px,py,pz,E)->LorentzVectorHEP(E,px,py,pz), dtype=Float64)
Loads the jets from a file. Ignores lines that start with '#'. Each line gets processed in the following way: the line is split using split(line, splitby) or simply split(line) by default. Every value in this line is then converted to the dtype (which is Float64 by default). These values are then used as arguments for the constructor function which should produce individual jets. By default, the constructor constructs Lorentz vectors.
Everything that was already in jets is not affected as we only use push! on it.
Example
# Load jets from two files into one array
 jets = []
 loadjets!("myjets1.dat", jets)
-loadjets!("myjets2.dat", jets)
source
JetReconstruction.loadjets — Method
loadjets(filename; splitby=isspace, constructor=(px,py,pz,E)->LorentzVectorHEP(E,px,py,pz), VT=LorentzVector)
Load jets from a file.
Arguments
  • filename: The name of the file to load jets from.
  • splitby: The delimiter used to split the data in the file. Default is isspace.
  • constructor: A function that constructs a VT object from the jet data. Default is (px,py,pz,E)->LorentzVector(E,px,py,pz).
  • VT: The type of the vector used to store the jet data. Default is LorentzVector.
Returns
  • A vector of VT objects representing the loaded jets.
source
JetReconstruction.n_exclusive_jets — Method
n_exclusive_jets(clusterseq::ClusterSequence; dcut::AbstractFloat)
Return the number of exclusive jets of a ClusterSequence that are above a certain dcut value.
Arguments
  • clusterseq::ClusterSequence: The ClusterSequence object containing the clustering history.
  • dcut::AbstractFloat: The maximum value for the distance parameter in the reconstruction.
Returns
The number of exclusive jets in the ClusterSequence object.
Example
n_exclusive_jets(clusterseq, dcut = 20.0)
source
JetReconstruction.plain_jet_reconstruct — Method
plain_jet_reconstruct(particles::Vector{T}; p = -1, R = 1.0, recombine = +) where T
Perform pp jet reconstruction using the plain algorithm.
Arguments
  • particles::Vector{T}: A vector of particles used for jet reconstruction, any  array of particles, which supports suitable 4-vector methods, viz. pt2(),  phi(), rapidity(), px(), py(), pz(), energy(), can be used. for each element.
  • algorithm::Union{JetAlgorithm, Nothing} = nothing: The explicit jet algorithm to use.
  • p::Int=-1: The integer value used for jet reconstruction.
  • R::Float64=1.0: The radius parameter used for jet reconstruction.
  • recombine::Function=+: The recombination function used for jet reconstruction.
Note for the particles argument, the 4-vector methods need to exist in the JetReconstruction package namespace.
This code will use the k_t algorithm types, operating in (rapidity, φ) space.
It is not necessary to specify both the algorithm and the p (power) value. If both are given they must be consistent or an exception is thrown.
Returns
  • Vector{PseudoJet}: A vector of reconstructed jets.
Example
jets = plain_jet_reconstruct(particles; p = -1, R = 0.4)
-jets = plain_jet_reconstruct(particles; algorithm = JetAlgorithm.Kt, R = 1.0)
source
JetReconstruction.read_final_state_particles — Method
read_final_state_particles(fname; maxevents = -1, skipevents = 0, T=PseudoJet)
Reads final state particles from a file and returns them as a vector of type T.
Arguments
  • fname: The name of the HepMC3 ASCII file to read particles from. If the file is gzipped, the function will automatically decompress it.
  • maxevents=-1: The maximum number of events to read. -1 means all events will be read.
  • skipevents=0: The number of events to skip before an event is included.
  • T=PseudoJet: The type of object to construct and return.
Returns
A vector of vectors of T objects, where each inner vector represents all the particles of a particular event. In particular T can be PseudoJet or a LorentzVector type. Note, if T is not PseudoJet, the order of the arguments in the constructor must be (t, x, y, z).
source
JetReconstruction.savejets — Method
savejets(filename, jets; format="px py pz E")
Save jet data to a file.
Arguments
  • filename: The name of the file to save the jet data to.
  • jets: An array of jet objects to save.
  • format="px py pz E": (optional) A string specifying the format of the jet data to save. The default format is "px py pz E".
Details
This function saves jet data to a file in a specific format. Each line in the file represents a jet and contains the information about the jet in the specified format. The format string can include the following placeholders:
  • "E" or "energy": Jet energy
  • "px": Momentum along the x-axis
  • "py": Momentum along the y-axis
  • "pz": Momentum along the z-axis
  • "pt2": Square of the transverse momentum
  • "phi": Azimuth angle
  • "rapidity": Rapidity
Lines starting with '#' are treated as comments and are ignored.
It is strongly NOT recommended to put something other than values and (possibly custom) separators in the format string.
source
JetReconstruction.tiled_jet_reconstruct — Method
tiled_jet_reconstruct(particles::Vector{T}; p = -1, R = 1.0, recombine = +) where {T}
Main jet reconstruction algorithm entry point for reconstructing jets using the tiled strategy for generic jet type T.
Note - if a non-standard recombination is used, it must be defined for JetReconstruction.PseudoJet, as this struct is used internally.
This code will use the k_t algorithm types, operating in (rapidity, φ) space.
It is not necessary to specify both the algorithm and the p (power) value. If both are given they must be consistent or an exception is thrown.
Arguments
  • particles::Vector{T}: A vector of particles used as input for jet reconstruction. T must support methods px, py, pz and energy (defined in the JetReconstruction namespace)
  • p::Union{Real, Nothing} = -1: The power parameter for the jet reconstruction algorithm, thus switching between different algorithms.
  • algorithm::Union{JetAlgorithm, Nothing} = nothing: The explicit jet algorithm to use.
  • R::Float64 = 1.0: The jet radius parameter for the jet reconstruction algorithm.
  • recombine::Function = +: The recombination function used for combining pseudojets.
Returns
  • Vector{PseudoJet}: A vector of reconstructed jets.
Example
tiled_jet_reconstruct(particles::Vector{LorentzVectorHEP}; p = -1, R = 0.4, recombine = +)
source
JetReconstruction.ClusterSequence — Type
struct ClusterSequence
A struct holding the full history of a jet clustering sequence, including the final jets.
Fields
  • algorithm::JetAlgorithm.Algorithm: The algorithm used for clustering.
  • strategy::RecoStrategy.Strategy: The strategy used for clustering.
  • power::Float64: The power value used for the clustering algorithm (not that this value is always stored as a Float64 to be type stable)
  • R::Float64: The R parameter used for the clustering algorithm.
  • jets::Vector{T}: The actual jets in the cluster sequence, which are of type T <: FourMomentum.
  • n_initial_jets::Int: The initial number of particles used for exclusive jets.
  • history::Vector{HistoryElement}: The branching history of the cluster sequence. Each stage in the history indicates where to look in the jets vector to get the physical PseudoJet.
  • Qtot::Any: The total energy of the event.
source
JetReconstruction.ClusterSequence — Method
ClusterSequence(algorithm::JetAlgorithm.Algorithm, p::Real, R::Float64, strategy::RecoStrategy.Strategy, jets::T, history, Qtot) where T <: FourMomentum
Construct a ClusterSequence object.
Arguments
  • algorithm::JetAlgorithm.Algorithm: The algorithm used for clustering.
  • p::Real: The power value used for the clustering algorithm.
  • R::Float64: The R parameter used for the clustering algorithm.
  • strategy::RecoStrategy.Strategy: The strategy used for clustering.
  • jets::Vector{T}: The jets in the cluster sequence, which are of T <: FourMomentum
  • history::Vector{HistoryElement}: The branching history of the cluster sequence.
  • Qtot::Any: The total energy of the event.
source
JetReconstruction.EEjet — Type
struct EEjet{T <: Real} <: FourMomentum
The EEjet struct is a 4-momentum object used for the e+e jet reconstruction routines. Internal fields are used to track the reconstruction and to cache values needed during the execution of the algorithm.
Fields
  • px::T: The x-component of the jet momentum.
  • py::T: The y-component of the jet momentum.
  • pz::T: The z-component of the jet momentum.
  • E::T: The energy of the jet.
  • _cluster_hist_index::Int: The index of the cluster histogram.
  • _p2::T: The squared momentum of the jet.
  • _inv_p::T: The inverse momentum of the jet.
Type Parameters
  • T <: Real: The type of the numerical values.
source
JetReconstruction.EEjet — Method
EEjet(pj::PseudoJet) -> EEjet
Constructs an EEjet object from a given PseudoJet object pj.
Arguments
  • pj::PseudoJet: A PseudoJet object used to create the EEjet.
Returns
  • An EEjet object initialized with the same properties of the given PseudoJet.
source
JetReconstruction.EEjet — Method
EEjet(px::T, py::T, pz::T, E::T) where {T <: Real}
Constructs an EEjet object with the given momentum components px, py, pz, energy E, and the cluster histogram index set to zero.
The constructed EEjet object will be parametrised by the type T.
Arguments
  • px::T: The x-component of the momentum.
  • py::T: The y-component of the momentum.
  • pz::T: The z-component of the momentum.
  • E::T: The energy of the jet.
Returns
  • The initialised EEjet object.
source
JetReconstruction.EEjet — Method
EEjet(px::T, py::T, pz::T, E::T, _cluster_hist_index::Integer) where {T <: Real}
Constructs an EEjet object with the given momentum components px, py, pz, energy E, and cluster histogram index _cluster_hist_index.
The constructed EEjet object will be parametrised by the type T.
Arguments
  • px::T: The x-component of the momentum.
  • py::T: The y-component of the momentum.
  • pz::T: The z-component of the momentum.
  • E::T: The energy of the jet.
  • _cluster_hist_index::Integer: The index of the cluster histogram.
Returns
  • The initialised EEjet object.
Note
  • T must be a subtype of Real.
  • The @muladd macro is used to perform fused multiply-add operations for computing p2.
  • The @fastmath macro is used to allow the compiler to perform optimizations for computing inv_p.
source
JetReconstruction.EEjet — Method
EEjet{U}(px::T, py::T, pz::T, E::T) where {T <: Real, U <: Real}
Constructs an EEjet object with conversion of the given momentum components (px, py, pz) and energy (E) from type T to type U.
Arguments
  • px::T: The x-component of the momentum.
  • py::T: The y-component of the momentum.
  • pz::T: The z-component of the momentum.
  • E::T: The energy.
Type Parameters
  • T <: Real: The type of the input momentum components and energy.
  • U <: Real: The type to which the input values will be converted
Returns
An EEjet object with the momentum components and energy parametrised to type U.
source
JetReconstruction.FinalJet — Type
struct FinalJet
A struct representing the final properties of a jet, used for JSON serialisation.
Fields
  • rap::Float64: The rapidity of the jet.
  • phi::Float64: The azimuthal angle of the jet.
  • pt::Float64: The transverse momentum of the jet.
source
JetReconstruction.FinalJets — Type
struct FinalJets
A struct with the vector of all jets for a certain jet identifier, used for JSON serialisation.
Fields
  • jetid::Int64: The ID of the jet.
  • jets::Vector{FinalJet}: A vector of FinalJet objects representing the jets.
source
JetReconstruction.PseudoJet — Type
mutable struct PseudoJet{T <: Real} <: FourMomentum
The PseudoJet struct represents a pseudojet, a four-momentum object used in jet reconstruction algorithms. Additional information for the link back into the history of the clustering is stored in the _cluster_hist_index field. There is caching of the more expensive calculations for rapidity and azimuthal angle.
Fields
  • px::T: The x-component of the momentum.
  • py::T: The y-component of the momentum.
  • pz::T: The z-component of the momentum.
  • E::T: The energy component of the momentum.
  • _cluster_hist_index::Int: The index of the cluster history.
  • _pt2::T: The squared transverse momentum.
  • _inv_pt2::T: The inverse squared transverse momentum.
  • _rap::T: The rapidity.
  • _phi::T: The azimuthal angle.
source
JetReconstruction.PseudoJet — Method
PseudoJet(px::T, py::T, pz::T, E::T) where T <: Real
Constructs a PseudoJet object with the given momentum components and energy.
Arguments
  • px::T: The x-component of the momentum.
  • py::T: The y-component of the momentum.
  • pz::T: The z-component of the momentum.
  • E::T: The energy.
Returns
A PseudoJet object, with type parameter T.
source
JetReconstruction.loadjets — Method
loadjets(filename; splitby=isspace, constructor=(px,py,pz,E)->LorentzVectorHEP(E,px,py,pz), VT=LorentzVector)
Load jets from a file.
Arguments
  • filename: The name of the file to load jets from.
  • splitby: The delimiter used to split the data in the file. Default is isspace.
  • constructor: A function that constructs a VT object from the jet data. Default is (px,py,pz,E)->LorentzVector(E,px,py,pz).
  • VT: The type of the vector used to store the jet data. Default is LorentzVector.
Returns
  • A vector of VT objects representing the loaded jets.
source
JetReconstruction.n_exclusive_jets — Method
n_exclusive_jets(clusterseq::ClusterSequence; dcut::AbstractFloat)
Return the number of exclusive jets of a ClusterSequence that are above a certain dcut value.
Arguments
  • clusterseq::ClusterSequence: The ClusterSequence object containing the clustering history.
  • dcut::AbstractFloat: The maximum value for the distance parameter in the reconstruction.
Returns
The number of exclusive jets in the ClusterSequence object.
Example
n_exclusive_jets(clusterseq, dcut = 20.0)
source
JetReconstruction.plain_jet_reconstruct — Method
plain_jet_reconstruct(particles::Vector{T}; p = -1, R = 1.0, recombine = +) where T
Perform pp jet reconstruction using the plain algorithm.
Arguments
  • particles::Vector{T}: A vector of particles used for jet reconstruction, any  array of particles, which supports suitable 4-vector methods, viz. pt2(),  phi(), rapidity(), px(), py(), pz(), energy(), can be used. for each element.
  • algorithm::Union{JetAlgorithm, Nothing} = nothing: The explicit jet algorithm to use.
  • p::Int=-1: The integer value used for jet reconstruction.
  • R::Float64=1.0: The radius parameter used for jet reconstruction.
  • recombine::Function=+: The recombination function used for jet reconstruction.
Note for the particles argument, the 4-vector methods need to exist in the JetReconstruction package namespace.
This code will use the k_t algorithm types, operating in (rapidity, φ) space.
It is not necessary to specify both the algorithm and the p (power) value. If both are given they must be consistent or an exception is thrown.
Returns
  • Vector{PseudoJet}: A vector of reconstructed jets.
Example
jets = plain_jet_reconstruct(particles; p = -1, R = 0.4)
+jets = plain_jet_reconstruct(particles; algorithm = JetAlgorithm.Kt, R = 1.0)
source
JetReconstruction.read_final_state_particles — Method
read_final_state_particles(fname; maxevents = -1, skipevents = 0, T=PseudoJet)
Reads final state particles from a file and returns them as a vector of type T.
Arguments
  • fname: The name of the HepMC3 ASCII file to read particles from. If the file is gzipped, the function will automatically decompress it.
  • maxevents=-1: The maximum number of events to read. -1 means all events will be read.
  • skipevents=0: The number of events to skip before an event is included.
  • T=PseudoJet: The type of object to construct and return.
Returns
A vector of vectors of T objects, where each inner vector represents all the particles of a particular event. In particular T can be PseudoJet or a LorentzVector type. Note, if T is not PseudoJet, the order of the arguments in the constructor must be (t, x, y, z).
source
JetReconstruction.savejets — Method
savejets(filename, jets; format="px py pz E")
Save jet data to a file.
Arguments
  • filename: The name of the file to save the jet data to.
  • jets: An array of jet objects to save.
  • format="px py pz E": (optional) A string specifying the format of the jet data to save. The default format is "px py pz E".
Details
This function saves jet data to a file in a specific format. Each line in the file represents a jet and contains the information about the jet in the specified format. The format string can include the following placeholders:
  • "E" or "energy": Jet energy
  • "px": Momentum along the x-axis
  • "py": Momentum along the y-axis
  • "pz": Momentum along the z-axis
  • "pt2": Square of the transverse momentum
  • "phi": Azimuth angle
  • "rapidity": Rapidity
Lines starting with '#' are treated as comments and are ignored.
It is strongly NOT recommended to put something other than values and (possibly custom) separators in the format string.
source
JetReconstruction.tiled_jet_reconstruct — Method
tiled_jet_reconstruct(particles::Vector{T}; p = -1, R = 1.0, recombine = +) where {T}
Main jet reconstruction algorithm entry point for reconstructing jets using the tiled strategy for generic jet type T.
Note - if a non-standard recombination is used, it must be defined for JetReconstruction.PseudoJet, as this struct is used internally.
This code will use the k_t algorithm types, operating in (rapidity, φ) space.
It is not necessary to specify both the algorithm and the p (power) value. If both are given they must be consistent or an exception is thrown.
Arguments
  • particles::Vector{T}: A vector of particles used as input for jet reconstruction. T must support methods px, py, pz and energy (defined in the JetReconstruction namespace)
  • p::Union{Real, Nothing} = -1: The power parameter for the jet reconstruction algorithm, thus switching between different algorithms.
  • algorithm::Union{JetAlgorithm, Nothing} = nothing: The explicit jet algorithm to use.
  • R::Float64 = 1.0: The jet radius parameter for the jet reconstruction algorithm.
  • recombine::Function = +: The recombination function used for combining pseudojets.
Returns
  • Vector{PseudoJet}: A vector of reconstructed jets.
Example
tiled_jet_reconstruct(particles::Vector{LorentzVectorHEP}; p = -1, R = 0.4, recombine = +)
source
JetReconstruction.ClusterSequence — Type
struct ClusterSequence
A struct holding the full history of a jet clustering sequence, including the final jets.
Fields
  • algorithm::JetAlgorithm.Algorithm: The algorithm used for clustering.
  • strategy::RecoStrategy.Strategy: The strategy used for clustering.
  • power::Float64: The power value used for the clustering algorithm (not that this value is always stored as a Float64 to be type stable)
  • R::Float64: The R parameter used for the clustering algorithm.
  • jets::Vector{T}: The actual jets in the cluster sequence, which are of type T <: FourMomentum.
  • n_initial_jets::Int: The initial number of particles used for exclusive jets.
  • history::Vector{HistoryElement}: The branching history of the cluster sequence. Each stage in the history indicates where to look in the jets vector to get the physical PseudoJet.
  • Qtot::Any: The total energy of the event.
source
JetReconstruction.ClusterSequence — Method
ClusterSequence(algorithm::JetAlgorithm.Algorithm, p::Real, R::Float64, strategy::RecoStrategy.Strategy, jets::T, history, Qtot) where T <: FourMomentum
Construct a ClusterSequence object.
Arguments
  • algorithm::JetAlgorithm.Algorithm: The algorithm used for clustering.
  • p::Real: The power value used for the clustering algorithm.
  • R::Float64: The R parameter used for the clustering algorithm.
  • strategy::RecoStrategy.Strategy: The strategy used for clustering.
  • jets::Vector{T}: The jets in the cluster sequence, which are of T <: FourMomentum
  • history::Vector{HistoryElement}: The branching history of the cluster sequence.
  • Qtot::Any: The total energy of the event.
source
JetReconstruction.EEjet — Type
struct EEjet{T <: Real} <: FourMomentum
The EEjet struct is a 4-momentum object used for the e+e jet reconstruction routines. Internal fields are used to track the reconstruction and to cache values needed during the execution of the algorithm.
Fields
  • px::T: The x-component of the jet momentum.
  • py::T: The y-component of the jet momentum.
  • pz::T: The z-component of the jet momentum.
  • E::T: The energy of the jet.
  • _cluster_hist_index::Int: The index of the cluster histogram.
  • _p2::T: The squared momentum of the jet.
  • _inv_p::T: The inverse momentum of the jet.
Type Parameters
  • T <: Real: The type of the numerical values.
source
JetReconstruction.EEjet — Method
EEjet(pj::PseudoJet) -> EEjet
Constructs an EEjet object from a given PseudoJet object pj.
Arguments
  • pj::PseudoJet: A PseudoJet object used to create the EEjet.
Returns
  • An EEjet object initialized with the same properties of the given PseudoJet.
source
JetReconstruction.EEjet — Method
EEjet(px::T, py::T, pz::T, E::T) where {T <: Real}
Constructs an EEjet object with the given momentum components px, py, pz, energy E, and the cluster histogram index set to zero.
The constructed EEjet object will be parametrised by the type T.
Arguments
  • px::T: The x-component of the momentum.
  • py::T: The y-component of the momentum.
  • pz::T: The z-component of the momentum.
  • E::T: The energy of the jet.
Returns
  • The initialised EEjet object.
source
JetReconstruction.EEjet — Method
EEjet(px::T, py::T, pz::T, E::T, _cluster_hist_index::Integer) where {T <: Real}
Constructs an EEjet object with the given momentum components px, py, pz, energy E, and cluster histogram index _cluster_hist_index.
The constructed EEjet object will be parametrised by the type T.
Arguments
  • px::T: The x-component of the momentum.
  • py::T: The y-component of the momentum.
  • pz::T: The z-component of the momentum.
  • E::T: The energy of the jet.
  • _cluster_hist_index::Integer: The index of the cluster histogram.
Returns
  • The initialised EEjet object.
Note
  • T must be a subtype of Real.
  • The @muladd macro is used to perform fused multiply-add operations for computing p2.
  • The @fastmath macro is used to allow the compiler to perform optimizations for computing inv_p.
source
JetReconstruction.EEjet — Method
EEjet{U}(px::T, py::T, pz::T, E::T) where {T <: Real, U <: Real}
Constructs an EEjet object with conversion of the given momentum components (px, py, pz) and energy (E) from type T to type U.
Arguments
  • px::T: The x-component of the momentum.
  • py::T: The y-component of the momentum.
  • pz::T: The z-component of the momentum.
  • E::T: The energy.
Type Parameters
  • T <: Real: The type of the input momentum components and energy.
  • U <: Real: The type to which the input values will be converted
Returns
An EEjet object with the momentum components and energy parametrised to type U.
source
JetReconstruction.FinalJet — Type
struct FinalJet
A struct representing the final properties of a jet, used for JSON serialisation.
Fields
  • rap::Float64: The rapidity of the jet.
  • phi::Float64: The azimuthal angle of the jet.
  • pt::Float64: The transverse momentum of the jet.
source
JetReconstruction.FinalJets — Type
struct FinalJets
A struct with the vector of all jets for a certain jet identifier, used for JSON serialisation.
Fields
  • jetid::Int64: The ID of the jet.
  • jets::Vector{FinalJet}: A vector of FinalJet objects representing the jets.
source
JetReconstruction.PseudoJet — Type
mutable struct PseudoJet{T <: Real} <: FourMomentum
The PseudoJet struct represents a pseudojet, a four-momentum object used in jet reconstruction algorithms. Additional information for the link back into the history of the clustering is stored in the _cluster_hist_index field. There is caching of the more expensive calculations for rapidity and azimuthal angle.
Fields
  • px::T: The x-component of the momentum.
  • py::T: The y-component of the momentum.
  • pz::T: The z-component of the momentum.
  • E::T: The energy component of the momentum.
  • _cluster_hist_index::Int: The index of the cluster history.
  • _pt2::T: The squared transverse momentum.
  • _inv_pt2::T: The inverse squared transverse momentum.
  • _rap::T: The rapidity.
  • _phi::T: The azimuthal angle.
source
JetReconstruction.PseudoJet — Method
PseudoJet(px::T, py::T, pz::T, E::T) where T <: Real
Constructs a PseudoJet object with the given momentum components and energy.
Arguments
  • px::T: The x-component of the momentum.
  • py::T: The y-component of the momentum.
  • pz::T: The z-component of the momentum.
  • E::T: The energy.
Returns
A PseudoJet object, with type parameter T.
source
JetReconstruction.PseudoJet — Method
PseudoJet{T}(px::T, py::T, pz::T, E::T,
     _cluster_hist_index::Int,
-    pt2::T) where {T <: Real}
Constructs a parametrised PseudoJet object with the given momentum components and energy and history index.
Arguments
  • px::T: The x-component of the momentum.
  • py::T: The y-component of the momentum.
  • pz::T: The z-component of the momentum.
  • E::T: The energy.
  • _cluster_hist_index::Int: The cluster history index.
  • pt2::T: The transverse momentum squared.
Returns
A PseudoJet object.
source
JetReconstruction.PseudoJet — Method
PseudoJet{U}(px::T, py::T, pz::T, E::T) where T <: Real, U <: Real
Constructs a PseudoJet object with the given momentum components and energy, parameterised by U.
Arguments
  • px::T: The x-component of the momentum.
  • py::T: The y-component of the momentum.
  • pz::T: The z-component of the momentum.
  • E::T: The energy.
  • U <: Real: The type parameter for the PseudoJet object.
Returns
A PseudoJet object, with type parameter U.
source

+    pt2::T) where {T <: Real}

Constructs a parametrised PseudoJet object with the given momentum components and energy and history index.

Arguments

  • px::T: The x-component of the momentum.
  • py::T: The y-component of the momentum.
  • pz::T: The z-component of the momentum.
  • E::T: The energy.
  • _cluster_hist_index::Int: The cluster history index.
  • pt2::T: The transverse momentum squared.

Returns

A PseudoJet object.

source
JetReconstruction.PseudoJet — Method
PseudoJet{U}(px::T, py::T, pz::T, E::T) where T <: Real, U <: Real

Constructs a PseudoJet object with the given momentum components and energy, parameterised by U.

Arguments

  • px::T: The x-component of the momentum.

  • py::T: The y-component of the momentum.

  • pz::T: The z-component of the momentum.

  • E::T: The energy.

  • U <: Real: The type parameter for the PseudoJet object.

Returns

A PseudoJet object, with type parameter U.

source
diff --git a/previews/PR97/particles/index.html b/previews/PR97/particles/index.html index ce2396b..f449f42 100644 --- a/previews/PR97/particles/index.html +++ b/previews/PR97/particles/index.html @@ -1,2 +1,2 @@ -Particle Inputs · JetReconstruction.jl
GitHub

Input Particle Types

For the particles input to the reconstruction any one dimensional AbstractArray{T, 1} can be used, where the type T has to implement methods to extract the 4-vector components, viz, the following are required:

  • JetReconstuction.px(particle::T)
  • JetReconstuction.py(particle::T)
  • JetReconstuction.pz(particle::T)
  • JetReconstuction.energy(particle::T)

Currently built-in supported types are LorentzVectorHEP, the PseudoJet and EEjets from this package, and ReconstructedParticles from EDM4hep Inputs.

If you require support for a different input collection type then ensure you define the px(), etc. methods for your specific type and in the JetReconstruction package. This use of what might be considered type piracy is blessed as long as you are en end user of the jet reconstruction package.

If your type is used in several places or by different users, please consider writing a package extension that will support your type, following the model for EDM4hep in ext/EDM4hepJets.jl.

+Particle Inputs · JetReconstruction.jl
GitHub

Input Particle Types

For the particles input to the reconstruction any one dimensional AbstractArray{T, 1} can be used, where the type T has to implement methods to extract the 4-vector components, viz, the following are required:

  • JetReconstuction.px(particle::T)
  • JetReconstuction.py(particle::T)
  • JetReconstuction.pz(particle::T)
  • JetReconstuction.energy(particle::T)

Currently built-in supported types are LorentzVectorHEP, the PseudoJet and EEjets from this package, and ReconstructedParticles from EDM4hep Inputs.

If you require support for a different input collection type then ensure you define the px(), etc. methods for your specific type and in the JetReconstruction package. This use of what might be considered type piracy is blessed as long as you are en end user of the jet reconstruction package.

If your type is used in several places or by different users, please consider writing a package extension that will support your type, following the model for EDM4hep in ext/EDM4hepJets.jl.

diff --git a/previews/PR97/search_index.js b/previews/PR97/search_index.js index e9bc65d..e5b474a 100644 --- a/previews/PR97/search_index.js +++ b/previews/PR97/search_index.js @@ -1,3 +1,3 @@ var documenterSearchIndex = {"docs": -[{"location":"particles/#Input-Particle-Types","page":"Particle Inputs","title":"Input Particle Types","text":"","category":"section"},{"location":"particles/","page":"Particle Inputs","title":"Particle Inputs","text":"For the particles input to the reconstruction any one dimensional AbstractArray{T, 1} can be used, where the type T has to implement methods to extract the 4-vector components, viz, the following are required:","category":"page"},{"location":"particles/","page":"Particle Inputs","title":"Particle Inputs","text":"JetReconstuction.px(particle::T)\nJetReconstuction.py(particle::T)\nJetReconstuction.pz(particle::T)\nJetReconstuction.energy(particle::T)","category":"page"},{"location":"particles/","page":"Particle Inputs","title":"Particle Inputs","text":"Currently built-in supported types are LorentzVectorHEP, the PseudoJet and EEjets from this package, and ReconstructedParticles from EDM4hep Inputs.","category":"page"},{"location":"particles/","page":"Particle Inputs","title":"Particle Inputs","text":"If you require support for a different input collection type then ensure you define the px(), etc. methods for your specific type and in the JetReconstruction package. This use of what might be considered type piracy is blessed as long as you are en end user of the jet reconstruction package.","category":"page"},{"location":"particles/","page":"Particle Inputs","title":"Particle Inputs","text":"If your type is used in several places or by different users, please consider writing a package extension that will support your type, following the model for EDM4hep in ext/EDM4hepJets.jl.","category":"page"},{"location":"EDM4hep/#EDM4hep-Inputs","page":"EDM4hep","title":"EDM4hep Inputs","text":"","category":"section"},{"location":"EDM4hep/","page":"EDM4hep","title":"EDM4hep","text":"Extension functionality to read EDM4hep ReconstructedParticles, using the EDM4hep.jl package.","category":"page"},{"location":"EDM4hep/#Examples","page":"EDM4hep","title":"Examples","text":"","category":"section"},{"location":"EDM4hep/","page":"EDM4hep","title":"EDM4hep","text":"EDM4hep ReconstructedParticles can be used as direct input into jet reconstruction.","category":"page"},{"location":"EDM4hep/","page":"EDM4hep","title":"EDM4hep","text":"A number of working examples are maintained in the EDM4hep examples directory of the package's examples.","category":"page"},{"location":"EDM4hep/","page":"EDM4hep","title":"EDM4hep","text":"Here is a snippet that shows the main steps:","category":"page"},{"location":"EDM4hep/","page":"EDM4hep","title":"EDM4hep","text":"using EDM4hep\nusing EDM4hep.RootIO\nusing JetReconstruction\n\n# Change this to something that works on your system\ninput_file = joinpath(\"directory\", \"EDM4hep.root\")\nreader = RootIO.Reader(input_file)\nevents = RootIO.get(reader, \"events\")\n\nevt = events[1]\n\nrecps = RootIO.get(reader, evt, \"ReconstructedParticles\")\n\ncs = jet_reconstruct(recps; algorithm = JetAlgorithm.Durham)","category":"page"},{"location":"EDM4hep/#Function-Index","page":"EDM4hep","title":"Function Index","text":"","category":"section"},{"location":"EDM4hep/","page":"EDM4hep","title":"EDM4hep","text":"Pages = [\"EDM4hep.md\"]","category":"page"},{"location":"EDM4hep/#EDM4hep-Interfaces","page":"EDM4hep","title":"EDM4hep Interfaces","text":"","category":"section"},{"location":"EDM4hep/","page":"EDM4hep","title":"EDM4hep","text":"Modules = [EDM4hepJets]\nOrder = [:function]","category":"page"},{"location":"EDM4hep/#JetReconstruction.energy-Tuple{ReconstructedParticle}","page":"EDM4hep","title":"JetReconstruction.energy","text":"JetReconstruction.energy(recoparticle::ReconstructedParticle)\n\nReturn the energy component of a ReconstructedParticle's four vector.\n\n\n\n\n\n","category":"method"},{"location":"EDM4hep/#JetReconstruction.px-Tuple{ReconstructedParticle}","page":"EDM4hep","title":"JetReconstruction.px","text":"JetReconstruction.px(recoparticle::ReconstructedParticle)\n\nReturn the x component of the momentum of a ReconstructedParticle.\n\n\n\n\n\n","category":"method"},{"location":"EDM4hep/#JetReconstruction.py-Tuple{ReconstructedParticle}","page":"EDM4hep","title":"JetReconstruction.py","text":"JetReconstruction.py(recoparticle::ReconstructedParticle)\n\nReturn the y component of the momentum of a ReconstructedParticle.\n\n\n\n\n\n","category":"method"},{"location":"EDM4hep/#JetReconstruction.pz-Tuple{ReconstructedParticle}","page":"EDM4hep","title":"JetReconstruction.pz","text":"JetReconstruction.pz(recoparticle::ReconstructedParticle)\n\nReturn the z component of the momentum of a ReconstructedParticle.\n\n\n\n\n\n","category":"method"},{"location":"strategy/#Algorithm-Strategy","page":"Reconstruction Strategies","title":"Algorithm Strategy","text":"","category":"section"},{"location":"strategy/","page":"Reconstruction Strategies","title":"Reconstruction Strategies","text":"For the pp algorithms three strategies are available for the different algorithms, which can be specified by passing the named argument strategy=... to the reconstruction.","category":"page"},{"location":"strategy/","page":"Reconstruction Strategies","title":"Reconstruction Strategies","text":"Strategy Name Notes Interface\nRecoStrategy.Best Dynamically switch strategy based on input particle density jet_reconstruct\nRecoStrategy.N2Plain Global matching of particles at each interation (works well for low N) plain_jet_reconstruct\nRecoStrategy.N2Tiled Use tiles of radius R to limit search space (works well for higher N) tiled_jet_reconstruct","category":"page"},{"location":"strategy/","page":"Reconstruction Strategies","title":"Reconstruction Strategies","text":"Generally one can use the jet_reconstruct interface, shown above, as the Best strategy safely as the overhead is extremely low. That interface supports a strategy option to switch to a different option.","category":"page"},{"location":"strategy/","page":"Reconstruction Strategies","title":"Reconstruction Strategies","text":"For e^+e^- algorithms particle densities are low, so the only implementation is of the same type as N2Plain.","category":"page"},{"location":"examples/#Jet-Reconstruction-Examples","page":"Examples","title":"Jet Reconstruction Examples","text":"","category":"section"},{"location":"examples/","page":"Examples","title":"Examples","text":"The Jet Reconstruction package has a number of example files that show how to usage. These are in the examples subdirectory of the package and can be browsed directly on GitHub.","category":"page"},{"location":"examples/","page":"Examples","title":"Examples","text":"Note: because of extra dependencies in these scripts, one must use the Project.toml file in the examples directory.","category":"page"},{"location":"examples/#Standalone-Examples","page":"Examples","title":"Standalone Examples","text":"","category":"section"},{"location":"examples/#jetreco.jl","page":"Examples","title":"jetreco.jl","text":"","category":"section"},{"location":"examples/","page":"Examples","title":"Examples","text":"This is a basic jet reconstruction example that shows how to call the package to perform a jet reconstruction, with different algorithms and (optionally) strategy, producing exclusive and inclusive jet selections.","category":"page"},{"location":"examples/","page":"Examples","title":"Examples","text":"julia --project=examples examples/jetreco.jl --algorithm=AntiKt test/data/events.pp13TeV.hepmc3.gz\n...\njulia --project=examples examples/jetreco.jl --algorithm=Durham test/data/events.eeH.hepmc3.gz\n...\njulia --project=examples examples/jetreco.jl --maxevents=10 --strategy=N2Plain --algorithm=Kt --exclusive-njets=3 test/data/events.pp13TeV.hepmc3.gz\n...","category":"page"},{"location":"examples/","page":"Examples","title":"Examples","text":"There are options to explicitly set the algorithm (use --help to see these).","category":"page"},{"location":"examples/#instrumented-jetreco.jl","page":"Examples","title":"instrumented-jetreco.jl","text":"","category":"section"},{"location":"examples/","page":"Examples","title":"Examples","text":"This is a more sophisticated example that allows performance measurements to be made of the reconstruction, as well as profiling (flamegraphs and memory profiling). Use the --help option to see usage. e.g., to extract timing performance for the AntiKt algorithm using the tiled strategy:","category":"page"},{"location":"examples/","page":"Examples","title":"Examples","text":"julia --project instrumented-jetreco.jl -S N2Tiled -A AntiKt --nsamples 100 ../test/data/events.hepmc3","category":"page"},{"location":"examples/#visualise-jets.jl","page":"Examples","title":"visualise-jets.jl","text":"","category":"section"},{"location":"examples/","page":"Examples","title":"Examples","text":"This script will produce a PNG/PDF showing the results of a jet reconstruction. This is a 3D plot where all the initial energy deposits are visualised, with colours that indicate in which final cluster the deposit ended up in.","category":"page"},{"location":"examples/#visualise-jets.ipynb","page":"Examples","title":"visualise-jets.ipynb","text":"","category":"section"},{"location":"examples/","page":"Examples","title":"Examples","text":"Similar to visualise-jets.jl this notebook will produce a visualisation of jet reconstruction in the browser. This is a 3D plot where all the initial energy deposits are visualised, with colours that indicate in which final cluster the deposit ended up in.","category":"page"},{"location":"examples/#animate-reconstruction.jl","page":"Examples","title":"animate-reconstruction.jl","text":"","category":"section"},{"location":"examples/","page":"Examples","title":"Examples","text":"Performs jet reconstruction and then produces and animation of the process, showing how the jets merge from their different constituents.","category":"page"},{"location":"examples/#EDM4hep","page":"Examples","title":"EDM4hep","text":"","category":"section"},{"location":"examples/","page":"Examples","title":"Examples","text":"The examples/EDM4hep folder contains examples of using EDM4hep reconstructed particles as input to jet reconstruction. See the specific README.md file in that directory as well as EDM4hep Inputs.","category":"page"},{"location":"examples/#Jet-Constituents","page":"Examples","title":"Jet Constituents","text":"","category":"section"},{"location":"examples/","page":"Examples","title":"Examples","text":"The examples/constituents folder shows an example of the two mechanisms to retrieve jet constituents.","category":"page"},{"location":"visualisation/#Jet-Visualisation-Documentation","page":"Visualisation","title":"Jet Visualisation Documentation","text":"","category":"section"},{"location":"visualisation/","page":"Visualisation","title":"Visualisation","text":"Documentation for visualisation interfaces extension module.","category":"page"},{"location":"visualisation/#Plotting-and-Animation","page":"Visualisation","title":"Plotting and Animation","text":"","category":"section"},{"location":"visualisation/","page":"Visualisation","title":"Visualisation","text":"(Image: illustration)","category":"page"},{"location":"visualisation/","page":"Visualisation","title":"Visualisation","text":"To visualise the clustered jets as a 3d bar plot (see illustration above) Makie.jl is used. See the jetsplot function in ext/JetVisualisation.jl and its documentation for more. There are two worked examples in the examples directory of this package.","category":"page"},{"location":"visualisation/","page":"Visualisation","title":"Visualisation","text":"The plotting code is a package extension and will load if the one of the Makie modules is loaded in the environment.","category":"page"},{"location":"visualisation/","page":"Visualisation","title":"Visualisation","text":"The animatereco function will animate the reconstruction sequence, given a ClusterSequence object. See the function documentation below for the many options that can be customised.","category":"page"},{"location":"visualisation/#Function-Index","page":"Visualisation","title":"Function Index","text":"","category":"section"},{"location":"visualisation/","page":"Visualisation","title":"Visualisation","text":"Pages = [\"visualisation.md\"]","category":"page"},{"location":"visualisation/#Jet-Visualisation-Public-Interfaces","page":"Visualisation","title":"Jet Visualisation Public Interfaces","text":"","category":"section"},{"location":"visualisation/","page":"Visualisation","title":"Visualisation","text":"Modules = [JetVisualisation]\nOrder = [:function]","category":"page"},{"location":"visualisation/#JetReconstruction.animatereco-Tuple{ClusterSequence, Any}","page":"Visualisation","title":"JetReconstruction.animatereco","text":"animatereco(cs::ClusterSequence, filename;\n barsize_phi = 0.1,\n barsize_y = 0.1,\n colormap = :glasbey_category10_n256,\n perspective = 0.5,\n azimuth = 2.7,\n elevation = 0.5,\n framerate = 5,\n ancestors = false,\n Module = Makie)\n\nAnimate the jet reconstruction process and save it as a video file.\n\nArguments\n\ncs::ClusterSequence: The cluster sequence object containing the jets.\nfilename: The name of the output video file.\n\nOptional Arguments\n\nbarsize_phi=0.1: The size of the bars in the phi direction.\nbarsize_y=0.1: The size of the bars in the y direction.\ncolormap=:glasbey_category10_n256: The colormap to use for coloring the jets.\nperspective=0.5: The perspective of the plot.\nazimuth=2.7: The azimuth angle of the plot.\nelevation=0.5: The elevation angle of the plot.\nframerate=5: The framerate of the output video.\nend_frames=0: The number of static frames to show at the end of the animation. This can be useful to show the final state of the jets for a longer time.\ntitle=nothing: The title to add to the plot.\nancestors=false: Whether to include ancestors of the jets in the animation. When true the ancestors of the jets will be plotted as well, as height zero bars, with the same colour as the jet they are ancestors of.\nModule: The plotting module to use. Default is Makie.\n\nFor perspective, azimuth, and elevation, a single value can be passed for a fixed viewpoint, or a tuple of two values for a changing viewpoint. The viewpoint will then change linearly between the two values over the course of the animation.\n\nReturns\n\nfig: The figure object representing the final frame.\n\n\n\n\n\n","category":"method"},{"location":"visualisation/#JetReconstruction.jetsplot-Tuple{Any, Any}","page":"Visualisation","title":"JetReconstruction.jetsplot","text":"jetsplot(objects, idx_arrays; barsize_phi=0.1, barsize_eta=0.1, colormap=:glasbey_hv_n256, Module=Main)\n\nPlots a 3d bar chart that represents jets. Takes an objects array of objects to display and idx_arrays, an array of arrays with indices, where idx_arrays[i] gives indices of objects that form the jet number i. This function's signature might not be the most practical for the current version of the JetReconstruction.jl package, as it has been written during the early stage of development. There is now an overload of it that takes a ClusterSequence object as its argument.\n\nOptional arguments: barsize_phi::Real — width of a bar along the ϕ axis; barsize_eta::Real — width of a bar along the η axis; colormap::Symbol — Makie colour map; Module — the module where you have your Makie (see below);\n\n# example\nusing CairoMakie # use any other Makie that you have here\n\njetsplot([object1, object2, object3], [[1], [2, 3]])\n\nThe example above plots object1 as a separate jet in one colour and object2 and object3 together in another colour.\n\nThis function needs Makie.jl to work. You should install and import/use a specific backend yourself. jetsplot works with CairoMakie, WGLMakie, GLMakie, etc. Additionally, you can specify the module where you have your Makie explicitly:\n\nimport CairoMakie\njetsplot(my_objects, my_colour_arrays, Module=CairoMakie)\n\nimport GLMakie\njetsplot(my_objects, my_colour_arrays, Module=GLMakie)\n\nusing WGLMakie\njetsplot(my_objects, my_colour_arrays, Module=Main) #default\n\n\n\n\n\n","category":"method"},{"location":"visualisation/#JetReconstruction.jetsplot-Tuple{Any, ClusterSequence}","page":"Visualisation","title":"JetReconstruction.jetsplot","text":"jetsplot(objects, cs::ClusterSequence; barsize_phi=0.1, barsize_eta=0.1, colormap=:glasbey_hv_n256, Module=Main)\n\nPlots a 3d bar chart that represents jets. Takes objects, an array of objects to display (should be the same array you have passed to jet_reconstruct to get the cs::ClusterSequence), and the cs::ClusterSequence itself as arguments.\n\nOptional arguments: barsize_phi::Real — width of a bar along the ϕ axis; barsize_eta::Real — width of a bar along the η axis; colormap::Symbol — Makie colour map; Module — the module where you have your Makie (see below);\n\n# example\nusing CairoMakie # use any other Makie that you have here\njetsplot([object1, object2, object3], cluster_sequence_I_got_from_jet_reconstruct; Module=CairoMakie)\n\nThis function needs Makie.jl to work. You should install and import/use a specific backend yourself. jetsplot works with CairoMakie, WGLMakie, GLMakie, etc. Additionally, you can specify the module where you have your Makie explicitly:\n\nimport CairoMakie\njetsplot(my_objects, cs, Module=CairoMakie)\n\nimport GLMakie\njetsplot(my_objects, cs, Module=GLMakie)\n\nusing WGLMakie\njetsplot(my_objects, cs, Module=Main) #default\n\n\n\n\n\n","category":"method"},{"location":"extras/serialisation/#Jet-Serialisation","page":"Serialisation","title":"Jet Serialisation","text":"","category":"section"},{"location":"extras/serialisation/","page":"Serialisation","title":"Serialisation","text":"The package provides methods such as loadjets, loadjets!, and savejets that one can use to save and load objects on/from disk easily in a very flexible format. See documentation for more.","category":"page"},{"location":"lib/public/#Jet-Reconstruction-Public-Documentation","page":"Public API","title":"Jet Reconstruction Public Documentation","text":"","category":"section"},{"location":"lib/public/","page":"Public API","title":"Public API","text":"Documentation for JetReconstruction.jl's public interfaces.","category":"page"},{"location":"lib/public/#Index","page":"Public API","title":"Index","text":"","category":"section"},{"location":"lib/public/","page":"Public API","title":"Public API","text":"Pages = [\"public.md\"]","category":"page"},{"location":"lib/public/#Public-Methods-and-Types","page":"Public API","title":"Public Methods and Types","text":"","category":"section"},{"location":"lib/public/","page":"Public API","title":"Public API","text":"Modules = [JetReconstruction]\nPrivate = false\nOrder = [:function, :type]","category":"page"},{"location":"lib/public/#JetReconstruction.constituent_indexes-Union{Tuple{T}, Tuple{T, ClusterSequence{T}}} where T<:JetReconstruction.FourMomentum","page":"Public API","title":"JetReconstruction.constituent_indexes","text":"constituent_indexes(jet::T, cs::ClusterSequence{T}) where T <: FourMomentum\n\nReturn the indexes of the original particles which are the constituents of the given jet.\n\nArguments\n\njet::T: The jet for which to retrieve the constituents.\ncs::ClusterSequence{T}: The cluster sequence object.\n\nReturns\n\nAn vector of indices representing the original constituents of the given jet.\n\n\n\n\n\n","category":"method"},{"location":"lib/public/#JetReconstruction.constituents-Union{Tuple{T}, Tuple{T, ClusterSequence{T}}} where T<:JetReconstruction.FourMomentum","page":"Public API","title":"JetReconstruction.constituents","text":"constituents(jet::T, cs::ClusterSequence{T}) where T <: FourMomentum\n\nGet the constituents of a given jet in a cluster sequence.\n\nArguments\n\ncs::ClusterSequence{T}: The cluster sequence object.\njet::T: The jet for which to retrieve the constituents.\n\nReturns\n\nAn array of jet objects (which are of the same type as the input jet) representing the constituents of the given jet, \n\n\n\n\n\n","category":"method"},{"location":"lib/public/#JetReconstruction.ee_genkt_algorithm-Union{Tuple{AbstractVector{T}}, Tuple{T}} where T","page":"Public API","title":"JetReconstruction.ee_genkt_algorithm","text":"ee_genkt_algorithm(particles::Vector{T}; p = -1, R = 4.0,\n algorithm::JetAlgorithm.Algorithm = JetAlgorithm.Durham,\n recombine = +) where {T}\n\nRun an e+e- reconstruction algorithm on a set of initial particles.\n\nArguments\n\nparticles::Vector{T}: A vector of particles to be clustered.\np = 1: The power parameter for the algorithm. Not required / ignored for the Durham algorithm when it is set to 1.\nR = 4.0: The jet radius parameter. Not required / ignored for the Durham algorithm.\nalgorithm::JetAlgorithm.Algorithm = JetAlgorithm.Durham: The specific jet algorithm to use.\nrecombine: The recombination scheme to use. Defaults to +.\n\nReturns\n\nThe result of the jet clustering as a ClusterSequence object.\n\nNotes\n\nThis is the public interface to the e+e- jet clustering algorithm. The function will check for consistency between the algorithm and the power parameter as needed. It will then prepare the internal EDM particles for the clustering itself, and call the actual reconstruction method _ee_genkt_algorithm.\n\nIf the algorithm is Durham, p is set to 1 and R is nominally set to 4.\n\nNote that unlike pp reconstruction the algorithm has to be specified explicitly.\n\n\n\n\n\n","category":"method"},{"location":"lib/public/#JetReconstruction.exclusive_jets-Tuple{ClusterSequence}","page":"Public API","title":"JetReconstruction.exclusive_jets","text":"exclusive_jets(clusterseq::ClusterSequence; dcut = nothing, njets = nothing, T = LorentzVectorCyl)\n\nReturn all exclusive jets of a ClusterSequence, with either a specific number of jets or a cut on the maximum distance parameter.\n\nArguments\n\nclusterseq::ClusterSequence: The ClusterSequence object containing the clustering history and jets.\ndcut::Union{Nothing, Real}: The distance parameter used to define the exclusive jets. If dcut is provided, the number of exclusive jets will be calculated based on this parameter.\nnjets::Union{Nothing, Integer}: The number of exclusive jets to be calculated. If njets is provided, the distance parameter dcut will be calculated based on this number.\nT = LorentzVectorCyl: The return type used for the selected jets.\n\nNote: Either dcut or njets must be provided (but not both).\n\nReturns\n\nAn array of T objects representing the exclusive jets.\n\nValid return types are LorentzVectorCyl and PseudoJet (N.B. this will evolve in the future to be any subtype of FourMomemntumBase; currently unrecognised types will return LorentzVectorCyl)\n\nExceptions\n\nArgumentError: If neither dcut nor njets is provided.\nArgumentError: If the algorithm used in the ClusterSequence object is not suitable for exclusive jets.\nErrorException: If the cluster sequence is incomplete and exclusive jets are unavailable.\n\nExamples\n\nexclusive_jets(clusterseq, dcut = 20.0)\nexclusive_jets(clusterseq, njets = 3, T = PseudoJet)\n\n\n\n\n\n","category":"method"},{"location":"lib/public/#JetReconstruction.final_jets","page":"Public API","title":"JetReconstruction.final_jets","text":"final_jets(jets::Vector{PseudoJet}, ptmin::AbstractFloat=0.0)\n\nThis function takes a vector of PseudoJet objects and a minimum transverse momentum ptmin as input. It returns a vector of FinalJet objects that satisfy the transverse momentum condition.\n\nArguments\n\njets::Vector{PseudoJet}: A vector of PseudoJet objects representing the input jets.\nptmin::AbstractFloat=0.0: The minimum transverse momentum required for a jet to be included in the final jets vector.\n\nReturns\n\nA vector of FinalJet objects that satisfy the transverse momentum condition.\n\n\n\n\n\n","category":"function"},{"location":"lib/public/#JetReconstruction.final_jets-2","page":"Public API","title":"JetReconstruction.final_jets","text":"Specialisation for final jets from LorentzVectors (TODO: merge into more general function)\n\n\n\n\n\n","category":"function"},{"location":"lib/public/#JetReconstruction.final_jets-3","page":"Public API","title":"JetReconstruction.final_jets","text":"Specialisation for final jets from LorentzVectorCyl (TODO: merge into more general function)\n\n\n\n\n\n","category":"function"},{"location":"lib/public/#JetReconstruction.inclusive_jets-Tuple{ClusterSequence}","page":"Public API","title":"JetReconstruction.inclusive_jets","text":"inclusive_jets(clusterseq::ClusterSequence; ptmin = 0.0, T = LorentzVectorCyl)\n\nReturn all inclusive jets of a ClusterSequence with pt > ptmin.\n\nArguments\n\nclusterseq::ClusterSequence: The ClusterSequence object containing the clustering history and jets.\nptmin::Float64 = 0.0: The minimum transverse momentum (pt) threshold for the inclusive jets.\nT = LorentzVectorCyl: The return type used for the selected jets.\n\nReturns\n\nAn array of T objects representing the inclusive jets.\n\nDescription\n\nThis function computes the inclusive jets from a given ClusterSequence object. It iterates over the clustering history and checks the transverse momentum of each parent jet. If the transverse momentum is greater than or equal to ptmin, the jet is added to the array of inclusive jets.\n\nValid return types are LorentzVectorCyl and PseudoJet (N.B. this will evolve in the future to be any subtype of FourMomemntumBase; currently unrecognised types will return LorentzVectorCyl).\n\nExample\n\ninclusive_jets(clusterseq; ptmin = 10.0)\n\n\n\n\n\n","category":"method"},{"location":"lib/public/#JetReconstruction.jet_reconstruct-Tuple{Any}","page":"Public API","title":"JetReconstruction.jet_reconstruct","text":"jet_reconstruct(particles; p = -1, algorithm = nothing, R = 1.0, recombine = +, strategy = RecoStrategy.Best)\n\nReconstructs jets from a collection of particles using a specified algorithm and strategy\n\nArguments\n\nparticles: A collection of particles used for jet reconstruction. \np::Union{Real, Nothing} = -1: The power value used for the distance measure for generalised k_T, which maps to a particular reconstruction algorithm (-1 = AntiKt, 0 = Cambridge/Aachen, 1 = Kt).\nalgorithm::Union{JetAlgorithm.Algorithm, Nothing} = nothing: The algorithm to use for jet reconstruction.\nR=1.0: The jet radius parameter.\nrecombine=+: The recombination scheme used for combining particles.\nstrategy=RecoStrategy.Best: The jet reconstruction strategy to use. RecoStrategy.Best makes a dynamic decision based on the number of starting particles.\n\nReturns\n\nA cluster sequence object containing the reconstructed jets and the merging history.\n\nDetails\n\nparticles argument\n\nAny type that supplies the methods pt2(), phi(), rapidity(), px(), py(), pz(), energy() (in the JetReconstruction namespace) can be used. This includes LorentzVector, LorentzVectorCyl, and PseudoJet, for which these methods are already predefined in the JetReconstruction namespace.\n\nrecombine argument\n\nThe recombine argument is the function used to merge pairs of particles. The default is simply +(jet1,jet2), i.e. 4-momenta addition or the E-scheme.\n\nConsistency of p, algorithm and R arguments\n\nIf an algorithm is explicitly specified the p value should be consistent with it or nothing. If the algorithm is one where p can vary, then it has to be given, along with the algorithm.\n\nIf the p parameter is passed and algorithm=nothing, then pp-type reconstruction is implied (i.e., AntiKt, CA, Kt or GenKt will be used, depending on the value of p).\n\nWhen an algorithm has no R dependence the R parameter is ignored.\n\nExample\n\njet_reconstruct(particles; p = -1, R = 0.4)\njet_reconstruct(particles; algorithm = JetAlgorithm.Kt, R = 1.0)\njet_reconstruct(particles; algorithm = JetAlgorithm.Durham)\njet_reconstruct(particles; algorithm = JetAlgorithm.GenKt, p = 0.5, R = 1.0)\n\n\n\n\n\n","category":"method"},{"location":"lib/public/#JetReconstruction.loadjets!-Tuple{Any, Any}","page":"Public API","title":"JetReconstruction.loadjets!","text":"loadjets!(filename, jets; splitby=isspace, constructor=(px,py,pz,E)->LorentzVectorHEP(E,px,py,pz), dtype=Float64)\n\nLoads the jets from a file. Ignores lines that start with '#'. Each line gets processed in the following way: the line is split using split(line, splitby) or simply split(line) by default. Every value in this line is then converted to the dtype (which is Float64 by default). These values are then used as arguments for the constructor function which should produce individual jets. By default, the constructor constructs Lorentz vectors.\n\nEverything that was already in jets is not affected as we only use push! on it.\n\nExample\n\n# Load jets from two files into one array\njets = []\nloadjets!(\"myjets1.dat\", jets)\nloadjets!(\"myjets2.dat\", jets)\n\n\n\n\n\n","category":"method"},{"location":"lib/public/#JetReconstruction.loadjets-Tuple{Any}","page":"Public API","title":"JetReconstruction.loadjets","text":"loadjets(filename; splitby=isspace, constructor=(px,py,pz,E)->LorentzVectorHEP(E,px,py,pz), VT=LorentzVector)\n\nLoad jets from a file.\n\nArguments\n\nfilename: The name of the file to load jets from.\nsplitby: The delimiter used to split the data in the file. Default is isspace.\nconstructor: A function that constructs a VT object from the jet data. Default is (px,py,pz,E)->LorentzVector(E,px,py,pz).\nVT: The type of the vector used to store the jet data. Default is LorentzVector.\n\nReturns\n\nA vector of VT objects representing the loaded jets.\n\n\n\n\n\n","category":"method"},{"location":"lib/public/#JetReconstruction.n_exclusive_jets-Tuple{ClusterSequence}","page":"Public API","title":"JetReconstruction.n_exclusive_jets","text":"n_exclusive_jets(clusterseq::ClusterSequence; dcut::AbstractFloat)\n\nReturn the number of exclusive jets of a ClusterSequence that are above a certain dcut value.\n\nArguments\n\nclusterseq::ClusterSequence: The ClusterSequence object containing the clustering history.\ndcut::AbstractFloat: The maximum value for the distance parameter in the reconstruction.\n\nReturns\n\nThe number of exclusive jets in the ClusterSequence object.\n\nExample\n\nn_exclusive_jets(clusterseq, dcut = 20.0)\n\n\n\n\n\n","category":"method"},{"location":"lib/public/#JetReconstruction.plain_jet_reconstruct-Union{Tuple{AbstractVector{T}}, Tuple{T}} where T","page":"Public API","title":"JetReconstruction.plain_jet_reconstruct","text":"plain_jet_reconstruct(particles::Vector{T}; p = -1, R = 1.0, recombine = +) where T\n\nPerform pp jet reconstruction using the plain algorithm.\n\nArguments\n\nparticles::Vector{T}: A vector of particles used for jet reconstruction, any array of particles, which supports suitable 4-vector methods, viz. pt2(), phi(), rapidity(), px(), py(), pz(), energy(), can be used. for each element.\nalgorithm::Union{JetAlgorithm, Nothing} = nothing: The explicit jet algorithm to use.\np::Int=-1: The integer value used for jet reconstruction.\nR::Float64=1.0: The radius parameter used for jet reconstruction.\nrecombine::Function=+: The recombination function used for jet reconstruction.\n\nNote for the particles argument, the 4-vector methods need to exist in the JetReconstruction package namespace.\n\nThis code will use the k_t algorithm types, operating in (rapidity, φ) space.\n\nIt is not necessary to specify both the algorithm and the p (power) value. If both are given they must be consistent or an exception is thrown.\n\nReturns\n\nVector{PseudoJet}: A vector of reconstructed jets.\n\nExample\n\njets = plain_jet_reconstruct(particles; p = -1, R = 0.4)\njets = plain_jet_reconstruct(particles; algorithm = JetAlgorithm.Kt, R = 1.0)\n\n\n\n\n\n","category":"method"},{"location":"lib/public/#JetReconstruction.read_final_state_particles-Tuple{Any}","page":"Public API","title":"JetReconstruction.read_final_state_particles","text":"read_final_state_particles(fname; maxevents = -1, skipevents = 0, T=PseudoJet)\n\nReads final state particles from a file and returns them as a vector of type T.\n\nArguments\n\nfname: The name of the HepMC3 ASCII file to read particles from. If the file is gzipped, the function will automatically decompress it.\nmaxevents=-1: The maximum number of events to read. -1 means all events will be read.\nskipevents=0: The number of events to skip before an event is included.\nT=PseudoJet: The type of object to construct and return.\n\nReturns\n\nA vector of vectors of T objects, where each inner vector represents all the particles of a particular event. In particular T can be PseudoJet or a LorentzVector type. Note, if T is not PseudoJet, the order of the arguments in the constructor must be (t, x, y, z).\n\n\n\n\n\n","category":"method"},{"location":"lib/public/#JetReconstruction.savejets-Tuple{Any, Any}","page":"Public API","title":"JetReconstruction.savejets","text":"savejets(filename, jets; format=\"px py pz E\")\n\nSave jet data to a file.\n\nArguments\n\nfilename: The name of the file to save the jet data to.\njets: An array of jet objects to save.\nformat=\"px py pz E\": (optional) A string specifying the format of the jet data to save. The default format is \"px py pz E\".\n\nDetails\n\nThis function saves jet data to a file in a specific format. Each line in the file represents a jet and contains the information about the jet in the specified format. The format string can include the following placeholders:\n\n\"E\" or \"energy\": Jet energy\n\"px\": Momentum along the x-axis\n\"py\": Momentum along the y-axis\n\"pz\": Momentum along the z-axis\n\"pt2\": Square of the transverse momentum\n\"phi\": Azimuth angle\n\"rapidity\": Rapidity\n\nLines starting with '#' are treated as comments and are ignored.\n\nIt is strongly NOT recommended to put something other than values and (possibly custom) separators in the format string.\n\n\n\n\n\n","category":"method"},{"location":"lib/public/#JetReconstruction.tiled_jet_reconstruct-Union{Tuple{AbstractVector{T}}, Tuple{T}} where T","page":"Public API","title":"JetReconstruction.tiled_jet_reconstruct","text":"tiled_jet_reconstruct(particles::Vector{T}; p = -1, R = 1.0, recombine = +) where {T}\n\nMain jet reconstruction algorithm entry point for reconstructing jets using the tiled strategy for generic jet type T.\n\nNote - if a non-standard recombination is used, it must be defined for JetReconstruction.PseudoJet, as this struct is used internally.\n\nThis code will use the k_t algorithm types, operating in (rapidity, φ) space.\n\nIt is not necessary to specify both the algorithm and the p (power) value. If both are given they must be consistent or an exception is thrown.\n\nArguments\n\nparticles::Vector{T}: A vector of particles used as input for jet reconstruction. T must support methods px, py, pz and energy (defined in the JetReconstruction namespace)\np::Union{Real, Nothing} = -1: The power parameter for the jet reconstruction algorithm, thus switching between different algorithms.\nalgorithm::Union{JetAlgorithm, Nothing} = nothing: The explicit jet algorithm to use.\nR::Float64 = 1.0: The jet radius parameter for the jet reconstruction algorithm.\nrecombine::Function = +: The recombination function used for combining pseudojets.\n\nReturns\n\nVector{PseudoJet}: A vector of reconstructed jets.\n\nExample\n\ntiled_jet_reconstruct(particles::Vector{LorentzVectorHEP}; p = -1, R = 0.4, recombine = +)\n\n\n\n\n\n","category":"method"},{"location":"lib/public/#JetReconstruction.ClusterSequence","page":"Public API","title":"JetReconstruction.ClusterSequence","text":"struct ClusterSequence\n\nA struct holding the full history of a jet clustering sequence, including the final jets.\n\nFields\n\nalgorithm::JetAlgorithm.Algorithm: The algorithm used for clustering.\nstrategy::RecoStrategy.Strategy: The strategy used for clustering.\npower::Float64: The power value used for the clustering algorithm (not that this value is always stored as a Float64 to be type stable)\nR::Float64: The R parameter used for the clustering algorithm.\njets::Vector{T}: The actual jets in the cluster sequence, which are of type T <: FourMomentum.\nn_initial_jets::Int: The initial number of particles used for exclusive jets.\nhistory::Vector{HistoryElement}: The branching history of the cluster sequence. Each stage in the history indicates where to look in the jets vector to get the physical PseudoJet.\nQtot::Any: The total energy of the event.\n\n\n\n\n\n","category":"type"},{"location":"lib/public/#JetReconstruction.ClusterSequence-Union{Tuple{T}, Tuple{JetReconstruction.JetAlgorithm.Algorithm, Real, Float64, JetReconstruction.RecoStrategy.Strategy, Vector{T}, Any, Any}} where T<:JetReconstruction.FourMomentum","page":"Public API","title":"JetReconstruction.ClusterSequence","text":"ClusterSequence(algorithm::JetAlgorithm.Algorithm, p::Real, R::Float64, strategy::RecoStrategy.Strategy, jets::T, history, Qtot) where T <: FourMomentum\n\nConstruct a ClusterSequence object.\n\nArguments\n\nalgorithm::JetAlgorithm.Algorithm: The algorithm used for clustering.\np::Real: The power value used for the clustering algorithm.\nR::Float64: The R parameter used for the clustering algorithm.\nstrategy::RecoStrategy.Strategy: The strategy used for clustering.\njets::Vector{T}: The jets in the cluster sequence, which are of T <: FourMomentum\nhistory::Vector{HistoryElement}: The branching history of the cluster sequence.\nQtot::Any: The total energy of the event.\n\n\n\n\n\n","category":"method"},{"location":"lib/public/#JetReconstruction.EEjet","page":"Public API","title":"JetReconstruction.EEjet","text":"struct EEjet{T <: Real} <: FourMomentum\n\nThe EEjet struct is a 4-momentum object used for the e+e jet reconstruction routines. Internal fields are used to track the reconstruction and to cache values needed during the execution of the algorithm.\n\nFields\n\npx::T: The x-component of the jet momentum.\npy::T: The y-component of the jet momentum.\npz::T: The z-component of the jet momentum.\nE::T: The energy of the jet.\n_cluster_hist_index::Int: The index of the cluster histogram.\n_p2::T: The squared momentum of the jet.\n_inv_p::T: The inverse momentum of the jet.\n\nType Parameters\n\nT <: Real: The type of the numerical values.\n\n\n\n\n\n","category":"type"},{"location":"lib/public/#JetReconstruction.EEjet-Tuple{PseudoJet}","page":"Public API","title":"JetReconstruction.EEjet","text":"EEjet(pj::PseudoJet) -> EEjet\n\nConstructs an EEjet object from a given PseudoJet object pj.\n\nArguments\n\npj::PseudoJet: A PseudoJet object used to create the EEjet.\n\nReturns\n\nAn EEjet object initialized with the same properties of the given PseudoJet.\n\n\n\n\n\n","category":"method"},{"location":"lib/public/#JetReconstruction.EEjet-Union{Tuple{T}, NTuple{4, T}} where T<:Real","page":"Public API","title":"JetReconstruction.EEjet","text":"EEjet(px::T, py::T, pz::T, E::T) where {T <: Real}\n\nConstructs an EEjet object with the given momentum components px, py, pz, energy E, and the cluster histogram index set to zero.\n\nThe constructed EEjet object will be parametrised by the type T.\n\nArguments\n\npx::T: The x-component of the momentum.\npy::T: The y-component of the momentum.\npz::T: The z-component of the momentum.\nE::T: The energy of the jet.\n\nReturns\n\nThe initialised EEjet object.\n\n\n\n\n\n","category":"method"},{"location":"lib/public/#JetReconstruction.EEjet-Union{Tuple{T}, Tuple{T, T, T, T, Integer}} where T<:Real","page":"Public API","title":"JetReconstruction.EEjet","text":"EEjet(px::T, py::T, pz::T, E::T, _cluster_hist_index::Integer) where {T <: Real}\n\nConstructs an EEjet object with the given momentum components px, py, pz, energy E, and cluster histogram index _cluster_hist_index.\n\nThe constructed EEjet object will be parametrised by the type T.\n\nArguments\n\npx::T: The x-component of the momentum.\npy::T: The y-component of the momentum.\npz::T: The z-component of the momentum.\nE::T: The energy of the jet.\n_cluster_hist_index::Integer: The index of the cluster histogram.\n\nReturns\n\nThe initialised EEjet object.\n\nNote\n\nT must be a subtype of Real.\nThe @muladd macro is used to perform fused multiply-add operations for computing p2.\nThe @fastmath macro is used to allow the compiler to perform optimizations for computing inv_p.\n\n\n\n\n\n","category":"method"},{"location":"lib/public/#JetReconstruction.EEjet-Union{Tuple{U}, Tuple{T}, NTuple{4, T}} where {T<:Real, U<:Real}","page":"Public API","title":"JetReconstruction.EEjet","text":"EEjet{U}(px::T, py::T, pz::T, E::T) where {T <: Real, U <: Real}\n\nConstructs an EEjet object with conversion of the given momentum components (px, py, pz) and energy (E) from type T to type U.\n\nArguments\n\npx::T: The x-component of the momentum.\npy::T: The y-component of the momentum.\npz::T: The z-component of the momentum.\nE::T: The energy.\n\nType Parameters\n\nT <: Real: The type of the input momentum components and energy.\nU <: Real: The type to which the input values will be converted\n\nReturns\n\nAn EEjet object with the momentum components and energy parametrised to type U.\n\n\n\n\n\n","category":"method"},{"location":"lib/public/#JetReconstruction.FinalJet","page":"Public API","title":"JetReconstruction.FinalJet","text":"struct FinalJet\n\nA struct representing the final properties of a jet, used for JSON serialisation.\n\nFields\n\nrap::Float64: The rapidity of the jet.\nphi::Float64: The azimuthal angle of the jet.\npt::Float64: The transverse momentum of the jet.\n\n\n\n\n\n","category":"type"},{"location":"lib/public/#JetReconstruction.FinalJets","page":"Public API","title":"JetReconstruction.FinalJets","text":"struct FinalJets\n\nA struct with the vector of all jets for a certain jet identifier, used for JSON serialisation.\n\nFields\n\njetid::Int64: The ID of the jet.\njets::Vector{FinalJet}: A vector of FinalJet objects representing the jets.\n\n\n\n\n\n","category":"type"},{"location":"lib/public/#JetReconstruction.PseudoJet","page":"Public API","title":"JetReconstruction.PseudoJet","text":"mutable struct PseudoJet{T <: Real} <: FourMomentum\n\nThe PseudoJet struct represents a pseudojet, a four-momentum object used in jet reconstruction algorithms. Additional information for the link back into the history of the clustering is stored in the _cluster_hist_index field. There is caching of the more expensive calculations for rapidity and azimuthal angle.\n\nFields\n\npx::T: The x-component of the momentum.\npy::T: The y-component of the momentum.\npz::T: The z-component of the momentum.\nE::T: The energy component of the momentum.\n_cluster_hist_index::Int: The index of the cluster history.\n_pt2::T: The squared transverse momentum.\n_inv_pt2::T: The inverse squared transverse momentum.\n_rap::T: The rapidity.\n_phi::T: The azimuthal angle.\n\n\n\n\n\n","category":"type"},{"location":"lib/public/#JetReconstruction.PseudoJet-Union{Tuple{T}, NTuple{4, T}} where T<:Real","page":"Public API","title":"JetReconstruction.PseudoJet","text":"PseudoJet(px::T, py::T, pz::T, E::T) where T <: Real\n\nConstructs a PseudoJet object with the given momentum components and energy.\n\nArguments\n\npx::T: The x-component of the momentum.\npy::T: The y-component of the momentum.\npz::T: The z-component of the momentum.\nE::T: The energy.\n\nReturns\n\nA PseudoJet object, with type parameter T.\n\n\n\n\n\n","category":"method"},{"location":"lib/public/#JetReconstruction.PseudoJet-Union{Tuple{T}, Tuple{T, T, T, T, Int64, T}} where T<:Real","page":"Public API","title":"JetReconstruction.PseudoJet","text":"PseudoJet{T}(px::T, py::T, pz::T, E::T,\n _cluster_hist_index::Int,\n pt2::T) where {T <: Real}\n\nConstructs a parametrised PseudoJet object with the given momentum components and energy and history index.\n\nArguments\n\npx::T: The x-component of the momentum.\npy::T: The y-component of the momentum.\npz::T: The z-component of the momentum.\nE::T: The energy.\n_cluster_hist_index::Int: The cluster history index.\npt2::T: The transverse momentum squared.\n\nReturns\n\nA PseudoJet object.\n\n\n\n\n\n","category":"method"},{"location":"lib/public/#JetReconstruction.PseudoJet-Union{Tuple{U}, Tuple{T}, NTuple{4, T}} where {T<:Real, U<:Real}","page":"Public API","title":"JetReconstruction.PseudoJet","text":"PseudoJet{U}(px::T, py::T, pz::T, E::T) where T <: Real, U <: Real\n\nConstructs a PseudoJet object with the given momentum components and energy, parameterised by U.\n\nArguments\n\npx::T: The x-component of the momentum.\npy::T: The y-component of the momentum.\npz::T: The z-component of the momentum.\nE::T: The energy.\nU <: Real: The type parameter for the PseudoJet object.\n\nReturns\n\nA PseudoJet object, with type parameter U.\n\n\n\n\n\n","category":"method"},{"location":"#Jet-Reconstruction","page":"Home","title":"Jet Reconstruction","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"This package implements sequential Jet Reconstruction (clustering) algorithms, which are used in high-energy physics as part of event reconstruction for pp and e^+e^- colliders.","category":"page"},{"location":"#Algorithms","page":"Home","title":"Algorithms","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Algorithms used are based on the C++ FastJet package (https://fastjet.fr, hep-ph/0512210, arXiv:1111.6097), reimplemented natively in Julia.","category":"page"},{"location":"","page":"Home","title":"Home","text":"The algorithms include anti-k_textT, Cambridge/Aachen, inclusive k_textT, generalised k_textT for pp events; and the Durham algorithm and generalised k_textT for e^+e^-.","category":"page"},{"location":"#Reconstruction-Interface","page":"Home","title":"Reconstruction Interface","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"The main interface for reconstruction is jet_reconstruct, called as, e.g.,","category":"page"},{"location":"","page":"Home","title":"Home","text":"jet_reconstruct(particles; algorithm = JetAlgorithm.AntiKt, R = 1.0)","category":"page"},{"location":"","page":"Home","title":"Home","text":"or with some of the optional arguments,","category":"page"},{"location":"","page":"Home","title":"Home","text":"jet_reconstruct(particles; algorithm = JetAlgorithm.GenKt, R = 0.4, \n p = 0.5, recombine = +, strategy = RecoStrategy.Best)","category":"page"},{"location":"","page":"Home","title":"Home","text":"Where particles is a collection of 4-vector objects (see Input Particle Types) to reconstruct and the algorithm is either given explicitly or implied by the power value.","category":"page"},{"location":"","page":"Home","title":"Home","text":"For the case of generalised k_T (for pp and e^+e^-) both the algorithm (GenKt, EEKt) and p are needed.","category":"page"},{"location":"","page":"Home","title":"Home","text":"The R value determines the cone size; in the case of the Durham algorithm the R value is ignored.","category":"page"},{"location":"","page":"Home","title":"Home","text":"The object returned is a ClusterSequence, which internally tracks all merge steps and is used for Inclusive and Exclusive Selections.","category":"page"},{"location":"#Algorithm-Types","page":"Home","title":"Algorithm Types","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Each known algorithm is referenced using a JetAlgorithm scoped enum value.","category":"page"},{"location":"","page":"Home","title":"Home","text":"Algorithm Type name Notes\nanti-k_textT JetAlgorithm.AntiKt Implies p=-1\nCambridge/Aachen JetAlgorithm.CA Implies p=0\ninclusive k_textT JetAlgorithm.Kt Implies p=1\ngeneralised k_textT JetAlgorithm.GenKt For pp, value of p must also be specified\ne^+e- k_textT / Durham JetAlgorithm.Durham R value ignored and can be omitted\ngeneralised e^+e- k_textT JetAlgorithm.EEKt For e^+e^-, value of p must also be specified","category":"page"},{"location":"#pp-Algorithms","page":"Home","title":"pp Algorithms","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"For the three pp algorithms with fixed p values, the p value can be given instead of the algorithm name. However, this should be considered deprecated and will be removed in a future release.","category":"page"},{"location":"#Strategy","page":"Home","title":"Strategy","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Generally one does not need to manually specify a strategy, but Algorithm Strategy describes how to do this, if desired.","category":"page"},{"location":"#Inclusive-and-Exclusive-Selections","page":"Home","title":"Inclusive and Exclusive Selections","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"To obtain final jets both inclusive (p_T cut) and exclusive (n_jets or d_ij cut) selections are supported:","category":"page"},{"location":"","page":"Home","title":"Home","text":"inclusive_jets(clusterseq::ClusterSequence, ptmin = 0.0)\nexclusive_jets(clusterseq::ClusterSequence; dcut = nothing, njets = nothing)","category":"page"},{"location":"","page":"Home","title":"Home","text":"(For exclusive_jets either dcut or njets is needed, but not both.)","category":"page"},{"location":"#Sorting","page":"Home","title":"Sorting","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Sorting vectors is trivial in Julia, no special sorting methods are provided. As an example, to sort exclusive jets of 50 (usually GeV, depending on your EDM) from highest energy to lowest:","category":"page"},{"location":"","page":"Home","title":"Home","text":"sorted_jets = sort!(inclusive_jets(cs::ClusterSequence; ptmin=5.0), \n by=JetReconstruction.energy, rev=true)","category":"page"},{"location":"#Jet-Constituents","page":"Home","title":"Jet Constituents","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"There are two ways to retrieve jet constituents. The first way is just to retrieve the indexes of the constituent jets. These indexes refer to the original collection of particles passed in to the reconstruction.","category":"page"},{"location":"","page":"Home","title":"Home","text":"constituent_indexes","category":"page"},{"location":"","page":"Home","title":"Home","text":"The alternative it to retrieve the actual jets from the reconstruction sequence. In this case the returned array contains references to the jet objects (of type T) used internally in the reconstruction.","category":"page"},{"location":"","page":"Home","title":"Home","text":"constituents","category":"page"},{"location":"","page":"Home","title":"Home","text":"Note that in both these cases the cluster sequence object from the reconstruction is required (to avoid circular dependencies and improve memory management reconstructed jets do not contain a link back to their cluster sequence).","category":"page"},{"location":"#References","page":"Home","title":"References","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Although it has been developed further since the CHEP2023 conference, the CHEP conference proceedings, 10.1051/epjconf/202429505017, should be cited if you use this package:","category":"page"},{"location":"","page":"Home","title":"Home","text":"@article{refId0,\n author = {{Stewart, Graeme Andrew} and {Gras, Philippe} and {Hegner, Benedikt} and {Krasnopolski, Atell}},\n doi = {10.1051/epjconf/202429505017},\n journal = {EPJ Web of Conf.},\n pages = {05017},\n title = {Polyglot Jet Finding},\n url = {https://doi.org/10.1051/epjconf/202429505017},\n volume = 295,\n year = 2024,\n eprint={2309.17309},\n archivePrefix={arXiv},\n primaryClass={hep-ex}\n}","category":"page"},{"location":"","page":"Home","title":"Home","text":"The original paper on arXiv is:","category":"page"},{"location":"","page":"Home","title":"Home","text":"@misc{stewart2023polyglot,\n title={Polyglot Jet Finding}, \n author={Graeme Andrew Stewart and Philippe Gras and Benedikt Hegner and Atell Krasnopolski},\n year={2023},\n eprint={2309.17309},\n archivePrefix={arXiv},\n primaryClass={hep-ex}\n}","category":"page"},{"location":"#Authors-and-Copyright","page":"Home","title":"Authors and Copyright","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Code in this package is authored by:","category":"page"},{"location":"","page":"Home","title":"Home","text":"Atell Krasnopolski \nGraeme A Stewart \nPhilippe Gras ","category":"page"},{"location":"","page":"Home","title":"Home","text":"and is Copyright 2022-2024 The Authors, CERN.","category":"page"},{"location":"","page":"Home","title":"Home","text":"The code is under the MIT License.","category":"page"},{"location":"lib/internal/#Jet-Reconstruction-Internal-Documentation","page":"Internal API","title":"Jet Reconstruction Internal Documentation","text":"","category":"section"},{"location":"lib/internal/","page":"Internal API","title":"Internal API","text":"Documentation for JetReconstruction.jl's internal methods and types.","category":"page"},{"location":"lib/internal/","page":"Internal API","title":"Internal API","text":"N.B. no guarantee is made of stability of these interfaces or types.","category":"page"},{"location":"lib/internal/","page":"Internal API","title":"Internal API","text":"CollapsedDocStrings = true","category":"page"},{"location":"lib/internal/#Index","page":"Internal API","title":"Index","text":"","category":"section"},{"location":"lib/internal/","page":"Internal API","title":"Internal API","text":"Pages = [\"internal.md\"]","category":"page"},{"location":"lib/internal/#Internal-Methods-and-Types","page":"Internal API","title":"Internal Methods and Types","text":"","category":"section"},{"location":"lib/internal/","page":"Internal API","title":"Internal API","text":"Modules = [JetReconstruction]\nPublic = false\nOrder = [:function, :type]","category":"page"},{"location":"lib/internal/#Base.:+-Tuple{PseudoJet, PseudoJet}","page":"Internal API","title":"Base.:+","text":"+(j1::PseudoJet, j2::PseudoJet)\n\nAddition operator for PseudoJet objects.\n\nArguments\n\nj1::PseudoJet: The first PseudoJet object.\nj2::PseudoJet: The second PseudoJet object.\n\nReturns\n\nA new PseudoJet object with the sum of the momenta and energy of j1 and j2.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#Base.copy-Tuple{JetReconstruction.TiledJet}","page":"Internal API","title":"Base.copy","text":"copy(j::TiledJet)\n\nCreate a copy of a TiledJet object.\n\nArguments\n\nj::TiledJet: The TiledJet object to be copied.\n\nReturns\n\nA new TiledJet object with the same attributes as the input object.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#Base.eltype-Union{Tuple{Type{EEjet{T}}}, Tuple{T}} where T","page":"Internal API","title":"Base.eltype","text":"Base.eltype(::Type{EEjet{T}}) where T\n\nReturn the element type of the EEjet struct.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#Base.eltype-Union{Tuple{Type{PseudoJet{T}}}, Tuple{T}} where T","page":"Internal API","title":"Base.eltype","text":"Base.eltype(::Type{PseudoJet{T}}) where T\n\nReturn the element type of the PseudoJet struct.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#Base.iterate","page":"Internal API","title":"Base.iterate","text":"Base.iterate(t::neighbour_tiles, state=1)\n\nIterate over the neighbour_tiles object, returning all the neighbour tiles for a given Cartesian tile index.\n\n\n\n\n\n","category":"function"},{"location":"lib/internal/#Base.iterate-2","page":"Internal API","title":"Base.iterate","text":"Base.iterate(t::rightmost_tiles, state=1)\n\nIterate over the rightmost_tiles object, returning all the rightmost tiles for a given Cartesian tile index.\n\n\n\n\n\n","category":"function"},{"location":"lib/internal/#Base.iterate-Tuple{JetReconstruction.TiledJet}","page":"Internal API","title":"Base.iterate","text":"Base.iterate(tj::TiledJet)\n\nIterate over a TiledJet object's linked list, walking over all jets until the end (then the next jet is invalid).\n\nArguments\n\ntj::TiledJet: The TiledJet object to start to iterate over.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#Base.show-Tuple{IO, PseudoJet}","page":"Internal API","title":"Base.show","text":"show(io::IO, jet::PseudoJet)\n\nPrint a PseudoJet object to the specified IO stream.\n\nArguments\n\nio::IO: The IO stream to which the information will be printed.\njet::PseudoJet: The PseudoJet object whose information will be printed.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#Base.tryparse-Tuple{Type{<:Enum}, String}","page":"Internal API","title":"Base.tryparse","text":"Base.tryparse(E::Type{<:Enum}, str::String)\n\nParser that converts a string to an enum value if it exists, otherwise returns nothing.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.CosTheta-Tuple{PseudoJet}","page":"Internal API","title":"JetReconstruction.CosTheta","text":"CosTheta(p::PseudoJet)\n\nCompute the cosine of the angle between the momentum vector p and the z-axis.\n\nArguments\n\np::PseudoJet: The PseudoJet object representing the momentum vector.\n\nReturns\n\nThe cosine of the angle between p and the z-axis.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction._ee_genkt_algorithm-Union{Tuple{}, Tuple{T}} where T<:Real","page":"Internal API","title":"JetReconstruction._ee_genkt_algorithm","text":"_ee_genkt_algorithm(; particles::Vector{EEjet}, p = 1, R = 4.0,\n algorithm::JetAlgorithm.Algorithm = JetAlgorithm.Durham,\n recombine = +)\n\nThis function is the actual implementation of the e+e- jet clustering algorithm.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction._ensure_valid_rap_phi-Tuple{PseudoJet}","page":"Internal API","title":"JetReconstruction._ensure_valid_rap_phi","text":"_ensure_valid_rap_phi(p::PseudoJet)\n\nEnsure that the rapidity and azimuthal angle of the PseudoJet p are valid. If the azimuthal angle is invalid (used as a proxy for both variables), they are set to a valid value using _set_rap_phi!.\n\nArguments\n\np::PseudoJet: The PseudoJet object to ensure valid rapidity and azimuthal angle for.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction._plain_jet_reconstruct-Union{Tuple{}, Tuple{T}} where T<:Real","page":"Internal API","title":"JetReconstruction._plain_jet_reconstruct","text":"_plain_jet_reconstruct(; particles::Vector{PseudoJet}, p = -1, R = 1.0, recombine = +)\n\nThis is the internal implementation of jet reconstruction using the plain algorithm. It takes a vector of particles representing the input particles and reconstructs jets based on the specified parameters. Here the particles must be of type PseudoJet.\n\nUsers of the package should use the plain_jet_reconstruct function as their entry point to this jet reconstruction.\n\nThe power value maps to specific pp jet reconstruction algorithms: -1 = AntiKt, 0 = Cambridge/Aachen, 1 = Inclusive Kt. Floating point values are allowed for generalised k_t algorithm.\n\nArguments\n\nparticles: A vector of PseudoJet objects representing the input particles.\np=-1: The power to which the transverse momentum (pt) of each particle is raised.\nR=1.0: The jet radius parameter.\nrecombine: The recombination function used to merge two jets. Default is + (additive recombination).\n\nReturns\n\nclusterseq: The resulting ClusterSequence object representing the reconstructed jets.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction._set_rap_phi!-Tuple{PseudoJet}","page":"Internal API","title":"JetReconstruction._set_rap_phi!","text":"setrap_phi!(p::PseudoJet)\n\nSet the rapidity and azimuthal angle of the PseudoJet p.\n\nArguments\n\np::PseudoJet: The PseudoJet object for which to set the rapidity and azimuthal angle.\n\nDescription\n\nThis function calculates and sets the rapidity and azimuthal angle of the PseudoJet p based on its momentum components. The rapidity is calculated in a way that is insensitive to roundoff errors when the momentum components are large. If the PseudoJet represents a point with infinite rapidity, a large number is assigned to the rapidity in order to lift the degeneracy between different zero-pt momenta.\n\nNote - the ϕ angle is calculated in the range [0, 2π).\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction._tiled_jet_reconstruct-Union{Tuple{Array{PseudoJet{T}, 1}}, Tuple{T}} where T<:Real","page":"Internal API","title":"JetReconstruction._tiled_jet_reconstruct","text":"_tiled_jet_reconstruct(particles::Vector{PseudoJet}; p = -1, R = 1.0, recombine = +) where {T}\n\nMain jet reconstruction algorithm entry point for reconstructing jets once preprocessing of data types are done.\n\nArguments\n\nparticles::Vector{PseudoJet}: A vector of PseudoJet particles used as input for jet reconstruction.\np::Int = -1: The power parameter for the jet reconstruction algorithm, thus switching between different algorithms.\nR::Float64 = 1.0: The jet radius parameter for the jet reconstruction algorithm.\nrecombine::Function = +: The recombination function used for combining pseudojets.\n\nReturns\n\nVector{PseudoJet}: A vector of reconstructed jets.\n\nExample\n\ntiled_jet_reconstruct(particles::Vector{PseudoJet}; p = 1, R = 1.0, recombine = +)\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction._tj_diJ-Tuple{Any}","page":"Internal API","title":"JetReconstruction._tj_diJ","text":"_tj_diJ(jet)\n\nCompute the dij metric value for a given jet.\n\nArguments\n\njet: The input jet.\n\nReturns\n\nThe dij value for the jet.\n\nExample\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction._tj_dist-Tuple{Any, Any}","page":"Internal API","title":"JetReconstruction._tj_dist","text":"_tj_dist(jetA, jetB)\n\nCompute the geometric distance in the (y, ϕ)-plane between two jets in the TiledAlgoLL module.\n\nArguments\n\njetA: The first jet.\njetB: The second jet.\n\nReturns\n\nThe squared distance between jetA and jetB.\n\nExamples\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.add_step_to_history!-Tuple{ClusterSequence, Vararg{Any, 4}}","page":"Internal API","title":"JetReconstruction.add_step_to_history!","text":"add_step_to_history!(clusterseq::ClusterSequence, parent1, parent2, jetp_index, dij)\n\nAdd a new jet's history into the recombination sequence.\n\nArguments:\n\nclusterseq::ClusterSequence: The cluster sequence object.\nparent1: The index of the first parent.\nparent2: The index of the second parent.\njetp_index: The index of the jet.\ndij: The dij value.\n\nThis function adds a new HistoryElement to the history vector of the clusterseq object. The HistoryElement contains information about the parents, child, jet index, dij value, and the maximum dij value so far. It also updates the child index of the parent elements.\n\nIf the parent1 or parent2 have already been recombined, an InternalError is thrown. The jetp_index is used to update the _cluster_hist_index of the corresponding PseudoJet object.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.add_untagged_neighbours_to_tile_union-NTuple{4, Any}","page":"Internal API","title":"JetReconstruction.add_untagged_neighbours_to_tile_union","text":"add_untagged_neighbours_to_tile_union(center_index, tile_union, n_near_tiles, tiling)\n\nAdds to the vector tileunion the tiles that are in the neighbourhood of the specified centerindex, including itself and whose tagged status are false - start adding from position nneartiles-1, and increase nneartiles. When a neighbour is added its tagged status is set to true.\n\nArguments\n\ncenter_index: The index of the center tile.\ntile_union: An array to store the indices of neighbouring tiles.\nn_near_tiles: The number of neighbouring tiles.\ntiling: The tiling object containing the tile tags.\n\nReturns\n\nThe updated number of near tiles.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.angular_distance-Tuple{Any, Any, Any}","page":"Internal API","title":"JetReconstruction.angular_distance","text":"angular_distance(eereco, i, j) -> Float64\n\nCalculate the angular distance between two jets i and j using the formula 1 - cos(θ_ij).\n\nArguments\n\neereco: The array of EERecoJet objects.\ni: The first jet.\nj: The second jet.\n\nReturns\n\nFloat64: The angular distance between i and j, which is 1 - cos\theta.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.check_algorithm_power_consistency-Tuple{}","page":"Internal API","title":"JetReconstruction.check_algorithm_power_consistency","text":"Allow a check for algorithm and power consistency\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.copy_to_slot!-Tuple{Any, Any, Any}","page":"Internal API","title":"JetReconstruction.copy_to_slot!","text":"copy_to_slot!(eereco, i, j)\n\nCopy the contents of slot i in the eereco array to slot j.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.detach!-Tuple{JetReconstruction.TiledJet}","page":"Internal API","title":"JetReconstruction.detach!","text":"detach!(jet::TiledJet)\n\nDetach a TiledJet from its linked list by updating the previous and next pointers.\n\nArguments\n\njet::TiledJet: The TiledJet object to detach.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.determine_rapidity_extent-Union{Tuple{Vector{T}}, Tuple{T}} where T<:AbstractFloat","page":"Internal API","title":"JetReconstruction.determine_rapidity_extent","text":"determine_rapidity_extent(eta::Vector{T}) where T <: AbstractFloat\n\nCalculate the minimum and maximum rapidities based on the input vector eta. The function determines the rapidity extent by binning the multiplicities as a function of rapidity and finding the minimum and maximum rapidities such that the edge bins contain a certain fraction (~1/4) of the busiest bin and a minimum number of particles.\n\nThis is the heuristic which is used by FastJet (inline comments are from FastJet).\n\nArguments\n\neta::Vector{T}: A vector of rapidity values.\n\nReturns\n\nminrap::T: The minimum rapidity value.\nmaxrap::T: The maximum rapidity value.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.dij-NTuple{4, Any}","page":"Internal API","title":"JetReconstruction.dij","text":"dij(i, kt2_array, nn, nndist)\n\nCompute the dij value for a given index i to its nearest neighbor. The nearest neighbor is determined from nn[i], and the metric distance to the nearest neighbor is given by the distance nndist[i] applying the lower of the kt2_array values for the two particles.ßß\n\nArguments\n\ni: The index of the element.\nkt2_array: An array of kt2 values.\nnn: An array of nearest neighbors.\nnndist: An array of nearest neighbor distances.\n\nReturns\n\nThe computed dij value.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.dij_dist-NTuple{4, Any}","page":"Internal API","title":"JetReconstruction.dij_dist","text":"dij_dist(eereco, i, j, dij_factor)\n\nCalculate the dij distance between two e^+e^-jets.\n\nArguments\n\neereco: The array of EERecoJet objects.\ni: The first jet.\nj: The second jet.\ndij_factor: The scaling factor to multiply the dij distance by.\n\nReturns\n\nThe dij distance between i and j.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.dist-NTuple{4, Any}","page":"Internal API","title":"JetReconstruction.dist","text":"dist(i, j, rapidity_array, phi_array)\n\nCompute the distance between points in a 2D space defined by rapidity and phi coordinates.\n\nArguments\n\ni::Int: Index of the first point to consider (indexes into rapidity_array and phi_array).\nj::Int: Index of the second point to consider (indexes into rapidity_array and phi_array).\nrapidity_array::Vector{Float64}: Array of rapidity coordinates.\nphi_array::Vector{Float64}: Array of phi coordinates.\n\nReturns\n\ndistance::Float64: The distance between the two points.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.do_iB_recombination_step!-Tuple{ClusterSequence, Any, Any}","page":"Internal API","title":"JetReconstruction.do_iB_recombination_step!","text":"do_iB_recombination_step!(clusterseq::ClusterSequence, jet_i, diB)\n\nBookkeeping for recombining a jet with the beam (i.e., finalising the jet) by adding a step to the history of the cluster sequence.\n\nArguments\n\nclusterseq::ClusterSequence: The cluster sequence object.\njet_i: The index of the jet.\ndiB: The diB value.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.do_ij_recombination_step!","page":"Internal API","title":"JetReconstruction.do_ij_recombination_step!","text":"do_ij_recombination_step!(clusterseq::ClusterSequence, jet_i, jet_j, dij, recombine=+)\n\nPerform the bookkeeping associated with the step of recombining jeti and jetj (assuming a distance dij).\n\nArguments\n\nclusterseq::ClusterSequence: The cluster sequence object.\njet_i: The index of the first jet to be recombined.\njet_j: The index of the second jet to be recombined.\ndij: The distance between the two jets.\nrecombine=+: The recombination function to be used. Default is addition.\n\nReturns\n\nnewjet_k: The index of the newly created jet.\n\nDescription\n\nThis function performs the i-j recombination step in the cluster sequence. It creates a new jet by recombining the first two jets using the specified recombination function. The new jet is then added to the cluster sequence. The function also updates the indices and history information of the new jet and sorts out the history.\n\n\n\n\n\n","category":"function"},{"location":"lib/internal/#JetReconstruction.energy-Tuple{PseudoJet}","page":"Internal API","title":"JetReconstruction.energy","text":"energy(p::PseudoJet)\n\nReturn the energy of a PseudoJet.\n\nArguments\n\np::PseudoJet: The PseudoJet object.\n\nReturns\n\nThe energy of the PseudoJet.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.eta-Tuple{PseudoJet}","page":"Internal API","title":"JetReconstruction.eta","text":"eta(p::PseudoJet)\n\nCompute the pseudorapidity (η) of a PseudoJet.\n\nArguments\n\np::PseudoJet: The PseudoJet object for which to compute the pseudorapidity.\n\nReturns\n\nThe pseudorapidity (η) of the PseudoJet.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.fast_findmin-Tuple{Any, Any}","page":"Internal API","title":"JetReconstruction.fast_findmin","text":"fast_findmin(dij, n)\n\nFind the minimum value and its index in the first n elements of the dij array. The use of @turbo macro gives a significant performance boost.\n\nArguments\n\ndij: An array of values.\nn: The number of elements to consider in the dij array.\n\nReturns\n\ndij_min: The minimum value in the first n elements of the dij array.\nbest: The index of the minimum value in the dij array.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.find_tile_neighbours!-NTuple{5, Any}","page":"Internal API","title":"JetReconstruction.find_tile_neighbours!","text":"find_tile_neighbours!(tile_union, jetA, jetB, oldB, tiling)\n\nFind the union of neighbouring tiles of jetA, jetB, and oldB and add them to the tile_union. This established the set of tiles over which searches for updated and new nearest-neighbours must be run\n\nArguments\n\ntile_union: The tile union to which the neighbouring tiles will be added.\njetA: The first jet.\njetB: The second jet.\noldB: The old second jet.\ntiling: The tiling information.\n\nReturns\n\nThe number of neighbouring tiles added to the tile_union.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.geometric_distance-NTuple{4, AbstractFloat}","page":"Internal API","title":"JetReconstruction.geometric_distance","text":"geometric_distance(eta1::AbstractFloat, phi1::AbstractFloat, eta2::AbstractFloat, phi2::AbstractFloat)\n\nCompute the geometric distance between two points in the rap-phi plane.\n\nArguments\n\neta1::AbstractFloat: The eta coordinate of the first point.\nphi1::AbstractFloat: The phi coordinate of the first point.\neta2::AbstractFloat: The eta coordinate of the second point.\nphi2::AbstractFloat: The phi coordinate of the second point.\n\nReturns\n\ndistance::Float64: The geometric distance between the two points.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.get_algorithm_power_consistency-Tuple{}","page":"Internal API","title":"JetReconstruction.get_algorithm_power_consistency","text":"get_algorithm_power_consistency(; p::Union{Real, Nothing}, algorithm::Union{JetAlgorithm, Nothing})\n\nGet the algorithm and power consistency correct\n\nThis function checks the consistency between the algorithm and power parameters. If the algorithm is specified, it checks if the power parameter is consistent with the algorithm's known power. If the power parameter is not specified, it sets the power parameter based on the algorithm. If neither the algorithm nor the power parameter is specified, it throws an ArgumentError.\n\nArguments\n\np::Union{Real, Nothing}: The power value.\nalgorithm::Union{JetAlgorithm, Nothing}: The algorithm.\n\nReturns\n\nA named tuple of the consistent power and algorithm values.\n\nThrows\n\nArgumentError: If the algorithm and power are inconsistent or if neither the algorithm nor the power is specified.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.get_all_ancestors-Tuple{Any, ClusterSequence}","page":"Internal API","title":"JetReconstruction.get_all_ancestors","text":"get_all_ancestors(idx, cs::ClusterSequence)\n\nRecursively finds all ancestors of a given index in a ClusterSequence object.\n\nArguments\n\nidx: The index of the jet for which to find ancestors.\ncs: The ClusterSequence object containing the jet history.\n\nReturns\n\nAn array of indices representing the ancestors of the given jet.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.get_dij_dist-NTuple{4, Any}","page":"Internal API","title":"JetReconstruction.get_dij_dist","text":"get_dij_dist(nn_dist, kt2_1, kt2_2, R2)\n\nCompute the dij metric distance between two jets.\n\nArguments\n\nnn_dist: The nearest-neighbor distance between two jets.\nkt2_1: The squared momentum metric value of the first jet.\nkt2_2: The squared momentum metric value of the second jet.\nR2: The jet radius parameter squared.\n\nReturns\n\nThe distance between the two jets.\n\nIf kt2_2 is equal to 0.0, then the first jet doesn't actually have a valid neighbour, so it's treated as a single jet adjacent to the beam.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.get_tile-Tuple{JetReconstruction.TilingDef, AbstractFloat, AbstractFloat}","page":"Internal API","title":"JetReconstruction.get_tile","text":"get_tile(tiling_setup::TilingDef, eta::AbstractFloat, phi::AbstractFloat)\n\nGiven a tiling_setup object, eta and phi values, this function calculates the tile indices for the given eta and phi values.\n\nArguments\n\ntiling_setup: A TilingDef object that contains the tiling setup parameters.\neta: The eta value for which to calculate the tile index.\nphi: The phi value for which to calculate the tile index.\n\nReturns\n\nieta: The tile index along the eta direction.\niphi: The tile index along the phi direction.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.get_tile_cartesian_indices-Tuple{JetReconstruction.TilingDef, Int64}","page":"Internal API","title":"JetReconstruction.get_tile_cartesian_indices","text":"get_tile_linear_index(tiling_setup::TilingDef, i_η::Int, i_ϕ::Int)\n\nCompute the linear index of a tile in a tiled setup. This is much faster in this function than using the LinearIndices construct (like x100, which is bonkers, but there you go...)\n\nArguments\n\ntiling_setup::TilingDef: The tiling setup defining the number of tiles in each dimension.\ni_η::Int: The index of the tile in the η dimension.\ni_ϕ::Int: The index of the tile in the ϕ dimension.\n\nReturns\n\nThe linear index of the tile.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.initial_history-Tuple{Any}","page":"Internal API","title":"JetReconstruction.initial_history","text":"initial_history(particles)\n\nCreate an initial history for the given particles.\n\nArguments\n\nparticles: The initial vector of stable particles.\n\nReturns\n\nhistory: An array of HistoryElement objects.\nQtot: The total energy in the event.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.insert!-Tuple{JetReconstruction.TiledJet, JetReconstruction.TiledJet}","page":"Internal API","title":"JetReconstruction.insert!","text":"insert!(nextjet::TiledJet, jettomove::TiledJet)\n\nInserts a TiledJet object into the linked list of TiledJet objects, before the nextjet object. The jet to move can be an isolated jet, a jet from another list or a jet from the same list\n\nArguments\n\nnextjet::TiledJet: The TiledJet object after which jettomove should be inserted.\njettomove::TiledJet: The TiledJet object to be inserted.\n\nExample\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.is_ee-Tuple{JetReconstruction.JetAlgorithm.Algorithm}","page":"Internal API","title":"JetReconstruction.is_ee","text":"is_ee(algorithm::JetAlgorithm.Algorithm)\n\nCheck if the algorithm is a e+e- reconstruction algorithm.\n\nReturns\n\ntrue if the algorithm is a e+e- reconstruction algorithm, false otherwise.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.is_pp-Tuple{JetReconstruction.JetAlgorithm.Algorithm}","page":"Internal API","title":"JetReconstruction.is_pp","text":"is_pp(algorithm::JetAlgorithm.Algorithm)\n\nCheck if the algorithm is a pp reconstruction algorithm.\n\nReturns\n\ntrue if the algorithm is a pp reconstruction algorithm, false otherwise.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.isvalid-Tuple{JetReconstruction.TiledJet}","page":"Internal API","title":"JetReconstruction.isvalid","text":"isvalid(t::TiledJet)\n\nCheck if a TiledJet is valid, by seeing if it is not the noTiledJet object.\n\nArguments\n\nt::TiledJet: The TiledJet object to check.\n\nReturns\n\nBool: true if the TiledJet object is valid, false otherwise.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.jet_ranks-Tuple{ClusterSequence}","page":"Internal API","title":"JetReconstruction.jet_ranks","text":"jet_ranks(clusterseq::ClusterSequence; compare_fn = JetReconstruction.pt)\n\nCompute the ranks of jets in a given ClusterSequence object based on a specified comparison function.\n\nArguments\n\nclusterseq::ClusterSequence: The ClusterSequence object containing the jets to rank.\ncompare_fn = JetReconstruction.pt: The comparison function used to determine the order of the jets. Defaults to JetReconstruction.pt, which compares jets based on their transverse momentum.\n\nReturns\n\nA dictionary mapping each jet index to its rank.\n\nNote\n\nThis is a utility function that can be used to rank initial clusters based on a specified jet property. It can be used to assign a consistent \"rank\" to each reconstructed jet in the cluster sequence, which is useful for stable plotting of jet outputs.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.m-Tuple{PseudoJet}","page":"Internal API","title":"JetReconstruction.m","text":"m(p::PseudoJet)\n\nCompute the invariant mass of a PseudoJet object. By convention if m^2 < 0, then -sqrt{(-m^2)} is returned.\n\nArguments\n\np::PseudoJet: The PseudoJet object for which to compute the invariant mass.\n\nReturns\n\nThe invariant mass of the PseudoJet object.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.m2-Tuple{PseudoJet}","page":"Internal API","title":"JetReconstruction.m2","text":"m2(p::PseudoJet)\n\nCalculate the invariant mass squared (m^2) of a PseudoJet.\n\nArguments\n\np::PseudoJet: The PseudoJet object for which to calculate the invariant mass squared.\n\nReturns\n\nThe invariant mass squared (m^2) of the PseudoJet.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.mag-Tuple{PseudoJet}","page":"Internal API","title":"JetReconstruction.mag","text":"mag(p::PseudoJet)\n\nReturn the magnitude of the momentum of a PseudoJet, |p|.\n\nArguments\n\np::PseudoJet: The PseudoJet object for which to compute the magnitude.\n\nReturns\n\nThe magnitude of the PseudoJet object.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.mass-Tuple{PseudoJet}","page":"Internal API","title":"JetReconstruction.mass","text":"mass(p::PseudoJet)\n\nCompute the invariant mass (alias for m(p)).\n\nArguments\n\np::PseudoJet: The PseudoJet object for which to compute the mass.\n\nReturns\n\nThe mass of the PseudoJet.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.mass2","page":"Internal API","title":"JetReconstruction.mass2","text":"Alias for m2 function\n\n\n\n\n\n","category":"function"},{"location":"lib/internal/#JetReconstruction.merge_steps-Tuple{ClusterSequence}","page":"Internal API","title":"JetReconstruction.merge_steps","text":"merge_steps(clusterseq::ClusterSequence)\n\nCompute the number of jet-jet merge steps in a cluster sequence. This is useful to give the number of meaningful recombination steps in a jet reconstruction sequence (beam merge steps are not counted).\n\nArguments\n\nclusterseq::ClusterSequence: The cluster sequence object.\n\nReturns\n\nmerge_steps::Int: The number of merge steps.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.phi-Tuple{PseudoJet}","page":"Internal API","title":"JetReconstruction.phi","text":"phi(p::PseudoJet)\n\nCompute the ϕ angle of a PseudoJet object p.\n\nNote this function is a wrapper for phi_02pi(p).\n\nArguments\n\np::PseudoJet: The PseudoJet object for which to compute the azimuthal angle.\n\nReturns\n\nThe azimuthal angle of p in the range [0, 2π).\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.phi_02pi-Tuple{PseudoJet}","page":"Internal API","title":"JetReconstruction.phi_02pi","text":"phi_02pi(p::PseudoJet)\n\nCompute the azimuthal angle of a PseudoJet object p in the range [0, 2π).\n\nArguments\n\np::PseudoJet: The PseudoJet object for which to compute the azimuthal angle.\n\nReturns\n\nThe azimuthal angle of p in the range [0, 2π).\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.pt-Tuple{PseudoJet}","page":"Internal API","title":"JetReconstruction.pt","text":"pt(p::PseudoJet)\n\nCompute the scalar transverse momentum (pt) of a PseudoJet.\n\nArguments\n\np::PseudoJet: The PseudoJet object for which to compute the transverse momentum.\n\nReturns\n\nThe transverse momentum (pt) of the PseudoJet.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.pt2-Tuple{PseudoJet}","page":"Internal API","title":"JetReconstruction.pt2","text":"pt2(p::PseudoJet)\n\nGet the squared transverse momentum of a PseudoJet.\n\nArguments\n\np::PseudoJet: The PseudoJet object.\n\nReturns\n\nThe squared transverse momentum of the PseudoJet.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.px-Tuple{PseudoJet}","page":"Internal API","title":"JetReconstruction.px","text":"px(p::PseudoJet)\n\nReturn the x-component of the momentum of a PseudoJet.\n\nArguments\n\np::PseudoJet: The PseudoJet object.\n\nReturns\n\nThe x-component of the momentum of the PseudoJet.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.py-Tuple{PseudoJet}","page":"Internal API","title":"JetReconstruction.py","text":"py(p::PseudoJet)\n\nReturn the y-component of the momentum of a PseudoJet.\n\nArguments\n\np::PseudoJet: The PseudoJet object.\n\nReturns\n\nThe y-component of the momentum of the PseudoJet.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.pz-Tuple{PseudoJet}","page":"Internal API","title":"JetReconstruction.pz","text":"pz(p::PseudoJet)\n\nReturn the z-component of the momentum of a PseudoJet.\n\nArguments\n\np::PseudoJet: The PseudoJet object.\n\nReturns\n\nThe z-component of the momentum of the PseudoJet.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.rapidity-Tuple{PseudoJet}","page":"Internal API","title":"JetReconstruction.rapidity","text":"rapidity(p::PseudoJet)\n\nCompute the rapidity of a PseudoJet object.\n\nArguments\n\np::PseudoJet: The PseudoJet object for which to compute the rapidity.\n\nReturns\n\nThe rapidity of the PseudoJet object.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.reco_state-Tuple{ClusterSequence, Any}","page":"Internal API","title":"JetReconstruction.reco_state","text":"reco_state(cs::ClusterSequence, pt_ranks; iteration=0)\n\nThis function returns the reconstruction state of a ClusterSequence object based on a given iteration number in the reconstruction.\n\nArguments\n\ncs::ClusterSequence: The ClusterSequence object to update.\nranks: The ranks of the original clusters, that are inherited by pseudojets\n\nduring the reconstruction process.\n\niteration=0: The iteration number to consider for updating the reconstruction state (0 represents the initial state).\nignore_beam_merge=true: Ignore beam merging steps in the reconstruction (which produce no change in status).\n\nReturns\n\nA dictionary representing a snapshot of the reconstruction state.\n\nDetails\n\nThe function starts by initializing the reconstruction state with the initial particles. Then, it walks over the iteration sequence and updates the reconstruction state based on the history of recombination and finalization/beam merger steps.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.rightneighbours-Tuple{Int64, JetReconstruction.Tiling}","page":"Internal API","title":"JetReconstruction.rightneighbours","text":"rightneighbours(center::Int, tiling::Tiling)\n\nCompute the indices of the right neighbors of a given center index in a tiling. This is used in the initial sweep to calculate the nearest neighbors, where the search between jets for the nearest neighbour is bi-directional, thus when a tile is considered only the right neighbours are needed to compare jet distances as the left-hand tiles have been done from that tile already.\n\nArguments\n\ncenter::Int: The center index.\ntiling::Tiling: The tiling object.\n\nReturns\n\nSurrounding: An object containing the indices of the right neighbors.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.set_momentum!-Tuple{PseudoJet, Vararg{Any, 4}}","page":"Internal API","title":"JetReconstruction.set_momentum!","text":"set_momentum!(j::PseudoJet, px, py, pz, E)\n\nSet the momentum components and energy of a PseudoJet object.\n\nArguments\n\nj::PseudoJet: The PseudoJet object to set the momentum for.\npx: The x-component of the momentum.\npy: The y-component of the momentum.\npz: The z-component of the momentum.\nE: The energy of the particle.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.set_nearest_neighbours!-Tuple{ClusterSequence, JetReconstruction.Tiling, Vector{JetReconstruction.TiledJet}}","page":"Internal API","title":"JetReconstruction.set_nearest_neighbours!","text":"set_nearest_neighbours!(clusterseq::ClusterSequence, tiling::Tiling, tiledjets::Vector{TiledJet})\n\nThis function sets the nearest neighbor information for all jets in the tiledjets vector.\n\nArguments\n\nclusterseq::ClusterSequence: The cluster sequence object.\ntiling::Tiling: The tiling object.\ntiledjets::Vector{TiledJet}: The vector of tiled jets.\n\nReturns\n\nNNs::Vector{TiledJet}: The vector of nearest neighbor jets.\ndiJ::Vector{Float64}: The vector of diJ values.\n\nThe function iterates over each tile in the tiling and sets the nearest neighbor information for each jet in the tile. It then looks for neighbor jets in the neighboring tiles and updates the nearest neighbor information accordingly. Finally, it creates the diJ table and returns the vectors of nearest neighbor jets and diJ values.\n\nNote: The diJ values are calculated as the kt distance multiplied by R^2.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.setup_tiling-Union{Tuple{T}, Tuple{Vector{T}, AbstractFloat}} where T<:AbstractFloat","page":"Internal API","title":"JetReconstruction.setup_tiling","text":"setup_tiling(eta::Vector{T}, Rparam::AbstractFloat) where T <: AbstractFloat\n\nThis function sets up the tiling parameters for a reconstruction given a vector of rapidities eta and a radius parameter Rparam.\n\nArguments\n\neta::Vector{T}: A vector of rapidities.\nRparam::AbstractFloat: The jet radius parameter.\n\nReturns\n\ntiling_setup: A TilingDef object containing the tiling setup parameters.\n\nDescription\n\nThe function first decides the tile sizes based on the Rparam value. It then determines the number of tiles in the phi direction (n_tiles_phi) based on the tile size. Next, it determines the rapidity extent of the input eta vector and adjusts the values accordingly. Finally, it creates a TilingDef object with the calculated tiling parameters and returns it.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.surrounding-Tuple{Int64, JetReconstruction.Tiling}","page":"Internal API","title":"JetReconstruction.surrounding","text":"surrounding(center::Int, tiling::Tiling)\n\nCompute the surrounding indices of a given center index in a tiling.\n\nArguments\n\ncenter::Int: The center index.\ntiling::Tiling: The tiling object.\n\nReturns\n\nSurrounding: An object containing the surrounding indices.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.tile_index-Tuple{Any, Float64, Float64}","page":"Internal API","title":"JetReconstruction.tile_index","text":"tile_index(tiling_setup, eta::Float64, phi::Float64)\n\nCompute the tile index for a given (eta, phi) coordinate.\n\nArguments\n\ntiling_setup: The tiling setup object containing the tile size and number of tiles.\neta::Float64: The eta coordinate.\nphi::Float64: The phi coordinate.\n\nReturns\n\nThe tile index corresponding to the (eta, phi) coordinate.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.tiledjet_remove_from_tiles!-Tuple{Any, Any}","page":"Internal API","title":"JetReconstruction.tiledjet_remove_from_tiles!","text":"tiledjet_remove_from_tiles!(tiling, jet)\n\nRemove a jet from the given tiling structure.\n\nArguments\n\ntiling: The tiling structure from which the jet will be removed.\njet: The jet to be removed from the tiling structure.\n\nDescription\n\nThis function removes a jet from the tiling structure. It adjusts the linked list to be consistent with the removal of the jet.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.tiledjet_set_jetinfo!-Tuple{JetReconstruction.TiledJet, ClusterSequence, JetReconstruction.Tiling, Any, Any, Any}","page":"Internal API","title":"JetReconstruction.tiledjet_set_jetinfo!","text":"tiledjet_set_jetinfo!(jet::TiledJet, clusterseq::ClusterSequence, tiling::Tiling, jets_index, R2, p)\n\nInitialise a tiled jet from a PseudoJet (using an index into our ClusterSequence)\n\nArguments:\n\njet::TiledJet: The TiledJet object to set the information for.\nclusterseq::ClusterSequence: The ClusterSequence object containing the jets.\ntiling::Tiling: The Tiling object containing the tile information.\njets_index: The index of the jet in the ClusterSequence.\nR2: The jet radius parameter squared.\np: The power to raise the pt2 value to.\n\nThis function sets the eta, phi, kt2, jetsindex, NNdist, NN, tile_index, previous, and next fields of the TiledJet object.\n\nReturns:\n\nnothing\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.upd_nn_crosscheck!-Tuple{Int64, Int64, Int64, Vararg{Any, 5}}","page":"Internal API","title":"JetReconstruction.upd_nn_crosscheck!","text":"upd_nn_crosscheck!(i, from, to, rapidity_array, phi_array, R2, nndist, nn)\n\nUpdate the nearest neighbor information for a given particle index i against all particles in the range indexes from to to. The function updates the nndist and nn arrays with the nearest neighbor distance and index respectively, both for particle i and the checked particles [from:to] (hence crosscheck).\n\nArguments\n\ni::Int: The index of the particle to update and check against.\nfrom::Int: The starting index of the range of particles to check against.\nto::Int: The ending index of the range of particles to check against.\nrapidity_array: An array containing the rapidity values of all particles.\nphi_array: An array containing the phi values of the all particles.\nR2: The squared jet distance threshold for considering a particle as a neighbour.\nnndist: The array that stores the nearest neighbor distances.\nnn: The array that stores the nearest neighbor indices.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.upd_nn_nocross!-Tuple{Int64, Int64, Int64, Vararg{Any, 5}}","page":"Internal API","title":"JetReconstruction.upd_nn_nocross!","text":"upd_nn_nocross!(i, from, to, rapidity_array, phi_array, R2, nndist, nn)\n\nUpdate the nearest neighbor information for a given particle index i against all particles in the range indexes from to to. The function updates the nndist and nn arrays with the nearest neighbor distance and index respectively, only for particle i (hence nocross).\n\nArguments\n\ni::Int: The index of the particle to update and check against.\nfrom::Int: The starting index of the range of particles to check against.\nto::Int: The ending index of the range of particles to check against.\nrapidity_array: An array containing the rapidity values of all particles.\nphi_array: An array containing the phi values of the all particles.\nR2: The squared jet distance threshold for considering a particle as a neighbour.\nnndist: The array that stores the nearest neighbor distances.\nnn: The array that stores the nearest neighbor indices.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.upd_nn_step!-NTuple{12, Any}","page":"Internal API","title":"JetReconstruction.upd_nn_step!","text":"upd_nn_step!(i, j, k, N, Nn, kt2_array, rapidity_array, phi_array, R2, nndist, nn, nndij)\n\nUpdate the nearest neighbor information after a jet merge step.\n\nArguments:\n\ni: Index of the first particle in the last merge step.\nj: Index of the second particle in the last merge step.\nk: Index of the current particle for which the nearest neighbour will be updated.\nN: Total number of particles (currently valid array indexes are [1:N]).\nNn: Number of nearest neighbors to consider.\nkt2_array: Array of transverse momentum squared values.\nrapidity_array: Array of rapidity values.\nphi_array: Array of azimuthal angle values.\nR2: Distance threshold squared for nearest neighbors.\nnndist: Array of nearest neighbor geometric distances.\nnn: Array of nearest neighbor indices.\nnndij: Array of metric distances between particles.\n\nThis function updates the nearest neighbor information for the current particle k by considering the distances to particles i and j. It checks if the distance between k and i is smaller than the current nearest neighbor distance for k, and updates the nearest neighbor information accordingly. It also updates the nearest neighbor information for i if the distance between k and i is smaller than the current nearest neighbor distance for i. Finally, it checks if the nearest neighbor of k is the total number of particles Nn and updates it to j if necessary.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.η","page":"Internal API","title":"JetReconstruction.η","text":"const η = eta\n\nAlias for the pseudorapidity function, eta.\n\n\n\n\n\n","category":"function"},{"location":"lib/internal/#JetReconstruction.EERecoJet","page":"Internal API","title":"JetReconstruction.EERecoJet","text":"mutable struct EERecoJet{T <: Real}\n\nOptimised struct for e+e jets reconstruction, to be used with StructArrays.\n\nFields\n\nindex::Int: The index of the jet.\nnni::Int: The nearest neighbour index.\nnndist::T: The distance to the nearest neighbour.\ndijdist::T: The distance between jets.\nnx::T: The x-component of the jet's momentum.\nny::T: The y-component of the jet's momentum.\nnz::T: The z-component of the jet's momentum.\nE2p::T: The energy raised to the power of 2p for this jet.\n\nType Parameters\n\nT <: Real: The type of the numerical values.\n\n\n\n\n\n","category":"type"},{"location":"lib/internal/#JetReconstruction.FourMomentum","page":"Internal API","title":"JetReconstruction.FourMomentum","text":"Interface for composite types that includes fields px, py, py, and E that represents the components of a four-momentum vector.\n\n\n\n\n\n","category":"type"},{"location":"lib/internal/#JetReconstruction.HistoryElement","page":"Internal API","title":"JetReconstruction.HistoryElement","text":"struct HistoryElement\n\nA struct holding a record of jet mergers and finalisations\n\nFields:\n\nparent1: Index in history where first parent of this jet was created (NonexistentParent if this jet is an original particle)\nparent2: Index in history where second parent of this jet was created (NonexistentParent if this jet is an original particle); BeamJet if this history entry just labels the fact that the jet has recombined with the beam)\nchild: Index in history where the current jet is recombined with another jet to form its child. It is Invalid if this jet does not further recombine.\njetp_index: Index in the jets vector where we will find the PseudoJet object corresponding to this jet (i.e. the jet created at this entry of the history). NB: if this element of the history corresponds to a beam recombination, then jetp_index=Invalid.\ndij: The distance corresponding to the recombination at this stage of the clustering.\nmax_dij_so_far: The largest recombination distance seen so far in the clustering history.\n\n\n\n\n\n","category":"type"},{"location":"lib/internal/#JetReconstruction.HistoryElement-Tuple{Any}","page":"Internal API","title":"JetReconstruction.HistoryElement","text":"HistoryElement(jetp_index)\n\nConstructs a HistoryElement object with the given jetp_index, used for initialising the history with original particles.\n\nArguments\n\njetp_index: The index of the jetp.\n\nReturns\n\nA HistoryElement object.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.JetWithAncestors","page":"Internal API","title":"JetReconstruction.JetWithAncestors","text":"struct JetWithAncestors\n\nA struct representing a jet with its origin ancestors.\n\nFields\n\nself::PseudoJet: The PseudoJet object for this jet.\njetp_index::Int: The index of the jet in the corresponding cluster sequence.\nancestors::Set{Int}: A set of indices representing the jetp_indexes of ancestors of the jet (in the cluster sequence).\njet_rank::Int: The rank of the jet based on a comparison of all of the jet's ancestors\n\nNote\n\nThis structure needs its associated cluster sequence origin to be useful.\n\n\n\n\n\n","category":"type"},{"location":"lib/internal/#JetReconstruction.Surrounding","page":"Internal API","title":"JetReconstruction.Surrounding","text":"struct Surrounding{N}\n\nStructure used for iterating over neighbour tiles.\n\nFields\n\nindices::NTuple{N, Int}: A tuple of N integers representing the indices.\n\n\n\n\n\n","category":"type"},{"location":"lib/internal/#JetReconstruction.TiledJet","page":"Internal API","title":"JetReconstruction.TiledJet","text":"struct TiledJet\n\nTiledJet represents a jet in a tiled algorithm for jet reconstruction, with additional information to track the jet's position in the tiled structures.\n\nFields\n\nid::Int: The ID of the jet.\neta::Float64: The rapidity of the jet.\nphi::Float64: The azimuthal angle of the jet.\nkt2::Float64: The transverse momentum squared of the jet.\nNN_dist::Float64: The distance to the nearest neighbor.\njets_index::Int: The index of the jet in the jet array.\ntile_index::Int: The index of the tile in the tile array.\ndij_posn::Int: The position of this jet in the dij compact array.\nNN::TiledJet: The nearest neighbor.\nprevious::TiledJet: The previous jet.\nnext::TiledJet: The next jet.\n\n\n\n\n\n","category":"type"},{"location":"lib/internal/#JetReconstruction.TiledJet-Tuple{Any}","page":"Internal API","title":"JetReconstruction.TiledJet","text":"TiledJet(id)\n\nConstructs a TiledJet object with the given id and initializes its properties to zero.\n\nArguments\n\nid: The ID of the TiledJet object.\n\nReturns\n\nA TiledJet object with the specified id and values set to zero or noTiledJet.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.Tiling","page":"Internal API","title":"JetReconstruction.Tiling","text":"struct Tiling\n\nThe Tiling struct represents a tiling configuration for jet reconstruction.\n\nFields\n\nsetup::TilingDef: The tiling definition used for the configuration.\ntiles::Matrix{TiledJet}: A matrix of tiled jets, containing the first jet in each tile (then the linked list of the first jet is followed to get access to all jets in this tile).\npositions::Matrix{Int}: Used to track tiles that are on the edge of ϕ array, where neighbours need to be wrapped around.\ntags::Matrix{Bool}: The matrix of tags indicating whether a tile is valid or not (set to false initially, then true when the tile has been setup properly).\n\n\n\n\n\n","category":"type"},{"location":"lib/internal/#JetReconstruction.Tiling-Tuple{JetReconstruction.TilingDef}","page":"Internal API","title":"JetReconstruction.Tiling","text":"Tiling(setup::TilingDef)\n\nConstructs a initial Tiling object based on the provided setup parameters.\n\nArguments\n\nsetup::TilingDef: The setup parameters for the tiling.\n\nReturns\n\nA Tiling object.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.TilingDef","page":"Internal API","title":"JetReconstruction.TilingDef","text":"struct TilingDef\n\nA struct representing the definition of a specific tiling scheme.\n\nFields\n\n_tiles_eta_min::Float64: The minimum rapidity of the tiles.\n_tiles_eta_max::Float64: The maximum rapidity of the tiles.\n_tile_size_eta::Float64: The size of a tile in rapidity (usually R^2).\n_tile_size_phi::Float64: The size of a tile in phi (usually a bit more than R^2).\n_n_tiles_eta::Int: The number of tiles across rapidity.\n_n_tiles_phi::Int: The number of tiles across phi.\n_n_tiles::Int: The total number of tiles.\n_tiles_ieta_min::Int: The minimum rapidity tile index.\n_tiles_ieta_max::Int: The maximum rapidity tile index.\n\nConstructor\n\nTilingDef(_tiles_eta_min, _tiles_eta_max, _tile_size_eta, _tile_size_phi,\n\t_n_tiles_eta, _n_tiles_phi, _tiles_ieta_min, _tiles_ieta_max)\n\nConstructs a TilingDef object with the given parameters.\n\n\n\n\n\n","category":"type"},{"location":"lib/internal/#JetReconstruction.neighbour_tiles","page":"Internal API","title":"JetReconstruction.neighbour_tiles","text":"struct neighbour_tiles\n\nA struct representing the neighbouring tiles.\n\nA struct for iterating over all neighbour tiles for a given Cartesian tile index. These are the tiles above and to the right of the given tile (X=included, O=not included):\n\nXXX\nX.X\nXXX\n\nNote, rapidity coordinate must be in range, ϕ coordinate wraps\n\nFields\n\nn_η::Int: Number of η tiles\nn_ϕ::Int: Number of ϕ tiles\nstart_η::Int: Centre η tile coordinate\nstart_ϕ::Int: Centre ϕ tile coordinate\n\n\n\n\n\n","category":"type"},{"location":"lib/internal/#JetReconstruction.rightmost_tiles","page":"Internal API","title":"JetReconstruction.rightmost_tiles","text":"struct rightmost_tiles\n\nA struct for iterating over rightmost tiles for a given Cartesian tile index. These are the tiles above and to the right of the given tile (X=included, O=not included):\n\nXXX\nO.X\nOOO\n\nNote, rapidity coordinate must be in range, ϕ coordinate wraps\n\nFields\n\nn_η::Int: Number of η tiles\nn_ϕ::Int: Number of ϕ tiles\nstart_η::Int: Centre η tile coordinate\nstart_ϕ::Int: Centre ϕ tile coordinate\n\n\n\n\n\n","category":"type"}] +[{"location":"particles/#Input-Particle-Types","page":"Particle Inputs","title":"Input Particle Types","text":"","category":"section"},{"location":"particles/","page":"Particle Inputs","title":"Particle Inputs","text":"For the particles input to the reconstruction any one dimensional AbstractArray{T, 1} can be used, where the type T has to implement methods to extract the 4-vector components, viz, the following are required:","category":"page"},{"location":"particles/","page":"Particle Inputs","title":"Particle Inputs","text":"JetReconstuction.px(particle::T)\nJetReconstuction.py(particle::T)\nJetReconstuction.pz(particle::T)\nJetReconstuction.energy(particle::T)","category":"page"},{"location":"particles/","page":"Particle Inputs","title":"Particle Inputs","text":"Currently built-in supported types are LorentzVectorHEP, the PseudoJet and EEjets from this package, and ReconstructedParticles from EDM4hep Inputs.","category":"page"},{"location":"particles/","page":"Particle Inputs","title":"Particle Inputs","text":"If you require support for a different input collection type then ensure you define the px(), etc. methods for your specific type and in the JetReconstruction package. This use of what might be considered type piracy is blessed as long as you are en end user of the jet reconstruction package.","category":"page"},{"location":"particles/","page":"Particle Inputs","title":"Particle Inputs","text":"If your type is used in several places or by different users, please consider writing a package extension that will support your type, following the model for EDM4hep in ext/EDM4hepJets.jl.","category":"page"},{"location":"EDM4hep/#EDM4hep-Inputs","page":"EDM4hep","title":"EDM4hep Inputs","text":"","category":"section"},{"location":"EDM4hep/","page":"EDM4hep","title":"EDM4hep","text":"Extension functionality to read EDM4hep ReconstructedParticles, using the EDM4hep.jl package.","category":"page"},{"location":"EDM4hep/#Examples","page":"EDM4hep","title":"Examples","text":"","category":"section"},{"location":"EDM4hep/","page":"EDM4hep","title":"EDM4hep","text":"EDM4hep ReconstructedParticles can be used as direct input into jet reconstruction.","category":"page"},{"location":"EDM4hep/","page":"EDM4hep","title":"EDM4hep","text":"A number of working examples are maintained in the EDM4hep examples directory of the package's examples.","category":"page"},{"location":"EDM4hep/","page":"EDM4hep","title":"EDM4hep","text":"Here is a snippet that shows the main steps:","category":"page"},{"location":"EDM4hep/","page":"EDM4hep","title":"EDM4hep","text":"using EDM4hep\nusing EDM4hep.RootIO\nusing JetReconstruction\n\n# Change this to something that works on your system\ninput_file = joinpath(\"directory\", \"EDM4hep.root\")\nreader = RootIO.Reader(input_file)\nevents = RootIO.get(reader, \"events\")\n\nevt = events[1]\n\nrecps = RootIO.get(reader, evt, \"ReconstructedParticles\")\n\ncs = jet_reconstruct(recps; algorithm = JetAlgorithm.Durham)","category":"page"},{"location":"EDM4hep/#Function-Index","page":"EDM4hep","title":"Function Index","text":"","category":"section"},{"location":"EDM4hep/","page":"EDM4hep","title":"EDM4hep","text":"Pages = [\"EDM4hep.md\"]","category":"page"},{"location":"EDM4hep/#EDM4hep-Interfaces","page":"EDM4hep","title":"EDM4hep Interfaces","text":"","category":"section"},{"location":"EDM4hep/","page":"EDM4hep","title":"EDM4hep","text":"Modules = [EDM4hepJets]\nOrder = [:function]","category":"page"},{"location":"EDM4hep/#JetReconstruction.energy-Tuple{ReconstructedParticle}","page":"EDM4hep","title":"JetReconstruction.energy","text":"JetReconstruction.energy(recoparticle::ReconstructedParticle)\n\nReturn the energy component of a ReconstructedParticle's four vector.\n\n\n\n\n\n","category":"method"},{"location":"EDM4hep/#JetReconstruction.px-Tuple{ReconstructedParticle}","page":"EDM4hep","title":"JetReconstruction.px","text":"JetReconstruction.px(recoparticle::ReconstructedParticle)\n\nReturn the x component of the momentum of a ReconstructedParticle.\n\n\n\n\n\n","category":"method"},{"location":"EDM4hep/#JetReconstruction.py-Tuple{ReconstructedParticle}","page":"EDM4hep","title":"JetReconstruction.py","text":"JetReconstruction.py(recoparticle::ReconstructedParticle)\n\nReturn the y component of the momentum of a ReconstructedParticle.\n\n\n\n\n\n","category":"method"},{"location":"EDM4hep/#JetReconstruction.pz-Tuple{ReconstructedParticle}","page":"EDM4hep","title":"JetReconstruction.pz","text":"JetReconstruction.pz(recoparticle::ReconstructedParticle)\n\nReturn the z component of the momentum of a ReconstructedParticle.\n\n\n\n\n\n","category":"method"},{"location":"strategy/#Algorithm-Strategy","page":"Reconstruction Strategies","title":"Algorithm Strategy","text":"","category":"section"},{"location":"strategy/","page":"Reconstruction Strategies","title":"Reconstruction Strategies","text":"For the pp algorithms three strategies are available for the different algorithms, which can be specified by passing the named argument strategy=... to the reconstruction.","category":"page"},{"location":"strategy/","page":"Reconstruction Strategies","title":"Reconstruction Strategies","text":"Strategy Name Notes Interface\nRecoStrategy.Best Dynamically switch strategy based on input particle density jet_reconstruct\nRecoStrategy.N2Plain Global matching of particles at each interation (works well for low N) plain_jet_reconstruct\nRecoStrategy.N2Tiled Use tiles of radius R to limit search space (works well for higher N) tiled_jet_reconstruct","category":"page"},{"location":"strategy/","page":"Reconstruction Strategies","title":"Reconstruction Strategies","text":"Generally one can use the jet_reconstruct interface, shown above, as the Best strategy safely as the overhead is extremely low. That interface supports a strategy option to switch to a different option.","category":"page"},{"location":"strategy/","page":"Reconstruction Strategies","title":"Reconstruction Strategies","text":"For e^+e^- algorithms particle densities are low, so the only implementation is of the same type as N2Plain.","category":"page"},{"location":"examples/#Jet-Reconstruction-Examples","page":"Examples","title":"Jet Reconstruction Examples","text":"","category":"section"},{"location":"examples/","page":"Examples","title":"Examples","text":"The Jet Reconstruction package has a number of example files that show how to usage. These are in the examples subdirectory of the package and can be browsed directly on GitHub.","category":"page"},{"location":"examples/","page":"Examples","title":"Examples","text":"Note: because of extra dependencies in these scripts, one must use the Project.toml file in the examples directory.","category":"page"},{"location":"examples/#Standalone-Examples","page":"Examples","title":"Standalone Examples","text":"","category":"section"},{"location":"examples/#jetreco.jl","page":"Examples","title":"jetreco.jl","text":"","category":"section"},{"location":"examples/","page":"Examples","title":"Examples","text":"This is a basic jet reconstruction example that shows how to call the package to perform a jet reconstruction, with different algorithms and (optionally) strategy, producing exclusive and inclusive jet selections.","category":"page"},{"location":"examples/","page":"Examples","title":"Examples","text":"julia --project=examples examples/jetreco.jl --algorithm=AntiKt test/data/events.pp13TeV.hepmc3.gz\n...\njulia --project=examples examples/jetreco.jl --algorithm=Durham test/data/events.eeH.hepmc3.gz\n...\njulia --project=examples examples/jetreco.jl --maxevents=10 --strategy=N2Plain --algorithm=Kt --exclusive-njets=3 test/data/events.pp13TeV.hepmc3.gz\n...","category":"page"},{"location":"examples/","page":"Examples","title":"Examples","text":"There are options to explicitly set the algorithm (use --help to see these).","category":"page"},{"location":"examples/#instrumented-jetreco.jl","page":"Examples","title":"instrumented-jetreco.jl","text":"","category":"section"},{"location":"examples/","page":"Examples","title":"Examples","text":"This is a more sophisticated example that allows performance measurements to be made of the reconstruction, as well as profiling (flamegraphs and memory profiling). Use the --help option to see usage. e.g., to extract timing performance for the AntiKt algorithm using the tiled strategy:","category":"page"},{"location":"examples/","page":"Examples","title":"Examples","text":"julia --project instrumented-jetreco.jl -S N2Tiled -A AntiKt --nsamples 100 ../test/data/events.hepmc3","category":"page"},{"location":"examples/#visualise-jets.jl","page":"Examples","title":"visualise-jets.jl","text":"","category":"section"},{"location":"examples/","page":"Examples","title":"Examples","text":"This script will produce a PNG/PDF showing the results of a jet reconstruction. This is a 3D plot where all the initial energy deposits are visualised, with colours that indicate in which final cluster the deposit ended up in.","category":"page"},{"location":"examples/#visualise-jets.ipynb","page":"Examples","title":"visualise-jets.ipynb","text":"","category":"section"},{"location":"examples/","page":"Examples","title":"Examples","text":"Similar to visualise-jets.jl this notebook will produce a visualisation of jet reconstruction in the browser. This is a 3D plot where all the initial energy deposits are visualised, with colours that indicate in which final cluster the deposit ended up in.","category":"page"},{"location":"examples/#animate-reconstruction.jl","page":"Examples","title":"animate-reconstruction.jl","text":"","category":"section"},{"location":"examples/","page":"Examples","title":"Examples","text":"Performs jet reconstruction and then produces and animation of the process, showing how the jets merge from their different constituents.","category":"page"},{"location":"examples/#EDM4hep","page":"Examples","title":"EDM4hep","text":"","category":"section"},{"location":"examples/","page":"Examples","title":"Examples","text":"The examples/EDM4hep folder contains examples of using EDM4hep reconstructed particles as input to jet reconstruction. See the specific README.md file in that directory as well as EDM4hep Inputs.","category":"page"},{"location":"examples/#Jet-Constituents","page":"Examples","title":"Jet Constituents","text":"","category":"section"},{"location":"examples/","page":"Examples","title":"Examples","text":"The examples/constituents folder shows an example of the two mechanisms to retrieve jet constituents.","category":"page"},{"location":"visualisation/#Jet-Visualisation-Documentation","page":"Visualisation","title":"Jet Visualisation Documentation","text":"","category":"section"},{"location":"visualisation/","page":"Visualisation","title":"Visualisation","text":"Documentation for visualisation interfaces extension module.","category":"page"},{"location":"visualisation/#Plotting-and-Animation","page":"Visualisation","title":"Plotting and Animation","text":"","category":"section"},{"location":"visualisation/","page":"Visualisation","title":"Visualisation","text":"(Image: illustration)","category":"page"},{"location":"visualisation/","page":"Visualisation","title":"Visualisation","text":"To visualise the clustered jets as a 3d bar plot (see illustration above) Makie.jl is used. See the jetsplot function in ext/JetVisualisation.jl and its documentation for more. There are two worked examples in the examples directory of this package.","category":"page"},{"location":"visualisation/","page":"Visualisation","title":"Visualisation","text":"The plotting code is a package extension and will load if the one of the Makie modules is loaded in the environment.","category":"page"},{"location":"visualisation/","page":"Visualisation","title":"Visualisation","text":"The animatereco function will animate the reconstruction sequence, given a ClusterSequence object. See the function documentation below for the many options that can be customised.","category":"page"},{"location":"visualisation/#Function-Index","page":"Visualisation","title":"Function Index","text":"","category":"section"},{"location":"visualisation/","page":"Visualisation","title":"Visualisation","text":"Pages = [\"visualisation.md\"]","category":"page"},{"location":"visualisation/#Jet-Visualisation-Public-Interfaces","page":"Visualisation","title":"Jet Visualisation Public Interfaces","text":"","category":"section"},{"location":"visualisation/","page":"Visualisation","title":"Visualisation","text":"Modules = [JetVisualisation]\nOrder = [:function]","category":"page"},{"location":"visualisation/#JetReconstruction.animatereco-Tuple{ClusterSequence, Any}","page":"Visualisation","title":"JetReconstruction.animatereco","text":"animatereco(cs::ClusterSequence, filename;\n barsize_phi = 0.1,\n barsize_y = 0.1,\n colormap = :glasbey_category10_n256,\n perspective = 0.5,\n azimuth = 2.7,\n elevation = 0.5,\n framerate = 5,\n ancestors = false,\n Module = Makie)\n\nAnimate the jet reconstruction process and save it as a video file.\n\nArguments\n\ncs::ClusterSequence: The cluster sequence object containing the jets.\nfilename: The name of the output video file.\n\nOptional Arguments\n\nbarsize_phi=0.1: The size of the bars in the phi direction.\nbarsize_y=0.1: The size of the bars in the y direction.\ncolormap=:glasbey_category10_n256: The colormap to use for coloring the jets.\nperspective=0.5: The perspective of the plot.\nazimuth=2.7: The azimuth angle of the plot.\nelevation=0.5: The elevation angle of the plot.\nframerate=5: The framerate of the output video.\nend_frames=0: The number of static frames to show at the end of the animation. This can be useful to show the final state of the jets for a longer time.\ntitle=nothing: The title to add to the plot.\nancestors=false: Whether to include ancestors of the jets in the animation. When true the ancestors of the jets will be plotted as well, as height zero bars, with the same colour as the jet they are ancestors of.\nModule: The plotting module to use. Default is Makie.\n\nFor perspective, azimuth, and elevation, a single value can be passed for a fixed viewpoint, or a tuple of two values for a changing viewpoint. The viewpoint will then change linearly between the two values over the course of the animation.\n\nReturns\n\nfig: The figure object representing the final frame.\n\n\n\n\n\n","category":"method"},{"location":"visualisation/#JetReconstruction.jetsplot-Tuple{Any, Any}","page":"Visualisation","title":"JetReconstruction.jetsplot","text":"jetsplot(objects, idx_arrays; barsize_phi=0.1, barsize_eta=0.1, colormap=:glasbey_hv_n256, Module=Main)\n\nPlots a 3d bar chart that represents jets. Takes an objects array of objects to display and idx_arrays, an array of arrays with indices, where idx_arrays[i] gives indices of objects that form the jet number i. This function's signature might not be the most practical for the current version of the JetReconstruction.jl package, as it has been written during the early stage of development. There is now an overload of it that takes a ClusterSequence object as its argument.\n\nOptional arguments: barsize_phi::Real — width of a bar along the ϕ axis; barsize_eta::Real — width of a bar along the η axis; colormap::Symbol — Makie colour map; Module — the module where you have your Makie (see below);\n\n# example\nusing CairoMakie # use any other Makie that you have here\n\njetsplot([object1, object2, object3], [[1], [2, 3]])\n\nThe example above plots object1 as a separate jet in one colour and object2 and object3 together in another colour.\n\nThis function needs Makie.jl to work. You should install and import/use a specific backend yourself. jetsplot works with CairoMakie, WGLMakie, GLMakie, etc. Additionally, you can specify the module where you have your Makie explicitly:\n\nimport CairoMakie\njetsplot(my_objects, my_colour_arrays, Module=CairoMakie)\n\nimport GLMakie\njetsplot(my_objects, my_colour_arrays, Module=GLMakie)\n\nusing WGLMakie\njetsplot(my_objects, my_colour_arrays, Module=Main) #default\n\n\n\n\n\n","category":"method"},{"location":"visualisation/#JetReconstruction.jetsplot-Tuple{Any, ClusterSequence}","page":"Visualisation","title":"JetReconstruction.jetsplot","text":"jetsplot(objects, cs::ClusterSequence; barsize_phi=0.1, barsize_eta=0.1, colormap=:glasbey_hv_n256, Module=Main)\n\nPlots a 3d bar chart that represents jets. Takes objects, an array of objects to display (should be the same array you have passed to jet_reconstruct to get the cs::ClusterSequence), and the cs::ClusterSequence itself as arguments.\n\nOptional arguments: barsize_phi::Real — width of a bar along the ϕ axis; barsize_eta::Real — width of a bar along the η axis; colormap::Symbol — Makie colour map; Module — the module where you have your Makie (see below);\n\n# example\nusing CairoMakie # use any other Makie that you have here\njetsplot([object1, object2, object3], cluster_sequence_I_got_from_jet_reconstruct; Module=CairoMakie)\n\nThis function needs Makie.jl to work. You should install and import/use a specific backend yourself. jetsplot works with CairoMakie, WGLMakie, GLMakie, etc. Additionally, you can specify the module where you have your Makie explicitly:\n\nimport CairoMakie\njetsplot(my_objects, cs, Module=CairoMakie)\n\nimport GLMakie\njetsplot(my_objects, cs, Module=GLMakie)\n\nusing WGLMakie\njetsplot(my_objects, cs, Module=Main) #default\n\n\n\n\n\n","category":"method"},{"location":"extras/serialisation/#Jet-Serialisation","page":"Serialisation","title":"Jet Serialisation","text":"","category":"section"},{"location":"extras/serialisation/","page":"Serialisation","title":"Serialisation","text":"The package provides methods such as loadjets, loadjets!, and savejets that one can use to save and load objects on/from disk easily in a very flexible format. See documentation for more.","category":"page"},{"location":"lib/public/#Jet-Reconstruction-Public-Documentation","page":"Public API","title":"Jet Reconstruction Public Documentation","text":"","category":"section"},{"location":"lib/public/","page":"Public API","title":"Public API","text":"Documentation for JetReconstruction.jl's public interfaces.","category":"page"},{"location":"lib/public/#Index","page":"Public API","title":"Index","text":"","category":"section"},{"location":"lib/public/","page":"Public API","title":"Public API","text":"Pages = [\"public.md\"]","category":"page"},{"location":"lib/public/#Public-Methods-and-Types","page":"Public API","title":"Public Methods and Types","text":"","category":"section"},{"location":"lib/public/","page":"Public API","title":"Public API","text":"Modules = [JetReconstruction]\nPrivate = false\nOrder = [:function, :type]","category":"page"},{"location":"lib/public/#JetReconstruction.constituent_indexes-Union{Tuple{T}, Tuple{T, ClusterSequence{T}}} where T<:JetReconstruction.FourMomentum","page":"Public API","title":"JetReconstruction.constituent_indexes","text":"constituent_indexes(jet::T, cs::ClusterSequence{T}) where T <: FourMomentum\n\nReturn the indexes of the original particles which are the constituents of the given jet.\n\nArguments\n\njet::T: The jet for which to retrieve the constituents.\ncs::ClusterSequence{T}: The cluster sequence object.\n\nReturns\n\nAn vector of indices representing the original constituents of the given jet.\n\n\n\n\n\n","category":"method"},{"location":"lib/public/#JetReconstruction.constituents-Union{Tuple{T}, Tuple{T, ClusterSequence{T}}} where T<:JetReconstruction.FourMomentum","page":"Public API","title":"JetReconstruction.constituents","text":"constituents(jet::T, cs::ClusterSequence{T}) where T <: FourMomentum\n\nGet the constituents of a given jet in a cluster sequence.\n\nArguments\n\ncs::ClusterSequence{T}: The cluster sequence object.\njet::T: The jet for which to retrieve the constituents.\n\nReturns\n\nAn array of jet objects (which are of the same type as the input jet) representing the constituents of the given jet, \n\n\n\n\n\n","category":"method"},{"location":"lib/public/#JetReconstruction.ee_genkt_algorithm-Union{Tuple{AbstractVector{T}}, Tuple{T}} where T","page":"Public API","title":"JetReconstruction.ee_genkt_algorithm","text":"ee_genkt_algorithm(particles::Vector{T}; p = -1, R = 4.0,\n algorithm::JetAlgorithm.Algorithm = JetAlgorithm.Durham,\n recombine = +) where {T}\n\nRun an e+e- reconstruction algorithm on a set of initial particles.\n\nArguments\n\nparticles::Vector{T}: A vector of particles to be clustered.\np = 1: The power parameter for the algorithm. Not required / ignored for the Durham algorithm when it is set to 1.\nR = 4.0: The jet radius parameter. Not required / ignored for the Durham algorithm.\nalgorithm::JetAlgorithm.Algorithm = JetAlgorithm.Durham: The specific jet algorithm to use.\nrecombine: The recombination scheme to use. Defaults to +.\n\nReturns\n\nThe result of the jet clustering as a ClusterSequence object.\n\nNotes\n\nThis is the public interface to the e+e- jet clustering algorithm. The function will check for consistency between the algorithm and the power parameter as needed. It will then prepare the internal EDM particles for the clustering itself, and call the actual reconstruction method _ee_genkt_algorithm.\n\nIf the algorithm is Durham, p is set to 1 and R is nominally set to 4.\n\nNote that unlike pp reconstruction the algorithm has to be specified explicitly.\n\n\n\n\n\n","category":"method"},{"location":"lib/public/#JetReconstruction.exclusive_jets-Tuple{ClusterSequence}","page":"Public API","title":"JetReconstruction.exclusive_jets","text":"exclusive_jets(clusterseq::ClusterSequence; dcut = nothing, njets = nothing, T = LorentzVectorCyl)\n\nReturn all exclusive jets of a ClusterSequence, with either a specific number of jets or a cut on the maximum distance parameter.\n\nArguments\n\nclusterseq::ClusterSequence: The ClusterSequence object containing the clustering history and jets.\ndcut::Union{Nothing, Real}: The distance parameter used to define the exclusive jets. If dcut is provided, the number of exclusive jets will be calculated based on this parameter.\nnjets::Union{Nothing, Integer}: The number of exclusive jets to be calculated. If njets is provided, the distance parameter dcut will be calculated based on this number.\nT = LorentzVectorCyl: The return type used for the selected jets.\n\nNote: Either dcut or njets must be provided (but not both).\n\nReturns\n\nAn array of T objects representing the exclusive jets.\n\nValid return types are LorentzVectorCyl and PseudoJet (N.B. this will evolve in the future to be any subtype of FourMomemntumBase; currently unrecognised types will return LorentzVectorCyl)\n\nExceptions\n\nArgumentError: If neither dcut nor njets is provided.\nArgumentError: If the algorithm used in the ClusterSequence object is not suitable for exclusive jets.\nErrorException: If the cluster sequence is incomplete and exclusive jets are unavailable.\n\nExamples\n\nexclusive_jets(clusterseq, dcut = 20.0)\nexclusive_jets(clusterseq, njets = 3, T = PseudoJet)\n\n\n\n\n\n","category":"method"},{"location":"lib/public/#JetReconstruction.final_jets","page":"Public API","title":"JetReconstruction.final_jets","text":"Specialisation for final jets from LorentzVectors (TODO: merge into more general function)\n\n\n\n\n\n","category":"function"},{"location":"lib/public/#JetReconstruction.final_jets-2","page":"Public API","title":"JetReconstruction.final_jets","text":"Specialisation for final jets from LorentzVectorCyl (TODO: merge into more general function)\n\n\n\n\n\n","category":"function"},{"location":"lib/public/#JetReconstruction.final_jets-3","page":"Public API","title":"JetReconstruction.final_jets","text":"final_jets(jets::Vector{PseudoJet}, ptmin::AbstractFloat=0.0)\n\nThis function takes a vector of PseudoJet objects and a minimum transverse momentum ptmin as input. It returns a vector of FinalJet objects that satisfy the transverse momentum condition.\n\nArguments\n\njets::Vector{PseudoJet}: A vector of PseudoJet objects representing the input jets.\nptmin::AbstractFloat=0.0: The minimum transverse momentum required for a jet to be included in the final jets vector.\n\nReturns\n\nA vector of FinalJet objects that satisfy the transverse momentum condition.\n\n\n\n\n\n","category":"function"},{"location":"lib/public/#JetReconstruction.inclusive_jets-Tuple{ClusterSequence}","page":"Public API","title":"JetReconstruction.inclusive_jets","text":"inclusive_jets(clusterseq::ClusterSequence; ptmin = 0.0, T = LorentzVectorCyl)\n\nReturn all inclusive jets of a ClusterSequence with pt > ptmin.\n\nArguments\n\nclusterseq::ClusterSequence: The ClusterSequence object containing the clustering history and jets.\nptmin::Float64 = 0.0: The minimum transverse momentum (pt) threshold for the inclusive jets.\nT = LorentzVectorCyl: The return type used for the selected jets.\n\nReturns\n\nAn array of T objects representing the inclusive jets.\n\nDescription\n\nThis function computes the inclusive jets from a given ClusterSequence object. It iterates over the clustering history and checks the transverse momentum of each parent jet. If the transverse momentum is greater than or equal to ptmin, the jet is added to the array of inclusive jets.\n\nValid return types are LorentzVectorCyl and PseudoJet (N.B. this will evolve in the future to be any subtype of FourMomemntumBase; currently unrecognised types will return LorentzVectorCyl).\n\nExample\n\ninclusive_jets(clusterseq; ptmin = 10.0)\n\n\n\n\n\n","category":"method"},{"location":"lib/public/#JetReconstruction.jet_reconstruct-Tuple{Any}","page":"Public API","title":"JetReconstruction.jet_reconstruct","text":"jet_reconstruct(particles; p = -1, algorithm = nothing, R = 1.0, recombine = +, strategy = RecoStrategy.Best)\n\nReconstructs jets from a collection of particles using a specified algorithm and strategy\n\nArguments\n\nparticles: A collection of particles used for jet reconstruction. \np::Union{Real, Nothing} = -1: The power value used for the distance measure for generalised k_T, which maps to a particular reconstruction algorithm (-1 = AntiKt, 0 = Cambridge/Aachen, 1 = Kt).\nalgorithm::Union{JetAlgorithm.Algorithm, Nothing} = nothing: The algorithm to use for jet reconstruction.\nR=1.0: The jet radius parameter.\nrecombine=+: The recombination scheme used for combining particles.\nstrategy=RecoStrategy.Best: The jet reconstruction strategy to use. RecoStrategy.Best makes a dynamic decision based on the number of starting particles.\n\nReturns\n\nA cluster sequence object containing the reconstructed jets and the merging history.\n\nDetails\n\nparticles argument\n\nAny type that supplies the methods pt2(), phi(), rapidity(), px(), py(), pz(), energy() (in the JetReconstruction namespace) can be used. This includes LorentzVector, LorentzVectorCyl, and PseudoJet, for which these methods are already predefined in the JetReconstruction namespace.\n\nrecombine argument\n\nThe recombine argument is the function used to merge pairs of particles. The default is simply +(jet1,jet2), i.e. 4-momenta addition or the E-scheme.\n\nConsistency of p, algorithm and R arguments\n\nIf an algorithm is explicitly specified the p value should be consistent with it or nothing. If the algorithm is one where p can vary, then it has to be given, along with the algorithm.\n\nIf the p parameter is passed and algorithm=nothing, then pp-type reconstruction is implied (i.e., AntiKt, CA, Kt or GenKt will be used, depending on the value of p).\n\nWhen an algorithm has no R dependence the R parameter is ignored.\n\nExample\n\njet_reconstruct(particles; p = -1, R = 0.4)\njet_reconstruct(particles; algorithm = JetAlgorithm.Kt, R = 1.0)\njet_reconstruct(particles; algorithm = JetAlgorithm.Durham)\njet_reconstruct(particles; algorithm = JetAlgorithm.GenKt, p = 0.5, R = 1.0)\n\n\n\n\n\n","category":"method"},{"location":"lib/public/#JetReconstruction.loadjets!-Tuple{Any, Any}","page":"Public API","title":"JetReconstruction.loadjets!","text":"loadjets!(filename, jets; splitby=isspace, constructor=(px,py,pz,E)->LorentzVectorHEP(E,px,py,pz), dtype=Float64)\n\nLoads the jets from a file. Ignores lines that start with '#'. Each line gets processed in the following way: the line is split using split(line, splitby) or simply split(line) by default. Every value in this line is then converted to the dtype (which is Float64 by default). These values are then used as arguments for the constructor function which should produce individual jets. By default, the constructor constructs Lorentz vectors.\n\nEverything that was already in jets is not affected as we only use push! on it.\n\nExample\n\n# Load jets from two files into one array\njets = []\nloadjets!(\"myjets1.dat\", jets)\nloadjets!(\"myjets2.dat\", jets)\n\n\n\n\n\n","category":"method"},{"location":"lib/public/#JetReconstruction.loadjets-Tuple{Any}","page":"Public API","title":"JetReconstruction.loadjets","text":"loadjets(filename; splitby=isspace, constructor=(px,py,pz,E)->LorentzVectorHEP(E,px,py,pz), VT=LorentzVector)\n\nLoad jets from a file.\n\nArguments\n\nfilename: The name of the file to load jets from.\nsplitby: The delimiter used to split the data in the file. Default is isspace.\nconstructor: A function that constructs a VT object from the jet data. Default is (px,py,pz,E)->LorentzVector(E,px,py,pz).\nVT: The type of the vector used to store the jet data. Default is LorentzVector.\n\nReturns\n\nA vector of VT objects representing the loaded jets.\n\n\n\n\n\n","category":"method"},{"location":"lib/public/#JetReconstruction.n_exclusive_jets-Tuple{ClusterSequence}","page":"Public API","title":"JetReconstruction.n_exclusive_jets","text":"n_exclusive_jets(clusterseq::ClusterSequence; dcut::AbstractFloat)\n\nReturn the number of exclusive jets of a ClusterSequence that are above a certain dcut value.\n\nArguments\n\nclusterseq::ClusterSequence: The ClusterSequence object containing the clustering history.\ndcut::AbstractFloat: The maximum value for the distance parameter in the reconstruction.\n\nReturns\n\nThe number of exclusive jets in the ClusterSequence object.\n\nExample\n\nn_exclusive_jets(clusterseq, dcut = 20.0)\n\n\n\n\n\n","category":"method"},{"location":"lib/public/#JetReconstruction.plain_jet_reconstruct-Union{Tuple{AbstractVector{T}}, Tuple{T}} where T","page":"Public API","title":"JetReconstruction.plain_jet_reconstruct","text":"plain_jet_reconstruct(particles::Vector{T}; p = -1, R = 1.0, recombine = +) where T\n\nPerform pp jet reconstruction using the plain algorithm.\n\nArguments\n\nparticles::Vector{T}: A vector of particles used for jet reconstruction, any array of particles, which supports suitable 4-vector methods, viz. pt2(), phi(), rapidity(), px(), py(), pz(), energy(), can be used. for each element.\nalgorithm::Union{JetAlgorithm, Nothing} = nothing: The explicit jet algorithm to use.\np::Int=-1: The integer value used for jet reconstruction.\nR::Float64=1.0: The radius parameter used for jet reconstruction.\nrecombine::Function=+: The recombination function used for jet reconstruction.\n\nNote for the particles argument, the 4-vector methods need to exist in the JetReconstruction package namespace.\n\nThis code will use the k_t algorithm types, operating in (rapidity, φ) space.\n\nIt is not necessary to specify both the algorithm and the p (power) value. If both are given they must be consistent or an exception is thrown.\n\nReturns\n\nVector{PseudoJet}: A vector of reconstructed jets.\n\nExample\n\njets = plain_jet_reconstruct(particles; p = -1, R = 0.4)\njets = plain_jet_reconstruct(particles; algorithm = JetAlgorithm.Kt, R = 1.0)\n\n\n\n\n\n","category":"method"},{"location":"lib/public/#JetReconstruction.read_final_state_particles-Tuple{Any}","page":"Public API","title":"JetReconstruction.read_final_state_particles","text":"read_final_state_particles(fname; maxevents = -1, skipevents = 0, T=PseudoJet)\n\nReads final state particles from a file and returns them as a vector of type T.\n\nArguments\n\nfname: The name of the HepMC3 ASCII file to read particles from. If the file is gzipped, the function will automatically decompress it.\nmaxevents=-1: The maximum number of events to read. -1 means all events will be read.\nskipevents=0: The number of events to skip before an event is included.\nT=PseudoJet: The type of object to construct and return.\n\nReturns\n\nA vector of vectors of T objects, where each inner vector represents all the particles of a particular event. In particular T can be PseudoJet or a LorentzVector type. Note, if T is not PseudoJet, the order of the arguments in the constructor must be (t, x, y, z).\n\n\n\n\n\n","category":"method"},{"location":"lib/public/#JetReconstruction.savejets-Tuple{Any, Any}","page":"Public API","title":"JetReconstruction.savejets","text":"savejets(filename, jets; format=\"px py pz E\")\n\nSave jet data to a file.\n\nArguments\n\nfilename: The name of the file to save the jet data to.\njets: An array of jet objects to save.\nformat=\"px py pz E\": (optional) A string specifying the format of the jet data to save. The default format is \"px py pz E\".\n\nDetails\n\nThis function saves jet data to a file in a specific format. Each line in the file represents a jet and contains the information about the jet in the specified format. The format string can include the following placeholders:\n\n\"E\" or \"energy\": Jet energy\n\"px\": Momentum along the x-axis\n\"py\": Momentum along the y-axis\n\"pz\": Momentum along the z-axis\n\"pt2\": Square of the transverse momentum\n\"phi\": Azimuth angle\n\"rapidity\": Rapidity\n\nLines starting with '#' are treated as comments and are ignored.\n\nIt is strongly NOT recommended to put something other than values and (possibly custom) separators in the format string.\n\n\n\n\n\n","category":"method"},{"location":"lib/public/#JetReconstruction.tiled_jet_reconstruct-Union{Tuple{AbstractVector{T}}, Tuple{T}} where T","page":"Public API","title":"JetReconstruction.tiled_jet_reconstruct","text":"tiled_jet_reconstruct(particles::Vector{T}; p = -1, R = 1.0, recombine = +) where {T}\n\nMain jet reconstruction algorithm entry point for reconstructing jets using the tiled strategy for generic jet type T.\n\nNote - if a non-standard recombination is used, it must be defined for JetReconstruction.PseudoJet, as this struct is used internally.\n\nThis code will use the k_t algorithm types, operating in (rapidity, φ) space.\n\nIt is not necessary to specify both the algorithm and the p (power) value. If both are given they must be consistent or an exception is thrown.\n\nArguments\n\nparticles::Vector{T}: A vector of particles used as input for jet reconstruction. T must support methods px, py, pz and energy (defined in the JetReconstruction namespace)\np::Union{Real, Nothing} = -1: The power parameter for the jet reconstruction algorithm, thus switching between different algorithms.\nalgorithm::Union{JetAlgorithm, Nothing} = nothing: The explicit jet algorithm to use.\nR::Float64 = 1.0: The jet radius parameter for the jet reconstruction algorithm.\nrecombine::Function = +: The recombination function used for combining pseudojets.\n\nReturns\n\nVector{PseudoJet}: A vector of reconstructed jets.\n\nExample\n\ntiled_jet_reconstruct(particles::Vector{LorentzVectorHEP}; p = -1, R = 0.4, recombine = +)\n\n\n\n\n\n","category":"method"},{"location":"lib/public/#JetReconstruction.ClusterSequence","page":"Public API","title":"JetReconstruction.ClusterSequence","text":"struct ClusterSequence\n\nA struct holding the full history of a jet clustering sequence, including the final jets.\n\nFields\n\nalgorithm::JetAlgorithm.Algorithm: The algorithm used for clustering.\nstrategy::RecoStrategy.Strategy: The strategy used for clustering.\npower::Float64: The power value used for the clustering algorithm (not that this value is always stored as a Float64 to be type stable)\nR::Float64: The R parameter used for the clustering algorithm.\njets::Vector{T}: The actual jets in the cluster sequence, which are of type T <: FourMomentum.\nn_initial_jets::Int: The initial number of particles used for exclusive jets.\nhistory::Vector{HistoryElement}: The branching history of the cluster sequence. Each stage in the history indicates where to look in the jets vector to get the physical PseudoJet.\nQtot::Any: The total energy of the event.\n\n\n\n\n\n","category":"type"},{"location":"lib/public/#JetReconstruction.ClusterSequence-Union{Tuple{T}, Tuple{JetReconstruction.JetAlgorithm.Algorithm, Real, Float64, JetReconstruction.RecoStrategy.Strategy, Vector{T}, Any, Any}} where T<:JetReconstruction.FourMomentum","page":"Public API","title":"JetReconstruction.ClusterSequence","text":"ClusterSequence(algorithm::JetAlgorithm.Algorithm, p::Real, R::Float64, strategy::RecoStrategy.Strategy, jets::T, history, Qtot) where T <: FourMomentum\n\nConstruct a ClusterSequence object.\n\nArguments\n\nalgorithm::JetAlgorithm.Algorithm: The algorithm used for clustering.\np::Real: The power value used for the clustering algorithm.\nR::Float64: The R parameter used for the clustering algorithm.\nstrategy::RecoStrategy.Strategy: The strategy used for clustering.\njets::Vector{T}: The jets in the cluster sequence, which are of T <: FourMomentum\nhistory::Vector{HistoryElement}: The branching history of the cluster sequence.\nQtot::Any: The total energy of the event.\n\n\n\n\n\n","category":"method"},{"location":"lib/public/#JetReconstruction.EEjet","page":"Public API","title":"JetReconstruction.EEjet","text":"struct EEjet{T <: Real} <: FourMomentum\n\nThe EEjet struct is a 4-momentum object used for the e+e jet reconstruction routines. Internal fields are used to track the reconstruction and to cache values needed during the execution of the algorithm.\n\nFields\n\npx::T: The x-component of the jet momentum.\npy::T: The y-component of the jet momentum.\npz::T: The z-component of the jet momentum.\nE::T: The energy of the jet.\n_cluster_hist_index::Int: The index of the cluster histogram.\n_p2::T: The squared momentum of the jet.\n_inv_p::T: The inverse momentum of the jet.\n\nType Parameters\n\nT <: Real: The type of the numerical values.\n\n\n\n\n\n","category":"type"},{"location":"lib/public/#JetReconstruction.EEjet-Tuple{PseudoJet}","page":"Public API","title":"JetReconstruction.EEjet","text":"EEjet(pj::PseudoJet) -> EEjet\n\nConstructs an EEjet object from a given PseudoJet object pj.\n\nArguments\n\npj::PseudoJet: A PseudoJet object used to create the EEjet.\n\nReturns\n\nAn EEjet object initialized with the same properties of the given PseudoJet.\n\n\n\n\n\n","category":"method"},{"location":"lib/public/#JetReconstruction.EEjet-Union{Tuple{T}, NTuple{4, T}} where T<:Real","page":"Public API","title":"JetReconstruction.EEjet","text":"EEjet(px::T, py::T, pz::T, E::T) where {T <: Real}\n\nConstructs an EEjet object with the given momentum components px, py, pz, energy E, and the cluster histogram index set to zero.\n\nThe constructed EEjet object will be parametrised by the type T.\n\nArguments\n\npx::T: The x-component of the momentum.\npy::T: The y-component of the momentum.\npz::T: The z-component of the momentum.\nE::T: The energy of the jet.\n\nReturns\n\nThe initialised EEjet object.\n\n\n\n\n\n","category":"method"},{"location":"lib/public/#JetReconstruction.EEjet-Union{Tuple{T}, Tuple{T, T, T, T, Integer}} where T<:Real","page":"Public API","title":"JetReconstruction.EEjet","text":"EEjet(px::T, py::T, pz::T, E::T, _cluster_hist_index::Integer) where {T <: Real}\n\nConstructs an EEjet object with the given momentum components px, py, pz, energy E, and cluster histogram index _cluster_hist_index.\n\nThe constructed EEjet object will be parametrised by the type T.\n\nArguments\n\npx::T: The x-component of the momentum.\npy::T: The y-component of the momentum.\npz::T: The z-component of the momentum.\nE::T: The energy of the jet.\n_cluster_hist_index::Integer: The index of the cluster histogram.\n\nReturns\n\nThe initialised EEjet object.\n\nNote\n\nT must be a subtype of Real.\nThe @muladd macro is used to perform fused multiply-add operations for computing p2.\nThe @fastmath macro is used to allow the compiler to perform optimizations for computing inv_p.\n\n\n\n\n\n","category":"method"},{"location":"lib/public/#JetReconstruction.EEjet-Union{Tuple{U}, Tuple{T}, NTuple{4, T}} where {T<:Real, U<:Real}","page":"Public API","title":"JetReconstruction.EEjet","text":"EEjet{U}(px::T, py::T, pz::T, E::T) where {T <: Real, U <: Real}\n\nConstructs an EEjet object with conversion of the given momentum components (px, py, pz) and energy (E) from type T to type U.\n\nArguments\n\npx::T: The x-component of the momentum.\npy::T: The y-component of the momentum.\npz::T: The z-component of the momentum.\nE::T: The energy.\n\nType Parameters\n\nT <: Real: The type of the input momentum components and energy.\nU <: Real: The type to which the input values will be converted\n\nReturns\n\nAn EEjet object with the momentum components and energy parametrised to type U.\n\n\n\n\n\n","category":"method"},{"location":"lib/public/#JetReconstruction.FinalJet","page":"Public API","title":"JetReconstruction.FinalJet","text":"struct FinalJet\n\nA struct representing the final properties of a jet, used for JSON serialisation.\n\nFields\n\nrap::Float64: The rapidity of the jet.\nphi::Float64: The azimuthal angle of the jet.\npt::Float64: The transverse momentum of the jet.\n\n\n\n\n\n","category":"type"},{"location":"lib/public/#JetReconstruction.FinalJets","page":"Public API","title":"JetReconstruction.FinalJets","text":"struct FinalJets\n\nA struct with the vector of all jets for a certain jet identifier, used for JSON serialisation.\n\nFields\n\njetid::Int64: The ID of the jet.\njets::Vector{FinalJet}: A vector of FinalJet objects representing the jets.\n\n\n\n\n\n","category":"type"},{"location":"lib/public/#JetReconstruction.PseudoJet","page":"Public API","title":"JetReconstruction.PseudoJet","text":"mutable struct PseudoJet{T <: Real} <: FourMomentum\n\nThe PseudoJet struct represents a pseudojet, a four-momentum object used in jet reconstruction algorithms. Additional information for the link back into the history of the clustering is stored in the _cluster_hist_index field. There is caching of the more expensive calculations for rapidity and azimuthal angle.\n\nFields\n\npx::T: The x-component of the momentum.\npy::T: The y-component of the momentum.\npz::T: The z-component of the momentum.\nE::T: The energy component of the momentum.\n_cluster_hist_index::Int: The index of the cluster history.\n_pt2::T: The squared transverse momentum.\n_inv_pt2::T: The inverse squared transverse momentum.\n_rap::T: The rapidity.\n_phi::T: The azimuthal angle.\n\n\n\n\n\n","category":"type"},{"location":"lib/public/#JetReconstruction.PseudoJet-Union{Tuple{T}, NTuple{4, T}} where T<:Real","page":"Public API","title":"JetReconstruction.PseudoJet","text":"PseudoJet(px::T, py::T, pz::T, E::T) where T <: Real\n\nConstructs a PseudoJet object with the given momentum components and energy.\n\nArguments\n\npx::T: The x-component of the momentum.\npy::T: The y-component of the momentum.\npz::T: The z-component of the momentum.\nE::T: The energy.\n\nReturns\n\nA PseudoJet object, with type parameter T.\n\n\n\n\n\n","category":"method"},{"location":"lib/public/#JetReconstruction.PseudoJet-Union{Tuple{T}, Tuple{T, T, T, T, Int64, T}} where T<:Real","page":"Public API","title":"JetReconstruction.PseudoJet","text":"PseudoJet{T}(px::T, py::T, pz::T, E::T,\n _cluster_hist_index::Int,\n pt2::T) where {T <: Real}\n\nConstructs a parametrised PseudoJet object with the given momentum components and energy and history index.\n\nArguments\n\npx::T: The x-component of the momentum.\npy::T: The y-component of the momentum.\npz::T: The z-component of the momentum.\nE::T: The energy.\n_cluster_hist_index::Int: The cluster history index.\npt2::T: The transverse momentum squared.\n\nReturns\n\nA PseudoJet object.\n\n\n\n\n\n","category":"method"},{"location":"lib/public/#JetReconstruction.PseudoJet-Union{Tuple{U}, Tuple{T}, NTuple{4, T}} where {T<:Real, U<:Real}","page":"Public API","title":"JetReconstruction.PseudoJet","text":"PseudoJet{U}(px::T, py::T, pz::T, E::T) where T <: Real, U <: Real\n\nConstructs a PseudoJet object with the given momentum components and energy, parameterised by U.\n\nArguments\n\npx::T: The x-component of the momentum.\npy::T: The y-component of the momentum.\npz::T: The z-component of the momentum.\nE::T: The energy.\nU <: Real: The type parameter for the PseudoJet object.\n\nReturns\n\nA PseudoJet object, with type parameter U.\n\n\n\n\n\n","category":"method"},{"location":"#Jet-Reconstruction","page":"Home","title":"Jet Reconstruction","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"This package implements sequential Jet Reconstruction (clustering) algorithms, which are used in high-energy physics as part of event reconstruction for pp and e^+e^- colliders.","category":"page"},{"location":"#Algorithms","page":"Home","title":"Algorithms","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Algorithms used are based on the C++ FastJet package (https://fastjet.fr, hep-ph/0512210, arXiv:1111.6097), reimplemented natively in Julia.","category":"page"},{"location":"","page":"Home","title":"Home","text":"The algorithms include anti-k_textT, Cambridge/Aachen, inclusive k_textT, generalised k_textT for pp events; and the Durham algorithm and generalised k_textT for e^+e^-.","category":"page"},{"location":"#Reconstruction-Interface","page":"Home","title":"Reconstruction Interface","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"The main interface for reconstruction is jet_reconstruct, called as, e.g.,","category":"page"},{"location":"","page":"Home","title":"Home","text":"jet_reconstruct(particles; algorithm = JetAlgorithm.AntiKt, R = 1.0)","category":"page"},{"location":"","page":"Home","title":"Home","text":"or with some of the optional arguments,","category":"page"},{"location":"","page":"Home","title":"Home","text":"jet_reconstruct(particles; algorithm = JetAlgorithm.GenKt, R = 0.4, \n p = 0.5, recombine = +, strategy = RecoStrategy.Best)","category":"page"},{"location":"","page":"Home","title":"Home","text":"Where particles is a collection of 4-vector objects (see Input Particle Types) to reconstruct and the algorithm is either given explicitly or implied by the power value.","category":"page"},{"location":"","page":"Home","title":"Home","text":"For the case of generalised k_T (for pp and e^+e^-) both the algorithm (GenKt, EEKt) and p are needed.","category":"page"},{"location":"","page":"Home","title":"Home","text":"The R value determines the cone size; in the case of the Durham algorithm the R value is ignored.","category":"page"},{"location":"","page":"Home","title":"Home","text":"The object returned is a ClusterSequence, which internally tracks all merge steps and is used for Inclusive and Exclusive Selections.","category":"page"},{"location":"#Algorithm-Types","page":"Home","title":"Algorithm Types","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Each known algorithm is referenced using a JetAlgorithm scoped enum value.","category":"page"},{"location":"","page":"Home","title":"Home","text":"Algorithm Type name Notes\nanti-k_textT JetAlgorithm.AntiKt Implies p=-1\nCambridge/Aachen JetAlgorithm.CA Implies p=0\ninclusive k_textT JetAlgorithm.Kt Implies p=1\ngeneralised k_textT JetAlgorithm.GenKt For pp, value of p must also be specified\ne^+e- k_textT / Durham JetAlgorithm.Durham R value ignored and can be omitted\ngeneralised e^+e- k_textT JetAlgorithm.EEKt For e^+e^-, value of p must also be specified","category":"page"},{"location":"#pp-Algorithms","page":"Home","title":"pp Algorithms","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"For the three pp algorithms with fixed p values, the p value can be given instead of the algorithm name. However, this should be considered deprecated and will be removed in a future release.","category":"page"},{"location":"#Strategy","page":"Home","title":"Strategy","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Generally one does not need to manually specify a strategy, but Algorithm Strategy describes how to do this, if desired.","category":"page"},{"location":"#Inclusive-and-Exclusive-Selections","page":"Home","title":"Inclusive and Exclusive Selections","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"To obtain final jets both inclusive (p_T cut) and exclusive (n_jets or d_ij cut) selections are supported:","category":"page"},{"location":"","page":"Home","title":"Home","text":"inclusive_jets(clusterseq::ClusterSequence, ptmin = 0.0)\nexclusive_jets(clusterseq::ClusterSequence; dcut = nothing, njets = nothing)","category":"page"},{"location":"","page":"Home","title":"Home","text":"(For exclusive_jets either dcut or njets is needed, but not both.)","category":"page"},{"location":"#Sorting","page":"Home","title":"Sorting","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Sorting vectors is trivial in Julia, no special sorting methods are provided. As an example, to sort exclusive jets of 50 (usually GeV, depending on your EDM) from highest energy to lowest:","category":"page"},{"location":"","page":"Home","title":"Home","text":"sorted_jets = sort!(inclusive_jets(cs::ClusterSequence; ptmin=5.0), \n by=JetReconstruction.energy, rev=true)","category":"page"},{"location":"#Jet-Constituents","page":"Home","title":"Jet Constituents","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"There are two ways to retrieve jet constituents. The first way is just to retrieve the indexes of the constituent jets. These indexes refer to the original collection of particles passed in to the reconstruction.","category":"page"},{"location":"","page":"Home","title":"Home","text":"constituent_indexes","category":"page"},{"location":"","page":"Home","title":"Home","text":"The alternative it to retrieve the actual jets from the reconstruction sequence. In this case the returned array contains references to the jet objects (of type T) used internally in the reconstruction.","category":"page"},{"location":"","page":"Home","title":"Home","text":"constituents","category":"page"},{"location":"","page":"Home","title":"Home","text":"Note that in both these cases the cluster sequence object from the reconstruction is required (to avoid circular dependencies and improve memory management reconstructed jets do not contain a link back to their cluster sequence).","category":"page"},{"location":"#References","page":"Home","title":"References","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Although it has been developed further since the CHEP2023 conference, the CHEP conference proceedings, 10.1051/epjconf/202429505017, should be cited if you use this package:","category":"page"},{"location":"","page":"Home","title":"Home","text":"@article{refId0,\n author = {{Stewart, Graeme Andrew} and {Gras, Philippe} and {Hegner, Benedikt} and {Krasnopolski, Atell}},\n doi = {10.1051/epjconf/202429505017},\n journal = {EPJ Web of Conf.},\n pages = {05017},\n title = {Polyglot Jet Finding},\n url = {https://doi.org/10.1051/epjconf/202429505017},\n volume = 295,\n year = 2024,\n eprint={2309.17309},\n archivePrefix={arXiv},\n primaryClass={hep-ex}\n}","category":"page"},{"location":"","page":"Home","title":"Home","text":"The original paper on arXiv is:","category":"page"},{"location":"","page":"Home","title":"Home","text":"@misc{stewart2023polyglot,\n title={Polyglot Jet Finding}, \n author={Graeme Andrew Stewart and Philippe Gras and Benedikt Hegner and Atell Krasnopolski},\n year={2023},\n eprint={2309.17309},\n archivePrefix={arXiv},\n primaryClass={hep-ex}\n}","category":"page"},{"location":"#Authors-and-Copyright","page":"Home","title":"Authors and Copyright","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Code in this package is authored by:","category":"page"},{"location":"","page":"Home","title":"Home","text":"Atell Krasnopolski \nGraeme A Stewart \nPhilippe Gras ","category":"page"},{"location":"","page":"Home","title":"Home","text":"and is Copyright 2022-2024 The Authors, CERN.","category":"page"},{"location":"","page":"Home","title":"Home","text":"The code is under the MIT License.","category":"page"},{"location":"lib/internal/#Jet-Reconstruction-Internal-Documentation","page":"Internal API","title":"Jet Reconstruction Internal Documentation","text":"","category":"section"},{"location":"lib/internal/","page":"Internal API","title":"Internal API","text":"Documentation for JetReconstruction.jl's internal methods and types.","category":"page"},{"location":"lib/internal/","page":"Internal API","title":"Internal API","text":"N.B. no guarantee is made of stability of these interfaces or types.","category":"page"},{"location":"lib/internal/","page":"Internal API","title":"Internal API","text":"CollapsedDocStrings = true","category":"page"},{"location":"lib/internal/#Index","page":"Internal API","title":"Index","text":"","category":"section"},{"location":"lib/internal/","page":"Internal API","title":"Internal API","text":"Pages = [\"internal.md\"]","category":"page"},{"location":"lib/internal/#Internal-Methods-and-Types","page":"Internal API","title":"Internal Methods and Types","text":"","category":"section"},{"location":"lib/internal/","page":"Internal API","title":"Internal API","text":"Modules = [JetReconstruction]\nPublic = false\nOrder = [:function, :type]","category":"page"},{"location":"lib/internal/#Base.:+-Tuple{PseudoJet, PseudoJet}","page":"Internal API","title":"Base.:+","text":"+(j1::PseudoJet, j2::PseudoJet)\n\nAddition operator for PseudoJet objects.\n\nArguments\n\nj1::PseudoJet: The first PseudoJet object.\nj2::PseudoJet: The second PseudoJet object.\n\nReturns\n\nA new PseudoJet object with the sum of the momenta and energy of j1 and j2.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#Base.copy-Tuple{JetReconstruction.TiledJet}","page":"Internal API","title":"Base.copy","text":"copy(j::TiledJet)\n\nCreate a copy of a TiledJet object.\n\nArguments\n\nj::TiledJet: The TiledJet object to be copied.\n\nReturns\n\nA new TiledJet object with the same attributes as the input object.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#Base.eltype-Union{Tuple{Type{EEjet{T}}}, Tuple{T}} where T","page":"Internal API","title":"Base.eltype","text":"Base.eltype(::Type{EEjet{T}}) where T\n\nReturn the element type of the EEjet struct.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#Base.eltype-Union{Tuple{Type{PseudoJet{T}}}, Tuple{T}} where T","page":"Internal API","title":"Base.eltype","text":"Base.eltype(::Type{PseudoJet{T}}) where T\n\nReturn the element type of the PseudoJet struct.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#Base.iterate","page":"Internal API","title":"Base.iterate","text":"Base.iterate(t::neighbour_tiles, state=1)\n\nIterate over the neighbour_tiles object, returning all the neighbour tiles for a given Cartesian tile index.\n\n\n\n\n\n","category":"function"},{"location":"lib/internal/#Base.iterate-2","page":"Internal API","title":"Base.iterate","text":"Base.iterate(t::rightmost_tiles, state=1)\n\nIterate over the rightmost_tiles object, returning all the rightmost tiles for a given Cartesian tile index.\n\n\n\n\n\n","category":"function"},{"location":"lib/internal/#Base.iterate-Tuple{JetReconstruction.TiledJet}","page":"Internal API","title":"Base.iterate","text":"Base.iterate(tj::TiledJet)\n\nIterate over a TiledJet object's linked list, walking over all jets until the end (then the next jet is invalid).\n\nArguments\n\ntj::TiledJet: The TiledJet object to start to iterate over.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#Base.show-Tuple{IO, PseudoJet}","page":"Internal API","title":"Base.show","text":"show(io::IO, jet::PseudoJet)\n\nPrint a PseudoJet object to the specified IO stream.\n\nArguments\n\nio::IO: The IO stream to which the information will be printed.\njet::PseudoJet: The PseudoJet object whose information will be printed.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#Base.tryparse-Tuple{Type{<:Enum}, String}","page":"Internal API","title":"Base.tryparse","text":"Base.tryparse(E::Type{<:Enum}, str::String)\n\nParser that converts a string to an enum value if it exists, otherwise returns nothing.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.CosTheta-Tuple{PseudoJet}","page":"Internal API","title":"JetReconstruction.CosTheta","text":"CosTheta(p::PseudoJet)\n\nCompute the cosine of the angle between the momentum vector p and the z-axis.\n\nArguments\n\np::PseudoJet: The PseudoJet object representing the momentum vector.\n\nReturns\n\nThe cosine of the angle between p and the z-axis.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction._ee_genkt_algorithm-Union{Tuple{}, Tuple{T}} where T<:Real","page":"Internal API","title":"JetReconstruction._ee_genkt_algorithm","text":"_ee_genkt_algorithm(; particles::Vector{EEjet}, p = 1, R = 4.0,\n algorithm::JetAlgorithm.Algorithm = JetAlgorithm.Durham,\n recombine = +)\n\nThis function is the actual implementation of the e+e- jet clustering algorithm.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction._ensure_valid_rap_phi-Tuple{PseudoJet}","page":"Internal API","title":"JetReconstruction._ensure_valid_rap_phi","text":"_ensure_valid_rap_phi(p::PseudoJet)\n\nEnsure that the rapidity and azimuthal angle of the PseudoJet p are valid. If the azimuthal angle is invalid (used as a proxy for both variables), they are set to a valid value using _set_rap_phi!.\n\nArguments\n\np::PseudoJet: The PseudoJet object to ensure valid rapidity and azimuthal angle for.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction._plain_jet_reconstruct-Union{Tuple{}, Tuple{T}} where T<:Real","page":"Internal API","title":"JetReconstruction._plain_jet_reconstruct","text":"_plain_jet_reconstruct(; particles::Vector{PseudoJet}, p = -1, R = 1.0, recombine = +)\n\nThis is the internal implementation of jet reconstruction using the plain algorithm. It takes a vector of particles representing the input particles and reconstructs jets based on the specified parameters. Here the particles must be of type PseudoJet.\n\nUsers of the package should use the plain_jet_reconstruct function as their entry point to this jet reconstruction.\n\nThe power value maps to specific pp jet reconstruction algorithms: -1 = AntiKt, 0 = Cambridge/Aachen, 1 = Inclusive Kt. Floating point values are allowed for generalised k_t algorithm.\n\nArguments\n\nparticles: A vector of PseudoJet objects representing the input particles.\np=-1: The power to which the transverse momentum (pt) of each particle is raised.\nR=1.0: The jet radius parameter.\nrecombine: The recombination function used to merge two jets. Default is + (additive recombination).\n\nReturns\n\nclusterseq: The resulting ClusterSequence object representing the reconstructed jets.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction._set_rap_phi!-Tuple{PseudoJet}","page":"Internal API","title":"JetReconstruction._set_rap_phi!","text":"setrap_phi!(p::PseudoJet)\n\nSet the rapidity and azimuthal angle of the PseudoJet p.\n\nArguments\n\np::PseudoJet: The PseudoJet object for which to set the rapidity and azimuthal angle.\n\nDescription\n\nThis function calculates and sets the rapidity and azimuthal angle of the PseudoJet p based on its momentum components. The rapidity is calculated in a way that is insensitive to roundoff errors when the momentum components are large. If the PseudoJet represents a point with infinite rapidity, a large number is assigned to the rapidity in order to lift the degeneracy between different zero-pt momenta.\n\nNote - the ϕ angle is calculated in the range [0, 2π).\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction._tiled_jet_reconstruct-Union{Tuple{Array{PseudoJet{T}, 1}}, Tuple{T}} where T<:Real","page":"Internal API","title":"JetReconstruction._tiled_jet_reconstruct","text":"_tiled_jet_reconstruct(particles::Vector{PseudoJet}; p = -1, R = 1.0, recombine = +) where {T}\n\nMain jet reconstruction algorithm entry point for reconstructing jets once preprocessing of data types are done.\n\nArguments\n\nparticles::Vector{PseudoJet}: A vector of PseudoJet particles used as input for jet reconstruction.\np::Int = -1: The power parameter for the jet reconstruction algorithm, thus switching between different algorithms.\nR::Float64 = 1.0: The jet radius parameter for the jet reconstruction algorithm.\nrecombine::Function = +: The recombination function used for combining pseudojets.\n\nReturns\n\nVector{PseudoJet}: A vector of reconstructed jets.\n\nExample\n\ntiled_jet_reconstruct(particles::Vector{PseudoJet}; p = 1, R = 1.0, recombine = +)\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction._tj_diJ-Tuple{Any}","page":"Internal API","title":"JetReconstruction._tj_diJ","text":"_tj_diJ(jet)\n\nCompute the dij metric value for a given jet.\n\nArguments\n\njet: The input jet.\n\nReturns\n\nThe dij value for the jet.\n\nExample\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction._tj_dist-Tuple{Any, Any}","page":"Internal API","title":"JetReconstruction._tj_dist","text":"_tj_dist(jetA, jetB)\n\nCompute the geometric distance in the (y, ϕ)-plane between two jets in the TiledAlgoLL module.\n\nArguments\n\njetA: The first jet.\njetB: The second jet.\n\nReturns\n\nThe squared distance between jetA and jetB.\n\nExamples\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.add_step_to_history!-Tuple{ClusterSequence, Vararg{Any, 4}}","page":"Internal API","title":"JetReconstruction.add_step_to_history!","text":"add_step_to_history!(clusterseq::ClusterSequence, parent1, parent2, jetp_index, dij)\n\nAdd a new jet's history into the recombination sequence.\n\nArguments:\n\nclusterseq::ClusterSequence: The cluster sequence object.\nparent1: The index of the first parent.\nparent2: The index of the second parent.\njetp_index: The index of the jet.\ndij: The dij value.\n\nThis function adds a new HistoryElement to the history vector of the clusterseq object. The HistoryElement contains information about the parents, child, jet index, dij value, and the maximum dij value so far. It also updates the child index of the parent elements.\n\nIf the parent1 or parent2 have already been recombined, an InternalError is thrown. The jetp_index is used to update the _cluster_hist_index of the corresponding PseudoJet object.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.add_untagged_neighbours_to_tile_union-NTuple{4, Any}","page":"Internal API","title":"JetReconstruction.add_untagged_neighbours_to_tile_union","text":"add_untagged_neighbours_to_tile_union(center_index, tile_union, n_near_tiles, tiling)\n\nAdds to the vector tileunion the tiles that are in the neighbourhood of the specified centerindex, including itself and whose tagged status are false - start adding from position nneartiles-1, and increase nneartiles. When a neighbour is added its tagged status is set to true.\n\nArguments\n\ncenter_index: The index of the center tile.\ntile_union: An array to store the indices of neighbouring tiles.\nn_near_tiles: The number of neighbouring tiles.\ntiling: The tiling object containing the tile tags.\n\nReturns\n\nThe updated number of near tiles.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.angular_distance-Tuple{Any, Any, Any}","page":"Internal API","title":"JetReconstruction.angular_distance","text":"angular_distance(eereco, i, j) -> Float64\n\nCalculate the angular distance between two jets i and j using the formula 1 - cos(θ_ij).\n\nArguments\n\neereco: The array of EERecoJet objects.\ni: The first jet.\nj: The second jet.\n\nReturns\n\nFloat64: The angular distance between i and j, which is 1 - cos\theta.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.check_algorithm_power_consistency-Tuple{}","page":"Internal API","title":"JetReconstruction.check_algorithm_power_consistency","text":"Allow a check for algorithm and power consistency\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.copy_to_slot!-Tuple{Any, Any, Any}","page":"Internal API","title":"JetReconstruction.copy_to_slot!","text":"copy_to_slot!(eereco, i, j)\n\nCopy the contents of slot i in the eereco array to slot j.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.detach!-Tuple{JetReconstruction.TiledJet}","page":"Internal API","title":"JetReconstruction.detach!","text":"detach!(jet::TiledJet)\n\nDetach a TiledJet from its linked list by updating the previous and next pointers.\n\nArguments\n\njet::TiledJet: The TiledJet object to detach.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.determine_rapidity_extent-Union{Tuple{Vector{T}}, Tuple{T}} where T<:AbstractFloat","page":"Internal API","title":"JetReconstruction.determine_rapidity_extent","text":"determine_rapidity_extent(eta::Vector{T}) where T <: AbstractFloat\n\nCalculate the minimum and maximum rapidities based on the input vector eta. The function determines the rapidity extent by binning the multiplicities as a function of rapidity and finding the minimum and maximum rapidities such that the edge bins contain a certain fraction (~1/4) of the busiest bin and a minimum number of particles.\n\nThis is the heuristic which is used by FastJet (inline comments are from FastJet).\n\nArguments\n\neta::Vector{T}: A vector of rapidity values.\n\nReturns\n\nminrap::T: The minimum rapidity value.\nmaxrap::T: The maximum rapidity value.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.dij-NTuple{4, Any}","page":"Internal API","title":"JetReconstruction.dij","text":"dij(i, kt2_array, nn, nndist)\n\nCompute the dij value for a given index i to its nearest neighbor. The nearest neighbor is determined from nn[i], and the metric distance to the nearest neighbor is given by the distance nndist[i] applying the lower of the kt2_array values for the two particles.ßß\n\nArguments\n\ni: The index of the element.\nkt2_array: An array of kt2 values.\nnn: An array of nearest neighbors.\nnndist: An array of nearest neighbor distances.\n\nReturns\n\nThe computed dij value.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.dij_dist-NTuple{4, Any}","page":"Internal API","title":"JetReconstruction.dij_dist","text":"dij_dist(eereco, i, j, dij_factor)\n\nCalculate the dij distance between two e^+e^-jets.\n\nArguments\n\neereco: The array of EERecoJet objects.\ni: The first jet.\nj: The second jet.\ndij_factor: The scaling factor to multiply the dij distance by.\n\nReturns\n\nThe dij distance between i and j.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.dist-NTuple{4, Any}","page":"Internal API","title":"JetReconstruction.dist","text":"dist(i, j, rapidity_array, phi_array)\n\nCompute the distance between points in a 2D space defined by rapidity and phi coordinates.\n\nArguments\n\ni::Int: Index of the first point to consider (indexes into rapidity_array and phi_array).\nj::Int: Index of the second point to consider (indexes into rapidity_array and phi_array).\nrapidity_array::Vector{Float64}: Array of rapidity coordinates.\nphi_array::Vector{Float64}: Array of phi coordinates.\n\nReturns\n\ndistance::Float64: The distance between the two points.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.do_iB_recombination_step!-Tuple{ClusterSequence, Any, Any}","page":"Internal API","title":"JetReconstruction.do_iB_recombination_step!","text":"do_iB_recombination_step!(clusterseq::ClusterSequence, jet_i, diB)\n\nBookkeeping for recombining a jet with the beam (i.e., finalising the jet) by adding a step to the history of the cluster sequence.\n\nArguments\n\nclusterseq::ClusterSequence: The cluster sequence object.\njet_i: The index of the jet.\ndiB: The diB value.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.do_ij_recombination_step!","page":"Internal API","title":"JetReconstruction.do_ij_recombination_step!","text":"do_ij_recombination_step!(clusterseq::ClusterSequence, jet_i, jet_j, dij, recombine=+)\n\nPerform the bookkeeping associated with the step of recombining jeti and jetj (assuming a distance dij).\n\nArguments\n\nclusterseq::ClusterSequence: The cluster sequence object.\njet_i: The index of the first jet to be recombined.\njet_j: The index of the second jet to be recombined.\ndij: The distance between the two jets.\nrecombine=+: The recombination function to be used. Default is addition.\n\nReturns\n\nnewjet_k: The index of the newly created jet.\n\nDescription\n\nThis function performs the i-j recombination step in the cluster sequence. It creates a new jet by recombining the first two jets using the specified recombination function. The new jet is then added to the cluster sequence. The function also updates the indices and history information of the new jet and sorts out the history.\n\n\n\n\n\n","category":"function"},{"location":"lib/internal/#JetReconstruction.energy-Tuple{PseudoJet}","page":"Internal API","title":"JetReconstruction.energy","text":"energy(p::PseudoJet)\n\nReturn the energy of a PseudoJet.\n\nArguments\n\np::PseudoJet: The PseudoJet object.\n\nReturns\n\nThe energy of the PseudoJet.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.eta-Tuple{PseudoJet}","page":"Internal API","title":"JetReconstruction.eta","text":"eta(p::PseudoJet)\n\nCompute the pseudorapidity (η) of a PseudoJet.\n\nArguments\n\np::PseudoJet: The PseudoJet object for which to compute the pseudorapidity.\n\nReturns\n\nThe pseudorapidity (η) of the PseudoJet.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.fast_findmin-Tuple{Any, Any}","page":"Internal API","title":"JetReconstruction.fast_findmin","text":"fast_findmin(dij, n)\n\nFind the minimum value and its index in the first n elements of the dij array. The use of @turbo macro gives a significant performance boost.\n\nArguments\n\ndij: An array of values.\nn: The number of elements to consider in the dij array.\n\nReturns\n\ndij_min: The minimum value in the first n elements of the dij array.\nbest: The index of the minimum value in the dij array.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.find_tile_neighbours!-NTuple{5, Any}","page":"Internal API","title":"JetReconstruction.find_tile_neighbours!","text":"find_tile_neighbours!(tile_union, jetA, jetB, oldB, tiling)\n\nFind the union of neighbouring tiles of jetA, jetB, and oldB and add them to the tile_union. This established the set of tiles over which searches for updated and new nearest-neighbours must be run\n\nArguments\n\ntile_union: The tile union to which the neighbouring tiles will be added.\njetA: The first jet.\njetB: The second jet.\noldB: The old second jet.\ntiling: The tiling information.\n\nReturns\n\nThe number of neighbouring tiles added to the tile_union.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.geometric_distance-NTuple{4, AbstractFloat}","page":"Internal API","title":"JetReconstruction.geometric_distance","text":"geometric_distance(eta1::AbstractFloat, phi1::AbstractFloat, eta2::AbstractFloat, phi2::AbstractFloat)\n\nCompute the geometric distance between two points in the rap-phi plane.\n\nArguments\n\neta1::AbstractFloat: The eta coordinate of the first point.\nphi1::AbstractFloat: The phi coordinate of the first point.\neta2::AbstractFloat: The eta coordinate of the second point.\nphi2::AbstractFloat: The phi coordinate of the second point.\n\nReturns\n\ndistance::Float64: The geometric distance between the two points.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.get_algorithm_power_consistency-Tuple{}","page":"Internal API","title":"JetReconstruction.get_algorithm_power_consistency","text":"get_algorithm_power_consistency(; p::Union{Real, Nothing}, algorithm::Union{JetAlgorithm, Nothing})\n\nGet the algorithm and power consistency correct\n\nThis function checks the consistency between the algorithm and power parameters. If the algorithm is specified, it checks if the power parameter is consistent with the algorithm's known power. If the power parameter is not specified, it sets the power parameter based on the algorithm. If neither the algorithm nor the power parameter is specified, it throws an ArgumentError.\n\nArguments\n\np::Union{Real, Nothing}: The power value.\nalgorithm::Union{JetAlgorithm, Nothing}: The algorithm.\n\nReturns\n\nA named tuple of the consistent power and algorithm values.\n\nThrows\n\nArgumentError: If the algorithm and power are inconsistent or if neither the algorithm nor the power is specified.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.get_all_ancestors-Tuple{Any, ClusterSequence}","page":"Internal API","title":"JetReconstruction.get_all_ancestors","text":"get_all_ancestors(idx, cs::ClusterSequence)\n\nRecursively finds all ancestors of a given index in a ClusterSequence object.\n\nArguments\n\nidx: The index of the jet for which to find ancestors.\ncs: The ClusterSequence object containing the jet history.\n\nReturns\n\nAn array of indices representing the ancestors of the given jet.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.get_dij_dist-NTuple{4, Any}","page":"Internal API","title":"JetReconstruction.get_dij_dist","text":"get_dij_dist(nn_dist, kt2_1, kt2_2, R2)\n\nCompute the dij metric distance between two jets.\n\nArguments\n\nnn_dist: The nearest-neighbor distance between two jets.\nkt2_1: The squared momentum metric value of the first jet.\nkt2_2: The squared momentum metric value of the second jet.\nR2: The jet radius parameter squared.\n\nReturns\n\nThe distance between the two jets.\n\nIf kt2_2 is equal to 0.0, then the first jet doesn't actually have a valid neighbour, so it's treated as a single jet adjacent to the beam.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.get_tile-Tuple{JetReconstruction.TilingDef, AbstractFloat, AbstractFloat}","page":"Internal API","title":"JetReconstruction.get_tile","text":"get_tile(tiling_setup::TilingDef, eta::AbstractFloat, phi::AbstractFloat)\n\nGiven a tiling_setup object, eta and phi values, this function calculates the tile indices for the given eta and phi values.\n\nArguments\n\ntiling_setup: A TilingDef object that contains the tiling setup parameters.\neta: The eta value for which to calculate the tile index.\nphi: The phi value for which to calculate the tile index.\n\nReturns\n\nieta: The tile index along the eta direction.\niphi: The tile index along the phi direction.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.get_tile_cartesian_indices-Tuple{JetReconstruction.TilingDef, Int64}","page":"Internal API","title":"JetReconstruction.get_tile_cartesian_indices","text":"get_tile_linear_index(tiling_setup::TilingDef, i_η::Int, i_ϕ::Int)\n\nCompute the linear index of a tile in a tiled setup. This is much faster in this function than using the LinearIndices construct (like x100, which is bonkers, but there you go...)\n\nArguments\n\ntiling_setup::TilingDef: The tiling setup defining the number of tiles in each dimension.\ni_η::Int: The index of the tile in the η dimension.\ni_ϕ::Int: The index of the tile in the ϕ dimension.\n\nReturns\n\nThe linear index of the tile.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.initial_history-Tuple{Any}","page":"Internal API","title":"JetReconstruction.initial_history","text":"initial_history(particles)\n\nCreate an initial history for the given particles.\n\nArguments\n\nparticles: The initial vector of stable particles.\n\nReturns\n\nhistory: An array of HistoryElement objects.\nQtot: The total energy in the event.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.insert!-Tuple{JetReconstruction.TiledJet, JetReconstruction.TiledJet}","page":"Internal API","title":"JetReconstruction.insert!","text":"insert!(nextjet::TiledJet, jettomove::TiledJet)\n\nInserts a TiledJet object into the linked list of TiledJet objects, before the nextjet object. The jet to move can be an isolated jet, a jet from another list or a jet from the same list\n\nArguments\n\nnextjet::TiledJet: The TiledJet object after which jettomove should be inserted.\njettomove::TiledJet: The TiledJet object to be inserted.\n\nExample\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.is_ee-Tuple{JetReconstruction.JetAlgorithm.Algorithm}","page":"Internal API","title":"JetReconstruction.is_ee","text":"is_ee(algorithm::JetAlgorithm.Algorithm)\n\nCheck if the algorithm is a e+e- reconstruction algorithm.\n\nReturns\n\ntrue if the algorithm is a e+e- reconstruction algorithm, false otherwise.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.is_pp-Tuple{JetReconstruction.JetAlgorithm.Algorithm}","page":"Internal API","title":"JetReconstruction.is_pp","text":"is_pp(algorithm::JetAlgorithm.Algorithm)\n\nCheck if the algorithm is a pp reconstruction algorithm.\n\nReturns\n\ntrue if the algorithm is a pp reconstruction algorithm, false otherwise.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.isvalid-Tuple{JetReconstruction.TiledJet}","page":"Internal API","title":"JetReconstruction.isvalid","text":"isvalid(t::TiledJet)\n\nCheck if a TiledJet is valid, by seeing if it is not the noTiledJet object.\n\nArguments\n\nt::TiledJet: The TiledJet object to check.\n\nReturns\n\nBool: true if the TiledJet object is valid, false otherwise.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.jet_ranks-Tuple{ClusterSequence}","page":"Internal API","title":"JetReconstruction.jet_ranks","text":"jet_ranks(clusterseq::ClusterSequence; compare_fn = JetReconstruction.pt)\n\nCompute the ranks of jets in a given ClusterSequence object based on a specified comparison function.\n\nArguments\n\nclusterseq::ClusterSequence: The ClusterSequence object containing the jets to rank.\ncompare_fn = JetReconstruction.pt: The comparison function used to determine the order of the jets. Defaults to JetReconstruction.pt, which compares jets based on their transverse momentum.\n\nReturns\n\nA dictionary mapping each jet index to its rank.\n\nNote\n\nThis is a utility function that can be used to rank initial clusters based on a specified jet property. It can be used to assign a consistent \"rank\" to each reconstructed jet in the cluster sequence, which is useful for stable plotting of jet outputs.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.m-Tuple{PseudoJet}","page":"Internal API","title":"JetReconstruction.m","text":"m(p::PseudoJet)\n\nCompute the invariant mass of a PseudoJet object. By convention if m^2 < 0, then -sqrt{(-m^2)} is returned.\n\nArguments\n\np::PseudoJet: The PseudoJet object for which to compute the invariant mass.\n\nReturns\n\nThe invariant mass of the PseudoJet object.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.m2-Tuple{PseudoJet}","page":"Internal API","title":"JetReconstruction.m2","text":"m2(p::PseudoJet)\n\nCalculate the invariant mass squared (m^2) of a PseudoJet.\n\nArguments\n\np::PseudoJet: The PseudoJet object for which to calculate the invariant mass squared.\n\nReturns\n\nThe invariant mass squared (m^2) of the PseudoJet.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.mag-Tuple{PseudoJet}","page":"Internal API","title":"JetReconstruction.mag","text":"mag(p::PseudoJet)\n\nReturn the magnitude of the momentum of a PseudoJet, |p|.\n\nArguments\n\np::PseudoJet: The PseudoJet object for which to compute the magnitude.\n\nReturns\n\nThe magnitude of the PseudoJet object.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.mass-Tuple{PseudoJet}","page":"Internal API","title":"JetReconstruction.mass","text":"mass(p::PseudoJet)\n\nCompute the invariant mass (alias for m(p)).\n\nArguments\n\np::PseudoJet: The PseudoJet object for which to compute the mass.\n\nReturns\n\nThe mass of the PseudoJet.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.mass2","page":"Internal API","title":"JetReconstruction.mass2","text":"Alias for m2 function\n\n\n\n\n\n","category":"function"},{"location":"lib/internal/#JetReconstruction.merge_steps-Tuple{ClusterSequence}","page":"Internal API","title":"JetReconstruction.merge_steps","text":"merge_steps(clusterseq::ClusterSequence)\n\nCompute the number of jet-jet merge steps in a cluster sequence. This is useful to give the number of meaningful recombination steps in a jet reconstruction sequence (beam merge steps are not counted).\n\nArguments\n\nclusterseq::ClusterSequence: The cluster sequence object.\n\nReturns\n\nmerge_steps::Int: The number of merge steps.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.phi-Tuple{PseudoJet}","page":"Internal API","title":"JetReconstruction.phi","text":"phi(p::PseudoJet)\n\nCompute the ϕ angle of a PseudoJet object p.\n\nNote this function is a wrapper for phi_02pi(p).\n\nArguments\n\np::PseudoJet: The PseudoJet object for which to compute the azimuthal angle.\n\nReturns\n\nThe azimuthal angle of p in the range [0, 2π).\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.phi_02pi-Tuple{PseudoJet}","page":"Internal API","title":"JetReconstruction.phi_02pi","text":"phi_02pi(p::PseudoJet)\n\nCompute the azimuthal angle of a PseudoJet object p in the range [0, 2π).\n\nArguments\n\np::PseudoJet: The PseudoJet object for which to compute the azimuthal angle.\n\nReturns\n\nThe azimuthal angle of p in the range [0, 2π).\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.pt-Tuple{PseudoJet}","page":"Internal API","title":"JetReconstruction.pt","text":"pt(p::PseudoJet)\n\nCompute the scalar transverse momentum (pt) of a PseudoJet.\n\nArguments\n\np::PseudoJet: The PseudoJet object for which to compute the transverse momentum.\n\nReturns\n\nThe transverse momentum (pt) of the PseudoJet.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.pt2-Tuple{PseudoJet}","page":"Internal API","title":"JetReconstruction.pt2","text":"pt2(p::PseudoJet)\n\nGet the squared transverse momentum of a PseudoJet.\n\nArguments\n\np::PseudoJet: The PseudoJet object.\n\nReturns\n\nThe squared transverse momentum of the PseudoJet.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.px-Tuple{PseudoJet}","page":"Internal API","title":"JetReconstruction.px","text":"px(p::PseudoJet)\n\nReturn the x-component of the momentum of a PseudoJet.\n\nArguments\n\np::PseudoJet: The PseudoJet object.\n\nReturns\n\nThe x-component of the momentum of the PseudoJet.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.py-Tuple{PseudoJet}","page":"Internal API","title":"JetReconstruction.py","text":"py(p::PseudoJet)\n\nReturn the y-component of the momentum of a PseudoJet.\n\nArguments\n\np::PseudoJet: The PseudoJet object.\n\nReturns\n\nThe y-component of the momentum of the PseudoJet.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.pz-Tuple{PseudoJet}","page":"Internal API","title":"JetReconstruction.pz","text":"pz(p::PseudoJet)\n\nReturn the z-component of the momentum of a PseudoJet.\n\nArguments\n\np::PseudoJet: The PseudoJet object.\n\nReturns\n\nThe z-component of the momentum of the PseudoJet.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.rapidity-Tuple{PseudoJet}","page":"Internal API","title":"JetReconstruction.rapidity","text":"rapidity(p::PseudoJet)\n\nCompute the rapidity of a PseudoJet object.\n\nArguments\n\np::PseudoJet: The PseudoJet object for which to compute the rapidity.\n\nReturns\n\nThe rapidity of the PseudoJet object.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.reco_state-Tuple{ClusterSequence, Any}","page":"Internal API","title":"JetReconstruction.reco_state","text":"reco_state(cs::ClusterSequence, pt_ranks; iteration=0)\n\nThis function returns the reconstruction state of a ClusterSequence object based on a given iteration number in the reconstruction.\n\nArguments\n\ncs::ClusterSequence: The ClusterSequence object to update.\nranks: The ranks of the original clusters, that are inherited by pseudojets\n\nduring the reconstruction process.\n\niteration=0: The iteration number to consider for updating the reconstruction state (0 represents the initial state).\nignore_beam_merge=true: Ignore beam merging steps in the reconstruction (which produce no change in status).\n\nReturns\n\nA dictionary representing a snapshot of the reconstruction state.\n\nDetails\n\nThe function starts by initializing the reconstruction state with the initial particles. Then, it walks over the iteration sequence and updates the reconstruction state based on the history of recombination and finalization/beam merger steps.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.rightneighbours-Tuple{Int64, JetReconstruction.Tiling}","page":"Internal API","title":"JetReconstruction.rightneighbours","text":"rightneighbours(center::Int, tiling::Tiling)\n\nCompute the indices of the right neighbors of a given center index in a tiling. This is used in the initial sweep to calculate the nearest neighbors, where the search between jets for the nearest neighbour is bi-directional, thus when a tile is considered only the right neighbours are needed to compare jet distances as the left-hand tiles have been done from that tile already.\n\nArguments\n\ncenter::Int: The center index.\ntiling::Tiling: The tiling object.\n\nReturns\n\nSurrounding: An object containing the indices of the right neighbors.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.set_momentum!-Tuple{PseudoJet, Vararg{Any, 4}}","page":"Internal API","title":"JetReconstruction.set_momentum!","text":"set_momentum!(j::PseudoJet, px, py, pz, E)\n\nSet the momentum components and energy of a PseudoJet object.\n\nArguments\n\nj::PseudoJet: The PseudoJet object to set the momentum for.\npx: The x-component of the momentum.\npy: The y-component of the momentum.\npz: The z-component of the momentum.\nE: The energy of the particle.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.set_nearest_neighbours!-Tuple{ClusterSequence, JetReconstruction.Tiling, Vector{JetReconstruction.TiledJet}}","page":"Internal API","title":"JetReconstruction.set_nearest_neighbours!","text":"set_nearest_neighbours!(clusterseq::ClusterSequence, tiling::Tiling, tiledjets::Vector{TiledJet})\n\nThis function sets the nearest neighbor information for all jets in the tiledjets vector.\n\nArguments\n\nclusterseq::ClusterSequence: The cluster sequence object.\ntiling::Tiling: The tiling object.\ntiledjets::Vector{TiledJet}: The vector of tiled jets.\n\nReturns\n\nNNs::Vector{TiledJet}: The vector of nearest neighbor jets.\ndiJ::Vector{Float64}: The vector of diJ values.\n\nThe function iterates over each tile in the tiling and sets the nearest neighbor information for each jet in the tile. It then looks for neighbor jets in the neighboring tiles and updates the nearest neighbor information accordingly. Finally, it creates the diJ table and returns the vectors of nearest neighbor jets and diJ values.\n\nNote: The diJ values are calculated as the kt distance multiplied by R^2.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.setup_tiling-Union{Tuple{T}, Tuple{Vector{T}, AbstractFloat}} where T<:AbstractFloat","page":"Internal API","title":"JetReconstruction.setup_tiling","text":"setup_tiling(eta::Vector{T}, Rparam::AbstractFloat) where T <: AbstractFloat\n\nThis function sets up the tiling parameters for a reconstruction given a vector of rapidities eta and a radius parameter Rparam.\n\nArguments\n\neta::Vector{T}: A vector of rapidities.\nRparam::AbstractFloat: The jet radius parameter.\n\nReturns\n\ntiling_setup: A TilingDef object containing the tiling setup parameters.\n\nDescription\n\nThe function first decides the tile sizes based on the Rparam value. It then determines the number of tiles in the phi direction (n_tiles_phi) based on the tile size. Next, it determines the rapidity extent of the input eta vector and adjusts the values accordingly. Finally, it creates a TilingDef object with the calculated tiling parameters and returns it.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.surrounding-Tuple{Int64, JetReconstruction.Tiling}","page":"Internal API","title":"JetReconstruction.surrounding","text":"surrounding(center::Int, tiling::Tiling)\n\nCompute the surrounding indices of a given center index in a tiling.\n\nArguments\n\ncenter::Int: The center index.\ntiling::Tiling: The tiling object.\n\nReturns\n\nSurrounding: An object containing the surrounding indices.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.tile_index-Tuple{Any, Float64, Float64}","page":"Internal API","title":"JetReconstruction.tile_index","text":"tile_index(tiling_setup, eta::Float64, phi::Float64)\n\nCompute the tile index for a given (eta, phi) coordinate.\n\nArguments\n\ntiling_setup: The tiling setup object containing the tile size and number of tiles.\neta::Float64: The eta coordinate.\nphi::Float64: The phi coordinate.\n\nReturns\n\nThe tile index corresponding to the (eta, phi) coordinate.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.tiledjet_remove_from_tiles!-Tuple{Any, Any}","page":"Internal API","title":"JetReconstruction.tiledjet_remove_from_tiles!","text":"tiledjet_remove_from_tiles!(tiling, jet)\n\nRemove a jet from the given tiling structure.\n\nArguments\n\ntiling: The tiling structure from which the jet will be removed.\njet: The jet to be removed from the tiling structure.\n\nDescription\n\nThis function removes a jet from the tiling structure. It adjusts the linked list to be consistent with the removal of the jet.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.tiledjet_set_jetinfo!-Tuple{JetReconstruction.TiledJet, ClusterSequence, JetReconstruction.Tiling, Any, Any, Any}","page":"Internal API","title":"JetReconstruction.tiledjet_set_jetinfo!","text":"tiledjet_set_jetinfo!(jet::TiledJet, clusterseq::ClusterSequence, tiling::Tiling, jets_index, R2, p)\n\nInitialise a tiled jet from a PseudoJet (using an index into our ClusterSequence)\n\nArguments:\n\njet::TiledJet: The TiledJet object to set the information for.\nclusterseq::ClusterSequence: The ClusterSequence object containing the jets.\ntiling::Tiling: The Tiling object containing the tile information.\njets_index: The index of the jet in the ClusterSequence.\nR2: The jet radius parameter squared.\np: The power to raise the pt2 value to.\n\nThis function sets the eta, phi, kt2, jetsindex, NNdist, NN, tile_index, previous, and next fields of the TiledJet object.\n\nReturns:\n\nnothing\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.upd_nn_crosscheck!-Tuple{Int64, Int64, Int64, Vararg{Any, 5}}","page":"Internal API","title":"JetReconstruction.upd_nn_crosscheck!","text":"upd_nn_crosscheck!(i, from, to, rapidity_array, phi_array, R2, nndist, nn)\n\nUpdate the nearest neighbor information for a given particle index i against all particles in the range indexes from to to. The function updates the nndist and nn arrays with the nearest neighbor distance and index respectively, both for particle i and the checked particles [from:to] (hence crosscheck).\n\nArguments\n\ni::Int: The index of the particle to update and check against.\nfrom::Int: The starting index of the range of particles to check against.\nto::Int: The ending index of the range of particles to check against.\nrapidity_array: An array containing the rapidity values of all particles.\nphi_array: An array containing the phi values of the all particles.\nR2: The squared jet distance threshold for considering a particle as a neighbour.\nnndist: The array that stores the nearest neighbor distances.\nnn: The array that stores the nearest neighbor indices.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.upd_nn_nocross!-Tuple{Int64, Int64, Int64, Vararg{Any, 5}}","page":"Internal API","title":"JetReconstruction.upd_nn_nocross!","text":"upd_nn_nocross!(i, from, to, rapidity_array, phi_array, R2, nndist, nn)\n\nUpdate the nearest neighbor information for a given particle index i against all particles in the range indexes from to to. The function updates the nndist and nn arrays with the nearest neighbor distance and index respectively, only for particle i (hence nocross).\n\nArguments\n\ni::Int: The index of the particle to update and check against.\nfrom::Int: The starting index of the range of particles to check against.\nto::Int: The ending index of the range of particles to check against.\nrapidity_array: An array containing the rapidity values of all particles.\nphi_array: An array containing the phi values of the all particles.\nR2: The squared jet distance threshold for considering a particle as a neighbour.\nnndist: The array that stores the nearest neighbor distances.\nnn: The array that stores the nearest neighbor indices.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.upd_nn_step!-NTuple{12, Any}","page":"Internal API","title":"JetReconstruction.upd_nn_step!","text":"upd_nn_step!(i, j, k, N, Nn, kt2_array, rapidity_array, phi_array, R2, nndist, nn, nndij)\n\nUpdate the nearest neighbor information after a jet merge step.\n\nArguments:\n\ni: Index of the first particle in the last merge step.\nj: Index of the second particle in the last merge step.\nk: Index of the current particle for which the nearest neighbour will be updated.\nN: Total number of particles (currently valid array indexes are [1:N]).\nNn: Number of nearest neighbors to consider.\nkt2_array: Array of transverse momentum squared values.\nrapidity_array: Array of rapidity values.\nphi_array: Array of azimuthal angle values.\nR2: Distance threshold squared for nearest neighbors.\nnndist: Array of nearest neighbor geometric distances.\nnn: Array of nearest neighbor indices.\nnndij: Array of metric distances between particles.\n\nThis function updates the nearest neighbor information for the current particle k by considering the distances to particles i and j. It checks if the distance between k and i is smaller than the current nearest neighbor distance for k, and updates the nearest neighbor information accordingly. It also updates the nearest neighbor information for i if the distance between k and i is smaller than the current nearest neighbor distance for i. Finally, it checks if the nearest neighbor of k is the total number of particles Nn and updates it to j if necessary.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.η","page":"Internal API","title":"JetReconstruction.η","text":"const η = eta\n\nAlias for the pseudorapidity function, eta.\n\n\n\n\n\n","category":"function"},{"location":"lib/internal/#JetReconstruction.EERecoJet","page":"Internal API","title":"JetReconstruction.EERecoJet","text":"mutable struct EERecoJet{T <: Real}\n\nOptimised struct for e+e jets reconstruction, to be used with StructArrays.\n\nFields\n\nindex::Int: The index of the jet.\nnni::Int: The nearest neighbour index.\nnndist::T: The distance to the nearest neighbour.\ndijdist::T: The distance between jets.\nnx::T: The x-component of the jet's momentum.\nny::T: The y-component of the jet's momentum.\nnz::T: The z-component of the jet's momentum.\nE2p::T: The energy raised to the power of 2p for this jet.\n\nType Parameters\n\nT <: Real: The type of the numerical values.\n\n\n\n\n\n","category":"type"},{"location":"lib/internal/#JetReconstruction.FourMomentum","page":"Internal API","title":"JetReconstruction.FourMomentum","text":"Interface for composite types that includes fields px, py, py, and E that represents the components of a four-momentum vector.\n\n\n\n\n\n","category":"type"},{"location":"lib/internal/#JetReconstruction.HistoryElement","page":"Internal API","title":"JetReconstruction.HistoryElement","text":"struct HistoryElement\n\nA struct holding a record of jet mergers and finalisations\n\nFields:\n\nparent1: Index in history where first parent of this jet was created (NonexistentParent if this jet is an original particle)\nparent2: Index in history where second parent of this jet was created (NonexistentParent if this jet is an original particle); BeamJet if this history entry just labels the fact that the jet has recombined with the beam)\nchild: Index in history where the current jet is recombined with another jet to form its child. It is Invalid if this jet does not further recombine.\njetp_index: Index in the jets vector where we will find the PseudoJet object corresponding to this jet (i.e. the jet created at this entry of the history). NB: if this element of the history corresponds to a beam recombination, then jetp_index=Invalid.\ndij: The distance corresponding to the recombination at this stage of the clustering.\nmax_dij_so_far: The largest recombination distance seen so far in the clustering history.\n\n\n\n\n\n","category":"type"},{"location":"lib/internal/#JetReconstruction.HistoryElement-Tuple{Any}","page":"Internal API","title":"JetReconstruction.HistoryElement","text":"HistoryElement(jetp_index)\n\nConstructs a HistoryElement object with the given jetp_index, used for initialising the history with original particles.\n\nArguments\n\njetp_index: The index of the jetp.\n\nReturns\n\nA HistoryElement object.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.JetWithAncestors","page":"Internal API","title":"JetReconstruction.JetWithAncestors","text":"struct JetWithAncestors\n\nA struct representing a jet with its origin ancestors.\n\nFields\n\nself::PseudoJet: The PseudoJet object for this jet.\njetp_index::Int: The index of the jet in the corresponding cluster sequence.\nancestors::Set{Int}: A set of indices representing the jetp_indexes of ancestors of the jet (in the cluster sequence).\njet_rank::Int: The rank of the jet based on a comparison of all of the jet's ancestors\n\nNote\n\nThis structure needs its associated cluster sequence origin to be useful.\n\n\n\n\n\n","category":"type"},{"location":"lib/internal/#JetReconstruction.Surrounding","page":"Internal API","title":"JetReconstruction.Surrounding","text":"struct Surrounding{N}\n\nStructure used for iterating over neighbour tiles.\n\nFields\n\nindices::NTuple{N, Int}: A tuple of N integers representing the indices.\n\n\n\n\n\n","category":"type"},{"location":"lib/internal/#JetReconstruction.TiledJet","page":"Internal API","title":"JetReconstruction.TiledJet","text":"struct TiledJet\n\nTiledJet represents a jet in a tiled algorithm for jet reconstruction, with additional information to track the jet's position in the tiled structures.\n\nFields\n\nid::Int: The ID of the jet.\neta::Float64: The rapidity of the jet.\nphi::Float64: The azimuthal angle of the jet.\nkt2::Float64: The transverse momentum squared of the jet.\nNN_dist::Float64: The distance to the nearest neighbor.\njets_index::Int: The index of the jet in the jet array.\ntile_index::Int: The index of the tile in the tile array.\ndij_posn::Int: The position of this jet in the dij compact array.\nNN::TiledJet: The nearest neighbor.\nprevious::TiledJet: The previous jet.\nnext::TiledJet: The next jet.\n\n\n\n\n\n","category":"type"},{"location":"lib/internal/#JetReconstruction.TiledJet-Tuple{Any}","page":"Internal API","title":"JetReconstruction.TiledJet","text":"TiledJet(id)\n\nConstructs a TiledJet object with the given id and initializes its properties to zero.\n\nArguments\n\nid: The ID of the TiledJet object.\n\nReturns\n\nA TiledJet object with the specified id and values set to zero or noTiledJet.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.Tiling","page":"Internal API","title":"JetReconstruction.Tiling","text":"struct Tiling\n\nThe Tiling struct represents a tiling configuration for jet reconstruction.\n\nFields\n\nsetup::TilingDef: The tiling definition used for the configuration.\ntiles::Matrix{TiledJet}: A matrix of tiled jets, containing the first jet in each tile (then the linked list of the first jet is followed to get access to all jets in this tile).\npositions::Matrix{Int}: Used to track tiles that are on the edge of ϕ array, where neighbours need to be wrapped around.\ntags::Matrix{Bool}: The matrix of tags indicating whether a tile is valid or not (set to false initially, then true when the tile has been setup properly).\n\n\n\n\n\n","category":"type"},{"location":"lib/internal/#JetReconstruction.Tiling-Tuple{JetReconstruction.TilingDef}","page":"Internal API","title":"JetReconstruction.Tiling","text":"Tiling(setup::TilingDef)\n\nConstructs a initial Tiling object based on the provided setup parameters.\n\nArguments\n\nsetup::TilingDef: The setup parameters for the tiling.\n\nReturns\n\nA Tiling object.\n\n\n\n\n\n","category":"method"},{"location":"lib/internal/#JetReconstruction.TilingDef","page":"Internal API","title":"JetReconstruction.TilingDef","text":"struct TilingDef\n\nA struct representing the definition of a specific tiling scheme.\n\nFields\n\n_tiles_eta_min::Float64: The minimum rapidity of the tiles.\n_tiles_eta_max::Float64: The maximum rapidity of the tiles.\n_tile_size_eta::Float64: The size of a tile in rapidity (usually R^2).\n_tile_size_phi::Float64: The size of a tile in phi (usually a bit more than R^2).\n_n_tiles_eta::Int: The number of tiles across rapidity.\n_n_tiles_phi::Int: The number of tiles across phi.\n_n_tiles::Int: The total number of tiles.\n_tiles_ieta_min::Int: The minimum rapidity tile index.\n_tiles_ieta_max::Int: The maximum rapidity tile index.\n\nConstructor\n\nTilingDef(_tiles_eta_min, _tiles_eta_max, _tile_size_eta, _tile_size_phi,\n\t_n_tiles_eta, _n_tiles_phi, _tiles_ieta_min, _tiles_ieta_max)\n\nConstructs a TilingDef object with the given parameters.\n\n\n\n\n\n","category":"type"},{"location":"lib/internal/#JetReconstruction.neighbour_tiles","page":"Internal API","title":"JetReconstruction.neighbour_tiles","text":"struct neighbour_tiles\n\nA struct representing the neighbouring tiles.\n\nA struct for iterating over all neighbour tiles for a given Cartesian tile index. These are the tiles above and to the right of the given tile (X=included, O=not included):\n\nXXX\nX.X\nXXX\n\nNote, rapidity coordinate must be in range, ϕ coordinate wraps\n\nFields\n\nn_η::Int: Number of η tiles\nn_ϕ::Int: Number of ϕ tiles\nstart_η::Int: Centre η tile coordinate\nstart_ϕ::Int: Centre ϕ tile coordinate\n\n\n\n\n\n","category":"type"},{"location":"lib/internal/#JetReconstruction.rightmost_tiles","page":"Internal API","title":"JetReconstruction.rightmost_tiles","text":"struct rightmost_tiles\n\nA struct for iterating over rightmost tiles for a given Cartesian tile index. These are the tiles above and to the right of the given tile (X=included, O=not included):\n\nXXX\nO.X\nOOO\n\nNote, rapidity coordinate must be in range, ϕ coordinate wraps\n\nFields\n\nn_η::Int: Number of η tiles\nn_ϕ::Int: Number of ϕ tiles\nstart_η::Int: Centre η tile coordinate\nstart_ϕ::Int: Centre ϕ tile coordinate\n\n\n\n\n\n","category":"type"}] } diff --git a/previews/PR97/strategy/index.html b/previews/PR97/strategy/index.html index 00ce60c..b98c313 100644 --- a/previews/PR97/strategy/index.html +++ b/previews/PR97/strategy/index.html @@ -1,2 +1,2 @@ -Reconstruction Strategies · JetReconstruction.jl
GitHub

Algorithm Strategy

For the $pp$ algorithms three strategies are available for the different algorithms, which can be specified by passing the named argument strategy=... to the reconstruction.

Strategy NameNotesInterface
RecoStrategy.BestDynamically switch strategy based on input particle densityjet_reconstruct
RecoStrategy.N2PlainGlobal matching of particles at each interation (works well for low $N$)plain_jet_reconstruct
RecoStrategy.N2TiledUse tiles of radius $R$ to limit search space (works well for higher $N$)tiled_jet_reconstruct

Generally one can use the jet_reconstruct interface, shown above, as the Best strategy safely as the overhead is extremely low. That interface supports a strategy option to switch to a different option.

For $e^+e^-$ algorithms particle densities are low, so the only implementation is of the same type as N2Plain.

+Reconstruction Strategies · JetReconstruction.jl
GitHub

Algorithm Strategy

For the $pp$ algorithms three strategies are available for the different algorithms, which can be specified by passing the named argument strategy=... to the reconstruction.

Strategy NameNotesInterface
RecoStrategy.BestDynamically switch strategy based on input particle densityjet_reconstruct
RecoStrategy.N2PlainGlobal matching of particles at each interation (works well for low $N$)plain_jet_reconstruct
RecoStrategy.N2TiledUse tiles of radius $R$ to limit search space (works well for higher $N$)tiled_jet_reconstruct

Generally one can use the jet_reconstruct interface, shown above, as the Best strategy safely as the overhead is extremely low. That interface supports a strategy option to switch to a different option.

For $e^+e^-$ algorithms particle densities are low, so the only implementation is of the same type as N2Plain.

diff --git a/previews/PR97/visualisation/index.html b/previews/PR97/visualisation/index.html index 9863ab5..56e0afb 100644 --- a/previews/PR97/visualisation/index.html +++ b/previews/PR97/visualisation/index.html @@ -1,5 +1,5 @@ -Visualisation · JetReconstruction.jl
GitHub

Jet Visualisation Documentation

Documentation for visualisation interfaces extension module.

Plotting and Animation

illustration

To visualise the clustered jets as a 3d bar plot (see illustration above) Makie.jl is used. See the jetsplot function in ext/JetVisualisation.jl and its documentation for more. There are two worked examples in the examples directory of this package.

The plotting code is a package extension and will load if the one of the Makie modules is loaded in the environment.

The animatereco function will animate the reconstruction sequence, given a ClusterSequence object. See the function documentation below for the many options that can be customised.

Function Index

Jet Visualisation Public Interfaces

JetReconstruction.animatereco — Method
animatereco(cs::ClusterSequence, filename;
+Visualisation · JetReconstruction.jl
GitHub
Jet Visualisation Documentation
Documentation for visualisation interfaces extension module.
Plotting and Animation
illustration
To visualise the clustered jets as a 3d bar plot (see illustration above) Makie.jl is used. See the jetsplot function in ext/JetVisualisation.jl and its documentation for more. There are two worked examples in the examples directory of this package.
The plotting code is a package extension and will load if the one of the Makie modules is loaded in the environment.
The animatereco function will animate the reconstruction sequence, given a ClusterSequence object. See the function documentation below for the many options that can be customised.
Function Index
Jet Visualisation Public Interfaces
JetReconstruction.animatereco — Method
animatereco(cs::ClusterSequence, filename;
             barsize_phi = 0.1,
             barsize_y = 0.1,
             colormap = :glasbey_category10_n256,
@@ -8,7 +8,7 @@
             elevation = 0.5,
             framerate = 5,
             ancestors = false,
-            Module = Makie)
Animate the jet reconstruction process and save it as a video file.
Arguments
  • cs::ClusterSequence: The cluster sequence object containing the jets.
  • filename: The name of the output video file.
Optional Arguments
  • barsize_phi=0.1: The size of the bars in the phi direction.
  • barsize_y=0.1: The size of the bars in the y direction.
  • colormap=:glasbey_category10_n256: The colormap to use for coloring the jets.
  • perspective=0.5: The perspective of the plot.
  • azimuth=2.7: The azimuth angle of the plot.
  • elevation=0.5: The elevation angle of the plot.
  • framerate=5: The framerate of the output video.
  • end_frames=0: The number of static frames to show at the end of the animation. This can be useful to show the final state of the jets for a longer time.
  • title=nothing: The title to add to the plot.
  • ancestors=false: Whether to include ancestors of the jets in the animation. When true the ancestors of the jets will be plotted as well, as height zero bars, with the same colour as the jet they are ancestors of.
  • Module: The plotting module to use. Default is Makie.
For perspective, azimuth, and elevation, a single value can be passed for a fixed viewpoint, or a tuple of two values for a changing viewpoint. The viewpoint will then change linearly between the two values over the course of the animation.
Returns
  • fig: The figure object representing the final frame.
source
JetReconstruction.jetsplot — Method
jetsplot(objects, idx_arrays; barsize_phi=0.1, barsize_eta=0.1, colormap=:glasbey_hv_n256, Module=Main)
Plots a 3d bar chart that represents jets. Takes an objects array of objects to display and idx_arrays, an array of arrays with indices, where idx_arrays[i] gives indices of objects that form the jet number i. This function's signature might not be the most practical for the current version of the JetReconstruction.jl package, as it has been written during the early stage of development. There is now an overload of it that takes a ClusterSequence object as its argument.
Optional arguments: barsize_phi::Real — width of a bar along the ϕ axis; barsize_eta::Real — width of a bar along the η axis; colormap::Symbol — Makie colour map; Module — the module where you have your Makie (see below);
# example
+            Module = Makie)
Animate the jet reconstruction process and save it as a video file.
Arguments
  • cs::ClusterSequence: The cluster sequence object containing the jets.
  • filename: The name of the output video file.
Optional Arguments
  • barsize_phi=0.1: The size of the bars in the phi direction.
  • barsize_y=0.1: The size of the bars in the y direction.
  • colormap=:glasbey_category10_n256: The colormap to use for coloring the jets.
  • perspective=0.5: The perspective of the plot.
  • azimuth=2.7: The azimuth angle of the plot.
  • elevation=0.5: The elevation angle of the plot.
  • framerate=5: The framerate of the output video.
  • end_frames=0: The number of static frames to show at the end of the animation. This can be useful to show the final state of the jets for a longer time.
  • title=nothing: The title to add to the plot.
  • ancestors=false: Whether to include ancestors of the jets in the animation. When true the ancestors of the jets will be plotted as well, as height zero bars, with the same colour as the jet they are ancestors of.
  • Module: The plotting module to use. Default is Makie.
For perspective, azimuth, and elevation, a single value can be passed for a fixed viewpoint, or a tuple of two values for a changing viewpoint. The viewpoint will then change linearly between the two values over the course of the animation.
Returns
  • fig: The figure object representing the final frame.
source
JetReconstruction.jetsplot — Method
jetsplot(objects, idx_arrays; barsize_phi=0.1, barsize_eta=0.1, colormap=:glasbey_hv_n256, Module=Main)
Plots a 3d bar chart that represents jets. Takes an objects array of objects to display and idx_arrays, an array of arrays with indices, where idx_arrays[i] gives indices of objects that form the jet number i. This function's signature might not be the most practical for the current version of the JetReconstruction.jl package, as it has been written during the early stage of development. There is now an overload of it that takes a ClusterSequence object as its argument.
Optional arguments: barsize_phi::Real — width of a bar along the ϕ axis; barsize_eta::Real — width of a bar along the η axis; colormap::Symbol — Makie colour map; Module — the module where you have your Makie (see below);
# example
 using CairoMakie # use any other Makie that you have here
 
 jetsplot([object1, object2, object3], [[1], [2, 3]])
The example above plots object1 as a separate jet in one colour and object2 and object3 together in another colour.
This function needs Makie.jl to work. You should install and import/use a specific backend yourself. jetsplot works with CairoMakie, WGLMakie, GLMakie, etc. Additionally, you can specify the module where you have your Makie explicitly:
import CairoMakie
@@ -18,7 +18,7 @@
 jetsplot(my_objects, my_colour_arrays, Module=GLMakie)
 
 using WGLMakie
-jetsplot(my_objects, my_colour_arrays, Module=Main) #default
source
JetReconstruction.jetsplot — Method
jetsplot(objects, cs::ClusterSequence; barsize_phi=0.1, barsize_eta=0.1, colormap=:glasbey_hv_n256, Module=Main)
Plots a 3d bar chart that represents jets. Takes objects, an array of objects to display (should be the same array you have passed to jet_reconstruct to get the cs::ClusterSequence), and the cs::ClusterSequence itself as arguments.
Optional arguments: barsize_phi::Real — width of a bar along the ϕ axis; barsize_eta::Real — width of a bar along the η axis; colormap::Symbol — Makie colour map; Module — the module where you have your Makie (see below);
# example
+jetsplot(my_objects, my_colour_arrays, Module=Main) #default
source
JetReconstruction.jetsplot — Method
jetsplot(objects, cs::ClusterSequence; barsize_phi=0.1, barsize_eta=0.1, colormap=:glasbey_hv_n256, Module=Main)
Plots a 3d bar chart that represents jets. Takes objects, an array of objects to display (should be the same array you have passed to jet_reconstruct to get the cs::ClusterSequence), and the cs::ClusterSequence itself as arguments.
Optional arguments: barsize_phi::Real — width of a bar along the ϕ axis; barsize_eta::Real — width of a bar along the η axis; colormap::Symbol — Makie colour map; Module — the module where you have your Makie (see below);
# example
 using CairoMakie # use any other Makie that you have here
 jetsplot([object1, object2, object3], cluster_sequence_I_got_from_jet_reconstruct; Module=CairoMakie)
This function needs Makie.jl to work. You should install and import/use a specific backend yourself. jetsplot works with CairoMakie, WGLMakie, GLMakie, etc. Additionally, you can specify the module where you have your Makie explicitly:
import CairoMakie
 jetsplot(my_objects, cs, Module=CairoMakie)
@@ -27,4 +27,4 @@
 jetsplot(my_objects, cs, Module=GLMakie)
 
 using WGLMakie
-jetsplot(my_objects, cs, Module=Main) #default
source

+jetsplot(my_objects, cs, Module=Main) #default
source