ATLAS Offline Software
|
MET source indicators. More...
#include <MissingETBase.h>
Public Types | |
Bitmasks for MET source indicators | |
enum | Category : Types::bitmask_t { Category::Refined = 0x10000, Category::Truth = 0x20000, Category::Calo = 0x40000, Category::ID = 0x80000, Category::UnknownCategory = 0x00000, Category::ATH_BITMASK } |
Source category tag. More... | |
enum | Type : Types::bitmask_t { Type::Electron = 0x00001, Type::Photon = 0x00002, Type::Tau = 0x00004, Type::Muon = 0x00008, Type::Jet = 0x00010, Type::SoftEvent = 0x00020, Type::Total = 0x00040, Type::UnknownType = 0x00000, Type::ATH_BITMASK } |
Physics contribution types category. More... | |
enum | Region : Types::bitmask_t { Region::Central = 0x00100, Region::Endcap = 0x00200, Region::Forward = 0x00400, Region::FullAcceptance = 0x00000, Region::UnknownRegion = 0x00000, Region::ATH_BITMASK } |
Regional tags. More... | |
enum | TruthType : Types::bitmask_t { TruthType::NonInt = 0x21000, TruthType::Int = 0x22000, TruthType::IntOut = 0x24000, TruthType::TruthMuons = 0x28000, TruthType::UnknownTruth = 0x00000, TruthType::ATH_BITMASK } |
Truth type indicators. More... | |
enum | Signal : Types::bitmask_t { Signal::LCTopo = 0x01000, Signal::EMTopo = 0x02000, Signal::Track = 0x04000, Signal::UnknownSignal = 0x00000, Signal::ATH_BITMASK } |
Signal contribution types. More... | |
Static Public Member Functions | |
static bool | isElectronTerm (Types::bitmask_t bits, Region reg=Region::FullAcceptance) |
static bool | isPhotonTerm (Types::bitmask_t bits, Region reg=Region::FullAcceptance) |
static bool | isTauTerm (Types::bitmask_t bits, Region reg=Region::FullAcceptance) |
static bool | isMuonTerm (Types::bitmask_t bits, Region reg=Region::FullAcceptance) |
static bool | isJetTerm (Types::bitmask_t bits, Region reg=Region::FullAcceptance) |
static bool | isSoftTerm (Types::bitmask_t bits, Region reg=Region::FullAcceptance) |
static bool | isTrackTerm (Types::bitmask_t bits, Region reg=Region::FullAcceptance) |
static bool | isTotalTerm (Types::bitmask_t bits, Region reg=Region::FullAcceptance) |
static bool | isTruthNonInt (Types::bitmask_t bits) |
static bool | isTruthInt (Types::bitmask_t bits, Region reg=Region::FullAcceptance) |
static bool | isTruthIntOut (Types::bitmask_t bits) |
static bool | isTruthMuons (Types::bitmask_t bits, Region reg=Region::FullAcceptance) |
static Types::bitmask_t | unknown () |
Bit mask constructors for pre-defined MET physics object contributions | |
static Types::bitmask_t | electron (Region reg=Region::FullAcceptance) |
Standard MET term from reconstructed electrons. More... | |
static Types::bitmask_t | photon (Region reg=Region::FullAcceptance) |
Standard MET term from reconstructed photons. More... | |
static Types::bitmask_t | tau (Region reg=Region::FullAcceptance) |
Standard MET term from reconstructed tau leptons. More... | |
static Types::bitmask_t | muon (Region reg=Region::FullAcceptance) |
Standard MET term from reconstructed muons. More... | |
static Types::bitmask_t | jet (Region reg=Region::FullAcceptance) |
Standard MET term from reconstructed jets. More... | |
static Types::bitmask_t | softEvent (Region reg=Region::FullAcceptance) |
Standard MET term from reconstructed soft event. More... | |
static Types::bitmask_t | total (Region reg=Region::FullAcceptance) |
Standard full reconstructed MET. More... | |
Bit mask constructors for pre-defined MET signal object contributions | |
static Types::bitmask_t | signal (Signal sig=(Signal::LCTopo|Signal::Track), Region reg=Region::FullAcceptance) |
Bit mask for MET term from any (or mixed) signal objects. More... | |
static Types::bitmask_t | track (Region reg=Region::FullAcceptance) |
Bit mask for MET term from Track signal objects. More... | |
static Types::bitmask_t | clusterLC (Region reg=Region::FullAcceptance) |
Bit mask for MET term from LCTopo (locally calibrated calorimeter cell clusters) signal objects. More... | |
static Types::bitmask_t | clusterEM (Region reg=Region::FullAcceptance) |
Bit mask for MET term from EMTopo signal objects. More... | |
static Types::bitmask_t | cluster (Region reg=Region::FullAcceptance) |
Bit mask for MET term from any cluster signal objects. More... | |
Truth indicator bit patterns | |
static Types::bitmask_t | truthNonInt () |
Standard bit pattern indicating genuine true MET. More... | |
static Types::bitmask_t | truthInt (Region reg=Region::FullAcceptance) |
Standard bit pattern indicating effective true MET. More... | |
static Types::bitmask_t | truthIntOut () |
Standard bit pattern indicating a true MET contribution from particles outside of the detector \( \eta \) acceptance. More... | |
static Types::bitmask_t | truthMuons (Region reg=Region::FullAcceptance) |
Standard bit pattern indicating the true muon contribution to MET truth. More... | |
Indicators for MET terms from detector signals | |
static Types::bitmask_t | caloLCTopo (Region reg=Region::FullAcceptance) |
Bit pattern indicating a LCTopo MET term. More... | |
static Types::bitmask_t | caloEMTopo (Region reg=Region::FullAcceptance) |
Bit pattern indicating a EMTopo MET term. More... | |
static Types::bitmask_t | idTrack (Region reg=Region::FullAcceptance) |
Bit pattern indicating a ID Track MET term. More... | |
Pattern tests for categories, types, truth types, and signal tags | |
template<class E , class F > | |
static bool | hasPattern (E bits, F mask) |
Generic check for given pattern. More... | |
static bool | hasCategory (Types::bitmask_t bits, Category cat) |
Check if bit pattern includes a given category. More... | |
static bool | hasType (Types::bitmask_t bits, Type type) |
static bool | hasTruthType (Types::bitmask_t bits, TruthType type) |
static bool | hasSignal (Types::bitmask_t bits, Signal sig) |
MET source indicators.
The source indicators are collected into exclusive categories "Refined", "Truth", "Calo" and "ID". In addition, the (exclusive) type of the MET term (the signal source) can specified. Further indicators concern regional contributions (central, endcap, and forward), and dedicated qualifiers for the type of truth in MET from Monte Carlos.
MET Categories
Categories are exclusively tagged, no MET term can be in two categories at the same time.
The "Refined" category includes reconstructed MET terms from data and detector simulations which represent the highest level of corrections and calibrations applied to given physics and signal object contributions. The particular meaning of this depends on the context. For example, in the a long standing default in MET reconstruction the fully calibrated and corrected contributions from hard objects are tagged "Refined", as well as the SoftTerm with or without pile-up correction applied.
The "Truth" category is exclusivly used for Monte Carlo particle level MET terms.
The "Diagnostics" category is meant for MET contributions based on simplified reconstruction schemes, which are not appropriate for physics analysis but can help to evaluate the MET reconstruction performance.
Definition at line 160 of file MissingETBase.h.
|
strong |
Source category tag.
Enumerator | |
---|---|
Refined | Indicator for genuine reconstructed MET terms. |
Truth | Indicator for MET terms from the particle level (MC truth) event. |
Calo | Indicator for MET terms reconstructed from calorimeter signals alone. |
ID | Indicator for MET terms reconstructed from inner detector (ID) tracks alone. |
UnknownCategory | Indicator for an unknown category. |
ATH_BITMASK |
Definition at line 165 of file MissingETBase.h.
|
strong |
Regional tags.
These regional tags indicate MET contributions from three regions in ATLAS (central, endcap, and forward). The particular ranges in pseudorapidity ( \( \eta \)) defining these regions are set in the tools calculating the respective MET terms.
Enumerator | |
---|---|
Central | Indicator for MET contribution from the central region. |
Endcap | Indicator for MET contribution from the endcap region. |
Forward | Indicator for MET contribution from the forward region. |
FullAcceptance | Indicator for full detector acceptance contribution. |
UnknownRegion | Indicator for unknown region (same as full acceptance contribution) |
ATH_BITMASK |
Definition at line 191 of file MissingETBase.h.
|
strong |
Signal contribution types.
Enumerator | |
---|---|
LCTopo | Indicator for MET contribution from TopoClusters with LCW calibration applied. |
EMTopo | Indicator for MET contribution from TopoClusters with EM (basic signal) calibration applied. |
Track | Indicator for MET contribution from reconstructed charged particle tracks. |
UnknownSignal | Unknown signal contribution. |
ATH_BITMASK |
Definition at line 213 of file MissingETBase.h.
|
strong |
Truth type indicators.
These indicators are only applicable for MC generated events. The types have the Truth category bit set.
Enumerator | |
---|---|
NonInt | Indicator for MET from non-interacting particles generated in the collision. |
Int | Indicator for MET from interacting particles within the nominal \( \eta \) acceptance of the detector. |
IntOut | Indicator for MET contributions from particles outside of the \( \eta \) acceptance of the detector (typically between edge of the detector and the maximum \( \eta \) for "stable" particle production used in the MC generation) |
TruthMuons | Indicator for muons from MC truth (muons from the interaction) |
UnknownTruth | Unknown truth type indicator. |
ATH_BITMASK |
Definition at line 203 of file MissingETBase.h.
|
strong |
Physics contribution types category.
Enumerator | |
---|---|
Electron | Indicator for the MET term from reconstructed or MC truth electrons. |
Photon | Indicator for the MET term from reconstructed or MC truth electrons. |
Tau | Indicator for the MET term from reconstructed or MC truth tau leptons. |
Muon | Indicator for the MET term from reconstructed or MC truth muons. |
Jet | Indicator for the MET term from reconstructed or MC truth particle jets. |
SoftEvent | Indicator for the MET term from reconstructed soft event signals (tracks, clusters) or MC truth particles not contributing to any other (hard) final state object. |
Total | Indicator for the total reconstructed MET (sum of MET terms from reconstruction and MC truth particles) |
UnknownType | Indicator for an unknown MET term source. |
ATH_BITMASK |
Definition at line 174 of file MissingETBase.h.
|
inlinestatic |
Bit pattern indicating a EMTopo MET term.
[in] | reg | regional indicator bit pattern (optional, default is FullAcceptance) |
Definition at line 359 of file MissingETBase.h.
|
inlinestatic |
Bit pattern indicating a LCTopo MET term.
[in] | reg | regional indicator bit pattern (optional, default is FullAcceptance) |
Definition at line 352 of file MissingETBase.h.
|
inlinestatic |
Bit mask for MET term from any cluster signal objects.
[in] | reg | regional indicator bit pattern (optional, default is FullAcceptance) |
Definition at line 312 of file MissingETBase.h.
|
inlinestatic |
Bit mask for MET term from EMTopo signal objects.
[in] | reg | regional indicator bit pattern (optional, default is FullAcceptance) |
Definition at line 305 of file MissingETBase.h.
|
inlinestatic |
Bit mask for MET term from LCTopo (locally calibrated calorimeter cell clusters) signal objects.
[in] | reg | regional indicator bit pattern (optional, default is FullAcceptance) |
Definition at line 298 of file MissingETBase.h.
|
inlinestatic |
Standard MET term from reconstructed electrons.
[in] | reg | regional indicator bit pattern (optional, default is FullAcceptance) |
Definition at line 229 of file MissingETBase.h.
|
inlinestatic |
Check if bit pattern includes a given category.
true
if bits representing a given catergory are set, else false
.[in] | bits | bit pattern to be tested |
[in] | cat | category tag |
Definition at line 392 of file MissingETBase.h.
|
inlinestatic |
Generic check for given pattern.
true
if given bit pattern is set in data word, else false
.[in] | bits | bit pattern to be tested |
[in] | mask | test pattern |
Definition at line 382 of file MissingETBase.h.
|
inlinestatic |
Definition at line 395 of file MissingETBase.h.
|
inlinestatic |
Definition at line 394 of file MissingETBase.h.
|
inlinestatic |
Definition at line 393 of file MissingETBase.h.
|
inlinestatic |
Bit pattern indicating a ID Track MET term.
[in] | reg | regional indicator bit pattern (optional, default is FullAcceptance) |
Definition at line 366 of file MissingETBase.h.
|
inlinestatic |
Definition at line 398 of file MissingETBase.h.
|
inlinestatic |
Definition at line 402 of file MissingETBase.h.
|
inlinestatic |
Definition at line 401 of file MissingETBase.h.
|
inlinestatic |
Definition at line 399 of file MissingETBase.h.
|
inlinestatic |
Definition at line 403 of file MissingETBase.h.
|
inlinestatic |
Definition at line 400 of file MissingETBase.h.
|
inlinestatic |
Definition at line 405 of file MissingETBase.h.
|
inlinestatic |
Definition at line 404 of file MissingETBase.h.
|
inlinestatic |
Definition at line 408 of file MissingETBase.h.
|
inlinestatic |
Definition at line 409 of file MissingETBase.h.
|
inlinestatic |
Definition at line 410 of file MissingETBase.h.
|
inlinestatic |
Definition at line 407 of file MissingETBase.h.
|
inlinestatic |
Standard MET term from reconstructed jets.
[in] | reg | regional indicator bit pattern (optional, default is FullAcceptance) |
Definition at line 257 of file MissingETBase.h.
|
inlinestatic |
Standard MET term from reconstructed muons.
[in] | reg | regional indicator bit pattern (optional, default is FullAcceptance) |
Definition at line 250 of file MissingETBase.h.
|
inlinestatic |
Standard MET term from reconstructed photons.
[in] | reg | regional indicator bit pattern (optional, default is FullAcceptance) |
Definition at line 236 of file MissingETBase.h.
|
inlinestatic |
Bit mask for MET term from any (or mixed) signal objects.
[in] | sig | signal source indicator (optional, default is a mix of LCTopo and Track objects) |
[in] | reg | regional indicator bit pattern (optional, default is FullAcceptance) |
Definition at line 282 of file MissingETBase.h.
|
inlinestatic |
Standard MET term from reconstructed soft event.
[in] | reg | regional indicator bit pattern (optional, default is FullAcceptance) |
Definition at line 264 of file MissingETBase.h.
|
inlinestatic |
Standard MET term from reconstructed tau leptons.
[in] | reg | regional indicator bit pattern (optional, default is FullAcceptance) |
Definition at line 243 of file MissingETBase.h.
|
inlinestatic |
Standard full reconstructed MET.
[in] | reg | regional indicator bit pattern (optional, default is FullAcceptance) |
Definition at line 271 of file MissingETBase.h.
|
inlinestatic |
Bit mask for MET term from Track signal objects.
[in] | reg | regional indicator bit pattern (optional, default is FullAcceptance) |
Definition at line 291 of file MissingETBase.h.
|
inlinestatic |
Standard bit pattern indicating effective true MET.
[in] | reg | regional indicator bit pattern (optional, default is FullAcceptance) |
Definition at line 328 of file MissingETBase.h.
|
inlinestatic |
Standard bit pattern indicating a true MET contribution from particles outside of the detector \( \eta \) acceptance.
Definition at line 334 of file MissingETBase.h.
|
inlinestatic |
Standard bit pattern indicating the true muon contribution to MET truth.
[in] | reg | regional indicator bit pattern (optional, default is FullAcceptance) |
Definition at line 341 of file MissingETBase.h.
|
inlinestatic |
|
inlinestatic |
Definition at line 412 of file MissingETBase.h.