ATLAS Offline Software
LArFCAL_region.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 #ifndef LARFCAL_REGION_H
6 #define LARFCAL_REGION_H
7 
8 #include <vector>
9 
10  enum { NOT_VALID_FCAL_REGION = 63 };
11 
20 {
21 public:
22 
23  LArFCAL_region(void);
24 
25  LArFCAL_region(unsigned int& minHash, short int& nbEtaBins, short int& nPhi,
26  float minEta, float granulEta, float minPhi, float granulPhi, bool fullSym,
27  short int& prevEtaSamp, short int& nextEtaSamp);
28 
29  ~LArFCAL_region(void) = default;
30 
32  short int numberOfEta() const;
33 
35  short int phiN() const;
36 
38  float etaGranularity() const;
39 
41  float phiGranularity() const;
42 
44  bool fullTwoPi() const;
45 
47  float etaMin() const;
48 
50  float etaMax() const;
51 
53  float phiMin() const;
54 
56  float phiMax() const;
57 
59  unsigned int hashMin() const;
60 
62  unsigned int hashMax() const;
63 
65  bool isEtaMin(const unsigned int& index) const;
66 
68  bool isEtaMax(const unsigned int& index) const;
69 
71  bool isPhiMin(const unsigned int& index) const;
72 
74  bool isPhiMax(const unsigned int& index) const;
75 
77  short int prevSamplingRegion() const;
78 
80  short int nextSamplingRegion() const;
81 
82 
83 private:
84 
85  unsigned int m_hashMin;
86  short int m_nbEtaBins;
87  short int m_nPhi;
88  float m_minEta;
89  float m_granulEta;
90  float m_minPhi;
91  float m_granulPhi;
92  bool m_fullSym;
93 
94  short int m_prevSampReg;
95  short int m_nextSampReg;
96 
97 };
98 
99 #endif // LARFCAL_REGION_H
LArFCAL_region::isEtaMax
bool isEtaMax(const unsigned int &index) const
is the considered cell in the last eta bin of the region ?
Definition: LArFCAL_region.cxx:108
LArFCAL_region::etaMax
float etaMax() const
end eta
Definition: LArFCAL_region.cxx:76
LArFCAL_region::m_hashMin
unsigned int m_hashMin
Definition: LArFCAL_region.h:85
LArFCAL_region::phiN
short int phiN() const
number of phi bins
Definition: LArFCAL_region.cxx:51
LArFCAL_region::prevSamplingRegion
short int prevSamplingRegion() const
region number of the prev region in sampling
Definition: LArFCAL_region.cxx:134
index
Definition: index.py:1
LArFCAL_region::~LArFCAL_region
~LArFCAL_region(void)=default
LArFCAL_region::phiGranularity
float phiGranularity() const
phi granularity
Definition: LArFCAL_region.cxx:61
LArFCAL_region::LArFCAL_region
LArFCAL_region(void)
Definition: LArFCAL_region.cxx:12
NOT_VALID_FCAL_REGION
@ NOT_VALID_FCAL_REGION
Definition: LArFCAL_region.h:10
LArFCAL_region::m_granulEta
float m_granulEta
Definition: LArFCAL_region.h:89
TrigVSI::AlgConsts::nPhi
constexpr int nPhi
Default bin number of phi for vertex map.
Definition: Trigger/TrigTools/TrigVrtSecInclusive/TrigVrtSecInclusive/Constants.h:27
LArFCAL_region::etaGranularity
float etaGranularity() const
eta granularity
Definition: LArFCAL_region.cxx:56
LArFCAL_region::phiMax
float phiMax() const
end phi
Definition: LArFCAL_region.cxx:86
LArFCAL_region::m_prevSampReg
short int m_prevSampReg
Definition: LArFCAL_region.h:94
LArFCAL_region::m_minPhi
float m_minPhi
Definition: LArFCAL_region.h:90
LArFCAL_region::m_fullSym
bool m_fullSym
Definition: LArFCAL_region.h:92
LArFCAL_region::isPhiMin
bool isPhiMin(const unsigned int &index) const
is the considered cell in the first phi bin of the region ?
Definition: LArFCAL_region.cxx:115
LArFCAL_region::phiMin
float phiMin() const
starting phi
Definition: LArFCAL_region.cxx:81
LArFCAL_region::fullTwoPi
bool fullTwoPi() const
true if detector covers full 2pi (== wraparound option in dictionary)
Definition: LArFCAL_region.cxx:66
LArFCAL_region::m_nextSampReg
short int m_nextSampReg
Definition: LArFCAL_region.h:95
LArFCAL_region::nextSamplingRegion
short int nextSamplingRegion() const
region number of the next region in sampling
Definition: LArFCAL_region.cxx:129
LArFCAL_region
This class provides an interface to deal with regions in the neighbours finding.
Definition: LArFCAL_region.h:20
LArFCAL_region::isEtaMin
bool isEtaMin(const unsigned int &index) const
is the considered cell in the first eta bin of the region ?
Definition: LArFCAL_region.cxx:101
LArFCAL_region::numberOfEta
short int numberOfEta() const
number of eta bins in the whole region
Definition: LArFCAL_region.cxx:46
LArFCAL_region::m_minEta
float m_minEta
Definition: LArFCAL_region.h:88
LArFCAL_region::m_nPhi
short int m_nPhi
Definition: LArFCAL_region.h:87
LArFCAL_region::hashMax
unsigned int hashMax() const
hash Id of the last cell of the region +1
Definition: LArFCAL_region.cxx:96
LArFCAL_region::etaMin
float etaMin() const
starting eta
Definition: LArFCAL_region.cxx:71
LArFCAL_region::m_granulPhi
float m_granulPhi
Definition: LArFCAL_region.h:91
LArFCAL_region::hashMin
unsigned int hashMin() const
hash Id of the first cell of the region
Definition: LArFCAL_region.cxx:91
LArFCAL_region::isPhiMax
bool isPhiMax(const unsigned int &index) const
is the considered cell in the last phi bin of the region ?
Definition: LArFCAL_region.cxx:122
LArFCAL_region::m_nbEtaBins
short int m_nbEtaBins
Definition: LArFCAL_region.h:86