MissingETBase::Source Struct Reference

MET source indicators. More...

#include <MissingETBase.h>

List of all members.

Public Types

Bitmasks for MET source indicators



enum  Category {
  Refined = 0x10000, Truth = 0x20000, Calo = 0x40000, ID = 0x80000,
  UnknownCategory = 0x00000
}
 

Source category tag.

More...
enum  Type {
  Electron = 0x00001, Photon = 0x00002, Tau = 0x00004, Muon = 0x00008,
  Jet = 0x00010, SoftEvent = 0x00020, Total = 0x00040, UnknownType = 0x00000
}
 

Physics contribution types category.

More...
enum  Region {
  Central = 0x00100, Endcap = 0x00200, Forward = 0x00400, FullAcceptance = 0x00000,
  UnknownRegion = 0x00000
}
 

Regional tags.

More...
enum  TruthType {
  NonInt = 0x21000, Int = 0x22000, IntOut = 0x24000, TruthMuons = 0x28000,
  UnknownTruth = 0x00000
}
 

Truth type indicators.

More...
enum  Signal { LCTopo = 0x01000, EMTopo = 0x02000, Track = 0x04000, UnknownSignal = 0x00000 }
 

Signal contribution types.

More...

Static Public Member Functions

static bool isElectronTerm (Types::bitmask_t bits, Region reg=FullAcceptance)
static bool isPhotonTerm (Types::bitmask_t bits, Region reg=FullAcceptance)
static bool isTauTerm (Types::bitmask_t bits, Region reg=FullAcceptance)
static bool isMuonTerm (Types::bitmask_t bits, Region reg=FullAcceptance)
static bool isJetTerm (Types::bitmask_t bits, Region reg=FullAcceptance)
static bool isSoftTerm (Types::bitmask_t bits, Region reg=FullAcceptance)
static bool isTrackTerm (Types::bitmask_t bits, Region reg=FullAcceptance)
static bool isTotalTerm (Types::bitmask_t bits, Region reg=FullAcceptance)
static bool isTruthNonInt (Types::bitmask_t bits)
static bool isTruthInt (Types::bitmask_t bits, Region reg=FullAcceptance)
static bool isTruthIntOut (Types::bitmask_t bits)
static bool isTruthMuons (Types::bitmask_t bits, Region reg=FullAcceptance)
static bool unknown ()
Bit mask constructors for pre-defined MET physics object contributions



static Types::bitmask_t electron (Region reg=FullAcceptance)
 Standard MET term from reconstructed electrons.
static Types::bitmask_t photon (Region reg=FullAcceptance)
 Standard MET term from reconstructed photons.
static Types::bitmask_t tau (Region reg=FullAcceptance)
 Standard MET term from reconstructed tau leptons.
static Types::bitmask_t muon (Region reg=FullAcceptance)
 Standard MET term from reconstructed muons.
static Types::bitmask_t jet (Region reg=FullAcceptance)
 Standard MET term from reconstructed jets.
static Types::bitmask_t softEvent (Region reg=FullAcceptance)
 Standard MET term from reconstructed soft event.
static Types::bitmask_t total (Region reg=FullAcceptance)
 Standard full reconstructed MET.
Bit mask constructors for pre-defined MET signal object contributions



static Types::bitmask_t signal (Types::bitmask_t sig=(LCTopo|Track), Region reg=FullAcceptance)
 Bit mask for MET term from any (or mixed) signal objects.
static Types::bitmask_t track (Region reg=FullAcceptance)
 Bit mask for MET term from Track signal objects.
static Types::bitmask_t clusterLC (Region reg=FullAcceptance)
 Bit mask for MET term from LCTopo (locally calibrated calorimeter cell clusters) signal objects.
static Types::bitmask_t clusterEM (Region reg=FullAcceptance)
 Bit mask for MET term from EMTopo signal objects.
static Types::bitmask_t cluster (Region reg=FullAcceptance)
 Bit mask for MET term from any cluster signal objects.
Truth indicator bit patterns



static Types::bitmask_t truthNonInt ()
 Standard bit pattern indicating genuine true MET.
static Types::bitmask_t truthInt (Region reg=FullAcceptance)
 Standard bit pattern indicating effective true MET.
static Types::bitmask_t truthIntOut ()
 Standard bit pattern indicating a true MET contribution from particles outside of the detector $ \eta $ acceptance.
