ATLAS Offline Software
Classes | Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
LArHVScaleCorrTool Class Reference

#include <LArHVScaleCorrTool.h>

Collaboration diagram for LArHVScaleCorrTool:

Classes

struct  HV_t
 
struct  HVfix_t
 

Public Types

typedef std::vector< HV_t > voltageCell_t
 

Public Member Functions

 LArHVScaleCorrTool (const CaloCell_ID *caloCellID, MsgStream &msg, const std::vector< std::string > &fixHVStrings)
 
 LArHVScaleCorrTool ()=delete
 
virtual ~LArHVScaleCorrTool ()=default
 
float getHVScale (const CaloDetDescrElement *calodde, const voltageCell_t &hvlist, MsgStream &msg) const
 

Private Member Functions

float Scale_barrel (const float hv) const
 
float Scale_FCAL1 (const float hv) const
 
float champ_e (float hv, float d) const
 
float vdrift (float e, float tempe) const
 
float InvCharge (float e) const
 
float Respo (float e, float e_nominal, float tempe) const
 
float t_drift (float e, float e_nominal, float d, float tempe) const
 
float EMEC_nominal (const float eta_r) const
 
float EMEC_gap (const float eta_r, float Zeta) const
 
void buildFixHVList (const std::vector< std::string > &fixHVStrings, MsgStream &msg)
 

Private Attributes

const LArEM_ID * m_larem_id
 
const LArHEC_ID * m_larhec_id
 
const LArFCAL_ID * m_larfcal_id
 
const float m_T0
 
std::vector< HVfix_t > m_HVfix
 

Detailed Description

Definition at line 20 of file LArHVScaleCorrTool.h.

Member Typedef Documentation

◆ voltageCell_t

typedef std::vector<HV_t> LArHVScaleCorrTool::voltageCell_t

Definition at line 30 of file LArHVScaleCorrTool.h.

Constructor & Destructor Documentation

◆ LArHVScaleCorrTool() [1/2]

LArHVScaleCorrTool::LArHVScaleCorrTool ( const CaloCell_ID *  caloCellID,
MsgStream &  msg,
const std::vector< std::string > &  fixHVStrings 
)

Definition at line 15 of file LArHVScaleCorrTool.cxx.

16  :
17  m_larem_id(calocell_id->em_idHelper()),
18  m_larhec_id(calocell_id->hec_idHelper()),
19  m_larfcal_id(calocell_id->fcal_idHelper()),
20  m_T0(90.371)
21 {
22  buildFixHVList(fixHVStrings, msg);
23 }

◆ LArHVScaleCorrTool() [2/2]

LArHVScaleCorrTool::LArHVScaleCorrTool ( )
delete

◆ ~LArHVScaleCorrTool()

virtual LArHVScaleCorrTool::~LArHVScaleCorrTool ( )
virtualdefault

Member Function Documentation

◆ buildFixHVList()

void LArHVScaleCorrTool::buildFixHVList ( const std::vector< std::string > &  fixHVStrings,
MsgStream &  msg 
)
private

Definition at line 317 of file LArHVScaleCorrTool.cxx.

318  {
319 
320  m_HVfix.clear();
321  for (const std::string& theString : fixHVStrings) {
322  std::stringstream is;
323  is << theString << std::endl;
324 
325  unsigned int iDetector, ilayer_min, ilayer_max;
326  float eta_min, eta_max, phi_min, phi_max, corr;
327  is >> iDetector >> ilayer_min >> ilayer_max >> eta_min >> eta_max >>
328  phi_min >> phi_max >> corr;
329 
330  m_HVfix.push_back({.subdet = iDetector,
331  .layer_min = ilayer_min,
332  .layer_max = ilayer_max,
333  .eta_min = eta_min,
334  .eta_max = eta_max,
335  .phi_min = phi_min,
336  .phi_max = phi_max,
337  .corr = corr});
338  }
339 
340  msg << MSG::INFO
341  << " Number of regions with overwritten HV corrections from jobOptions "
342  << m_HVfix.size() << endmsg;
343 
344  return;
345 }

