ATLAS Offline Software
EnergySum_ROI.h
Go to the documentation of this file.
1 // Dear emacs, this is -*- c++ -*-
2 
3 /*
4  Copyright (C) 2002-2017 CERN for the benefit of the ATLAS collaboration
5 */
6 
7 // $Id: EnergySum_ROI.h,v 1.5 2008-05-08 15:00:11 krasznaa Exp $
8 #ifndef ANALYSISTRIGGEREVENT_ENERGYSUM_ROI_H
9 #define ANALYSISTRIGGEREVENT_ENERGYSUM_ROI_H
10 
11 // STL/System include(s):
12 #include <string>
13 #include <vector>
14 #include <inttypes.h>
15 
26 
27 public:
30  float energyX, float energyY, float energyT,
31  uint32_t thrPatSummET, uint32_t thrPatMissET, uint32_t thrPatMETSig, unsigned int overflows )
32  : m_roiWord0( roiWord0 ), m_roiWord1( roiWord1 ), m_roiWord2( roiWord2 ),
33  m_thrPatSummET( thrPatSummET ), m_thrPatMissET( thrPatMissET ), m_thrPatMETSig( thrPatMETSig ), m_thresholds( 0 ),
34  m_energyX( energyX ), m_energyY( energyY ), m_energyT( energyT ),
35  m_overflows( overflows ) {}
38  : m_roiWord0( 0 ), m_roiWord1( 0 ), m_roiWord2( 0 ), m_thrPatSummET( 0 ), m_thrPatMissET( 0 ), m_thrPatMETSig( 0 ),
39  m_thresholds( 0 ), m_energyX( 0. ), m_energyY( 0. ), m_energyT( 0. ), m_overflows( 0 ) {}
41  virtual ~EnergySum_ROI () {}
42 
44  typedef std::vector< std::string > thresholds_type;
45 
47  uint32_t getROIWord0() const { return m_roiWord0; }
49  uint32_t getROIWord1() const { return m_roiWord1; }
51  uint32_t getROIWord2() const { return m_roiWord2; }
52 
54  float getEnergyX() const { return m_energyX; }
56  float getEnergyY() const { return m_energyY; }
58  float getEnergyT() const { return m_energyT; }
60  float getExMiss() const { return -m_energyX; }
62  float getEyMiss() const { return -m_energyY; }
64  bool getOverflowX() const { return ( m_overflows & 0x1 ); }
66  bool getOverflowY() const { return ( ( m_overflows >> 1 ) & 0x1 ); }
68  bool getOverflowT() const { return ( ( m_overflows >> 2 ) & 0x1 ); }
70  unsigned int getOverflows() const { return m_overflows; }
71 
78 
80  const thresholds_type& getThresholds() const { return m_thresholds; }
81 
83  void addThreshold( thresholds_type::value_type thr ) { m_thresholds.push_back( thr ); }
84 
85 private:
89 
93 
95 
96  float m_energyX;
97  float m_energyY;
98  float m_energyT;
99 
100  unsigned int m_overflows;
101 
102 }; // class EnergySum_ROI
103 
104 #endif // ANALYSISTRIGGEREVENT_ENERGYSUM_ROI_H
EnergySum_ROI::m_energyT
float m_energyT
Total deposited transverse energy.
Definition: EnergySum_ROI.h:98
plotBeamSpotCompare.x1
x1
Definition: plotBeamSpotCompare.py:216
EnergySum_ROI::m_overflows
unsigned int m_overflows
Overflow flags: bit 0 = Ex, bit 1 = Ey, bit 2 = ETsum.
Definition: EnergySum_ROI.h:100
EnergySum_ROI
Energy-Sum RoI class for analysis.
Definition: EnergySum_ROI.h:25
EnergySum_ROI::m_roiWord2
uint32_t m_roiWord2
Third 32bit encoded ROI word.
Definition: EnergySum_ROI.h:88
EnergySum_ROI::getThresholds
const thresholds_type & getThresholds() const
Return the names of the passed threshodlds.
Definition: EnergySum_ROI.h:80
EnergySum_ROI::m_energyY
float m_energyY
Total energy deposited in the Y direction.
Definition: EnergySum_ROI.h:97
EnergySum_ROI::EnergySum_ROI
EnergySum_ROI(uint32_t roiWord0, uint32_t roiWord1, uint32_t roiWord2, float energyX, float energyY, float energyT, uint32_t thrPatSummET, uint32_t thrPatMissET, uint32_t thrPatMETSig, unsigned int overflows)
Constructor used when creating the object from RoIBResult data.
Definition: EnergySum_ROI.h:29
EnergySum_ROI::getOverflowT
bool getOverflowT() const
Return the overflow flag for the ET calculation.
Definition: EnergySum_ROI.h:68
xAOD::uint32_t
setEventNumber uint32_t
Definition: EventInfo_v1.cxx:127
EnergySum_ROI::m_thrPatMETSig
uint32_t m_thrPatMETSig
threshold bit pattern for Missing ET Significance
Definition: EnergySum_ROI.h:92
EnergySum_ROI::getOverflowX
bool getOverflowX() const
Return the overflow flag for the EX calculation.
Definition: EnergySum_ROI.h:64
EnergySum_ROI::getEnergyT
float getEnergyT() const
Return the deposited total transverse energy.
Definition: EnergySum_ROI.h:58
EnergySum_ROI::thresholds_type
std::vector< std::string > thresholds_type
Type storing the names of the passed thresholds.
Definition: EnergySum_ROI.h:44
EnergySum_ROI::getThrPatSummET
uint32_t getThrPatSummET() const
Return the bit-pattern describing the passed sum-ET thresholds.
Definition: EnergySum_ROI.h:73
EnergySum_ROI::getEnergyY
float getEnergyY() const
Return the total energy deposited in the Y direction.
Definition: EnergySum_ROI.h:56
EnergySum_ROI::m_roiWord0
uint32_t m_roiWord0
First 32bit encoded ROI word.
Definition: EnergySum_ROI.h:86
EnergySum_ROI::getEyMiss
float getEyMiss() const
Return the missing energy in the Y direction.
Definition: EnergySum_ROI.h:62
xAOD::energyY
energyY
Definition: EnergySumRoI_v1.cxx:139
EnergySum_ROI::m_thresholds
thresholds_type m_thresholds
Names of the passed thresholds.
Definition: EnergySum_ROI.h:94
EnergySum_ROI::getThrPatMissET
uint32_t getThrPatMissET() const
Return the bit-pattern describing the passed missing-ET thresholds.
Definition: EnergySum_ROI.h:75
EnergySum_ROI::m_roiWord1
uint32_t m_roiWord1
Second 32bit encoded ROI word.
Definition: EnergySum_ROI.h:87
EnergySum_ROI::getROIWord1
uint32_t getROIWord1() const
Return the second RoI word produced by the L1Calo hardware.
Definition: EnergySum_ROI.h:49
EnergySum_ROI::getROIWord0
uint32_t getROIWord0() const
Return the first RoI word produced by the L1Calo hardware.
Definition: EnergySum_ROI.h:47
EnergySum_ROI::~EnergySum_ROI
virtual ~EnergySum_ROI()
Destructor.
Definition: EnergySum_ROI.h:41
EnergySum_ROI::getOverflowY
bool getOverflowY() const
Return the overflow flag for the EY calculation.
Definition: EnergySum_ROI.h:66
EnergySum_ROI::getEnergyX
float getEnergyX() const
Return the total energy deposited in the X direction.
Definition: EnergySum_ROI.h:54
EnergySum_ROI::getROIWord2
uint32_t getROIWord2() const
Return the third RoI word produced by the L1Calo hardware.
Definition: EnergySum_ROI.h:51
EnergySum_ROI::getThrPatMETSig
uint32_t getThrPatMETSig() const
Return the bit-pattern describing the passed missing-ET significance thresholds.
Definition: EnergySum_ROI.h:77
EnergySum_ROI::m_thrPatSummET
uint32_t m_thrPatSummET
threshold bit pattern for Summed ET
Definition: EnergySum_ROI.h:90
EnergySum_ROI::addThreshold
void addThreshold(thresholds_type::value_type thr)
Add the name of a threshold that this RoI passed.
Definition: EnergySum_ROI.h:83
EnergySum_ROI::EnergySum_ROI
EnergySum_ROI()
Default constructor (for persistency purposes)
Definition: EnergySum_ROI.h:37
EnergySum_ROI::m_thrPatMissET
uint32_t m_thrPatMissET
threshold bit pattern for Missing ET
Definition: EnergySum_ROI.h:91
EnergySum_ROI::m_energyX
float m_energyX
Total energy deposited in the X direction.
Definition: EnergySum_ROI.h:96
xAOD::roiWord1
roiWord1
Definition: EnergySumRoI_v1.cxx:49
EnergySum_ROI::getExMiss
float getExMiss() const
Return the missing energy in the X direction.
Definition: EnergySum_ROI.h:60
EnergySum_ROI::getOverflows
unsigned int getOverflows() const
Return the overflow bit-pattern.
Definition: EnergySum_ROI.h:70