Jet Reconstruction Examples
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.
Note: because of extra dependencies in these scripts, one must use the Project.toml file in the examples directory.
Standalone Basic Reconstruction Examples
jetreco.jl
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.
julia --project=examples examples/jetreco.jl --algorithm=AntiKt test/data/events.pp13TeV.hepmc3.gz
...
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.hepmc3Visualisation
This subdirectory contains examples showing how to use built in support for visualising jets - either a final reconstruction state or an animation of the reconstruction process.
Particularly here the heavy Makie dependency is contained in the Project.toml file for these examples only.
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.
julia --project visualise-jets.jl -A AntiKt -R 1.0 ../../test/data/events.pp13TeV.hepmc3.gz test-pp.pngvisualise-jets.ipynb and visualise-jets-nb.ipynb
Similar to visualise-jets.jl these notebooks 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.
The first example is a Jupyter notebook, the second runs in Pluto.
animate-reconstruction.jl
Performs jet reconstruction and then produces and animation of the process, showing how the jets merge from their different constituents.
julia --project animate-reconstruction.jl -A AntiKt -R 1.0 ../../test/data/events.pp13TeV.hepmc3.gz test-pp.mp4EDM4hep
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.