◆ champ_e()

float LArHVScaleCorrTool::champ_e ( float  hv,
float  d 
) const
private

Definition at line 185 of file LArHVScaleCorrTool.cxx.

186 {
187  float e1;
188  if (hv < -3000.){
189  return -1000.;
190  }
191  else
192  e1 = std::abs(hv)/(d*1e3);
193  if ( e1 < 0.01 ) e1 = 0.01;
194  return e1;
195 }

◆ EMEC_gap()

float LArHVScaleCorrTool::EMEC_gap ( const float  eta_r,
float  Zeta 
) const
private

Definition at line 249 of file LArHVScaleCorrTool.cxx.

250 {
251  float EMECg;
252  if (aeta<=2.5 ) EMECg = 0.9 +1.9*( ( Zeta - 40. )/(10*std::sinh(aeta)) - 60.)/140.;
253  else EMECg = 1.8 + 1.3*( ( Zeta - 40. )/(10*std::sinh(aeta)) - 30.)/40.;
254  return EMECg;
255 }

◆ EMEC_nominal()

float LArHVScaleCorrTool::EMEC_nominal ( const float  eta_r) const
private

Definition at line 236 of file LArHVScaleCorrTool.cxx.

237 {
238  if ( aeta<1.5 ) return 2500.;
239  else if (aeta<1.6) return 2300.;
240  else if (aeta<1.8 ) return 2100.;
241  else if (aeta < 2.0 ) return 1700.;
242  else if (aeta < 2.1 ) return 1500.;
243  else if (aeta < 2.3 ) return 1250.;
244  else if (aeta < 2.5 ) return 1000.;
245  else if (aeta < 2.8 ) return 2300.;
246  else return 1800.;
247 }

◆ getHVScale()

float LArHVScaleCorrTool::getHVScale ( const CaloDetDescrElement *  calodde,
const voltageCell_t &  hvlist,
MsgStream &  msg 
) const

Definition at line 26 of file LArHVScaleCorrTool.cxx.

