ATLAS Offline Software
EnergySumRoI_v2.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: EnergySumRoI_v2.h 631149 2014-11-26 12:26:18Z krasznaa $
8 #ifndef XAODTRIGGER_VERSIONS_ENERGYSUMROI_V2_H
9 #define XAODTRIGGER_VERSIONS_ENERGYSUMROI_V2_H
10 
11 // System include(s):
12 extern "C" {
13 # include <stdint.h>
14 }
15 #include <vector>
16 #include <string>
17 
18 // xAOD include(s):
20 
21 namespace xAOD {
22 
36 
37  public:
40 
42  void initialize( uint32_t roiword0, uint32_t roiword1, uint32_t roiword2,
43  float energyX, float energyY, float energyT );
44 
47 
49  void setRoIWord( uint32_t value );
50 
52  uint32_t roiWord0() const;
55 
57  uint32_t roiWord1() const;
60 
62  uint32_t roiWord2() const;
65 
67  uint32_t roiWord3() const;
70 
72  uint32_t roiWord4() const;
75 
77  uint32_t roiWord5() const;
80 
82 
85 
87  uint32_t thrPatSumET( bool restricted = false ) const;
89  uint32_t thrPatMET( bool restricted = false ) const;
92  uint32_t thrPatMETSig() const;
93 
95 
98 
100  bool overflowX(bool restricted = false) const;
102  bool overflowY(bool restricted = false) const;
104  bool overflowT(bool restricted = false) const;
105 
107 
110 
112  void addThreshold( const std::string& name );
114  void clearThresholds();
115 
117  const std::vector< std::string >& thrNames() const;
118 
120 
123 
125  float energyX() const;
126  float energyXRestricted() const;
128  void setEnergyX(float value);
131  float exMiss() const { return -energyX(); }
132  float exMissRestricted() const { return -energyXRestricted(); }
133 
135  float energyY() const;
136  float energyYRestricted() const;
138  void setEnergyY(float value);
141  float eyMiss() const { return -energyY(); }
142  float eyMissRestricted() const { return -energyYRestricted(); }
143 
145  float energyT() const;
146  float energyTRestricted() const;
148  void setEnergyT(float value);
150 
152 
154  private:
155 
156  static const unsigned int s_Run2TruncRoIBit = 0x4000000;
157  static const unsigned int s_RoIType = 0xf0000000;
158  static const unsigned int s_Word0 = 0x40000000;
159  static const unsigned int s_Word1 = 0x60000000;
160  static const unsigned int s_Word2 = 0x50000000;
161 
162  }; // class EnergySumRoI_v2
163 
164 } // namespace xAOD
165 
166 // Declare the inheritace of the class:
167 #include "xAODCore/BaseInfo.h"
169 
170 #endif // XAODTRIGGER_VERSIONS_EnergySumRoI_v2_H
xAOD::EnergySumRoI_v2::thrPatMETSig
uint32_t thrPatMETSig() const
The bit-pattern describing the passed missing-ET significance thresholds.
Definition: EnergySumRoI_v2.cxx:114
xAOD::EnergySumRoI_v2::energyXRestricted
float energyXRestricted() const
xAOD::name
name
Definition: TriggerMenuJson_v1.cxx:29
xAOD::EnergySumRoI_v2::overflowX
bool overflowX(bool restricted=false) const
The overflow flag for the EX calculation.
Definition: EnergySumRoI_v2.cxx:127
xAOD::EnergySumRoI_v2::overflowT
bool overflowT(bool restricted=false) const
The overflow flag for the ET calculation.
Definition: EnergySumRoI_v2.cxx:139
xAOD::EnergySumRoI_v2::setEnergyX
void setEnergyX(float value)
Set the total energy deposited in the X direction.
xAOD::uint32_t
setEventNumber uint32_t
Definition: EventInfo_v1.cxx:127
xAOD::EnergySumRoI_v2::setRoIWord2
void setRoIWord2(uint32_t value)
Set the third "raw" RoI word describing the energy-sum RoI.
SG::AuxElement
Base class for elements of a container that can have aux data.
Definition: AuxElement.h:446
xAOD::EnergySumRoI_v2::energyT
float energyT() const
The deposited total transverse energy.
xAOD::EnergySumRoI_v2::s_Run2TruncRoIBit
static const unsigned int s_Run2TruncRoIBit
The basic setters and getters for the xAOD class.
Definition: EnergySumRoI_v2.h:156
BaseInfo.h
xAOD::EnergySumRoI_v2::thrPatSumET
uint32_t thrPatSumET(bool restricted=false) const
The bit-pattern describing the passed sum-ET thresholds.
Definition: EnergySumRoI_v2.cxx:102
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::EnergySumRoI_v2::energyY
float energyY() const
The total energy deposited in the Y direction.
xAOD::EnergySumRoI_v2::setRoIWord4
void setRoIWord4(uint32_t value)
Set the second "raw" RoI word describing the energy-sum RoI.
xAOD::EnergySumRoI_v2::exMissRestricted
float exMissRestricted() const
Definition: EnergySumRoI_v2.h:132
xAOD::EnergySumRoI_v2::setEnergyXRestricted
void setEnergyXRestricted(float value)
xAOD::EnergySumRoI_v2::roiWord4
uint32_t roiWord4() const
The fifth RoI word produced by the L1Calo hardware.
xAOD::EnergySumRoI_v2::roiWord3
uint32_t roiWord3() const
The fourth RoI word produced by the L1Calo hardware.
xAOD::EnergySumRoI_v2::s_Word0
static const unsigned int s_Word0
Definition: EnergySumRoI_v2.h:158
xAOD::EnergySumRoI_v2::setEnergyYRestricted
void setEnergyYRestricted(float value)
xAOD::EnergySumRoI_v2::setRoIWord5
void setRoIWord5(uint32_t value)
Set the third "raw" RoI word describing the energy-sum RoI.
xAOD::EnergySumRoI_v2::energyX
float energyX() const
The total energy deposited in the X direction.
xAOD::EnergySumRoI_v2::setEnergyTRestricted
void setEnergyTRestricted(float value)
xAOD::EnergySumRoI_v2::setEnergyY
void setEnergyY(float value)
Set the total energy deposited in the Y direction.
xAOD::EnergySumRoI_v2::EnergySumRoI_v2
EnergySumRoI_v2()
Default constructor.
Definition: EnergySumRoI_v2.cxx:14
xAOD::EnergySumRoI_v2::roiWord0
uint32_t roiWord0() const
The first RoI word produced by the L1Calo hardware.
xAOD::EnergySumRoI_v2::clearThresholds
void clearThresholds()
Remove all the passed thresholds.
Definition: EnergySumRoI_v2.cxx:163
xAOD::EnergySumRoI_v2::eyMissRestricted
float eyMissRestricted() const
Definition: EnergySumRoI_v2.h:142
xAOD::EnergySumRoI_v2::thrPatMET
uint32_t thrPatMET(bool restricted=false) const
The bit-pattern describing the passed missing-ET thresholds.
Definition: EnergySumRoI_v2.cxx:108
xAOD::EnergySumRoI_v2::roiWord5
uint32_t roiWord5() const
The sixth RoI word produced by the L1Calo hardware.
xAOD::EnergySumRoI_v2::setRoIWord0
void setRoIWord0(uint32_t value)
Set the first "raw" RoI word describing the energy-sum RoI.
xAOD::EnergySumRoI_v2::roiWord2
uint32_t roiWord2() const
The third RoI word produced by the L1Calo hardware.
xAOD::EnergySumRoI_v2::setEnergyT
void setEnergyT(float value)
Set the deposited total transverse energy.
xAOD::EnergySumRoI_v2::overflowY
bool overflowY(bool restricted=false) const
The overflow flag for the EY calculation.
Definition: EnergySumRoI_v2.cxx:133
xAOD::EnergySumRoI_v2::exMiss
float exMiss() const
The missing energy in the X direction.
Definition: EnergySumRoI_v2.h:131
xAOD::EnergySumRoI_v2::initialize
void initialize(uint32_t roiword0, uint32_t roiword1, uint32_t roiword2, float energyX, float energyY, float energyT)
Initialise the object with its most important properties from a single RoI.
Definition: EnergySumRoI_v2.cxx:25
SG_BASE
SG_BASE(xAOD::EnergySumRoI_v2, SG::AuxElement)
xAOD::EnergySumRoI_v2::energyTRestricted
float energyTRestricted() const
xAOD::EnergySumRoI_v2::s_Word1
static const unsigned int s_Word1
Definition: EnergySumRoI_v2.h:159
xAOD::EnergySumRoI_v2::addThreshold
void addThreshold(const std::string &name)
Add a new threshold that was passed.
Definition: EnergySumRoI_v2.cxx:157
xAOD::EnergySumRoI_v2::eyMiss
float eyMiss() const
The missing energy in the Y direction.
Definition: EnergySumRoI_v2.h:141
xAOD::EnergySumRoI_v2::s_Word2
static const unsigned int s_Word2
Definition: EnergySumRoI_v2.h:160
xAOD::EnergySumRoI_v2::s_RoIType
static const unsigned int s_RoIType
Definition: EnergySumRoI_v2.h:157
xAOD::EnergySumRoI_v2::energyYRestricted
float energyYRestricted() const
xAOD::EnergySumRoI_v2
Class describing a LVL1 energy-sum "RoI".
Definition: EnergySumRoI_v2.h:35
AuxElement.h
Base class for elements of a container that can have aux data.
xAOD::EnergySumRoI_v2::setRoIWord
void setRoIWord(uint32_t value)
Generic RoI word adding: the function will identify which word it is.
Definition: EnergySumRoI_v2.cxx:54
xAOD::EnergySumRoI_v2::roiWord1
uint32_t roiWord1() const
The second RoI word produced by the L1Calo hardware.
xAOD::EnergySumRoI_v2::thrNames
const std::vector< std::string > & thrNames() const
The names of the thresholds passed.
Definition: EnergySumRoI_v2.cxx:169
xAOD::EnergySumRoI_v2::setRoIWord3
void setRoIWord3(uint32_t value)
Set the first "raw" RoI word describing the energy-sum RoI.
xAOD::EnergySumRoI_v2::setRoIWord1
void setRoIWord1(uint32_t value)
Set the second "raw" RoI word describing the energy-sum RoI.