Rename momentum fraction, generalise jet functions

Rename the transverse momentum fraction to pt_fraction
Generalise a few methods of PseudoJet to work for all
FourMomentum objects

Author: graeme-a-stewart

src/JetReconstruction.jl

@@ -40,7 +40,7 @@ energy(p::LorentzVectorCyl) = LorentzVectorHEP.energy(p)
 include("Pseudojet.jl")
 include("EEjet.jl")
 include("JetUtils.jl")
-export PseudoJet, EEjet, momentum_fraction, kt_scale, lorentzvector, lorentzvector_cyl
+export PseudoJet, EEjet, pt_fraction, kt_scale, lorentzvector, lorentzvector_cyl
 
 # Jet reconstruction strategies and algorithms (enums!)
 include("AlgorithmStrategyEnums.jl")

src/JetUtils.jl

@@ -1,5 +1,54 @@
 # Generic utility functions for jet structs
 
+"""
+    mag(jet::T) where {T <: FourMomentum}
+
+Return the magnitude of the momentum of a `PseudoJet`, `|p|`.
+
+# Returns
+The magnitude of the `PseudoJet` object.
+"""
+mag(jet::T) where {T <: FourMomentum} = sqrt(muladd(jet.px, jet.px, jet.py^2) + jet.pz^2)
+
+"""
+    CosTheta(jet::PseudoJet) where {T <: FourMomentum}
+
+Compute the cosine of the angle between the momentum vector of `jet` and the z-axis.
+
+# Returns
+- The cosine of the angle between `jet` and the z-axis.
+"""
+@inline function CosTheta(jet::T) where {T <: FourMomentum}
+    fZ = jet.pz
+    ptot = mag(jet)
+    return ifelse(ptot == 0.0, 1.0, fZ / ptot)
+end
+
+"""
+    eta(jet::T) where {T <: FourMomentum}
+
+Compute the pseudorapidity (η) of a jet.
+
+# Returns
+- The pseudorapidity (η) of the PseudoJet.
+"""
+function eta(jet::T) where {T <: FourMomentum}
+    cosTheta = CosTheta(jet)
+    (cosTheta^2 < 1.0) && return -0.5 * log((1.0 - cosTheta) / (1.0 + cosTheta))
+    fZ = jet.pz
+    iszero(fZ) && return 0.0
+    # Warning("PseudoRapidity","transverse momentum = 0! return +/- 10e10");
+    fZ > 0.0 && return 10e10
+    return -10e10
+end
+
+"""
+    const η = eta
+
+Alias for the pseudorapidity function, `eta`.
+"""
+const η = eta
+
 """
     deltaR(jet1::T, jet2::T) where T <: FourMomentum
 
@@ -43,14 +92,14 @@ function deltar(jet1::T, jet2::T) where {T <: FourMomentum}
 end
 
 """
-    pt_momentum_fraction(jet1::T, jet2::T) where T <: FourMomentum
+    pt_fraction(jet1::T, jet2::T) where T <: FourMomentum
 
 Computes the transverse momentum fraction of the softer of two jets.
 
 # Returns
 - The transverse momentum fraction of the softer of the two jets.
 """
-function pt_momentum_fraction(jet1::T, jet2::T) where {T <: FourMomentum}
+function pt_fraction(jet1::T, jet2::T) where {T <: FourMomentum}
     pt1 = JetReconstruction.pt(jet1)
     pt2 = JetReconstruction.pt(jet2)
     return min(pt1, pt2) / (pt1 + pt2)

src/Pseudojet.jl

@@ -276,64 +276,6 @@ Calculate the invariant mass squared (m^2) of a PseudoJet.
 """
 m2(p::PseudoJet) = (p.E + p.pz) * (p.E - p.pz) - p._pt2
 
-"""
-    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.
-"""
-mag(p::PseudoJet) = sqrt(muladd(p.px, p.px, p.py^2) + p.pz^2)
-
-"""
-    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.
-"""
-@inline function CosTheta(p::PseudoJet)
-    fZ = p.pz
-    ptot = mag(p)
-    return ifelse(ptot == 0.0, 1.0, fZ / ptot)
-end
-
-"""
-    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.
-"""
-function eta(p::PseudoJet)
-    cosTheta = CosTheta(p)
-    (cosTheta^2 < 1.0) && return -0.5 * log((1.0 - cosTheta) / (1.0 + cosTheta))
-    fZ = p.pz
-    iszero(fZ) && return 0.0
-    # Warning("PseudoRapidity","transverse momentum = 0! return +/- 10e10");
-    fZ > 0.0 && return 10e10
-    return -10e10
-end
-
-"""
-    const η = eta
-
-Alias for the pseudorapidity function, `eta`.
-"""
-const η = eta
-
 """
     m(p::PseudoJet)
 

test/test-jet-utils.jl

@@ -9,8 +9,8 @@ eej1 = EEjet(1.0, 1.2, -2.2, 22.0)
 eej2 = EEjet(-1.0, 3.2, -1.2, 39.0)
 
 @testset "Common jet utilities" begin
-    @test JetReconstruction.pt_momentum_fraction(pj1, pj2) ≈ 0.3889609897118418
-    @test JetReconstruction.pt_momentum_fraction(eej1, eej2) ≈ 0.3178347357639779
+    @test JetReconstruction.pt_fraction(pj1, pj2) ≈ 0.3889609897118418
+    @test JetReconstruction.pt_fraction(eej1, eej2) ≈ 0.3178347357639779
 
     jr_kt_scale = JetReconstruction.kt_scale(pj1, pj2)
     lvhep_kt_scale = min(JetReconstruction.pt(pj1), JetReconstruction.pt(pj2)) *