ATLAS Offline Software
JetROI.h
Go to the documentation of this file.
1 /*
2  Copyright (C) 2002-2022 CERN for the benefit of the ATLAS collaboration
3 */
4 /***************************************************************************
5  Jetroi.h - description
6  -------------------
7  begin : Mon Jan 22 2001
8  email : moyse@heppch.ph.qmw.ac.uk
9  ***************************************************************************/
10 
11 
12 #ifndef JetROI_H
13 #define JetROI_H
14 
15 //LVL1 Calo trigger includes
17 
18 #include <vector>
19 
20 namespace LVL1 {
21 
30  class JetROI {
31  public:
32 
33  // constructor
34  JetROI(double phi, double eta, int energy, unsigned long int roiWord,
35  unsigned int m_cluster4, unsigned int m_cluster6, unsigned int m_cluster8,
36  bool saturated);
37 
38  // destructor
39  ~JetROI();
40 
44  unsigned int roiWord() const;
45 
51  bool saturated() const;
52 
54  double phi() const;
55 
57  double eta() const;
58 
60  int energy() const;
61 
64  bool thresholdPassed(int threshold_number) const;
65 
68  bool fwdThresholdPassed(int threshold_number) const;
69 
71  bool isForward() const;
72 
74  TrigT1CaloDefs::JetWindowSize thresholdType(int threshold_number) const;
76  unsigned int clusterEnergy4() const { return m_cluster4;}
78  unsigned int clusterEnergy6() const { return m_cluster6;}
80  unsigned int clusterEnergy8() const { return m_cluster8;}
81 
82  private: // Private attributes
83 
85  double m_phi;
86 
88  double m_eta;
89 
91  int m_energy;
92 
94  int m_cluster4;
95 
97  int m_cluster6;
98 
100  int m_cluster8;
101 
105  unsigned long int m_roiWord;
106 
108  bool m_isSaturated;
109 
111  std::vector<unsigned int> m_algorithmType;
112 
113 };
114 }//end of LVL1 namespace defn
115 
116 #endif
LVL1::JetROI::clusterEnergy6
unsigned int clusterEnergy6() const
returns the most energetic cluster from window size 6
Definition: JetROI.h:88
LVL1::JetROI::m_eta
double m_eta
eta coord of ROI
Definition: JetROI.h:98
LVL1::JetROI::clusterEnergy4
unsigned int clusterEnergy4() const
returns the most energetic cluster from window size 4
Definition: JetROI.h:86
LVL1::JetROI::clusterEnergy8
unsigned int clusterEnergy8() const
returns the most energetic cluster from window size 8
Definition: JetROI.h:90
LVL1::JetROI::fwdThresholdPassed
bool fwdThresholdPassed(int threshold_number) const
returns TRUE if threshold number threshold_number has been passed by this ROI.
Definition: JetROI.cxx:53
LVL1::JetROI::m_algorithmType
std::vector< unsigned int > m_algorithmType
Contains the algo type of thresh sets.
Definition: JetROI.h:121
LVL1::JetROI::JetROI
JetROI(double phi, double eta, int energy, unsigned long int roiWord, unsigned int m_cluster4, unsigned int m_cluster6, unsigned int m_cluster8, bool saturated)
Definition: JetROI.cxx:20
LVL1::JetROI::phi
double phi() const
returns phi coord of ROI
Definition: JetROI.cxx:78
LVL1::JetROI::m_cluster6
int m_cluster6
Energy of most energetic cluster.
Definition: JetROI.h:107
LVL1
eFexTowerBuilder creates xAOD::eFexTowerContainer from supercells (LATOME) and triggerTowers (TREX) i...
Definition: ICMMCPHitsCnvTool.h:18
LVL1::JetROI::~JetROI
~JetROI()
Definition: JetROI.cxx:34
LVL1::JetROI::m_roiWord
unsigned long int m_roiWord
this is the actual format of the data sent from the LVL1 hardware.
Definition: JetROI.h:115
LVL1::JetROI::m_energy
int m_energy
Energy of ROI core,.
Definition: JetROI.h:101
LVL1::JetROI::thresholdPassed
bool thresholdPassed(int threshold_number) const
returns TRUE if threshold number threshold_number has been passed by this ROI.
Definition: JetROI.cxx:46
LVL1::JetROI::energy
int energy() const
returns the energy
Definition: JetROI.cxx:84
LVL1::JetROI::m_cluster8
int m_cluster8
Energy of most energetic cluster.
Definition: JetROI.h:110
LVL1::JetROI::thresholdType
TrigT1CaloDefs::JetWindowSize thresholdType(int threshold_number) const
returns type of thresholds number threshold_number
Definition: JetROI.cxx:66
LVL1::JetROI::m_cluster4
int m_cluster4
Energy of most energetic cluster.
Definition: JetROI.h:104
LVL1::JetROI::m_phi
double m_phi
phi coord of ROI
Definition: JetROI.h:95
LVL1::JetROI::eta
double eta() const
returns eta coord of ROI
Definition: JetROI.cxx:73
TrigT1CaloDefs.h
LVL1::JetROI::roiWord
unsigned int roiWord() const
returns the 32bit ROI word.
Definition: JetROI.cxx:40
LVL1::JetROI::saturated
bool saturated() const
returns TRUE if ROI constructed from a Jet Element that was saturated - in other words this ROI is si...
Definition: JetROI.cxx:93
LVL1::JetROI::m_isSaturated
bool m_isSaturated
saturation flag
Definition: JetROI.h:118
LVL1::TrigT1CaloDefs::JetWindowSize
JetWindowSize
Definition: TrigT1CaloDefs.h:214
LVL1::JetROI::isForward
bool isForward() const
returns true if the RoI is a forward jet
Definition: JetROI.cxx:59