ATLAS Offline Software
gFexJetRoI_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_GFEXJETROI_V1_H
8 #define XAODTRIGGER_VERSIONS_GFEXJETROI_V1_H
9 
10 // System include(s):
11 extern "C" {
12 # include <stdint.h>
13 }
14 #include <vector>
15 #include <string>
16 
17 // xAOD include(s):
19 
20 namespace xAOD {
21 
24 
25  class gFexJetRoI_v1 : public SG::AuxElement {
26 
27  public:
29  gFexJetRoI_v1();
30 
32  void initialize( uint32_t word, int tobEtScale );
33 
35  enum ObjectType {
36  gRho = 0,
37  gBlockLead = 1,
38  gBlockSub = 2,
39  gJet = 3,
40  };
42 
44  uint32_t word() const;
47 
49  int menuEta() const;
50 
51  int tobEtScale() const;
53  void setScale( int value );
54 
56  int16_t gFexTobEt() const;
58  int16_t unpackEt( ) const;
59  float et() const;
60 
62  uint8_t iEta() const;
63  void setEta( uint8_t value);
64  unsigned int unpackEtaIndex( ) const;
65  float eta() const;
66  float etaMin() const;
67  float etaMax() const;
68 
70  uint8_t iPhi() const;
71  void setPhi( uint8_t value);
72  unsigned int unpackPhiIndex( ) const;
73  float phi_gFex() const;
74  float phiMin_gFex() const;
75  float phiMax_gFex() const;
76 
77  float phi() const;
78  float phiMin() const;
79  float phiMax() const;
80 
81  int iPhiTopo() const;
82 
84  uint8_t status() const;
85  void setStatus( uint8_t value ) ;
86  unsigned int unpackStatus( ) const;
87  uint8_t saturated() const;
90  unsigned int unpackSaturated( ) const;
91 
92  int gFexType () const;
93  void setgFexType ( int type) ;
94  int unpackType( ) const;
96  bool isgBlockLead() const;
97  //void setIsgBlockLead( char value);
98  bool isgBlockSub() const;
99  //void setIsgBlockSub( char value);
100  bool isgJet() const;
101  //void setIsgJet( char value);
102  bool isgRho() const;
103 
104 
105 
106 
107  private:
108 
109 
111  static const float s_PhiWidth;
112  static const std::vector<float> s_EtaEdge;
113  static const std::vector<float> s_EtaCenter;
114 
115 
121  // Data locations within word
122  static const int s_saturBit = 31;
123  static const int s_phiBit = 26;
124  static const int s_etaBit = 20;
125  static const int s_etBit = 8;
126  static const int s_statusBit = 7;
127  static const int s_resBit = 5;
128  static const int s_tobIDBit = 0;
129 
130  // Data masks
131  static const int s_saturMask = 0x1;
132  static const int s_phiMask = 0x1f;
133  static const int s_etaMask = 0x3f;
134  static const int s_etMask = 0xfff;
135  static const int s_statusMask = 0x1;
136  static const int s_resMask = 0x3;
137  static const int s_tobIDMask = 0x1f;
138 
139  }; // class gFexJetRoI_v1
140 
141 } // namespace xAOD
142 
143 // Declare the inheritance of the type:
144 #include "xAODCore/BaseInfo.h"
146 
147 #endif // XAODTRIGGER_VERSIONS_GFEXJETROI_V1_H
148 
xAOD::gFexJetRoI_v1::setScale
void setScale(int value)
Set the "raw" 32-bit words describing the object candidate.
xAOD::gFexJetRoI_v1::phi_gFex
float phi_gFex() const
retrieves the phi index from the 32-bit word
Definition: gFexJetRoI_v1.cxx:189
xAOD::gFexJetRoI_v1::isgJet
bool isgJet() const
Definition: gFexJetRoI_v1.cxx:119
xAOD::gFexJetRoI_v1::phiMax
float phiMax() const
Low value of phi corresponding to phi index (using ATLAS convention, phi in [-pi, pi]).
Definition: gFexJetRoI_v1.cxx:231
xAOD::gFexJetRoI_v1::s_phiMask
static const int s_phiMask
Definition: gFexJetRoI_v1.h:132
xAOD::gFexJetRoI_v1::setgFexType
void setgFexType(int type)
xAOD::gFexJetRoI_v1::setTobEt
void setTobEt(int16_t value)
getter for integer ET on TOB scale (3.2 GeV/count)
xAOD::uint8_t
uint8_t
Definition: Muon_v1.cxx:575
xAOD::gFexJetRoI_v1::eta
float eta() const
retrieves the Eta index from the 32-bit word
Definition: gFexJetRoI_v1.cxx:163
xAOD::uint32_t
setEventNumber uint32_t
Definition: EventInfo_v1.cxx:127
xAOD::gFexJetRoI_v1::etaMax
float etaMax() const
Floating point.
Definition: gFexJetRoI_v1.cxx:178
SG::AuxElement
Base class for elements of a container that can have aux data.
Definition: AuxElement.h:446
SG_BASE
SG_BASE(xAOD::gFexJetRoI_v1, SG::AuxElement)
xAOD::gFexJetRoI_v1::gBlockLead
@ gBlockLead
This object is a TOB (32 bit word)
Definition: gFexJetRoI_v1.h:37
xAOD::gFexJetRoI_v1::saturated
uint8_t saturated() const
retrieves the Status info from the 32-bit word
xAOD::gFexJetRoI_v1::s_tobIDMask
static const int s_tobIDMask
Definition: gFexJetRoI_v1.h:137
xAOD::gFexJetRoI_v1::unpackEtaIndex
unsigned int unpackEtaIndex() const
setter for the above
Definition: gFexJetRoI_v1.cxx:145
xAOD::gFexJetRoI_v1::etaMin
float etaMin() const
Floating point.
Definition: gFexJetRoI_v1.cxx:171
xAOD::gFexJetRoI_v1::setWord
void setWord(uint32_t value)
Set the "raw" 32-bit words describing the object candidate.
BaseInfo.h
xAOD::gFexJetRoI_v1::unpackSaturated
unsigned int unpackSaturated() const
Definition: gFexJetRoI_v1.cxx:132
athena.value
value
Definition: athena.py:122
xAOD
ICaloAffectedTool is abstract interface for tools checking if 4 mom is in calo affected region.
Definition: ICaloAffectedTool.h:24
xAOD::gFexJetRoI_v1::word
uint32_t word() const
The "raw" 32-bit word describing the object candidate.
xAOD::gFexJetRoI_v1::gFexTobEt
int16_t gFexTobEt() const
TOB ET (decoded from TOB, stored for convenience)
xAOD::gFexJetRoI_v1::s_statusBit
static const int s_statusBit
Definition: gFexJetRoI_v1.h:126
xAOD::gFexJetRoI_v1::phiMin_gFex
float phiMin_gFex() const
Central value of phi corresponding to phi index (using gFex convention, phi in [0,...
Definition: gFexJetRoI_v1.cxx:200
xAOD::gFexJetRoI_v1::phiMax_gFex
float phiMax_gFex() const
Low value of phi corresponding to phi index (using gFex convention, phi in [0, 2pi]).
Definition: gFexJetRoI_v1.cxx:210
xAOD::int16_t
setScaleOne setStatusOne setSaturated int16_t
Definition: gFexGlobalRoI_v1.cxx:55
xAOD::gFexJetRoI_v1::tobEtScale
int tobEtScale() const
xAOD::gFexJetRoI_v1::iPhiTopo
int iPhiTopo() const
High value of phi corresponding to phi index (using ATLAS convention, phi in [-pi,...
Definition: gFexJetRoI_v1.cxx:252
xAOD::gFexJetRoI_v1::setStatus
void setStatus(uint8_t value)
xAOD::gFexJetRoI_v1::unpackPhiIndex
unsigned int unpackPhiIndex() const
Setter for the above.
Definition: gFexJetRoI_v1.cxx:150
xAOD::gFexJetRoI_v1::s_etBit
static const int s_etBit
Definition: gFexJetRoI_v1.h:125
xAOD::gFexJetRoI_v1::gRho
@ gRho
Definition: gFexJetRoI_v1.h:36
xAOD::gFexJetRoI_v1::phi
float phi() const
High value of phi corresponding to phi index (using gFex convention, phi in [0, 2pi]).
Definition: gFexJetRoI_v1.cxx:220
xAOD::gFexJetRoI_v1::s_statusMask
static const int s_statusMask
Definition: gFexJetRoI_v1.h:135
xAOD::gFexJetRoI_v1::gBlockSub
@ gBlockSub
This object is a TOB (32 bit word)
Definition: gFexJetRoI_v1.h:38
xAOD::gFexJetRoI_v1::status
uint8_t status() const
phi index in the range used by L1Topo (0->127)
xAOD::gFexJetRoI_v1::iPhi
uint8_t iPhi() const
Floating point.
xAOD::gFexJetRoI_v1::setEta
void setEta(uint8_t value)
getter for integer eta index (0-63)
xAOD::gFexJetRoI_v1::s_EtaCenter
static const std::vector< float > s_EtaCenter
Definition: gFexJetRoI_v1.h:113
xAOD::gFexJetRoI_v1::unpackEt
int16_t unpackEt() const
setter for the above
Definition: gFexJetRoI_v1.cxx:138
xAOD::gFexJetRoI_v1::setPhi
void setPhi(uint8_t value)
Getter for integer phi index (0-32) --> check numbers for gFEX.
xAOD::gFexJetRoI_v1
Class describing properties of a LVL1 gFEX jet Trigger Object (TOB) in the xAOD format.
Definition: gFexJetRoI_v1.h:25
xAOD::gFexJetRoI_v1::gFexType
int gFexType() const
retrieves the Saturated info from the 32-bit word
xAOD::gFexJetRoI_v1::isgBlockSub
bool isgBlockSub() const
Definition: gFexJetRoI_v1.cxx:115
xAOD::gFexJetRoI_v1::s_etaBit
static const int s_etaBit
Definition: gFexJetRoI_v1.h:124
xAOD::gFexJetRoI_v1::s_etaMask
static const int s_etaMask
Definition: gFexJetRoI_v1.h:133
xAOD::gFexJetRoI_v1::iEta
uint8_t iEta() const
floating point value (GeV, TOB scale)
xAOD::gFexJetRoI_v1::s_resBit
static const int s_resBit
Definition: gFexJetRoI_v1.h:127
xAOD::gFexJetRoI_v1::et
float et() const
retrieves the Et index from the 32-bit word
Definition: gFexJetRoI_v1.cxx:157
xAOD::gFexJetRoI_v1::s_etMask
static const int s_etMask
Definition: gFexJetRoI_v1.h:134
xAOD::gFexJetRoI_v1::menuEta
int menuEta() const
the eta index to use for looking up thresholds in the menu
Definition: gFexJetRoI_v1.cxx:53
xAOD::gFexJetRoI_v1::s_saturMask
static const int s_saturMask
Definition: gFexJetRoI_v1.h:131
xAOD::gFexJetRoI_v1::unpackStatus
unsigned int unpackStatus() const
Definition: gFexJetRoI_v1.cxx:128
xAOD::gFexJetRoI_v1::s_EtaEdge
static const std::vector< float > s_EtaEdge
Definition: gFexJetRoI_v1.h:112
xAOD::gFexJetRoI_v1::gJet
@ gJet
This object is a TOB (32 bit word)
Definition: gFexJetRoI_v1.h:39
python.CaloScaleNoiseConfig.type
type
Definition: CaloScaleNoiseConfig.py:78
xAOD::gFexJetRoI_v1::phiMin
float phiMin() const
Central value of phi corresponding to phi index (using ATLAS convention, phi in [-pi,...
Definition: gFexJetRoI_v1.cxx:242
xAOD::gFexJetRoI_v1::gFexJetRoI_v1
gFexJetRoI_v1()
Default constructor.
Definition: gFexJetRoI_v1.cxx:35
xAOD::gFexJetRoI_v1::s_phiBit
static const int s_phiBit
Definition: gFexJetRoI_v1.h:123
xAOD::gFexJetRoI_v1::initialize
void initialize(uint32_t word, int tobEtScale)
Initialise the object with its most important properties: only the word for gFEX.
Definition: gFexJetRoI_v1.cxx:40
xAOD::gFexJetRoI_v1::setSaturated
void setSaturated(uint8_t value)
xAOD::gFexJetRoI_v1::s_resMask
static const int s_resMask
Definition: gFexJetRoI_v1.h:136
xAOD::gFexJetRoI_v1::unpackType
int unpackType() const
Definition: gFexJetRoI_v1.cxx:94
xAOD::gFexJetRoI_v1::isgRho
bool isgRho() const
Definition: gFexJetRoI_v1.cxx:123
xAOD::gFexJetRoI_v1::isgBlockLead
bool isgBlockLead() const
Identification of object type with flags.
Definition: gFexJetRoI_v1.cxx:111
xAOD::gFexJetRoI_v1::ObjectType
ObjectType
Object types.
Definition: gFexJetRoI_v1.h:35
xAOD::gFexJetRoI_v1::s_saturBit
static const int s_saturBit
Constants used in decoding TOB words For TOB word format changes these can be replaced by arrays in t...
Definition: gFexJetRoI_v1.h:122
xAOD::gFexJetRoI_v1::s_tobIDBit
static const int s_tobIDBit
Definition: gFexJetRoI_v1.h:128
xAOD::gFexJetRoI_v1::s_PhiWidth
static const float s_PhiWidth
Constants used in converting to ATLAS units.
Definition: gFexJetRoI_v1.h:111
AuxElement.h
Base class for elements of a container that can have aux data.