![]() |
ATLAS Offline Software
|
Classes | |
| struct | ParticleDef |
| Human-readable names for the values of ParticleType, ParticleOrigin and ParticleOutCome. More... | |
Enumerations | |
| enum | ParticleType : unsigned int { Unknown = 0 , UnknownElectron = 1 , IsoElectron = 2 , NonIsoElectron = 3 , BkgElectron = 4 , UnknownMuon = 5 , IsoMuon = 6 , NonIsoMuon = 7 , BkgMuon = 8 , UnknownTau = 9 , IsoTau = 10 , NonIsoTau = 11 , BkgTau = 12 , UnknownPhoton = 13 , IsoPhoton = 14 , NonIsoPhoton = 15 , BkgPhoton = 16 , Hadron = 17 , Neutrino = 18 , NuclFrag = 19 , NonPrimary = 20 , GenParticle = 21 , SUSYParticle = 22 , OtherBSMParticle = 39 , BBbarMesonPart = 23 , BottomMesonPart = 24 , CCbarMesonPart = 25 , CharmedMesonPart = 26 , BottomBaryonPart = 27 , CharmedBaryonPart = 28 , StrangeBaryonPart = 29 , LightBaryonPart = 30 , StrangeMesonPart = 31 , LightMesonPart = 32 , BJet = 33 , CJet = 34 , LJet = 35 , GJet = 36 , TauJet = 37 , UnknownJet = 38 } |
| Type of a truth particle, as assigned by MCTruthClassifier::particleTruthClassifier (the first member of the returned pair). More... | |
| enum | ParticleOrigin : unsigned int { NonDefined = 0 , SingleElec = 1 , SingleMuon = 2 , SinglePhot = 3 , SingleTau = 4 , PhotonConv = 5 , DalitzDec = 6 , ElMagProc = 7 , Mu = 8 , TauLep = 9 , top = 10 , QuarkWeakDec = 11 , WBoson = 12 , ZBoson = 13 , Higgs = 14 , HiggsMSSM = 15 , HeavyBoson = 16 , WBosonLRSM = 17 , NuREle = 18 , NuRMu = 19 , NuRTau = 20 , LQ = 21 , SUSY = 22 , OtherBSM = 46 , LightMeson = 23 , StrangeMeson = 24 , CharmedMeson = 25 , BottomMeson = 26 , CCbarMeson = 27 , JPsi = 28 , BBbarMeson = 29 , LightBaryon = 30 , StrangeBaryon = 31 , CharmedBaryon = 32 , BottomBaryon = 33 , PionDecay = 34 , KaonDecay = 35 , BremPhot = 36 , PromptPhot = 37 , UndrPhot = 38 , ISRPhot = 39 , FSRPhot = 40 , NucReact = 41 , PiZero = 42 , DiBoson = 43 , ZorHeavyBoson = 44 , MultiBoson = 47 , QCD = 45 } |
| Origin of a truth particle, as assigned by MCTruthClassifier::particleTruthClassifier (the second member of the returned pair). More... | |
| enum | ParticleOutCome : unsigned int { NonDefinedOutCome = 0 , UnknownOutCome = 1 , UnConverted = 2 , Converted = 3 , NonInteract = 4 , NuclInteraction = 5 , ElectrMagInter = 6 , DecaytoElectron = 7 , DecaytoMuon = 8 , OneProng = 9 , ThreeProng = 10 , FiveProng = 11 } |
| Outcome of a (simulated) truth particle: what happened to it after being produced, determined from its decay or end vertex (second member of IMCTruthClassifier::Info). More... | |
| enum | MCTC_bits : unsigned int { HadTau =0 , Tau , hadron , frombsm , uncat , isbsm , isgeant , stable , totalBits } |
| Bit positions in the classification word returned by defOrigOfParticle(). More... | |
Functions | |
| static ParticleOrigin | defOrigOfElectron (const xAOD::TruthParticleContainer &xTruthParticleContainer, const xAOD::TruthParticle *thePart, bool &isPrompt, ParticleOutCome &outCome) |
| static ParticleOrigin | defOrigOfMuon (const xAOD::TruthParticleContainer &xTruthParticleContainer, const xAOD::TruthParticle *thePart, bool &isPrompt, ParticleOutCome &outCome) |
| static ParticleOrigin | defOrigOfTau (const xAOD::TruthParticleContainer &xTruthParticleContainer, const xAOD::TruthParticle *thePart, int ancestorPDGin, ParticleOutCome &outCome) |
| static ParticleOrigin | defOrigOfPhoton (const xAOD::TruthParticleContainer &xTruthParticleContainer, const xAOD::TruthParticle *thePart, bool &isPrompt, ParticleOutCome &outCome) |
| static ParticleOrigin | defOrigOfNeutrino (const xAOD::TruthParticleContainer &xTruthParticleContainer, const xAOD::TruthParticle *thePart, bool &isPrompt, ParticleOutCome &outCome) |
| std::pair< ParticleType, ParticleOrigin > | classifyTruthParticle (const xAOD::TruthParticleContainer &truthParticleContainer, const xAOD::TruthParticle *const thePart, ParticleOutCome &outCome) |
| Classify thePart (not nullptr), using truthParticleContainer to look up its ancestors. | |
| ParticleOrigin | convHadronTypeToOrig (ParticleType pType, int motherPDG) |
| Convert a hadron ParticleType to a ParticleOrigin (JPsi if a c-cbar meson has a J/psi mother). | |
| ParticleOrigin | defHadronType (int pdg) |
| Classify a hadron by PDG ID into a ParticleOrigin (NonDefined if none applies). | |
| ParticleType | defTypeOfHadron (int pdg) |
| Classify a hadron by PDG ID into a ParticleType (Unknown if none applies). | |
| ParticleType | defTypeOfElectron (ParticleOrigin EleOrig, bool isPrompt) |
| Classify an electron (Unknown/Iso/NonIso/Bkg) from its origin; prompt electrons are always Iso. | |
| ParticleType | defTypeOfMuon (ParticleOrigin MuOrig, bool isPrompt) |
| Classify a muon (Unknown/Iso/NonIso/Bkg) from its origin; prompt muons are always Iso. | |
| ParticleType | defTypeOfTau (ParticleOrigin TauOrig) |
| Classify a tau (Unknown/Iso/NonIso/Bkg) from its origin. | |
| ParticleType | defTypeOfPhoton (ParticleOrigin PhotOrig) |
| Classify a photon (Unknown/Iso/NonIso/Bkg) from its origin. | |
| template<class T> | |
| ParticleOrigin | defJetOrig (const T &allJetMothers) |
| Determine a jet's origin from its mother particles (Higgs/BSM mothers return immediately; otherwise the last matching top, Z or W mother wins, with W not overriding top, and QCD only if none of them was found). | |
| template<class T> | |
| std::tuple< unsigned int, T > | defOrigOfParticle (T thePart) |
| Classify a particle into a bit-word (see MCTC_bits). | |
| int | isPrompt (const unsigned int classify, bool allow_prompt_tau_decays=true) |
| Tell whether a particle is prompt, from the word returned by defOrigOfParticle(). | |
| template<class T> | |
| ParticleOutCome | defOutComeOfElectron (T thePart) |
| Determine the outcome of a simulated electron from its end vertex (NonInteract, ElectrMagInter, NuclInteraction or UnknownOutCome). | |
| template<class T> | |
| ParticleOutCome | defOutComeOfMuon (T thePart) |
| Determine the outcome of a simulated muon from its end vertex (NonInteract, DecaytoElectron, NuclInteraction or UnknownOutCome). | |
| template<class T> | |
| ParticleOutCome | defOutComeOfTau (T thePart) |
| Determine the outcome of a simulated tau from its decay products (NonInteract, NuclInteraction, DecaytoElectron/Muon, One/Three/FiveProng or UnknownOutCome). | |
| template<class T> | |
| ParticleOutCome | defOutComeOfPhoton (T thePart) |
| Determine the outcome of a simulated photon from its end vertex (UnConverted, Converted, NuclInteraction or UnknownOutCome). | |
| enum MCTruthPartClassifier::MCTC_bits : unsigned int |
Bit positions in the classification word returned by defOrigOfParticle().
The word is an unsigned int whose bit i is set when the property i below holds (e.g. test it with std::bitset<MCTC_bits::totalBits>(word).test(MCTC_bits::hadron)). The numeric values are 1 << position: HadTau = 1, Tau = 2, hadron = 4, frombsm = 8, uncat = 16, isbsm = 32, isgeant = 64, stable = 128. The word is stored by the egamma, MCTC decoration and derivation code, so the positions must not be changed. The ancestry bits (HadTau, Tau, hadron, frombsm) are only filled for a physical particle with a production vertex that is not a simulation (Geant) particle; otherwise only uncat is set, together with the particle-level bits stable, isgeant and isbsm.
| Enumerator | |
|---|---|
| HadTau | Descends from a hadron and from a tau: a hadronic tau decay product (hadron && Tau). |
| Tau | A tau is among the ancestors, or the parents of an ancestor, that were walked on the way up (product of a tau decay). |
| hadron | The particle is a hadron (not a beam particle) or descends from one (non-prompt); unset for prompt particles. |
| frombsm | A BSM particle is among the ancestors walked, or the particle is itself BSM. |
| uncat | Uncategorised: the particle is not physical (neither stable nor decayed), has no production vertex or is a simulation particle; the ancestry bits are then not set. |
| isbsm | The particle itself is a BSM particle. |
| isgeant | The particle is produced by the detector simulation (e.g. Geant4), not by the generator. |
| stable | The particle is physical: stable or decayed (MC::isPhysical), not an intermediate or documentation entry. Despite the name this includes decayed particles. |
| totalBits | Number of bits (not a property). |
Definition at line 167 of file TruthClassifiers.h.
| enum MCTruthPartClassifier::ParticleOrigin : unsigned int |
Origin of a truth particle, as assigned by MCTruthClassifier::particleTruthClassifier (the second member of the returned pair).
For leptons and photons it names the process or the particle whose decay produced them, found by walking up the history to the first ancestor that is not a copy of the same particle (and skipping through intermediate W, tau and muon decays). Where an origin is a hadron class (LightMeson ... BBbarMeson), it is the class of that ancestor. Sherpa and MadGraph records, which lack explicit intermediate bosons, are recognised from the multiplicity of the hard-process vertex.
| Enumerator | |
|---|---|
| NonDefined | Origin could not be determined (no production vertex, no ancestor, or particle not classified). |
| SingleElec | Single-electron particle gun: production vertex with no mother and one outgoing particle. |
| SingleMuon | Single-muon particle gun. |
| SinglePhot | Single-photon particle gun. |
| SingleTau | Single-tau particle gun. |
| PhotonConv | Photon conversion (gamma -> e+ e-, or gamma -> mu+ mu- for muons). |
| DalitzDec | Dalitz decay of a pi0 (pi0 -> gamma e+ e-, or pi0 -> e+ e- e+ e-). |
| ElMagProc | Electromagnetic or nuclear material process: bremsstrahlung/pair production in the detector, Compton scattering, nuclear photo-fission, hadron-nucleus interaction. |
| Mu | Decay (or radiation) of a muon. |
| TauLep | Decay (or radiation) of a tau lepton that is not itself prompt. |
| top | Decay of a top quark (including through W). |
| QuarkWeakDec | Weak decay of a quark: q -> q' l nu with a single other quark in the final state. |
| WBoson | W boson decay (including Sherpa W records and W+gamma). |
| ZBoson | Z boson (or Z/gamma*) decay (including Sherpa Z records and Z+gamma). |
| Higgs | Higgs boson decay (SM Higgs, PDG 25). |
| HiggsMSSM | Decay of an extra (MSSM/2HDM) Higgs boson: H (35), A (36) or H+ (37). |
| HeavyBoson | Decay of a heavy gauge boson Z', Z'', W'+ (PDG 32, 33, 34), or a KK graviton (5100039) in the photon case. |
| WBosonLRSM | Decay of the W_R boson of the left-right symmetric model (Pythia-specific PDG 9900024). |
| NuREle | Decay of a right-handed electron neutrino (Pythia-specific PDG 9900012), or of a W_R decaying to it. |
| NuRMu | Decay of a right-handed muon neutrino (Pythia-specific PDG 9900014). |
| NuRTau | Decay of a right-handed tau neutrino (Pythia-specific PDG 9900016). |
| LQ | Leptoquark: the ancestor is a leptoquark, or the decay vertex contains one. |
| SUSY | Decay of a SUSY particle. |
| OtherBSM | Decay of a non-SUSY BSM particle (added later, hence the out-of-order value). |
| LightMeson | Decay of a light (u, d only) meson. |
| StrangeMeson | Decay of a meson containing s quark (e.g. kaon). |
| CharmedMeson | Decay of an open-charm meson. |
| BottomMeson | Decay of an open-bottom meson. |
| CCbarMeson | Decay of a hidden-charm meson other than J/psi. |
| JPsi | Decay of a J/psi. |
| BBbarMeson | Decay of a hidden-bottom meson. |
| LightBaryon | Decay of a light (u, d only) baryon. |
| StrangeBaryon | Decay of a strange baryon. |
| CharmedBaryon | Decay of a charmed baryon. |
| BottomBaryon | Decay of a bottom baryon. |
| PionDecay | Muon from pi -> mu nu in flight. |
| KaonDecay | Muon from K -> mu nu in flight. |
| BremPhot | Bremsstrahlung photon: the mother continues as a copy of itself plus this photon. |
| PromptPhot | Prompt (direct) photon of the hard process, e.g. Pythia8 gamma+jet. |
| UndrPhot | "Underlying" photon: radiated from a quark or gluon in the parton shower/underlying event |
| ISRPhot | Initial-state radiation photon (quark/gluon mother whose copy is a Herwig cluster). |
| FSRPhot | Final-state radiation photon, e.g. from the leptons of W/Z/H decays or from Photos. |
| NucReact | Photon from a nuclear reaction in the material. |
| PiZero | Photon from a pi0 decay. |
| DiBoson | Two-boson (WW, WZ, ZZ) production recorded without explicit bosons: four leptons/neutrinos in the hard-process vertex. |
| ZorHeavyBoson | UNUSED: never returned by the classifier; only compared against in defTypeOfElectron/Muon/Tau. |
| MultiBoson | Three or more bosons (VVV, 4-top with leptonic W decays): six or eight leptons/neutrinos in the hard-process vertex. |
| QCD | Jet origin: a quark or gluon mother (see defJetOrig); only assigned by the jet classifier, never to leptons or photons. |
Definition at line 80 of file TruthClasses.h.
| enum MCTruthPartClassifier::ParticleOutCome : unsigned int |
Outcome of a (simulated) truth particle: what happened to it after being produced, determined from its decay or end vertex (second member of IMCTruthClassifier::Info).
The defOutComeOf<X> functions in TruthClassifiers.h assign it for electrons, muons, taus and photons.
| Enumerator | |
|---|---|
| NonDefinedOutCome | UNUSED: never assigned; the default of IMCTruthClassifier::Info::particleOutCome is UnknownOutCome. |
| UnknownOutCome | End vertex exists, but its content matches none of the patterns below. |
| UnConverted | Photon without an end vertex: it did not convert. |
| Converted | Photon converted: end vertex has exactly one e+ and one e-. |
| NonInteract | Particle without an end vertex (survived the detector) – also used for neutrinos. |
| NuclInteraction | Interaction with nuclei: the end vertex contains hadrons, nucleons or nuclear fragments. |
| ElectrMagInter | Electron that only scattered electromagnetically: its end vertex has one electron and nothing else. |
| DecaytoElectron | Muon decayed to e nu_e nu_mu, or tau decayed to e nu nu (with optional photons). |
| DecaytoMuon | Tau decayed to mu nu nu (with optional photons). |
| OneProng | Tau decayed hadronically with one charged pion or kaon. |
| ThreeProng | Tau decayed hadronically with three charged pions or kaons. |
| FiveProng | Tau decayed hadronically with five charged pions or kaons. |
Definition at line 139 of file TruthClasses.h.
| enum MCTruthPartClassifier::ParticleType : unsigned int |
Type of a truth particle, as assigned by MCTruthClassifier::particleTruthClassifier (the first member of the returned pair).
Lepton and photon types come in four flavours, decided from the particle's ParticleOrigin (see defTypeOfElectron, defTypeOfMuon, defTypeOfTau, defTypeOfPhoton in TruthClassifiers.h):
| Enumerator | |
|---|---|
| Unknown | Not classified: not a lepton, photon, neutrino or hadron (e.g. a quark, a gluon, a boson), or no result. |
| UnknownElectron | Electron with undefined origin (no production vertex, or origin could not be traced). |
| IsoElectron | Isolated (prompt) electron, e.g. from W/Z/H/top/BSM decay, or a single-electron particle gun. |
| NonIsoElectron | Non-isolated electron from J/psi, B/D hadron, tau, muon or quark weak decay. |
| BkgElectron | Background electron: photon conversion, Dalitz decay, material interaction, light-hadron decay, ... |
| UnknownMuon | Muon with undefined origin. |
| IsoMuon | Isolated (prompt) muon. |
| NonIsoMuon | Non-isolated muon from J/psi, B/D hadron, tau or quark weak decay. |
| BkgMuon | Background muon: pion/kaon decay in flight and other remaining cases. |
| UnknownTau | Tau with undefined origin. |
| IsoTau | Isolated (prompt) tau. |
| NonIsoTau | Non-isolated tau from J/psi, B/D hadron or quark weak decay. |
| BkgTau | Background tau (remaining cases). |
| UnknownPhoton | Photon with undefined origin. |
| IsoPhoton | Isolated (prompt) photon: from W/Z/H/BSM decay, a hard-process prompt photon, or a single-photon gun. |
| NonIsoPhoton | Non-isolated photon: initial/final-state radiation, or from tau, muon or right-handed neutrino/W_R decay. |
| BkgPhoton | Background photon: bremsstrahlung, pi0 decay, hadron decay, nuclear reaction, underlying-event photon, ... |
| Hadron | Any hadron (neither the beam nor a nuclear fragment); the origin is not studied further. |
| Neutrino | Neutrino (an origin is determined for it, see ParticleOrigin). |
| NuclFrag | Nuclear fragment: a nucleus other than a proton, produced in a material interaction. |
| NonPrimary | Not a primary particle: a copy produced by the simulation (e.g. Geant4) with no production vertex, or the re-generated copy of its own mother. |
| GenParticle | Generator-level intermediate particle (decayed, or otherwise not a final-state candidate) that is not classified further. |
| SUSYParticle | Stable SUSY particle (e.g. the LSP). |
| OtherBSMParticle | Stable non-SUSY BSM particle (added later, hence the out-of-order value). |
| BBbarMesonPart | Hidden-bottom meson (e.g. Upsilon, chi_b). |
| BottomMesonPart | Open-bottom meson (B, B_s, B_c). |
| CCbarMesonPart | Hidden-charm meson (e.g. J/psi, chi_c). |
| CharmedMesonPart | Open-charm meson (D, D_s). |
| BottomBaryonPart | Baryon containing a b quark. |
| CharmedBaryonPart | Baryon containing a c quark (and no b). |
| StrangeBaryonPart | Baryon containing an s quark (and no c, b). |
| LightBaryonPart | Baryon made of u and d quarks only. |
| StrangeMesonPart | Meson containing an s quark (and no c, b), e.g. a kaon. |
| LightMesonPart | Meson made of u and d quarks only, e.g. a pion. |
| BJet | Jet containing a b-hadron (jet overload of the classifier; DR-matched or constituent truth particles). |
| CJet | Jet with a c-hadron and no b-hadron (jet overload of the classifier). |
| LJet | Jet with only light/strange hadrons (jet overload of the classifier). |
| GJet | UNUSED: never assigned or checked anywhere in Athena (gluon jet). |
| TauJet | UNUSED: never assigned or checked anywhere in Athena (hadronic tau jet). |
| UnknownJet | Jet with no classifiable hadron among its constituents (also the initial value of the jet classifier). |
Definition at line 26 of file TruthClasses.h.
| std::pair< ParticleType, ParticleOrigin > MCTruthPartClassifier::classifyTruthParticle | ( | const xAOD::TruthParticleContainer & | truthParticleContainer, |
| const xAOD::TruthParticle *const | thePart, | ||
| ParticleOutCome & | outCome ) |
Classify thePart (not nullptr), using truthParticleContainer to look up its ancestors.
Fills outCome with what happened to the particle in the simulation.
Definition at line 29 of file MCTruthClassifierGen.cxx.
|
inline |
Convert a hadron ParticleType to a ParticleOrigin (JPsi if a c-cbar meson has a J/psi mother).
Definition at line 15 of file TruthClassifiers.h.
|
inline |
Classify a hadron by PDG ID into a ParticleOrigin (NonDefined if none applies).
Definition at line 32 of file TruthClassifiers.h.
| ParticleOrigin MCTruthPartClassifier::defJetOrig | ( | const T & | allJetMothers | ) |
Determine a jet's origin from its mother particles (Higgs/BSM mothers return immediately; otherwise the last matching top, Z or W mother wins, with W not overriding top, and QCD only if none of them was found).
Definition at line 138 of file TruthClassifiers.h.
|
static |
Definition at line 159 of file MCTruthClassifierGen.cxx.
|
static |
Definition at line 442 of file MCTruthClassifierGen.cxx.
|
static |
Definition at line 1123 of file MCTruthClassifierGen.cxx.
| std::tuple< unsigned int, T > MCTruthPartClassifier::defOrigOfParticle | ( | T | thePart | ) |
Classify a particle into a bit-word (see MCTC_bits).
Definition at line 181 of file TruthClassifiers.h.
|
static |
Definition at line 864 of file MCTruthClassifierGen.cxx.
|
static |
Definition at line 676 of file MCTruthClassifierGen.cxx.
| ParticleOutCome MCTruthPartClassifier::defOutComeOfElectron | ( | T | thePart | ) |
Determine the outcome of a simulated electron from its end vertex (NonInteract, ElectrMagInter, NuclInteraction or UnknownOutCome).
Definition at line 224 of file TruthClassifiers.h.
| ParticleOutCome MCTruthPartClassifier::defOutComeOfMuon | ( | T | thePart | ) |
Determine the outcome of a simulated muon from its end vertex (NonInteract, DecaytoElectron, NuclInteraction or UnknownOutCome).
Definition at line 250 of file TruthClassifiers.h.
| ParticleOutCome MCTruthPartClassifier::defOutComeOfPhoton | ( | T | thePart | ) |
Determine the outcome of a simulated photon from its end vertex (UnConverted, Converted, NuclInteraction or UnknownOutCome).
Definition at line 308 of file TruthClassifiers.h.
| ParticleOutCome MCTruthPartClassifier::defOutComeOfTau | ( | T | thePart | ) |
Determine the outcome of a simulated tau from its decay products (NonInteract, NuclInteraction, DecaytoElectron/Muon, One/Three/FiveProng or UnknownOutCome).
Definition at line 278 of file TruthClassifiers.h.
|
inline |
Classify an electron (Unknown/Iso/NonIso/Bkg) from its origin; prompt electrons are always Iso.
Definition at line 64 of file TruthClassifiers.h.
|
inline |
Classify a hadron by PDG ID into a ParticleType (Unknown if none applies).
Definition at line 48 of file TruthClassifiers.h.
|
inline |
Classify a muon (Unknown/Iso/NonIso/Bkg) from its origin; prompt muons are always Iso.
Definition at line 84 of file TruthClassifiers.h.
|
inline |
Classify a photon (Unknown/Iso/NonIso/Bkg) from its origin.
Definition at line 121 of file TruthClassifiers.h.
|
inline |
Classify a tau (Unknown/Iso/NonIso/Bkg) from its origin.
Definition at line 103 of file TruthClassifiers.h.
|
inline |
Tell whether a particle is prompt, from the word returned by defOrigOfParticle().
| allow_prompt_tau_decays | count products of prompt tau decays as prompt |
Definition at line 214 of file TruthClassifiers.h.