Skip to content

📝 Add docstrings to master #14

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

Open
coderabbitai wants to merge 2 commits into
base: master
Choose a base branch
from
Open

📝 Add docstrings to master #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ad38fb5
📝 Add docstrings to `master`
coderabbitai[bot] Jan 19, 2026
b14b7e7
Fix missing final newline in docstring PR
github-actions[bot] Jan 19, 2026
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: 29 additions & 0 deletions generators/Herwig/HepMCTrigger/HepMCJetTrigger.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,17 @@ bool HepMCJetTrigger::isGoodEvent(HepMC::GenEvent* e1)
return false;
}

/**
* @brief Cluster final-state particles from a HepMC event into anti-kt (R=0.4) jets.
*
* Particles used for clustering are final-state (status == 1) with no end vertex; neutrinos
* (PDG IDs with absolute value in [12, 18]) are excluded. Each resulting PseudoJet has its
* user_index set to the originating particle's barcode.
*
* @param e1 Pointer to the HepMC::GenEvent to cluster.
* @return std::vector<fastjet::PseudoJet> Inclusive jets produced by the anti-kt (R=0.4) clustering,
* in FastJet's PseudoJet format.
*/
std::vector<fastjet::PseudoJet> HepMCJetTrigger::findAllJets(HepMC::GenEvent* e1)
{
// do the fast jet clustering, antikt r=-0.4
Expand All @@ -96,6 +107,11 @@ std::vector<fastjet::PseudoJet> HepMCJetTrigger::findAllJets(HepMC::GenEvent* e1
if (!(*iter)->end_vertex() && (*iter)->status() == 1)
{
auto p = (*iter)->momentum();
auto pd = std::abs((*iter)->pdg_id());
if (pd >= 12 && pd <= 18)
{
continue; // keep jet in the expected behavioro
}
fastjet::PseudoJet pj(p.px(), p.py(), p.pz(), p.e());
pj.set_user_index((*iter)->barcode());
input.push_back(pj);
Expand All @@ -115,13 +131,26 @@ std::vector<fastjet::PseudoJet> HepMCJetTrigger::findAllJets(HepMC::GenEvent* e1
return output;
}

/**
* @brief Counts jets that pass the eta and transverse momentum selection.
*
* Scans the provided jets, ignores those with absolute pseudorapidity greater than 1.1,
* and counts jets with transverse momentum greater than the configured threshold.
*
* @param jets Vector of candidate jets to evaluate.
* @return int Number of jets with |eta| ≤ 1.1 and pt greater than the trigger threshold.
*/
int HepMCJetTrigger::jetsAboveThreshold(const std::vector<fastjet::PseudoJet>& jets) const
{
// search through for the number of identified jets above the threshold
int n_good_jets = 0;
for (const auto& j : jets)
{
float const pt = j.pt();
if (std::abs(j.eta()) > 1.1)
{
continue;
}
if (pt > this->threshold)
{
n_good_jets++;
Expand Down
Loading