ATLAS Offline Software
Classes | Public Types | List of all members
MissingETBase::Status Struct Reference

Namespace for status word tags. More...

#include <MissingETCompositionBase.h>

Collaboration diagram for MissingETBase::Status:

Classes

struct  Tags
 

Public Types

enum  Reco : Types::bitmask_t {
  Reco::Total = 0x01000000, Reco::ContributedTerm = 0x02000000, Reco::CorrectedTerm = 0x04000000, Reco::AlternativeTerm = 0x08000000,
  Reco::StandAlone = 0x00000000, Reco::ATH_BITMASK
}
 General indicator of MET reconstruction status. More...
 
enum  Vertex : Types::bitmask_t {
  Vertex::Primary = 0x00100000, Vertex::Secondary = 0x00200000, Vertex::Event = 0x00010000, Vertex::Nominal = 0x00020000,
  Vertex::Specific = 0x00040000, Vertex::NoVertex = 0x00000000, Vertex::ATH_BITMASK
}
 Indicator for vertex choice in MET reconstruction. More...
 
enum  Correction : Types::bitmask_t {
  Correction::Corrected = 0x00001000, Correction::Pileup = 0x00001100, Correction::PileupCalo = 0x00001110, Correction::PileupTrack = 0x00001120,
  Correction::PileupSTVF = 0x00001121, Correction::PileupJetVertex = 0x00001122, Correction::PileupJetArea = 0x00001140, Correction::NotCorrected = 0x00000000,
  Correction::ATH_BITMASK
}
 Indicator for correction. More...
 

Bit pattern for overall contribution indicator

static const Types::bitmask_t clearedStatusTag = Reco::StandAlone | Vertex::NoVertex | Correction::NotCorrected
 General cleared term tag. More...
 
static const Types::bitmask_t generalSummedTag = Reco::Total | Vertex::NoVertex | Correction::NotCorrected
 General summed MET tag. More...
 
static const Types::bitmask_t generalContribTag = Reco::StandAlone | Vertex::NoVertex | Correction::NotCorrected
 General contribution tag. More...
 
static const Types::bitmask_t generalHardTermTag = Reco::ContributedTerm | Vertex::Specific | Correction::Pileup
 General hard term contribution tag. More...
 
static const Types::bitmask_t generalSoftTermTag = Reco::ContributedTerm | Vertex::NoVertex | Correction::NotCorrected
 General soft term contribution tag. More...
 
static Types::bitmask_t clearedStatus ()
 Cleared term tag accessor. More...
 
static Types::bitmask_t summedTerm ()
 General summed term tag accessor. More...
 
static Types::bitmask_t contributedTerm ()
 General contribution tag accesssor. More...
 
static Types::bitmask_t contributedHardTerm ()
 General hard term contribution tag accessor. More...
 
static Types::bitmask_t contributedSoftTerm ()
 General soft term contribution tag accessor. More...
 

Detailed Description

Namespace for status word tags.

This namespace collects bit patterns for three different categories characterizing the status of a contribution to a given MissingET object. MissingETBase::Status::Reco has bit patterns tagging the reconstruction status:

indcates

Definition at line 70 of file MissingETCompositionBase.h.

Member Enumeration Documentation

◆ Correction

Indicator for correction.

This is mainly applied for the MET SoftTerm and MET from hard jets, which may be subjected to a pile-up filter. These indicators are not meant to tag the fact that a contributing object has corrected kinematics.

Enumerator
Corrected 

Indicator for corrected MET.

Pileup 

MET term is pile-up corrected.

PileupCalo 

Calorimeter signal based pile-up correction.

PileupTrack 

Reconstructed track based pile-up correction.

PileupSTVF 

STVF correction is applied.

PileupJetVertex 

JVF based filter is applied.

PileupJetArea 

Jet area based pileup correction.

NotCorrected 

No MET specific correction applied to term.

ATH_BITMASK 

Definition at line 96 of file MissingETCompositionBase.h.

97  Corrected = 0x00001000,
98  Pileup = 0x00001100,
99  PileupCalo = 0x00001110,
100  PileupTrack = 0x00001120,
101  PileupSTVF = 0x00001121,
102  PileupJetVertex = 0x00001122,
103  PileupJetArea = 0x00001140,
104  NotCorrected = 0x00000000,
106  };

◆ Reco

General indicator of MET reconstruction status.

Enumerator
Total 

Total MET for given composition.

ContributedTerm 

Contribution to total MET.

CorrectedTerm 