27  {
28 
29  double d=.2; // nominal gap in cm
30  double nominal=2000.; // nominal HV in Volts
31  double T=88.; // temperature in Kelvin
32 
33  bool isbarrelEM=false;
34  bool isFCAL1=false;
35 
36  unsigned int subdet=99;
37  unsigned int layer=99;
38 
39  const Identifier offid=calodde->identify();
40  const float eta_raw = calodde->eta_raw();
41  const float phi_raw = calodde->phi_raw();
42 
43 
44  // EM calorimeter
45  if (m_larem_id->is_lar_em(offid)) {
46  // barrel
47  if (abs(m_larem_id->barrel_ec(offid))==1) {
48  subdet=0;
49  layer = m_larem_id->sampling(offid);
50  // EMB
51  if (m_larem_id->sampling(offid)>0) {
52  d=0.209;
53  nominal=2000.;
54  T=88.37;
55  isbarrelEM=true;
56  }
57  // EMBPS
58  else {
59  nominal = 2000.;
60  T = 88.37;
61  const int ieta=m_larem_id->eta(offid);
62  if (ieta>=0 && ieta<16) d = 0.196; //cm
63  else if (ieta>=16 && ieta<32) d = 0.193; //cm
64  else if (ieta>=32 && ieta<48) d = 0.2; //cm
65  else d = 0.190; //cm
66  }
67  }
68  // endcap
69  else {
70  subdet=1;
71  layer = m_larem_id->sampling(offid);
72  // End-Cap pre-sampler
73  if (abs(m_larem_id->barrel_ec(offid))==2 && m_larem_id->sampling(offid)==0){
74  T = 88.65; // temperature remainder Calorimeter
75  nominal = -2000.;
76  d = 0.2;
77  }
78  //EMEC
79  else {
80  T = 88.65;
81  float aeta_raw = std::abs(eta_raw);
82  double Zsamp;
83  if ( m_larem_id->sampling(offid)==1 && m_larem_id->region(offid)>=0 ) Zsamp = 3760.; //mm
84  else if ( m_larem_id->sampling(offid)==2 && m_larem_id->region(offid)<=1 ) Zsamp = 3880.; //mm
85  else if(aeta_raw< 2.) Zsamp=4200.-40.*(aeta_raw-1.5);
86  else Zsamp = 4180. - 160.*(aeta_raw-2.);
87  nominal = EMEC_nominal(aeta_raw);
88  d = EMEC_gap(aeta_raw, Zsamp)*0.1; //cm
89  }//end EMEC
90  }//end endcap
91  }//end is-em
92  // Forward Calorimeter
93  else if ( m_larfcal_id->is_lar_fcal(offid)) {
94  subdet=3;
95  layer = m_larfcal_id->module(offid);
96  T = 88.65;
97  if (m_larfcal_id->module(offid)==1){
98  d =0.0269; //cm
99  nominal = 250.;
100  isFCAL1=true;
101  }
102  else if (m_larfcal_id->module(offid)==2){
103  d =0.0376;//cm
104  nominal = 375.;
105  }
106  else {
107  d =0.0508;//cm
108  nominal = 500.;
109  }
110  }
111  // Hadronic Calorimeter
112  else if ( m_larhec_id->is_lar_hec(offid)) {
113  subdet=2;
114  layer = m_larhec_id->sampling(offid);
115  T = 88.65;
116  nominal = 1800.;
117  d = 0.196;//cm
118  }
119  T = T - m_T0;
120 
121  const double E_nominal = champ_e(nominal,d);
122 
123  // dump values
124  bool notfound=false;
125  for (unsigned int i=0;i<hvlist.size();i++) {
126  if (hvlist[i].hv<-10000) notfound=true;
127  }
128 
129  if (notfound) {
130  msg << MSG::WARNING << " At least one HV value not found in database for cell " << m_larem_id->show_to_string(offid) << endmsg;
131  }
132 
133  double mycorr=0.;
134  double mynorm=0.;
135  for (unsigned int i=0;i<hvlist.size();i++) {
136  double E = champ_e(hvlist[i].hv,d);
137 
138  // dont correct if E is very close to E nominal to avoid small glitches
139  if (std::abs(E_nominal)>1e-3) {
140  const double deviation = std::abs((E-E_nominal)/E_nominal);
141  if (deviation<1e-3) E = E_nominal;
142  }
143 
144  // barrel accordion
145  if (isbarrelEM) {
146  const double corr = this->Scale_barrel(hvlist[i].hv)*hvlist[i].weight;
147  mycorr += corr;
148  }
149  //FCAL module 1
150  else if (isFCAL1) {
151  const double corr = this->Scale_FCAL1(hvlist[i].hv) * hvlist[i].weight;
152  mycorr+=corr;
153  }
154  // other subdetectors
155  else {
156  const double corr = Respo(E,E_nominal,T)*hvlist[i].weight;
157  mycorr+= corr;
158  }
159  mynorm += hvlist[i].weight;
160  }//end loop over hvlist
161 
162 
163  if (mycorr>1e-2) mycorr = mynorm/mycorr;
164  else mycorr=1.;
165 
166  // Add protection against correction factor > 10
167  if (mycorr>10.) {
168  msg << MSG::DEBUG << "Correction factor > 10, ignore it... for cell " << m_larem_id->show_to_string(offid) << " " << mycorr << endmsg;;
169  mycorr=1.;
170  }
171 
172  //Overwrite with hardcoded jobOption numbers if requested
173  for (unsigned int ii=0;ii<m_HVfix.size();ii++) {
174  if (subdet == m_HVfix[ii].subdet && layer >= m_HVfix[ii].layer_min && layer <= m_HVfix[ii].layer_max &&
175  eta_raw >= m_HVfix[ii].eta_min && eta_raw < m_HVfix[ii].eta_max &&
176  phi_raw >= m_HVfix[ii].phi_min && phi_raw < m_HVfix[ii].phi_max ) {
177  msg << MSG::DEBUG << "Overwrite correction for cell " << m_larem_id->show_to_string(offid) << " " << m_HVfix[ii].corr << endmsg;;
178  mycorr = m_HVfix[ii].corr;
179  }
180  }
181 
182  return mycorr;
183 }