static Types::bitmask_t truthMuons (Region reg=FullAcceptance)
 Standard bit pattern indicating the true muon contribution to MET truth.
Indicators for MET terms from detector signals



static Types::bitmask_t caloLCTopo (Region reg=FullAcceptance)
 Bit pattern indicating a LCTopo MET term.
static Types::bitmask_t caloEMTopo (Region reg=FullAcceptance)
 Bit pattern indicating a EMTopo MET term.
static Types::bitmask_t idTrack (Region reg=FullAcceptance)
 Bit pattern indicating a ID Track MET term.
Pattern tests for categories, types, truth types, and signal tags



static bool hasPattern (Types::bitmask_t bits, Types::bitmask_t mask)
 Generic check for given pattern.
static bool hasCategory (Types::bitmask_t bits, Category cat)
 Check if bit pattern includes a given category.
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)

Detailed Description

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.


Member Enumeration Documentation

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.

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).

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.

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.

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.


Member Function Documentation

static Types::bitmask_t MissingETBase::Source::caloEMTopo ( Region  reg = FullAcceptance  )  [inline, static]

Bit pattern indicating a EMTopo MET term.

Returns:
Bit pattern indicating a MET term exclusively constructed from (all) EMTopo clusters in the event.
Parameters:
[in] reg regional indicator bit pattern (optional, default is FullAcceptance)
static Types::bitmask_t MissingETBase::Source::caloLCTopo ( Region  reg = FullAcceptance  )  [inline, static]

Bit pattern indicating a LCTopo MET term.

Returns:
Bit pattern indicating a MET term exclusively constructed from (all) LCTopo clusters in the event.
Parameters:
[in] reg regional indicator bit pattern (optional, default is FullAcceptance)
static Types::bitmask_t MissingETBase::Source::cluster ( Region  reg = FullAcceptance  )  [inline, static]

Bit mask for MET term from any cluster signal objects.

Returns:
Default bit pattern for a MET term constructed from EMTopo and/or LCTopo signal objects.
Parameters:
[in] reg regional indicator bit pattern (optional, default is FullAcceptance)
static Types::bitmask_t MissingETBase::Source::clusterEM ( Region  reg = FullAcceptance  )  [inline, static]

Bit mask for MET term from EMTopo signal objects.

Returns:
Default bit pattern for a MET term exclusively constructed from EMTopo signal objects.
Parameters:
[in] reg regional indicator bit pattern (optional, default is FullAcceptance)
static Types::bitmask_t MissingETBase::Source::clusterLC ( Region  reg = FullAcceptance  )  [inline, static]

Bit mask for MET term from LCTopo (locally calibrated calorimeter cell clusters) signal objects.

Returns:
Default bit pattern for a MET term exclusively constructed from LCTopo signal objects.
Parameters:
[in] reg regional indicator bit pattern (optional, default is FullAcceptance)
static Types::bitmask_t MissingETBase::Source::electron ( Region  reg = FullAcceptance  )  [inline, static]

Standard MET term from reconstructed electrons.

Returns:
Default bit pattern for the electron MET term indicator. It can optional be OR'ed with a regional tag.
Parameters:
[in] reg regional indicator bit pattern (optional, default is FullAcceptance)
static bool MissingETBase::Source::hasCategory ( Types::bitmask_t  bits,
Category  cat 
) [inline, static]

Check if bit pattern includes a given category.

Returns:
true if bits representing a given catergory are set, else false.
Parameters:
[in] bits bit pattern to be tested
[in] cat category tag
static bool MissingETBase::Source::hasPattern ( Types::bitmask_t  bits,
Types::bitmask_t  mask 
) [inline, static]

Generic check for given pattern.

Returns:
true if given bit pattern is set in data word, else false.
Parameters:
[in] bits bit pattern to be tested
[in] mask test pattern
Note:
This is not a test on equality of two bit patterns. The only requirement is that the tested word has all bits of a given pattern set. Additional set bits are ignored.
static Types::bitmask_t MissingETBase::Source::idTrack ( Region  reg = FullAcceptance  )  [inline, static]

Bit pattern indicating a ID Track MET term.

Returns:
Bit pattern indicating a MET term exclusively constructed from ID tracks.
Parameters:
[in] reg regional indicator bit pattern (optional, default is FullAcceptance)
static Types::bitmask_t MissingETBase::Source::jet ( Region  reg = FullAcceptance  )  [inline, static]

