Skip to content

allow exclusive and inclusive jets to return jet type used in clusterseq #118

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 30, 2025
Merged

allow exclusive and inclusive jets to return jet type used in clusterseq #118

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 16 additions & 13 deletions src/ClusterSequence.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ add_step_to_history!(clusterseq::ClusterSequence, parent1, parent2, jetp_index,
end

"""
inclusive_jets(clusterseq::ClusterSequence; ptmin = 0.0, T = LorentzVectorCyl)
inclusive_jets(clusterseq::ClusterSequence{U}; ptmin = 0.0, T = LorentzVectorCyl) where {U}

Return all inclusive jets of a ClusterSequence with pt > ptmin.

Expand All @@ -234,16 +234,18 @@ It iterates over the clustering history and checks the transverse momentum of
each parent jet. If the transverse momentum is greater than or equal to `ptmin`,
the jet is added to the array of inclusive jets.

Valid return types are `LorentzVectorCyl` and `PseudoJet` (N.B. this will evolve
in the future to be any subtype of `FourMomemntumBase`; currently unrecognised types
will return `LorentzVectorCyl`).
Valid return types are `LorentzVectorCyl` and the jet type of the input `clusterseq`
(`U` - either `PseudoJet` or `EEjet` depending which algorithm was used)
(N.B. this will evolve in the future to be any subtype of `FourMomentumBase`;
currently unrecognised types will return `LorentzVectorCyl`).

# Example
```julia
inclusive_jets(clusterseq; ptmin = 10.0)
```
"""
function inclusive_jets(clusterseq::ClusterSequence; ptmin = 0.0, T = LorentzVectorCyl)
function inclusive_jets(clusterseq::ClusterSequence{U}; ptmin = 0.0,
T = LorentzVectorCyl) where {U}
pt2min = ptmin * ptmin
jets_local = T[]
# sizehint!(jets_local, length(clusterseq.jets))
Expand All @@ -257,7 +259,7 @@ function inclusive_jets(clusterseq::ClusterSequence; ptmin = 0.0, T = LorentzVec
jet = clusterseq.jets[iparent_jet]
if pt2(jet) >= pt2min
@debug "Added inclusive jet index $iparent_jet"
if T == PseudoJet
if T == U
push!(jets_local, jet)
else
push!(jets_local,
Expand All @@ -269,7 +271,7 @@ function inclusive_jets(clusterseq::ClusterSequence; ptmin = 0.0, T = LorentzVec
end

"""
exclusive_jets(clusterseq::ClusterSequence; dcut = nothing, njets = nothing, T = LorentzVectorCyl)
exclusive_jets(clusterseq::ClusterSequence{U}; dcut = nothing, njets = nothing, T = LorentzVectorCyl) where {U}

Return all exclusive jets of a ClusterSequence, with either a specific number of
jets or a cut on the maximum distance parameter.
Expand All @@ -290,9 +292,10 @@ jets or a cut on the maximum distance parameter.
# Returns
- An array of `T` objects representing the exclusive jets.

Valid return types are `LorentzVectorCyl` and `PseudoJet` (N.B. this will evolve
in the future to be any subtype of `FourMomemntumBase`; currently unrecognised types
will return `LorentzVectorCyl`)
Valid return types are `LorentzVectorCyl` and the jet type of the input `clusterseq`
(`U` - either `PseudoJet` or `EEjet` depending which algorithm was used)
(N.B. this will evolve in the future to be any subtype of `FourMomentumBase`;
currently unrecognised types will return `LorentzVectorCyl`).

# Exceptions
- `ArgumentError`: If neither `dcut` nor `njets` is provided.
Expand All @@ -307,8 +310,8 @@ exclusive_jets(clusterseq, dcut = 20.0)
exclusive_jets(clusterseq, njets = 3, T = PseudoJet)
```
"""
function exclusive_jets(clusterseq::ClusterSequence; dcut = nothing, njets = nothing,
T = LorentzVectorCyl)
function exclusive_jets(clusterseq::ClusterSequence{U}; dcut = nothing, njets = nothing,
T = LorentzVectorCyl) where {U}
if isnothing(dcut) && isnothing(njets)
throw(ArgumentError("Must pass either a dcut or an njets value"))
end
Expand Down Expand Up @@ -343,7 +346,7 @@ function exclusive_jets(clusterseq::ClusterSequence; dcut = nothing, njets = not
if (parent < stop_point && parent > 0)
@debug "Added exclusive jet index $(clusterseq.history[parent].jetp_index)"
jet = clusterseq.jets[clusterseq.history[parent].jetp_index]
if (T == PseudoJet) || (T == EEjet)
if T == U
push!(excl_jets, jet)
else
push!(excl_jets,
Expand Down
Loading