ATLAS Offline Software
Loading...
Searching...
No Matches
gFexGlobalRoI_v1.h
Go to the documentation of this file.
1// Dear emacs, this is -*- c++ -*-
2
3/*
4 Copyright (C) 2002-2021 CERN for the benefit of the ATLAS collaboration
5*/
6
7#ifndef XAODTRIGGER_VERSIONS_GFEXGLOBALROI_V1_H
8#define XAODTRIGGER_VERSIONS_GFEXGLOBALROI_V1_H
9
10// System include(s):
11extern "C" {
12# include <stdint.h>
13}
14#include <vector>
15#include <string>
16
17// xAOD include(s):
19
20namespace xAOD {
21
24
26
27 public:
30
32 // void initialize( uint32_t word, int tobEtScaleOne );
34
37 gNull = 0,
38 gScalar = 1,
39 gMET = 2,
40 gMHT = 3,
41 gMST = 4
42 };
43
44
46 uint32_t word() const;
48 void setWord( uint32_t value );
49
50 int tobEtScaleOne() const;
52 void setScaleOne( int value );
53
54 int tobEtScaleTwo() const;
56 void setScaleTwo( int value );
57
60 void setQuantityOne( int16_t value);
62
64 void setQuantityTwo( int16_t value);
66
67 float METquantityOne() const;
68 float METquantityTwo() const;
69 float SumEt() const;
70
71
72
75 void setStatusOne( uint8_t value ) ;
77 void setStatusTwo( uint8_t value ) ;
78 unsigned int unpackStatusOne( ) const;
79 unsigned int unpackStatusTwo( ) const;
82 void setSaturated( uint8_t value ) ;
83 unsigned int unpackSaturated( ) const;
84
85 int globalType () const;
86 void setGlobalType ( int type) ;
87 int unpackType( ) const;
89 bool isgScalar() const;
90 bool isgMET() const;
91 bool isgMHT() const;
92 bool isgMST() const;
93
94
95
96
97 private:
98
99
101 // static const float s_globaltobEtScale;
102
103
104 // Constants used in decoding TOB words
105
106
107 // Data locations within word
108 static const int s_saturBit = 31;
109 static const int s_tobIDBit = 26;
110 static const int s_statusOneBit = 25;
111 static const int s_statusTwoBit = 24;
112 static const int s_quantityOneBit = 12;
113 static const int s_quantityTwoBit = 0;
114
115 // Data masks
116 static const int s_saturMask = 0x1;
117 static const int s_tobIDMask = 0x1f;
118 static const int s_statusOneMask = 0x1;
119 static const int s_statusTwoMask = 0x1;
120 static const int s_quantityOneMask = 0xfff;
121 static const int s_quantityTwoMask = 0xfff;
122
123
124 }; // class gFexGlobalRoI_v1
125
126} // namespace xAOD
127
128// Declare the inheritance of the type:
129#include "xAODCore/BaseInfo.h"
131
132#endif // XAODTRIGGER_VERSIONS_GFEXGLOBALROI_V1_H
133
Base class for elements of a container that can have aux data.
#define SG_BASE(D, B)
Declare that class D derives from class B.
Base class for elements of a container that can have aux data.
Definition AuxElement.h:483
Class describing properties of a LVL1 gFEX global Trigger Object (TOB) in the xAOD format.
unsigned int unpackStatusTwo() const
retrieves the Status info for Quantity 1 from the 32-bit word
uint8_t statusTwo() const
static const int s_statusOneBit
float METquantityTwo() const
floating point value (GeV, TOB scale)
void setWord(uint32_t value)
Set the "raw" 32-bit words describing the object candidate.
static const int s_quantityOneBit
@ gScalar
indicaes a null value (should be accompanied by a Status=0)
@ gMST
MET hard term components (MHTx, MHTy)
@ gMET
scalar values (MET, SumET))
@ gMHT
MET components (METx, METy)
int16_t quantityOne() const
TOB ET (decoded from TOB, stored for convenience)
int16_t quantityTwo() const
retrieves the Et index from the 32-bit word
static const int s_quantityTwoMask
static const int s_saturMask
void setQuantityTwo(int16_t value)
getter for integer ET on TOB scale (3.2 GeV/count)
int tobEtScaleOne() const
static const int s_statusTwoBit
static const int s_quantityTwoBit
int tobEtScaleTwo() const
int16_t unpackQuantityOne() const
setter for the above
int16_t unpackQuantityTwo() const
setter for the above
float METquantityOne() const
retrieves the Et index from the 32-bit word
uint8_t saturated() const
retrieves the Status info for Quantity 2 from the 32-bit word
unsigned int unpackStatusOne() const
void setStatusOne(uint8_t value)
static const int s_statusOneMask
static const int s_tobIDMask
static const int s_saturBit
Constants used in converting to ATLAS units.
void setSaturated(uint8_t value)
int globalType() const
retrieves the energy saturation status from the 32-bit word
bool isgScalar() const
Identification of object type with flags.
static const int s_statusTwoMask
unsigned int unpackSaturated() const
uint8_t statusOne() const
floating point value (GeV, TOB scale)
gFexGlobalRoI_v1()
Default constructor.
static const int s_quantityOneMask
void setQuantityOne(int16_t value)
getter for integer ET on TOB scale (3.2 GeV/count)
void setScaleOne(int value)
Set the "raw" 32-bit words describing the object candidate.
uint32_t word() const
The "raw" 32-bit word describing the object candidate.
static const int s_tobIDBit
void setGlobalType(int type)
void setStatusTwo(uint8_t value)
float SumEt() const
floating point value (GeV, TOB scale)
void setScaleTwo(int value)
Set the "raw" 32-bit words describing the object candidate.
ICaloAffectedTool is abstract interface for tools checking if 4 mom is in calo affected region.
setScaleOne setStatusOne setSaturated int16_t
setEventNumber uint32_t
void initialize()