Standard MET term from reconstructed jets.

Returns:
Default bit pattern for the jet MET term indicator. It can optional be OR'ed with a regional tag.
Parameters:
[in] reg regional indicator bit pattern (optional, default is FullAcceptance)
static Types::bitmask_t MissingETBase::Source::muon ( Region  reg = FullAcceptance  )  [inline, static]

Standard MET term from reconstructed muons.

Returns:
Default bit pattern for the muon MET term indicator. It can optional be OR'ed with a regional tag.
Parameters:
[in] reg regional indicator bit pattern (optional, default is FullAcceptance)
static Types::bitmask_t MissingETBase::Source::photon ( Region  reg = FullAcceptance  )  [inline, static]

Standard MET term from reconstructed photons.

Returns:
Default bit pattern for the photon MET term indicator. It can optional be OR'ed with a regional tag.
Parameters:
[in] reg regional indicator bit pattern (optional, default is FullAcceptance)
static Types::bitmask_t MissingETBase::Source::signal ( Types::bitmask_t  sig = (LCTopo|Track),
Region  reg = FullAcceptance 
) [inline, static]

Bit mask for MET term from any (or mixed) signal objects.

Returns:
Default bit pattern for a MET term exclusively constructed from LCTopo or Track signal objects, or a mix of LCTopo and Track objects (default behaviour).
Parameters:
[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)
static Types::bitmask_t MissingETBase::Source::softEvent ( Region  reg = FullAcceptance  )  [inline, static]

Standard MET term from reconstructed soft event.

Returns:
Default bit pattern for the soft event MET term indicator. It can optional be OR'ed with a regional tag.
Parameters:
[in] reg regional indicator bit pattern (optional, default is FullAcceptance)
static Types::bitmask_t MissingETBase::Source::tau ( Region  reg = FullAcceptance  )  [inline, static]

Standard MET term from reconstructed tau leptons.

Returns:
Default bit pattern for the tau MET term indicator. It can optional be OR'ed with a regional tag.
Parameters:
[in] reg regional indicator bit pattern (optional, default is FullAcceptance)
static Types::bitmask_t MissingETBase::Source::total ( Region  reg = FullAcceptance  )  [inline, static]

Standard full reconstructed MET.

Returns:
Default bit pattern for a fully reconstructed MET. It can optional be OR'ed with a regional tag.
Parameters:
[in] reg regional indicator bit pattern (optional, default is FullAcceptance)
static Types::bitmask_t MissingETBase::Source::track ( Region  reg = FullAcceptance  )  [inline, static]

Bit mask for MET term from Track signal objects.

Returns:
Default bit pattern for a MET term exclusively constructed from Track signal objects.
Parameters:
[in] reg regional indicator bit pattern (optional, default is FullAcceptance)
static Types::bitmask_t MissingETBase::Source::truthInt ( Region  reg = FullAcceptance  )  [inline, static]

Standard bit pattern indicating effective true MET.

Returns:
Default bit pattern for a MET term constructed from all (stable and interacting) particles emitted into the detector $ \eta $ acceptance.
Parameters:
[in] reg regional indicator bit pattern (optional, default is FullAcceptance)
static Types::bitmask_t MissingETBase::Source::truthIntOut (  )  [inline, static]

Standard bit pattern indicating a true MET contribution from particles outside of the detector $ \eta $ acceptance.

Returns:
Default bit pattern for a MET term constructed from all (stable and interacting) final state particles in the MC truth event generated outside the detector $ \eta $ acceptance.
static Types::bitmask_t MissingETBase::Source::truthMuons ( Region  reg = FullAcceptance  )  [inline, static]

Standard bit pattern indicating the true muon contribution to MET truth.

Returns:
Default bit pattern for a MET term constructed from muons generated in the interaction.
Parameters:
[in] reg regional indicator bit pattern (optional, default is FullAcceptance)
static Types::bitmask_t MissingETBase::Source::truthNonInt (  )  [inline, static]

Standard bit pattern indicating genuine true MET.

Returns:
Default bit pattern for a MET term constructed from non-interacting final state particles in the MC truth event.

The documentation for this struct was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 1 Dec 2017 for RootCore Packages by  doxygen 1.6.1