◆ InvCharge()

float LArHVScaleCorrTool::InvCharge ( float  e) const
private

Definition at line 206 of file LArHVScaleCorrTool.cxx.

208 {
209  float q = 1.;
210  if ( e > 2.) q=(1.+0.36/e);
211  else if (e>1e-6) q =(1.04+0.25/e);
212  return q;
213 }

◆ Respo()

float LArHVScaleCorrTool::Respo ( float  e,
float  e_nominal,
float  tempe 
) const
private

Definition at line 215 of file LArHVScaleCorrTool.cxx.

216 {
217  if (e < -999.) return 1.;
218  if (e < 0.01) return 0;
219  if ( e > e_nominal ) return 1;
220  float den = InvCharge(e)*vdrift(e_nominal,tempe);
221  float resp = den==0 ? 0 : (InvCharge(e_nominal)*vdrift(e,tempe))/den;
222  return resp;
223 }

◆ Scale_barrel()

float LArHVScaleCorrTool::Scale_barrel ( const float  hv) const
private

Definition at line 269 of file LArHVScaleCorrTool.cxx.

270 {
271  const float hvref[18]={1.,50.,100.,150.,200.,300.,400.,500.,600.,700.,800.,900.,1000.,1200.,1400.,1600.,1800.,2000.};
272  const float hvmax = 1998.;
273  const float facteur[18]={0.,0.1209,0.2135,0.2829,0.3390,0.4270,0.4961,0.5556,0.6065,0.6527,0.6906,
274  0.7290,0.7626,0.8224,0.8754,0.9190,0.9606,1.};
275 
276 // 0 HV, returns 0 response
277  if (hv<-999.) {
278  return 0;
279  }
280  else if (hv<hvref[0]) {
281  float resp=facteur[0];
282  return resp;
283  }
284 // 2000 HV, returns response=1
285  if (hv>hvmax) {
286  float resp=facteur[17];
287  return resp;
288  }
289 
290 // intermediate HV, find values between which to extrapolate
291  int i1,i2;
292  i1=1;
293  for (int i=0;i<18;i++) {
294  if (hv<hvref[i]) {
295  i1=i-1;
296  break;
297  }
298  }
299  i2=i1+1;
300  float resp=0.;
301 
302 // if lowHV>=50 V, logarithmic extrapolation
303  if (i1>0) {
304  const float b=(std::log(facteur[i2])-std::log(facteur[i1]))/(std::log(hvref[i2])-std::log(hvref[i1]));
305  const float a=std::log(facteur[i2])-b*std::log(hvref[i2]);
306  resp = std::exp(a+b*std::log(hv));
307  }
308 // if between 0 and 50 V, scales linearly
309  else {
310  resp=facteur[0]*(hv/hvref[0]);
311  }
312  //std::cout << " hv,i1,i2,resp " << hv << " " << i1 << " " << i2 << " " << resp << std::endl;
313  return resp;
314 }

◆ Scale_FCAL1()

float LArHVScaleCorrTool::Scale_FCAL1 ( const float  hv) const
private

Definition at line 257 of file LArHVScaleCorrTool.cxx.

258 {
259  if (hv<5.0) return 0;
260  const float R0=-2.612;
261  const float alpha=2.336;
262  const float beta=0.079;
263  const float scale=R0+alpha*std::pow(hv,beta);
264  return scale;
265 }

◆ t_drift()

float LArHVScaleCorrTool::t_drift ( float  e,
float  e_nominal,
float  d,
float  tempe 
) const
private

Definition at line 225 of file LArHVScaleCorrTool.cxx.

