ATLAS Offline Software
Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h
Go to the documentation of this file.
1 /*
2  Copyright (C) 2002-2023 CERN for the benefit of the ATLAS collaboration
3 */
4 
5 #ifndef TRIGEMCLUSTER_H
6 #define TRIGEMCLUSTER_H
7 
8 
9 /*******************************************************
10 
11 NAME: TrigEMCluster.h
12 PACKAGE: Trigger/TrigEvent/TrigCaloEvent
13 AUTHORS: Denis O. Damazio, Carlos Osuna, Xin Wu
14 
15 PURPOSE: Keep the important output variables
16  from the Calorimeter LVL2 egamma Trigger.
17  Optionally seed ID Trigger and EF.
18  Variables here should be corrected variables
19  not raw (in mother class).
20 INHERITSFROM: TrigCaloCluster
21 DATE: October 17th, 2005
22 
23 ******************************************************/
24 // includes section
26 #include "AthLinks/ElementLink.h"
28 
32 
33 public:
35  TrigEMCluster (float energy = 0.0, float eta = -10.0,
36  float phi = -10.0, long roi_word = 0);
38  ~TrigEMCluster ();
40  TrigEMCluster ( const TrigEMCluster* trigemcluster ) ;
42  TrigEMCluster ( const TrigEMCluster& trigemcluster ) ;
43 
44  TrigEMCluster& operator= ( const TrigEMCluster& trigemcluster ) = delete;
45 
47  void print ( void ) const;
49  void print ( MsgStream& log ) const;
50 
51  // set internal variables methods
53  inline void setEnergy ( float energy ) { m_Energy = energy; };
56  inline void setEt ( float et ) { m_Et = et; };
59  energy ) { m_EnergyS[sample] = energy; };
61  inline void setEta ( float eta ) { m_Eta = eta; };
63  inline void setPhi ( float phi ) { m_Phi = phi; };
65  inline void set_e237 ( float e237 ) { m_e237 = e237; };
67  inline void set_e277 ( float e277 ) { m_e277 = e277; };
70  inline void set_fracs1 ( float fracs1 ) { m_fracs1 = fracs1; };
72  inline void set_weta2 ( float weta2 ) { m_weta2 = weta2; };
74  inline void set_ehad1 ( float ehad1 ) { m_ehad1 = ehad1; };
76  inline void set_Eta1 ( float eta1 ) { m_Eta1 = eta1; };
78  inline void set_emaxs1 ( float emaxs1 ) { m_emaxs1 = emaxs1; };
80  inline void set_e2tsts1 ( float e2tsts1 ) { m_e2tsts1 = e2tsts1; };
82  inline void set_e233 ( float e233 ) { m_e233 = e233; };
84  inline void set_wstot ( float wstot ) { m_wstot = wstot; };
85 
86  // get internal variables methods
88  inline float energy ( ) const { return m_Energy ; };
90  inline float e ( ) const { return m_Energy ; };
92  inline float et ( ) const { return m_Et ; };
94  inline float energy( CaloSampling::CaloSample sample ) const
95  { return m_EnergyS[sample]; };
97  inline float energyInSample( CaloSampling::CaloSample sample ) const
98  { return m_EnergyS[sample]; };
100  inline float eta ( ) const { return m_Eta ; };
102  inline float phi ( ) const { return m_Phi ; };
104  inline float e237 ( ) const { return m_e237 ; };
106  inline float e277 ( ) const { return m_e277 ; };
109  inline float fracs1 ( ) const { return m_fracs1 ; };
111  inline float weta2 ( ) const { return m_weta2 ; };
113  inline float ehad1 ( ) const { return m_ehad1 ; };
115  inline float Eta1 ( ) const { return m_Eta1 ; };
117  inline float emaxs1 ( ) const { return m_emaxs1 ; };
119  inline float e2tsts1 ( ) const { return m_e2tsts1 ; };
121  inline float e233 ( ) const { return m_e233 ; };
123  inline float wstot ( ) const { return m_wstot ; };
124 
125  bool isValid() const;
126  void setRings(const RingerRingsContainer &ring_con, unsigned int ring_idx);
127  const RingerRings *rings() const;
130 
131 
132 // internal variables must be private
133 private:
135  float m_Energy;
137  float m_Et;
139  float m_EnergyS[MAXSIZE];
141  float m_Eta;
143  float m_Phi;
145  float m_e237;
147  float m_e277;
150  float m_fracs1;
152  float m_weta2;
154  float m_ehad1;
156  float m_Eta1;
158  float m_emaxs1;
160  float m_e2tsts1;
162  float m_e233;
164  float m_wstot;
165 
167 
168  template <class T>
169  friend class TrigEMClusterConverterBase;
170 };
171 
172 // stream output
173 std::string str( const TrigEMCluster& d );
174 MsgStream& operator<< ( MsgStream& m, const TrigEMCluster& d );
175 
176 //comparison
177 bool operator== (const TrigEMCluster& a, const TrigEMCluster& b);
178 inline bool operator!= ( const TrigEMCluster& a,
179  const TrigEMCluster& b ) { return !(a==b); }
180 
181 // CLIDSvc is already loaded in base class
182 CLASS_DEF ( TrigEMCluster, 31349851, 1)
183 #endif
str
std::string str(const TrigEMCluster &d)
Definition: TrigEMCluster.cxx:153
operator!=
bool operator!=(const TrigEMCluster &a, const TrigEMCluster &b)
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:178
et
Extra patterns decribing particle interation process.
TrigEMCluster::m_Phi
float m_Phi
Phi (calibrated)
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:157
TrigEMCluster::set_e233
void set_e233(float e233)
set Energy in a 3x3 cluster (no calibration) around hottest cell
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:96
python.SystemOfUnits.m
int m
Definition: SystemOfUnits.py:91
TrigEMCluster::operator=
TrigEMCluster & operator=(const TrigEMCluster &trigemcluster)=delete
TrigEMCluster::~TrigEMCluster
~TrigEMCluster()
Destructor
Definition: TrigEMCluster.cxx:39
TrigEMCluster::m_Eta
float m_Eta
Eta (calibrated)
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:155
TrigEMCluster::m_e237
float m_e237
Energy in a 3x7 cluster (no calibration) around hottest cell.
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:159
hist_file_dump.d
d
Definition: hist_file_dump.py:137
TrigEMCluster::e2tsts1
float e2tsts1() const
get second maximum energy in sampling 1 (strip layer)
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:133
TrigEMCluster::print
void print(void) const
Prints out cluster variables to std::cout
Definition: TrigEMCluster.cxx:74
TrigEMCluster::set_emaxs1
void set_emaxs1(float emaxs1)
set maximum energy in sampling 1 (strip layer)
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:92
TrigEMCluster::Eta1
float Eta1() const
get Eta sampling 1 (strip layer)
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:129
TrigEMCluster::m_e233
float m_e233
Energy in a 3x3 cluster (no calibration) around hottest cell.
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:176
TrigEMCluster::energyInSample
float energyInSample(CaloSampling::CaloSample sample) const
get Energy (calibrated) per sampling layer
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:111
TrigEMCluster::phi
float phi() const
get Phi (calibrated)
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:116
TrigEMCluster::setPhi
void setPhi(float phi)
set Phi (calibrated)
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:77
TrigEMCluster::TrigEMCluster
TrigEMCluster(float energy=0.0, float eta=-10.0, float phi=-10.0, long roi_word=0)
Constructor, please note the default values
Definition: TrigEMCluster.cxx:25
xAOD::eta1
setEt setPhi setE277 setWeta2 eta1
Definition: TrigEMCluster_v1.cxx:41
TrigEMCluster::setEt
void setEt(float et)
set Et (calibrated) - note that setting Energy this is not set by default
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:70
TrigEMCluster
Class with calibrated variables for egamma clustering.
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:31
TrigEMCluster::m_wstot
float m_wstot
width in first layer
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:178
TrigEMCluster::set_e237
void set_e237(float e237)
set Energy in a 3x7 cluster (no calibration) around hottest cell
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:79
TrigEMCluster::m_emaxs1
float m_emaxs1
maximum energy in sampling 1 (strip layer)
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:172
TrigEMCluster::e277
float e277() const
get Energy in a 7x7 cluster (no calibration) around hottest cell
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:120
TrigEMCluster::m_fracs1
float m_fracs1
Energy in a 7 strips (around hottest strip) minus energy in 3 strips divided by energy in 3 strips.
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:164
TrigEMCluster::weta2
float weta2() const
get cluster width (based on a 3x5 cluster - 2nd layer)
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:125
TrigEMCluster::e
float e() const
get Energy (calibrated)
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:104
operator==
bool operator==(const TrigEMCluster &a, const TrigEMCluster &b)
Definition: TrigEMCluster.cxx:182
TrigEMCluster::set_wstot
void set_wstot(float wstot)
set width in first layer
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:98
TrigEMCluster::fracs1
float fracs1() const
get Energy in a 7 strips (around hottest strip) minus energy in 3 strips divided by energy in 3 strip...
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:123
TrigEMCluster::set_Eta1
void set_Eta1(float eta1)
set Eta sampling 1 (strip layer)
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:90
TrigEMCluster::set_weta2
void set_weta2(float weta2)
set cluster width (based on a 3x5 cluster - 2nd layer)
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:86
RingerRingsContainer.h
TrigEMCluster::set_e2tsts1
void set_e2tsts1(float e2tsts1)
set second maximum energy in sampling 1 (strip layer)
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:94
TrigEMCluster::e237
float e237() const
get Energy in a 3x7 cluster (no calibration) around hottest cell
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:118
TrigEMCluster::m_e2tsts1
float m_e2tsts1
get second maximum energy in sampling 1 (strip layer)
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:174
FullCPAlgorithmsTest_eljob.sample
sample
Definition: FullCPAlgorithmsTest_eljob.py:113
CaloSampling::CaloSample
CaloSample
Definition: Calorimeter/CaloGeoHelpers/CaloGeoHelpers/CaloSampling.h:22
TrigEMCluster::wstot
float wstot() const
get width in first layer
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:137
MAXSIZE
const int MAXSIZE
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigCaloCluster.h:36
TrigEMCluster::isValid
bool isValid() const
Definition: TrigEMCluster.cxx:120
operator<<
MsgStream & operator<<(MsgStream &m, const TrigEMCluster &d)
Definition: TrigEMCluster.cxx:176
TrigEMClusterConverterBase
Definition: TrigEMClusterConverterBase.h:9
TrigCaloCluster
Base Cluster Class.
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigCaloCluster.h:39
TrigEMCluster::set_e277
void set_e277(float e277)
set Energy in a 7x7 cluster (no calibration) around hottest cell
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:81
TrigEMCluster::m_rings
ElementLink< RingerRingsContainer > m_rings
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:180
TrigEMCluster::m_Eta1
float m_Eta1
Eta sampling 1 (strip layer)
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:170
TrigEMCluster::eta
float eta() const
get Eta (calibrated)
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:114
TrigEMCluster::m_e277
float m_e277
Energy in a 7x7 cluster (no calibration) around hottest cell.
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:161
TrigEMCluster::setEnergy
void setEnergy(float energy)
set Energy (calibrated)
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:67
TrigEMCluster::ehad1
float ehad1() const
get hadronic Energy (first hadronic layer)
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:127
TrigEMCluster::energy
float energy() const
get Energy (calibrated)
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:102
plotBeamSpotMon.b
b
Definition: plotBeamSpotMon.py:77
RingerRings
This class carries the generated Rings.
Definition: RingerRings.h:18
TrigEMCluster::set_fracs1
void set_fracs1(float fracs1)
set Energy in a 7 strips (around hottest strip) minus energy in 3 strips divided by energy in 3 strip...
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:84
TrigEMCluster::rings
const RingerRings * rings() const
Definition: TrigEMCluster.cxx:140
TrigEMCluster::e233
float e233() const
get Energy in a 3x3 cluster (no calibration) around hottest cell
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:135
a
TList * a
Definition: liststreamerinfos.cxx:10
TrigEMCluster::emaxs1
float emaxs1() const
get maximum energy in sampling 1 (strip layer)
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:131
TrigEMCluster::ringsLink
const ElementLink< RingerRingsContainer > & ringsLink() const
Definition: TrigEMCluster.cxx:147
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
RingerRingsContainer
Definition: RingerRingsContainer.h:13
TrigEMCluster::m_ehad1
float m_ehad1
hadronic Energy (first hadronic layer)
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:168
TrigCaloCluster.h
python.CaloCondTools.log
log
Definition: CaloCondTools.py:20
TrigEMCluster::m_EnergyS
float m_EnergyS[MAXSIZE]
Energy (calibrated) per sampling layer
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:153
TrigEMCluster::m_weta2
float m_weta2
cluster width (based on a 3x5 cluster - 2nd layer)
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:166
TrigEMCluster::m_Energy
float m_Energy
Energy (calibrated)
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:149
TrigEMCluster::setEta
void setEta(float eta)
set Eta (calibrated)
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:75
TrigEMCluster::m_Et
float m_Et
Energy (calibrated)
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:151
TrigEMCluster::set_ehad1
void set_ehad1(float ehad1)
set hadronic Energy (first hadronic layer)
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:88
TrigEMCluster::setRings
void setRings(const RingerRingsContainer &ring_con, unsigned int ring_idx)
Definition: TrigEMCluster.cxx:124
TrigEMCluster::et
float et() const
get Et (calibrated)
Definition: Trigger/TrigEvent/TrigCaloEvent/TrigCaloEvent/TrigEMCluster.h:106