Valencia jets 🍊

docs/src/examples.md

@@ -26,6 +26,8 @@ julia --project jetreco.jl --algorithm=AntiKt ../test/data/events.pp13TeV.hepmc3
 ...
 julia --project jetreco.jl --algorithm=Durham ../test/data/events.eeH.hepmc3.zst
 ...
+julia --project jetreco.jl --algorithm=Valencia --p=1.2 --gamma=0.8 ../test/data/events.eeH.hepmc3.zst
+...
 julia --project jetreco.jl --maxevents=10 --strategy=N2Plain --algorithm=Kt --exclusive-njets=3 ../test/data/events.pp13TeV.hepmc3.zst
 ...
 ```

docs/src/index.md

@@ -56,6 +56,7 @@ Each known algorithm is referenced using a `JetAlgorithm` scoped enum value.
 | generalised ``k_\text{T}`` | `JetAlgorithm.GenKt` | For $pp$, value of `p` must also be specified |
 | ``e^+e-`` ``k_\text{T}`` / Durham | `JetAlgorithm.Durham` | `R` value ignored and can be omitted |
 | generalised ``e^+e-`` ``k_\text{T}`` | `JetAlgorithm.EEKt` | For ``e^+e^-``, value of `p` must also be specified |
+| Valencia | `JetAlgorithm.Valencia` | For ``e^+e^-``, values of `p` (β) and `γ` must be specified |
 
 ### Strategy
 

src/AlgorithmStrategyEnums.jl

@@ -26,8 +26,9 @@ Scoped enumeration (using EnumX) representing different jet algorithms used in t
 - `GenKt`: The Generalised Kt algorithm (with arbitrary power).
 - `EEKt`: The Generalised e+e- kt algorithm.
 - `Durham`: The e+e- kt algorithm, aka Durham.
+- `Valencia`: The Valencia e+e- algorithm.
 """
-@enumx T=Algorithm JetAlgorithm AntiKt CA Kt GenKt EEKt Durham
+@enumx T=Algorithm JetAlgorithm AntiKt CA Kt GenKt EEKt Durham Valencia
 const AllJetRecoAlgorithms = [String(Symbol(x)) for x in instances(JetAlgorithm.Algorithm)]
 
 """
@@ -36,7 +37,7 @@ const AllJetRecoAlgorithms = [String(Symbol(x)) for x in instances(JetAlgorithm.
 A constant array that contains the jet algorithms for which power is variable.
 
 """
-const varpower_algorithms = [JetAlgorithm.GenKt, JetAlgorithm.EEKt]
+const varpower_algorithms = [JetAlgorithm.GenKt, JetAlgorithm.EEKt, JetAlgorithm.Valencia]
 
 """
     algorithm2power
@@ -109,7 +110,7 @@ Check if the algorithm is a e+e- reconstruction algorithm.
 `true` if the algorithm is a e+e- reconstruction algorithm, `false` otherwise.
 """
 function is_ee(algorithm::JetAlgorithm.Algorithm)
-    return algorithm in [JetAlgorithm.EEKt, JetAlgorithm.Durham]
+    return algorithm in (JetAlgorithm.EEKt, JetAlgorithm.Durham, JetAlgorithm.Valencia)
 end
 
 """

src/ClusterSequence.jl

@@ -332,7 +332,7 @@ function exclusive_jets(clusterseq::ClusterSequence{U},
         throw(ArgumentError("Algorithm $(clusterseq.algorithm) requires power >= 0 for exclusive jets (power=$(clusterseq.power))"))
     elseif clusterseq.algorithm ∉
            (JetAlgorithm.CA, JetAlgorithm.Kt, JetAlgorithm.Durham, JetAlgorithm.GenKt,
-            JetAlgorithm.EEKt)
+            JetAlgorithm.EEKt, JetAlgorithm.Valencia)
         throw(ArgumentError("Algorithm used is not suitable for exclusive jets ($(clusterseq.algorithm))"))
     end
 
@@ -395,7 +395,7 @@ function n_exclusive_jets(clusterseq::ClusterSequence; dcut::AbstractFloat)
         throw(ArgumentError("Algorithm $(clusterseq.algorithm) requires power >= 0 for exclusive jets(power=$(clusterseq.power))"))
     elseif clusterseq.algorithm ∉
            (JetAlgorithm.CA, JetAlgorithm.Kt, JetAlgorithm.Durham, JetAlgorithm.GenKt,
-            JetAlgorithm.EEKt)
+            JetAlgorithm.EEKt, JetAlgorithm.Valencia)
         throw(ArgumentError("Algorithm used is not suitable for exclusive jets ($(clusterseq.algorithm))"))
     end