Corrected term (replaces default contributed term.

AlternativeTerm 

Alternative term.

StandAlone 

Unknown/standalone reconstruction.

ATH_BITMASK 

Definition at line 73 of file MissingETCompositionBase.h.

74  Total = 0x01000000,
75  ContributedTerm = 0x02000000,
76  CorrectedTerm = 0x04000000,
77  AlternativeTerm = 0x08000000,
78  StandAlone = 0x00000000,
80  };

◆ Vertex

Indicator for vertex choice in MET reconstruction.

Enumerator
Primary 

MET (term) is calculated with respect to primary vertex.

Secondary 

MET (term) is calculated with respect to secondary vertex.

Event 

Vertex recconstructed in event.

Nominal 

Primary vertex is nominal vertex.

Specific 

MET term is calculated with respect to object vertices.

NoVertex 

Unknown vertex.

ATH_BITMASK 

Definition at line 82 of file MissingETCompositionBase.h.

83  Primary = 0x00100000,
84  Secondary = 0x00200000,
85  Event = 0x00010000,
86  Nominal = 0x00020000,
87  Specific = 0x00040000,
88  NoVertex = 0x00000000,
90  };

Member Function Documentation

◆ clearedStatus()

static Types::bitmask_t MissingETBase::Status::clearedStatus ( )
inlinestatic

Cleared term tag accessor.

Definition at line 115 of file MissingETCompositionBase.h.

◆ contributedHardTerm()

static Types::bitmask_t MissingETBase::Status::contributedHardTerm ( )
inlinestatic

General hard term contribution tag accessor.

Definition at line 118 of file MissingETCompositionBase.h.

◆ contributedSoftTerm()

static Types::bitmask_t MissingETBase::Status::contributedSoftTerm ( )
inlinestatic

General soft term contribution tag accessor.

Definition at line 119 of file MissingETCompositionBase.h.

◆ contributedTerm()

static Types::bitmask_t MissingETBase::Status::contributedTerm ( )
inlinestatic

General contribution tag accesssor.

Definition at line 117 of file MissingETCompositionBase.h.

◆ summedTerm()

static Types::bitmask_t MissingETBase::Status::summedTerm ( )
inlinestatic

General summed term tag accessor.

Definition at line 116 of file MissingETCompositionBase.h.

Member Data Documentation

◆ clearedStatusTag

const Types::bitmask_t MissingETBase::Status::clearedStatusTag = Reco::StandAlone | Vertex::NoVertex | Correction::NotCorrected
static

General cleared term tag.

Definition at line 110 of file MissingETCompositionBase.h.

◆ generalContribTag

const Types::bitmask_t MissingETBase::Status::generalContribTag = Reco::StandAlone | Vertex::NoVertex | Correction::NotCorrected
static

General contribution tag.

Definition at line 112 of file MissingETCompositionBase.h.

◆ generalHardTermTag

const Types::bitmask_t MissingETBase::Status::generalHardTermTag = Reco::ContributedTerm | Vertex::Specific | Correction::Pileup
static

General hard term contribution tag.

Definition at line 113 of file MissingETCompositionBase.h.

◆ generalSoftTermTag

const Types::bitmask_t MissingETBase::Status::generalSoftTermTag = Reco::ContributedTerm | Vertex::NoVertex | Correction::NotCorrected
static

General soft term contribution tag.

Definition at line 114 of file MissingETCompositionBase.h.

◆ generalSummedTag

const Types::bitmask_t MissingETBase::Status::generalSummedTag = Reco::Total | Vertex::NoVertex | Correction::NotCorrected
static

General summed MET tag.

Definition at line 111 of file MissingETCompositionBase.h.


The documentation for this struct was generated from the following file:
ATH_BITMASK
#define ATH_BITMASK
Mark that a class enum should be treated as a bitmask.
Definition: bitmask.h:70
InDet::TrkOrigin::Pileup
@ Pileup
Definition: InDetTrackTruthOriginDefs.h:20
Event
Definition: trigbs_orderedMerge.cxx:42
Trk::TruthClassification::Secondary
@ Secondary
Definition: TruthClassificationDefs.h:26
MissingETBase::Types::bitmask_t
uint64_t bitmask_t
Type for status word bit mask.
Definition: MissingETBase.h:39
Analysis::Total
@ Total
Definition: CalibrationDataInterfaceROOT.h:70
InDet::ExclusiveOrigin::Primary
@ Primary
Definition: InDetTrackTruthOriginDefs.h:163
egEnergyCorr::Resolution::Nominal
@ Nominal
Definition: egammaEnergyCorrectionTool.h:62
TauAnalysisTools::PileupTrack
@ PileupTrack
Definition: TauTruthTrackMatchingTool.h:34