226 {
227  if ( e < -999.) {
228  float den = vdrift(e_nominal, tempe);
229  return den==0 ? 0 : (d*1e4)/den;
230  }
231  if (e > e_nominal ) e = e_nominal;
232  float den = vdrift(e, tempe);
233  return den==0 ? 0 : (d*1e4)/den; // ns
234 }

◆ vdrift()

float LArHVScaleCorrTool::vdrift ( float  e,
float  tempe 
) const
private

Definition at line 197 of file LArHVScaleCorrTool.cxx.

198 {
199  const float T = tempe;
200  static const float P[6] = {-0.01481,-0.0075,0.141,12.4,1.627,0.317};
201  if ( e < -999.) return 0.;
202  float vd = (P[0]*T+1)*( P[2]*e*std::log(1+ (P[3]/e)) + P[4]*std::pow(e,P[5])) + P[1]*T; // vdrift formula walcowialk mm/micro_s
203  return vd;
204 }

Member Data Documentation

◆ m_HVfix

std::vector<HVfix_t> LArHVScaleCorrTool::m_HVfix
private

Definition at line 94 of file LArHVScaleCorrTool.h.

◆ m_larem_id

const LArEM_ID* LArHVScaleCorrTool::m_larem_id
private

Definition at line 45 of file LArHVScaleCorrTool.h.

◆ m_larfcal_id

const LArFCAL_ID* LArHVScaleCorrTool::m_larfcal_id
private

Definition at line 47 of file LArHVScaleCorrTool.h.

◆ m_larhec_id

const LArHEC_ID* LArHVScaleCorrTool::m_larhec_id
private

Definition at line 46 of file LArHVScaleCorrTool.h.

◆ m_T0

const float LArHVScaleCorrTool::m_T0
private

Definition at line 48 of file LArHVScaleCorrTool.h.

