Improved animation script (#189)

* Improved animation script

Allow framerate, extra frames and title to be specified.

Small patch to the HepMC3 summary script to print the
particle density per event.

* Add ancestors option

Author: graeme-a-stewart

examples/visualisation/animate-reconstruction.jl

@@ -26,6 +26,7 @@ function main()
         "--algorithm", "-A"
         help = """Algorithm to use for jet reconstruction: $(join(JetReconstruction.AllJetRecoAlgorithms, ", "))"""
         arg_type = JetAlgorithm.Algorithm
+        default = JetAlgorithm.AntiKt
 
         "--power", "-p"
         help = """Power value for jet reconstruction"""
@@ -36,6 +37,23 @@ function main()
         arg_type = RecoStrategy.Strategy
         default = RecoStrategy.Best
 
+        "--ancestors", "-a"
+        help = """Show ancestors of jets in the animation"""
+        action = :store_true
+
+        "--title", "-t"
+        help = """Title for animation"""
+
+        "--framerate"
+        help = """Framerate per second"""
+        arg_type = Int
+        default = 10
+
+        "--end-frames"
+        help = """Number of end frames to pad animation with"""
+        arg_type = Int
+        default = 0
+
         "file"
         help = "HepMC3 event file in HepMC3 to read"
         required = true
@@ -52,17 +70,14 @@ function main()
     events::Vector{Vector{PseudoJet}} = read_final_state_particles(args[:file],
                                                                    maxevents = args[:event],
                                                                    skipevents = args[:event])
-    if isnothing(args[:algorithm]) && isnothing(args[:power])
-        @warn "Neither algorithm nor power specified, defaulting to AntiKt"
-        args[:algorithm] = JetAlgorithm.AntiKt
-    end
     cs = jet_reconstruct(events[1], R = args[:distance], p = args[:power],
                          algorithm = args[:algorithm],
                          strategy = args[:strategy])
 
     animatereco(cs, args[:output]; azimuth = (1.8, 3.0), elevation = 0.5,
-                perspective = 0.5, framerate = 20, ancestors = true,
-                barsize_phi = 0.1, barsize_y = 0.3)
+                perspective = 0.5, ancestors = args[:ancestors],
+                barsize_phi = 0.1, barsize_y = 0.3, title = args[:title],
+                framerate = args[:framerate], end_frames = args[:end_frames])
 
     @info "Saved jet reconstruction animation to $(args[:output])"
 end

test/data/hepmc32summary.jl

@@ -23,6 +23,10 @@ function parse_command_line(args)
         arg_type = Int
         default = 0
 
+        "--details"
+        help = "Print per-event density"
+        action = :store_true
+
         "files"
         help = "The HepMC3 event files to read."
         required = true
@@ -43,6 +47,11 @@ function main()
         for e in events
             push!(n_particles, length(e))
         end
+        if args[:details]
+            for (i, n) in enumerate(n_particles)
+                println("Event $i: $n")
+            end
+        end
         average_n = mean(n_particles)
         if args[:summary]
             println("$file,$average_n")