ATLAS Offline Software
RecEnergyRoI.h
Go to the documentation of this file.
1 // Dear emacs, this is -*- c++ -*-
2 /*
3  Copyright (C) 2002-2021 CERN for the benefit of the ATLAS collaboration
4 */
5 /***************************************************************************
6  RecEnergyRoI.h - description
7  -------------------
8  begin : Mon Jan 22 2001
9  email : moyse@heppch.ph.qmw.ac.uk
10 ***************************************************************************/
11 
12 #ifndef TRIGT1INTERFACES_RECENERGYROI_H
13 #define TRIGT1INTERFACES_RECENERGYROI_H
14 
15 // STL include(s):
16 #include <map>
17 
18 // Gaudi/Athena include(s):
20 
21 // Local include(s):
23 
24 // Forward declaration(s):
25 namespace TrigConf {
26  class TriggerThreshold;
27  class L1Menu;
28 }
29 
30 namespace LVL1 {
31 
37  class RecEnergyRoI {
38 
39  public:
40  // constructor
42  // constructor using Run 1+2 configuration
43  RecEnergyRoI( unsigned int RoIWord0, unsigned int RoIWord1, unsigned int RoIWord2,
44  const std::vector< TrigConf::TriggerThreshold* >* caloThresholds );
46  RecEnergyRoI( unsigned int RoIWord0, unsigned int RoIWord1, unsigned int RoIWord2,
47  const TrigConf::L1Menu * const l1menu );
48  // destructor
49  ~RecEnergyRoI();
50 
51  //copy constructor
52  RecEnergyRoI( const RecEnergyRoI &obj );
53 
54  //assignment operator
56 
57  // does excatly what the constructor should do
58  void construct( unsigned int RoIWord0, unsigned int RoIWord1, unsigned int RoIWord2,
59  const std::vector< TrigConf::TriggerThreshold* >* caloThresholds );
60  // using Run 3 menu
61  void construct(const TrigConf::L1Menu *const l1menu);
62 
65  unsigned int roiWord0() const;
66 
69  unsigned int roiWord1() const;
70 
73  unsigned int roiWord2() const;
74 
77  bool passedEtMissThreshold( unsigned int thresholdNumber ) const;
78 
81  bool passedSumEtThreshold( unsigned int thresholdNumber ) const;
82 
85  bool passedMEtSigThreshold( unsigned int thresholdNumber ) const;
86 
88  std::vector<unsigned int> etMissThresholdsPassed() const;
89 
91  std::vector<unsigned int> sumEtThresholdsPassed() const;
92 
94  std::vector<unsigned int> mEtSigThresholdsPassed() const;
95 
98  unsigned int etMissTriggerThreshold( const unsigned int thresh ) const;
99 
102  unsigned int sumEtTriggerThreshold( const unsigned int thresh ) const;
103 
106  unsigned int mEtSigTriggerThreshold( const unsigned int thresh ) const;
107 
109  bool isValidEtMissThreshold( const unsigned int thresh ) const;
110 
112  bool isValidSumEtThreshold( const unsigned int thresh ) const;
113 
115  bool isValidMEtSigThreshold( const unsigned int thresh ) const;
116 
119  int energyX() const;
121  bool overflowX() const;
124  int energyY() const;
126  bool overflowY() const;
129  int energyT() const;
131  bool overflowT() const;
132 
133  private:
137  unsigned long int m_roiWord0 { 0 };
141  unsigned long int m_roiWord1 { 0 };
145  unsigned long int m_roiWord2 { 0 };
146 
147  std::map< int, unsigned int > m_etMissThresholdValue;
148  std::map< int, unsigned int > m_sumEtThresholdValue;
149  std::map< int, unsigned int > m_mEtSigThresholdValue;
150 
151  }; // class RecEnergyRoI
152 
153 } // namespace LVL1
154 
155 #include "AthenaKernel/CLASS_DEF.h"
157 CLASS_DEF( LVL1::RecEnergyRoI, 6263, 1 )
158 
159 #endif // TRIGT1INTERFACES_RECENERGYROI_H
LVL1::RecEnergyRoI::roiWord1
unsigned int roiWord1() const
returns roi word 1.
Definition: RecEnergyRoI.cxx:167
LVL1::RecEnergyRoI::sumEtTriggerThreshold
unsigned int sumEtTriggerThreshold(const unsigned int thresh) const
returns the value of the trigger threshold for the threshold passed.
Definition: RecEnergyRoI.cxx:247
physval_make_web_display.thresh
thresh
Definition: physval_make_web_display.py:35
LVL1::RecEnergyRoI::energyX
int energyX() const
returns the (signed) Ex energy projection.
Definition: RecEnergyRoI.cxx:292
LVL1::RecEnergyRoI::energyT
int energyT() const
returns the total ET.
Definition: RecEnergyRoI.cxx:310
LVL1::RecEnergyRoI::m_roiWord1
unsigned long int m_roiWord1
this is the actual format of the data sent from the LVL1 hardware.
Definition: RecEnergyRoI.h:141
LVL1::RecEnergyRoI::roiWord2
unsigned int roiWord2() const
returns roi word 2.
Definition: RecEnergyRoI.cxx:172
LVL1::RecEnergyRoI::etMissTriggerThreshold
unsigned int etMissTriggerThreshold(const unsigned int thresh) const
returns the value of the trigger threshold for the threshold passed.
Definition: RecEnergyRoI.cxx:236
TrigConf::L1Menu
L1 menu configuration.
Definition: L1Menu.h:28
LVL1::RecEnergyRoI::overflowT
bool overflowT() const
returns the ETsum overflow bit
Definition: RecEnergyRoI.cxx:331
LVL1
eFexTowerBuilder creates xAOD::eFexTowerContainer from supercells (LATOME) and triggerTowers (TREX) i...
Definition: ICMMCPHitsCnvTool.h:18
LVL1::RecEnergyRoI::isValidEtMissThreshold
bool isValidEtMissThreshold(const unsigned int thresh) const
returns true if thresh is a valid EtMiss threshold number
Definition: RecEnergyRoI.cxx:270
LVL1::RecEnergyRoI
This class defines the reconstructed EnergySum ROI.
Definition: RecEnergyRoI.h:37
LVL1::RecEnergyRoI::mEtSigThresholdsPassed
std::vector< unsigned int > mEtSigThresholdsPassed() const
returns a vector of thresholds passed.
Definition: RecEnergyRoI.cxx:228
TrigConf
Forward iterator to traverse the main components of the trigger configuration.
Definition: Config.h:22
LVL1::RecEnergyRoI::passedMEtSigThreshold
bool passedMEtSigThreshold(unsigned int thresholdNumber) const
returns TRUE if threshold number threshold_number has been passed by this ROI.
Definition: RecEnergyRoI.cxx:203
LVL1::RecEnergyRoI::RecEnergyRoI
RecEnergyRoI()
Definition: RecEnergyRoI.h:41
LVL1::RecEnergyRoI::m_sumEtThresholdValue
std::map< int, unsigned int > m_sumEtThresholdValue
Definition: RecEnergyRoI.h:148
LVL1::RecEnergyRoI::overflowY
bool overflowY() const
returns the Ey overflow bit
Definition: RecEnergyRoI.cxx:324
LVL1::RecEnergyRoI::etMissThresholdsPassed
std::vector< unsigned int > etMissThresholdsPassed() const
returns a vector of thresholds passed.
Definition: RecEnergyRoI.cxx:214
LVL1::RecEnergyRoI::mEtSigTriggerThreshold
unsigned int mEtSigTriggerThreshold(const unsigned int thresh) const
returns the value of the trigger threshold for the threshold passed.
Definition: RecEnergyRoI.cxx:259
LVL1::RecEnergyRoI::sumEtThresholdsPassed
std::vector< unsigned int > sumEtThresholdsPassed() const
returns a vector of thresholds passed.
Definition: RecEnergyRoI.cxx:221
LVL1::RecEnergyRoI::~RecEnergyRoI
~RecEnergyRoI()
Definition: RecEnergyRoI.cxx:69
LVL1::RecEnergyRoI::passedSumEtThreshold
bool passedSumEtThreshold(unsigned int thresholdNumber) const
returns TRUE if threshold number threshold_number has been passed by this ROI.
Definition: RecEnergyRoI.cxx:191
DataVector
Derived DataVector<T>.
Definition: DataVector.h:581
LVL1::RecEnergyRoI::isValidSumEtThreshold
bool isValidSumEtThreshold(const unsigned int thresh) const
returns true if thresh is a valid Sum Et threshold number
Definition: RecEnergyRoI.cxx:277
LVL1::RecEnergyRoI::passedEtMissThreshold
bool passedEtMissThreshold(unsigned int thresholdNumber) const
returns TRUE if threshold number threshold_number has been passed by this ROI.
Definition: RecEnergyRoI.cxx:179
LVL1::RecEnergyRoI::m_mEtSigThresholdValue
std::map< int, unsigned int > m_mEtSigThresholdValue
Definition: RecEnergyRoI.h:149
LVL1::RecEnergyRoI::m_roiWord0
unsigned long int m_roiWord0
this is the actual format of the data sent from the LVL1 hardware.
Definition: RecEnergyRoI.h:137
LVL1::RecEnergyRoI::operator=
RecEnergyRoI & operator=(const RecEnergyRoI &obj)
Definition: RecEnergyRoI.cxx:56
LVL1::RecEnergyRoI::m_etMissThresholdValue
std::map< int, unsigned int > m_etMissThresholdValue
Definition: RecEnergyRoI.h:147
TrigT1CaloDefs.h
LVL1::RecEnergyRoI::isValidMEtSigThreshold
bool isValidMEtSigThreshold(const unsigned int thresh) const
returns true if thresh is a valid Sum Et threshold number
Definition: RecEnergyRoI.cxx:284
LVL1::RecEnergyRoI::construct
void construct(unsigned int RoIWord0, unsigned int RoIWord1, unsigned int RoIWord2, const std::vector< TrigConf::TriggerThreshold * > *caloThresholds)
The "construct" call unpacks the RoIWord and copies information about the passed thresholds from the ...
Definition: RecEnergyRoI.cxx:77
DataVector.h
An STL vector of pointers that by default owns its pointed-to elements.
LVL1::RecEnergyRoI::energyY
int energyY() const
returns the (signed) Ey energy projection.
Definition: RecEnergyRoI.cxx:301
LVL1::RecEnergyRoI::roiWord0
unsigned int roiWord0() const
returns roi word 0.
Definition: RecEnergyRoI.cxx:162
CLASS_DEF
#define CLASS_DEF(NAME, CID, VERSION)
associate a clid and a version to a type eg
Definition: Control/AthenaKernel/AthenaKernel/CLASS_DEF.h:64
python.XMLReader.l1menu
l1menu
Definition: XMLReader.py:73
python.PyAthena.obj
obj
Definition: PyAthena.py:135
CLASS_DEF.h
macros to associate a CLID to a type
LVL1::RecEnergyRoI::m_roiWord2
unsigned long int m_roiWord2
this is the actual format of the data sent from the LVL1 hardware.
Definition: RecEnergyRoI.h:145
LVL1::RecEnergyRoI::overflowX
bool overflowX() const
returns the Ex overflow bit
Definition: RecEnergyRoI.cxx:317