The documentation for this class was generated from the following files:
AllowedVariables::e
e
Definition: AsgElectronSelectorTool.cxx:37
add-xsec-uncert-quadrature-N.alpha
alpha
Definition: add-xsec-uncert-quadrature-N.py:110
LArHVScaleCorrTool::m_larem_id
const LArEM_ID * m_larem_id
Definition: LArHVScaleCorrTool.h:45
AtlasDetectorID::is_lar_fcal
bool is_lar_fcal(Identifier id) const
Definition: AtlasDetectorID.h:834
LArHVScaleCorrTool::Scale_barrel
float Scale_barrel(const float hv) const
Definition: LArHVScaleCorrTool.cxx:269
egammaEnergyPositionAllSamples::e1
double e1(const xAOD::CaloCluster &cluster)
return the uncorrected cluster energy in 1st sampling
LArHVScaleCorrTool::champ_e
float champ_e(float hv, float d) const
Definition: LArHVScaleCorrTool.cxx:185
hist_file_dump.d
d
Definition: hist_file_dump.py:142
DMTest::P
P_v1 P
Definition: P.h:23
LArHVScaleCorrTool::m_T0
const float m_T0
Definition: LArHVScaleCorrTool.h:48
LArFCAL_Base_ID::module
int module(const Identifier id) const
module [1,3]
LArEM_Base_ID::region
int region(const Identifier id) const
return region according to :
LArEM_Base_ID::sampling
int sampling(const Identifier id) const
return sampling according to :
LArHVScaleCorrTool::Respo
float Respo(float e, float e_nominal, float tempe) const
Definition: LArHVScaleCorrTool.cxx:215
CheckTagAssociation.notfound
notfound
Definition: CheckTagAssociation.py:105
drawFromPickle.exp
exp
Definition: drawFromPickle.py:36
yodamerge_tmp.scale
scale
Definition: yodamerge_tmp.py:138
LArHVScaleCorrTool::vdrift
float vdrift(float e, float tempe) const
Definition: LArHVScaleCorrTool.cxx:197
LArEM_Base_ID::eta
int eta(const Identifier id) const
return eta according to :
CaloDetDescrElement::eta_raw
float eta_raw() const
cell eta_raw
Definition: Calorimeter/CaloDetDescr/CaloDetDescr/CaloDetDescrElement.h:350
CaloDetDescrElement::identify
Identifier identify() const override final
cell identifier
Definition: CaloDetDescrElement.cxx:63
LArHVScaleCorrTool::m_HVfix
std::vector< HVfix_t > m_HVfix
Definition: LArHVScaleCorrTool.h:94
LArHVScaleCorrTool::m_larhec_id
const LArHEC_ID * m_larhec_id
Definition: LArHVScaleCorrTool.h:46
CheckAppliedSFs.e3
e3
Definition: CheckAppliedSFs.py:264
lumiFormat.i
int i
Definition: lumiFormat.py:85
PixelAthClusterMonAlgCfg.e4
e4
Definition: PixelAthClusterMonAlgCfg.py:332
endmsg
#define endmsg
Definition: AnalysisConfig_Ntuple.cxx:63
LArHVScaleCorrTool::m_larfcal_id
const LArFCAL_ID * m_larfcal_id
Definition: LArHVScaleCorrTool.h:47
TRT::Hit::layer
@ layer
Definition: HitInfo.h:79
LArHVScaleCorrTool::buildFixHVList
void buildFixHVList(const std::vector< std::string > &fixHVStrings, MsgStream &msg)
Definition: LArHVScaleCorrTool.cxx:317
AtlasDetectorID::is_lar_hec
bool is_lar_hec(Identifier id) const
Definition: AtlasDetectorID.h:824
LArHVScaleCorrTool::EMEC_nominal
float EMEC_nominal(const float eta_r) const
Definition: LArHVScaleCorrTool.cxx:236
LArHVScaleCorrTool::InvCharge
float InvCharge(float e) const
Definition: LArHVScaleCorrTool.cxx:206
VP1PartSpect::E
@ E
Definition: VP1PartSpectFlags.h:21
plotBeamSpotMon.b
b
Definition: plotBeamSpotMon.py:76
LArEM_Base_ID::barrel_ec
int barrel_ec(const Identifier id) const
return barrel_ec according to :
LArHVScaleCorrTool::EMEC_gap
float EMEC_gap(const float eta_r, float Zeta) const
Definition: LArHVScaleCorrTool.cxx:249
LArHVScaleCorrTool::Scale_FCAL1
float Scale_FCAL1(const float hv) const
Definition: LArHVScaleCorrTool.cxx:257
a
TList * a
Definition: liststreamerinfos.cxx:10
AtlasDetectorID::show_to_string
std::string show_to_string(Identifier id, const IdContext *context=0, char sep='.') const
or provide the printout in string form
Definition: AtlasDetectorID.cxx:365
python.Constants.INFO
int INFO
Definition: Control/AthenaCommon/python/Constants.py:15
DEBUG
#define DEBUG
Definition: page_access.h:11
LArHEC_Base_ID::sampling
int sampling(const Identifier id) const
return sampling [0,3] (only 0 for supercells)
python.CaloCondTools.log
log
Definition: CaloCondTools.py:20
extractSporadic.q
list q
Definition: extractSporadic.py:97
MuonParameters::beta
@ beta
Definition: MuonParamDefs.h:144
pow
constexpr int pow(int base, int exp) noexcept
Definition: ap_fixedTest.cxx:15
AtlasDetectorID::is_lar_em
bool is_lar_em(Identifier id) const
Definition: AtlasDetectorID.h:813
python.AutoConfigFlags.msg
msg
Definition: AutoConfigFlags.py:7
TSU::T
unsigned long long T
Definition: L1TopoDataTypes.h:35
CaloDetDescrElement::phi_raw
float phi_raw() const
cell phi_raw
Definition: Calorimeter/CaloDetDescr/CaloDetDescr/CaloDetDescrElement.h:352
Identifier
Definition: IdentifierFieldParser.cxx:14
Generated on Fri Oct 31 2025 21:39:03 for ATLAS Offline Software by   doxygen 1.8.18