ATLAS Offline Software
jFexFwdElRoI_v1.h
Go to the documentation of this file.
1 //create
2 /*
3  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
4 */
5 #ifndef XAODTRIGGER_VERSIONS_JFEXFWDELROI_V1_H
6 #define XAODTRIGGER_VERSIONS_JFEXFWDELROI_V1_H
7 
8 // System include(s):
9 extern "C" {
10 # include <stdint.h>
11 # include <math.h>
12 }
13 #include <vector>
14 #include <string>
15 
16 // xAOD include(s):
18 namespace xAOD {
19 
22 
24 
25  public:
28 
30  void initialize(uint8_t jFexNumber,uint8_t fpgaNumber, uint32_t tobWord, char istob, int resolution, float_t eta, float_t phi );
31 
33  uint32_t tobWord() const; //need 27/32 bits
35  uint16_t tobEt() const; //need 11 bits
36  uint8_t tobEMIso() const; //need 2 bits
37  uint8_t tobEMf1() const; //need 2 bits
38  uint8_t tobEMf2() const; //need 2 bits
39  uint8_t tobLocalEta() const; //need 5 bits
40  uint8_t tobLocalPhi() const; //need 4 bits
41  uint8_t tobSat() const; //need 1 bits
43  int globalEta() const;
44  uint globalPhi() const;
48  float eta() const;
49  float phi() const;
50  int tobEtScale() const;
51  char isTOB() const;
55  uint16_t EtEMiso() const;
56  uint16_t EtEM() const;
57  uint16_t EtHad1() const;
58  uint16_t EtHad2() const;
59 
61  int menuEta() const;
62 
64  void setIsTOB( char value);
65 
70 
72  unsigned int unpackEtTOB() const;
74  unsigned int et() const;
75 
77  unsigned int unpackEMIsoTOB() const;
79 
81  unsigned int unpackEMf1TOB() const;
83  unsigned int unpackEMf2TOB() const;
85 
87  unsigned int unpackEtaIndex() const;
89 
91  unsigned int unpackPhiIndex() const;
93 
94  //Saturation flag
95  unsigned int unpackSaturationIndex() const;
97 
98  //Global coords
99  int getGlobalEta() const;
100  void setGlobalEta(int value);
101  void setEta(float value);
102 
103  uint getGlobalPhi() const;
105  void setPhi(float value);
106 
107  //Et resolution
108  void setResolution(int value);
109 
110  // additional variables (not available yet)
111  unsigned int getEtEMiso() const;
113  unsigned int getEtEM() const;
115  unsigned int getEtHad1() const;
117  unsigned int getEtHad2() const;
119 
120 
121 
122  private:
123  //Constants used in converting to ATLAS units (see SR jets)
124  static const std::vector<int> s_FWD_EtaPosition;
125  static const std::vector<int> s_FCAL_EtaPosition;
126 
127  // Data locations within word
128  static const int s_resBit = 27;
129  static const int s_emf2Bit = 25;
130  static const int s_emf1Bit = 23;
131  static const int s_isoBit = 21;
132  static const int s_etBit = 10;
133  static const int s_etaBit = 5;
134  static const int s_phiBit = 1;
135  static const int s_satBit = 0;
136 
137  //Data masks
138  static const int s_resMask = 0x1f;
139  static const int s_emf2Mask = 0x3;
140  static const int s_emf1Mask = 0x3;
141  static const int s_isoMask = 0x3;
142  static const int s_etMask = 0x7ff;
143  static const int s_etaMask = 0x1f;
144  static const int s_phiMask = 0xf;
145  static const int s_satMask = 0x1;
146 
147  }; // class jFexFwdElRoI_v1
148 
149 } // namespace xAOD
150 // Declare the inheritance of the type:
151 #include "xAODCore/BaseInfo.h"
153 
154 #endif //XAODTRIGGER_VERSIONS_JFEXFWDELROI_V1_H
xAOD::jFexFwdElRoI_v1::unpackEtaIndex
unsigned int unpackEtaIndex() const
Eta coordinates.
Definition: jFexFwdElRoI_v1.cxx:135
xAOD::jFexFwdElRoI_v1::unpackEMf2TOB
unsigned int unpackEMf2TOB() const
Definition: jFexFwdElRoI_v1.cxx:130
xAOD::jFexFwdElRoI_v1::setjFexNumber
void setjFexNumber(uint8_t jFexNumber)
xAOD::jFexFwdElRoI_v1::setGlobalPhi
void setGlobalPhi(uint value)
xAOD::jFexFwdElRoI_v1::tobLocalEta
uint8_t tobLocalEta() const
xAOD::uint8_t
uint8_t
Definition: Muon_v1.cxx:557
xAOD::jFexFwdElRoI_v1::unpackEMf1TOB
unsigned int unpackEMf1TOB() const
TOB EM fraction bits (decoded from TOB, stored for convenience)
Definition: jFexFwdElRoI_v1.cxx:125
xAOD::jFexFwdElRoI_v1::isTOB
char isTOB() const
xAOD::uint32_t
setEventNumber uint32_t
Definition: EventInfo_v1.cxx:127
xAOD::jFexFwdElRoI_v1::tobEMf1
uint8_t tobEMf1() const
SG::AuxElement
Base class for elements of a container that can have aux data.
Definition: AuxElement.h:483
xAOD::jFexFwdElRoI_v1::eta
float eta() const
xAOD::jFexFwdElRoI_v1::getGlobalPhi
uint getGlobalPhi() const
Definition: jFexFwdElRoI_v1.cxx:203
xAOD::jFexFwdElRoI_v1::setEtEMiso
void setEtEMiso(uint16_t value)
xAOD::jFexFwdElRoI_v1::getGlobalEta
int getGlobalEta() const
could add iso, emf1 and emf2 calculated from EtEMiso, EtEM, ETHad1 and EtHad2
Definition: jFexFwdElRoI_v1.cxx:160
xAOD::jFexFwdElRoI_v1::jFexNumber
uint8_t jFexNumber() const
Additional info (initialization)
xAOD::jFexFwdElRoI_v1::phi
float phi() const
xAOD::jFexFwdElRoI_v1::globalEta
int globalEta() const
Calculated from Tob.
xAOD::jFexFwdElRoI_v1::s_etaMask
static const int s_etaMask
Definition: jFexFwdElRoI_v1.h:143
BaseInfo.h
xAOD::jFexFwdElRoI_v1::EtHad2
uint16_t EtHad2() const
xAOD::jFexFwdElRoI_v1::s_resBit
static const int s_resBit
Definition: jFexFwdElRoI_v1.h:128
xAOD::jFexFwdElRoI_v1::s_phiMask
static const int s_phiMask
Definition: jFexFwdElRoI_v1.h:144
athena.value
value
Definition: athena.py:124
xAOD::jFexFwdElRoI_v1::jFexFwdElRoI_v1
jFexFwdElRoI_v1()
Default constructor.
Definition: jFexFwdElRoI_v1.cxx:27
xAOD::jFexFwdElRoI_v1::tobLocalPhi
uint8_t tobLocalPhi() const
xAOD
ICaloAffectedTool is abstract interface for tools checking if 4 mom is in calo affected region.
Definition: ICaloAffectedTool.h:24
xAOD::jFexFwdElRoI_v1::s_FWD_EtaPosition
static const std::vector< int > s_FWD_EtaPosition
Definition: jFexFwdElRoI_v1.h:124
xAOD::jFexFwdElRoI_v1::setEtHad1
void setEtHad1(uint16_t value)
SG_BASE
SG_BASE(xAOD::jFexFwdElRoI_v1, SG::AuxElement)
xAOD::jFexFwdElRoI_v1::tobEtScale
int tobEtScale() const
xAOD::jFexFwdElRoI_v1::s_satBit
static const int s_satBit
Definition: jFexFwdElRoI_v1.h:135
Dedxcorrection::resolution
double resolution[nGasTypes][nParametersResolution]
Definition: TRT_ToT_Corrections.h:46
xAOD::jFexFwdElRoI_v1::s_etBit
static const int s_etBit
Definition: jFexFwdElRoI_v1.h:132
xAOD::jFexFwdElRoI_v1::unpackSaturationIndex
unsigned int unpackSaturationIndex() const
Definition: jFexFwdElRoI_v1.cxx:144
xAOD::jFexFwdElRoI_v1::tobEMIso
uint8_t tobEMIso() const
xAOD::jFexFwdElRoI_v1::s_satMask
static const int s_satMask
Definition: jFexFwdElRoI_v1.h:145
xAOD::jFexFwdElRoI_v1::EtEM
uint16_t EtEM() const
uint
unsigned int uint
Definition: LArOFPhaseFill.cxx:20
xAOD::jFexFwdElRoI_v1::globalPhi
uint globalPhi() const
xAOD::jFexFwdElRoI_v1::setTobEMf1
void setTobEMf1(uint8_t value)
xAOD::uint16_t
setWord1 uint16_t
Definition: eFexEMRoI_v1.cxx:93
xAOD::jFexFwdElRoI_v1::s_FCAL_EtaPosition
static const std::vector< int > s_FCAL_EtaPosition
Definition: jFexFwdElRoI_v1.h:125
xAOD::jFexFwdElRoI_v1::s_resMask
static const int s_resMask
Definition: jFexFwdElRoI_v1.h:138
xAOD::jFexFwdElRoI_v1::EtEMiso
uint16_t EtEMiso() const
Isolation and emfraction variables (not available yet) Bitwise: EtEMiso, EtEM, EtHad1,...
xAOD::jFexFwdElRoI_v1::s_isoMask
static const int s_isoMask
Definition: jFexFwdElRoI_v1.h:141
xAOD::jFexFwdElRoI_v1::setTobWord
void setTobWord(uint32_t tobWord)
Set the "raw" words describing the object candidate, need 27/32 bits.
xAOD::jFexFwdElRoI_v1::unpackEtTOB
unsigned int unpackEtTOB() const
TOB ET (decoded from TOB, stored for convenience)
Definition: jFexFwdElRoI_v1.cxx:115
xAOD::jFexFwdElRoI_v1::setTobSat
void setTobSat(uint8_t value)
xAOD::jFexFwdElRoI_v1::EtHad1
uint16_t EtHad1() const
xAOD::jFexFwdElRoI_v1::tobSat
uint8_t tobSat() const
xAOD::jFexFwdElRoI_v1::setIsTOB
void setIsTOB(char value)
Set the isTOB variable (TOB or xTOB)
xAOD::jFexFwdElRoI_v1::getEtHad1
unsigned int getEtHad1() const
Definition: jFexFwdElRoI_v1.cxx:240
xAOD::jFexFwdElRoI_v1::setTobEMIso
void setTobEMIso(uint8_t value)
xAOD::jFexFwdElRoI_v1::tobEMf2
uint8_t tobEMf2() const
xAOD::jFexFwdElRoI_v1::getEtHad2
unsigned int getEtHad2() const
Definition: jFexFwdElRoI_v1.cxx:245
xAOD::jFexFwdElRoI_v1::s_emf2Mask
static const int s_emf2Mask
Definition: jFexFwdElRoI_v1.h:139
xAOD::jFexFwdElRoI_v1::setResolution
void setResolution(int value)
xAOD::jFexFwdElRoI_v1::setGlobalEta
void setGlobalEta(int value)
xAOD::jFexFwdElRoI_v1::s_emf1Bit
static const int s_emf1Bit
Definition: jFexFwdElRoI_v1.h:130
xAOD::jFexFwdElRoI_v1::setfpgaNumber
void setfpgaNumber(uint8_t fpgaNumber)
xAOD::jFexFwdElRoI_v1::s_etaBit
static const int s_etaBit
Definition: jFexFwdElRoI_v1.h:133
xAOD::jFexFwdElRoI_v1::setTobLocalEta
void setTobLocalEta(uint8_t value)
xAOD::jFexFwdElRoI_v1::getEtEM
unsigned int getEtEM() const
Definition: jFexFwdElRoI_v1.cxx:235
xAOD::jFexFwdElRoI_v1::tobEt
uint16_t tobEt() const
Decoded from Tob (for convenience)
xAOD::jFexFwdElRoI_v1::s_emf2Bit
static const int s_emf2Bit
Definition: jFexFwdElRoI_v1.h:129
xAOD::jFexFwdElRoI_v1::setPhi
void setPhi(float value)
xAOD::jFexFwdElRoI_v1::unpackPhiIndex
unsigned int unpackPhiIndex() const
Phi coordinates.
Definition: jFexFwdElRoI_v1.cxx:139
xAOD::jFexFwdElRoI_v1::initialize
void initialize(uint8_t jFexNumber, uint8_t fpgaNumber, uint32_t tobWord, char istob, int resolution, float_t eta, float_t phi)
initialze the EDM
Definition: jFexFwdElRoI_v1.cxx:30
xAOD::jFexFwdElRoI_v1::s_isoBit
static const int s_isoBit
Definition: jFexFwdElRoI_v1.h:131
xAOD::jFexFwdElRoI_v1::setEtHad2
void setEtHad2(uint16_t value)
xAOD::jFexFwdElRoI_v1::s_phiBit
static const int s_phiBit
Definition: jFexFwdElRoI_v1.h:134
xAOD::jFexFwdElRoI_v1::et
unsigned int et() const
Methods that require combining results or applying scales.
Definition: jFexFwdElRoI_v1.cxx:151
xAOD::jFexFwdElRoI_v1::setTobEt
void setTobEt(uint16_t value)
xAOD::jFexFwdElRoI_v1::s_etMask
static const int s_etMask
Definition: jFexFwdElRoI_v1.h:142
xAOD::jFexFwdElRoI_v1::getEtEMiso
unsigned int getEtEMiso() const
Definition: jFexFwdElRoI_v1.cxx:230
xAOD::jFexFwdElRoI_v1::setTobLocalPhi
void setTobLocalPhi(uint8_t value)
xAOD::jFexFwdElRoI_v1::s_emf1Mask
static const int s_emf1Mask
Definition: jFexFwdElRoI_v1.h:140
xAOD::jFexFwdElRoI_v1::unpackEMIsoTOB
unsigned int unpackEMIsoTOB() const
TOB Isolation bits (decoded from TOB, stored for convenience)
Definition: jFexFwdElRoI_v1.cxx:120
xAOD::jFexFwdElRoI_v1::setEta
void setEta(float value)
xAOD::jFexFwdElRoI_v1::tobWord
uint32_t tobWord() const
The "raw" 32-bit word describing the object candidate, 27 bit-word used at hardware level.
xAOD::jFexFwdElRoI_v1::menuEta
int menuEta() const
the eta index to use for looking up thresholds in the menu
Definition: jFexFwdElRoI_v1.cxx:56
xAOD::jFexFwdElRoI_v1::setTobEMf2
void setTobEMf2(uint8_t value)
xAOD::jFexFwdElRoI_v1
Class describing properties of a LVL1 jFEX global Trigger Object (TOB) in the xAOD format.
Definition: jFexFwdElRoI_v1.h:23
xAOD::jFexFwdElRoI_v1::setEtEM
void setEtEM(uint16_t value)
AuxElement.h
Base class for elements of a container that can have aux data.
xAOD::jFexFwdElRoI_v1::fpgaNumber
uint8_t fpgaNumber() const