fix dump in jetreco and instrumented-jetreco examples (#182)

* fix dump in jetreco and instrumented-jetreco examples

* Refactor fixed dump option

Rename the jets selected as "selectedjets" to avoid confusion
with too many "final jets".

Add a test of this option to the example testing script "test.sh"

---------

Co-authored-by: Graeme A Stewart <[email protected]>

Author: m-fila

examples/.gitignore

@@ -6,3 +6,5 @@
 profile/*
 # Playground for development scripts and notebooks
 playground/*
+# Ignore outputs from tests
+test-output*

examples/instrumented-jetreco.jl

@@ -159,24 +159,24 @@ function benchmark_jet_reco(events::Vector{Vector{T}};
             cs = jet_reconstruct(event; R = distance, p = p, algorithm = algorithm,
                                  strategy = strategy, recombine...)
             if !isnothing(njets)
-                finaljets = exclusive_jets(cs; njets = njets)
+                selectedjets = exclusive_jets(cs; njets = njets)
             elseif !isnothing(dcut)
-                finaljets = exclusive_jets(cs; dcut = dcut)
+                selectedjets = exclusive_jets(cs; dcut = dcut)
             else
-                finaljets = inclusive_jets(cs; ptmin = ptmin)
+                selectedjets = inclusive_jets(cs; ptmin = ptmin)
             end
             # Only print the jet content once
             if irun == 0 || nsamples == 1
                 @info begin
                     jet_output = "Event $(ievt)\n"
-                    sort!(finaljets, by = x -> pt(x), rev = true)
-                    for (ijet, jet) in enumerate(finaljets)
+                    sort!(selectedjets, by = x -> pt(x), rev = true)
+                    for (ijet, jet) in enumerate(selectedjets)
                         jet_output *= " $(ijet) - $(jet)\n"
                     end
                     "$(jet_output)"
                 end
                 if !isnothing(dump)
-                    push!(jet_collection, FinalJets(ievt, finaljets))
+                    push!(jet_collection, FinalJets(ievt, final_jets(selectedjets)))
                 end
                 if dump_cs
                     println("Cluster sequence for event $(ievt)")

examples/jetreco.jl

@@ -34,6 +34,11 @@ function jet_process(events::Vector{Vector{T}};
                      dump::Union{String, Nothing} = nothing) where {T <:
                                                                     JetReconstruction.FourMomentum}
 
+    # If we are dumping the results, setup the JSON structure
+    if !isnothing(dump)
+        jet_collection = FinalJets[]
+    end
+
     # Set consistent algorithm power
     p = JetReconstruction.get_algorithm_power(p = p, algorithm = algorithm)
     @info "Jet reconstruction will use $(algorithm) with power $(p)"
@@ -54,22 +59,22 @@ function jet_process(events::Vector{Vector{T}};
                                       strategy = strategy)
         # Now select jets, with inclusive or exclusive parameters
         if !isnothing(njets)
-            finaljets = exclusive_jets(cluster_seq; njets = njets)
+            selectedjets = exclusive_jets(cluster_seq; njets = njets)
         elseif !isnothing(dcut)
-            finaljets = exclusive_jets(cluster_seq; dcut = dcut)
+            selectedjets = exclusive_jets(cluster_seq; dcut = dcut)
         else
-            finaljets = inclusive_jets(cluster_seq; ptmin = ptmin)
+            selectedjets = inclusive_jets(cluster_seq; ptmin = ptmin)
         end
         @info begin
             jet_output = "Event $(ievt)\n"
-            sort!(finaljets, by = x -> pt(x), rev = true)
-            for (ijet, jet) in enumerate(finaljets)
+            sort!(selectedjets, by = x -> pt(x), rev = true)
+            for (ijet, jet) in enumerate(selectedjets)
                 jet_output *= " $(ijet) - $(jet)\n"
             end
             "$(jet_output)"
         end
         if !isnothing(dump)
-            push!(jet_collection, FinalJets(ievt, finaljets))
+            push!(jet_collection, FinalJets(ievt, final_jets(selectedjets)))
         end
     end
 

examples/test.sh

@@ -12,6 +12,9 @@ julia --project instrumented-jetreco.jl --algorithm=CA -R 1.0 ../test/data/event
 echo "pp 14TeV Kt"
 julia --project instrumented-jetreco.jl --algorithm=Kt -R 1.0 ../test/data/events.pp13TeV.hepmc3.zst
 
+echo "pp 14TeV Kt with dump option"
+julia --project instrumented-jetreco.jl --algorithm=Kt -R 1.0 ../test/data/events.pp13TeV.hepmc3.zst --dump test-output-pp.csv
+
 echo "ee H Durham allocation test"
 julia --project instrumented-jetreco.jl --algorithm=Durham --alloc ../test/data/events.eeH.hepmc3.zst
 
@@ -21,3 +24,5 @@ julia --project jetreco.jl --algorithm=CA -R 1.0 ../test/data/events.pp13TeV.hep
 echo "ee basic reco test"
 julia --project jetreco.jl --algorithm=EEKt -R 1.0 -p -1.0 ../test/data/events.eeH.hepmc3.zst
 
+echo "ee basic reco test with dump"
+julia --project jetreco.jl --algorithm=EEKt -R 1.0 -p -1.0 ../test/data/events.eeH.hepmc3.zst --dump test-output-ee.csv