ATLAS Offline Software
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Private Types | Private Member Functions | Private Attributes | List of all members
LArRawChannelBuilderToolCubic Class Reference

Obtain ADC_max by making a cubic fit on samples. More...

#include <LArRawChannelBuilderToolCubic.h>

Inheritance diagram for LArRawChannelBuilderToolCubic:
Collaboration diagram for LArRawChannelBuilderToolCubic:

Public Member Functions

 LArRawChannelBuilderToolCubic (const std::string &type, const std::string &name, const IInterface *parent)
 
bool buildRawChannel (const LArDigit *digit, float pedestal, const std::vector< float > &ramps, MsgStream *pLog)
 
StatusCode initTool ()
 
void initEventHidden ()
 
int energy ()
 
int time ()
 
CaloGain::CaloGain gain ()
 
void BuildLArCell (int energy, int time, uint16_t quality, uint16_t provenance, const LArDigit *digit)
 
void BuildLArRawChannel (int energy, int time, uint16_t quality, uint16_t provenance, const LArDigit *digit)
 
StatusCode initToolHidden (LArRawChannelBuilderParams *myParent)
 
virtual void initEvent ()
 
virtual void finalEventHidden ()
 
virtual void finalEvent ()
 
virtual void printSummary ()
 
Identifier currentID ()
 
ServiceHandle< StoreGateSvc > & evtStore ()
 The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
 
const ServiceHandle< StoreGateSvc > & evtStore () const
 The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
 
const ServiceHandle< StoreGateSvc > & detStore () const
 The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc. More...
 
virtual StatusCode sysInitialize () override
 Perform system initialization for an algorithm. More...
 
virtual StatusCode sysStart () override
 Handle START transition. More...
 
virtual std::vector< Gaudi::DataHandle * > inputHandles () const override
 Return this algorithm's input handles. More...
 
virtual std::vector< Gaudi::DataHandle * > outputHandles () const override
 Return this algorithm's output handles. More...
 
Gaudi::Details::PropertyBase & declareProperty (Gaudi::Property< T > &t)
 
Gaudi::Details::PropertyBase * declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
 Declare a new Gaudi property. More...
 
Gaudi::Details::PropertyBase * declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
 Declare a new Gaudi property. More...
 
Gaudi::Details::PropertyBase * declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)
 
Gaudi::Details::PropertyBase * declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
 Declare a new Gaudi property. More...
 
Gaudi::Details::PropertyBase * declareProperty (const std::string &name, T &property, const std::string &doc="none")
 Declare a new Gaudi property. More...
 
void updateVHKA (Gaudi::Details::PropertyBase &)
 
MsgStream & msg () const
 
MsgStream & msg (const MSG::Level lvl) const
 
bool msgLvl (const MSG::Level lvl) const
 

Static Public Member Functions

static const InterfaceID & interfaceID ()
 

Public Attributes

void(LArRawChannelBuilderToolBase::* m_buildIt )(int energy, int time, uint16_t quality, uint16_t provenance, const LArDigit *digit)
 

Protected Member Functions

void renounceArray (SG::VarHandleKeyArray &handlesArray)
 remove all handles from I/O resolution More...
 
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > renounce (T &h)
 
void extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
 Add StoreName to extra input/output deps as needed. More...
 

Protected Attributes

LArRawChannelContainerm_larRawChannelContainer
 
int m_energy
 
int m_time
 
CaloGain::CaloGain m_gain
 
SG::ReadCondHandleKey< LArOnOffIdMappingm_cablingKey {this,"CablingKey","LArOnOffIdMap","SG Key of LArOnOffIdMapping object"}
 
SG::ReadCondHandleKey< LArOnOffIdMappingm_cablingKeySC {this,"SCCablingKey","LArOnOffIdMapSC","SG Key of SC LArOnOffIdMapping object"}
 
LArRawChannelBuilderParamsm_parent
 
LArRawChannelBuilderStatisticsm_helper
 
bool m_isSC
 

Private Types

typedef ServiceHandle< StoreGateSvcStoreGateSvc_t
 

Private Member Functions

 LArRawChannelBuilderToolCubic (const LArRawChannelBuilderToolCubic &)
 
LArRawChannelBuilderToolCubicoperator= (const LArRawChannelBuilderToolCubic &)
 
Gaudi::Details::PropertyBase & declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
 specialization for handling Gaudi::Property<SG::VarHandleKey> More...
 
Gaudi::Details::PropertyBase & declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
 specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...
 
Gaudi::Details::PropertyBase & declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
 specialization for handling Gaudi::Property<SG::VarHandleBase> More...
 
Gaudi::Details::PropertyBase & declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
 specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...
 

Private Attributes

bool m_useMaxSample
 
const LArFCAL_IDm_fcalId
 
int m_minADC
 
StoreGateSvc_t m_evtStore
 Pointer to StoreGate (event store by default) More...
 
StoreGateSvc_t m_detStore
 Pointer to StoreGate (detector store by default) More...
 
std::vector< SG::VarHandleKeyArray * > m_vhka
 
bool m_varHandleArraysDeclared
 

Detailed Description

Obtain ADC_max by making a cubic fit on samples.

Author
Rolf Seuster

Definition at line 20 of file LArRawChannelBuilderToolCubic.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t
privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ LArRawChannelBuilderToolCubic() [1/2]

LArRawChannelBuilderToolCubic::LArRawChannelBuilderToolCubic ( const std::string &  type,
const std::string &  name,
const IInterface *  parent 
)

Definition at line 24 of file LArRawChannelBuilderToolCubic.cxx.

26  :
28  m_fcalId(nullptr)
29 {
30  m_helper = new LArRawChannelBuilderStatistics( 3, // number of possible errors
31  0x04); // bit pattern special for this tool,
32  // to be stored in "uint16_t provenance"
33  m_helper->setErrorString(0, "no errors");
34  m_helper->setErrorString(1, "Fit failed");
35  m_helper->setErrorString(2, "is FCAL");
36 
37  declareProperty("UseMaxSample", m_useMaxSample = false);
38  declareProperty("minADCforCubic", m_minADC=30);
39 
40 }

◆ LArRawChannelBuilderToolCubic() [2/2]

LArRawChannelBuilderToolCubic::LArRawChannelBuilderToolCubic ( const LArRawChannelBuilderToolCubic )
private

Member Function Documentation

◆ BuildLArCell()

void LArRawChannelBuilderToolBase::BuildLArCell ( int  energy,
int  time,
uint16_t  quality,
uint16_t  provenance,
const LArDigit digit 
)
inlineinherited

Definition at line 72 of file LArRawChannelBuilderToolBase.h.

72  {
73  m_energy = energy;
74  m_time = time;
75  m_gain = digit->gain();
76 }

◆ BuildLArRawChannel()

void LArRawChannelBuilderToolBase::BuildLArRawChannel ( int  energy,
int  time,
uint16_t  quality,
uint16_t  provenance,
const LArDigit digit 
)
inlineinherited

Definition at line 79 of file LArRawChannelBuilderToolBase.h.

79  {
80  // It is assumed that m_larRawChannelContainer exists
81  LArRawChannel larRawChannel(digit->channelID(),
82  energy,time,
83  quality,provenance,digit->gain());
84  m_larRawChannelContainer->add(larRawChannel);
85 }

◆ buildRawChannel()

bool LArRawChannelBuilderToolCubic::buildRawChannel ( const LArDigit digit,
float  pedestal,
const std::vector< float > &  ramps,
MsgStream *  pLog 
)
virtual

Implements LArRawChannelBuilderToolBase.

Definition at line 51 of file LArRawChannelBuilderToolCubic.cxx.

55 {
56  float ADCPeak=0;
57 
58  bool CubicFailed=false;
59 
60  float time=0;
61 
62  // use fixed sample
63  unsigned int maxSample = m_parent->curr_shiftTimeSamples+2 ;
64 
65  // use max Sample
66  if(m_useMaxSample)
67  maxSample = m_parent->curr_maxsample ;
68 
69 
70  if( maxSample>= digit->samples().size() )
71  return false;
72 
73  // apply min ADC cut.
74  if( (digit->samples()[maxSample]-pedestal) < m_minADC )
75  return false;
76 
77 
78  // FCAL needs special treatment
80  {
81  if(bool(pLog))
82  (*pLog) << MSG::VERBOSE << "FCAL using special reconstuction !" << endmsg;
83 
84  unsigned int it0;
85 
86  const float invT[3][3]
87  = { { 1, 0, 0 },
88  { -1.5, 2, -0.5 },
89  { 0.5, -1, 0.5 } };
90 
91  // peak slice very early
92  if ( (maxSample) <= 1 )
93  {
94  it0 = 1;
95  } else if ( (maxSample) >= (m_parent->curr_nsamples) )
96  {
97  // peak is late
98  it0 = (m_parent->curr_nsamples) - 3;
99  } else {
100  // peak in safe region
101  it0 = (maxSample) - 1;
102  }
103 
104  // Quadratic interpolation using
105  // 3 samples to be used start at 0 <= t0 <= nsamples-3
106  float A[3] = {0, 0, 0};
107  float dtmax = 0.0;
108  // S = TA -> A = inv(T)S
109  for (int ia = 0; ia < 3; ia++)
110  for (int it = 0; it < 3; it++)
111  A[ia] += invT[ia][it] * (digit->samples()[it0+it] - (pedestal));
112 
113  // fit parameters
114  if ( not ( CubicFailed = ( A[2] == 0 ) ) ) {
115  dtmax = -1.0 * A[1] / 2.0 / A[2];
116  if ( ! ( CubicFailed = ( dtmax < 0 || dtmax > 2 ) ) ) {
117  //time = (float(it0) + dtmax) * 25.0 * nanosecond; // nsec
118  time=dtmax*25.0*ns;
119  for(int ia = 0; ia < 3; ia++)
120  ADCPeak += A[ia] * pow(dtmax, ia);
121  }
122  }
123  }else{
124 
125  unsigned int it0;
126  const float invT[4][4]
127  = { { 1, 0, 0, 0},
128  { -1.83333, 3, -1.5, 0.333333},
129  { 1, -2.5, 2, -0.5},
130  {-0.166666, 0.5, -0.5, 0.166666} };
131 
132  // peak slice very early
133  if ( (maxSample) <= 1 )
134  {
135  it0 = 1;
136  } else if ( (maxSample) >= (m_parent->curr_nsamples) - 2 )
137  { // peak is late
138  it0 = (m_parent->curr_nsamples) - 4;
139  } else { // peak in safe region
140  it0 = ( digit->samples()[(maxSample)-2] > digit->samples()[(maxSample)+2] )
141  ? (maxSample) - 2
142  : (maxSample) - 1;
143  }
144 
145  // 4 samples to be used start at 0 <= t0 <= nsamples-4
146  float A[4] = {0, 0, 0, 0};
147  float dtmax = 0.0;
148  float disc;
149  // S = TA -> A = inv(T)S
150  for (int ia = 0; ia < 4; ia++)
151  for (int it = 0; it < 4; it++)
152  A[ia] += invT[ia][it] * (digit->samples()[it0+it] - (pedestal));
153 
154  // fit parameters
155  disc = A[2]*A[2] - 3*A[1]*A[3];
156  if ( ! ( CubicFailed = ( disc < 0 || A[3] == 0 ) ) ) {
157  dtmax = (-A[2]-std::sqrt(disc))/(A[3]*3);
158  if ( ! ( CubicFailed = ( dtmax < 0 || dtmax > 3 ) ) ) {
159  time = (float(it0) + dtmax) * (25.0 * nanosecond/picosecond); // nsec
160  for(int ia = 0; ia < 4; ia++)
161  ADCPeak += A[ia] * pow(dtmax, ia);
162  }
163  }
164 
165  if(CubicFailed)
166  {
168  return false;
169  }
170  }
171 
172  float power=1;
173  float energy=0;
174  for( unsigned int i=0; i<ramps.size(); i++)
175  {
176  energy += ramps[i] * power;
177  power *= ADCPeak;
178  }
179 
180  // store which tools created this channel
181  uint16_t iquality=0;
182  uint16_t iprovenance=0;
183 
184  iprovenance |= m_parent->qualityBitPattern;
185  iprovenance |= m_helper->returnBitPattern();
186  iprovenance = iprovenance & 0x3FFF;
187 
188  const float fMAXINT = static_cast<float>(MAXINT);
189  const float fMAXINT2 = static_cast<float>(MAXINT2);
190 
191  if (time>fMAXINT) time=fMAXINT;
192  if (time<fMAXINT2) time=fMAXINT2;
193 
194  if (energy>fMAXINT) energy=fMAXINT;
195  if (energy<fMAXINT2) energy=fMAXINT2;
196 
197 
198  // Suppress false positive seen wth gcc.
199 #if __GNUC__ >= 11 && __GNUC__ <= 13
200 # pragma GCC diagnostic push
201 # pragma GCC diagnostic ignored "-Wmaybe-uninitialized"
202 #endif
203  (this->*m_buildIt)((int)(floor(energy+0.5)),(int)floor(time+0.5),iquality,iprovenance,digit);
204 #if __GNUC__ >= 11 && __GNUC__ <= 13
205 # pragma GCC diagnostic pop
206 #endif
207 
209 
210  return true;
211 }

◆ currentID()

Identifier LArRawChannelBuilderToolBaseClass::currentID ( )
inherited

Definition at line 94 of file LArRawChannelBuilderToolBaseClass.cxx.

95 {
96  const LArOnOffIdMapping *cabling=nullptr;
97  if(m_isSC) {
99  cabling = *cablingHdl;
100  } else {
102  cabling = *cablingHdl;
103  }
104  if(!cabling) {
105  m_parent->curr_id=0;
106  } else {
107  if(m_parent->curr_id==0) {
108  try {
109  m_parent->curr_id = cabling->cnvToIdentifier(m_parent->curr_chid);
110  } catch ( LArID_Exception & except ) {
111  ATH_MSG_INFO("Cabling exception was caught for channel 0x!"
112  << MSG::hex << m_parent->curr_chid.get_compact() << MSG::dec );
113  m_parent->curr_id=0;
114  }
115  }
116  }
117  return m_parent->curr_id;
118 }

◆ declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl,
const SG::VarHandleKeyArrayType  
)
inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKeyArray>

Definition at line 170 of file AthCommonDataStore.h.

172  {
173  return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
174  hndl.value(),
175  hndl.documentation());
176 
177  }

◆ declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl,
const SG::VarHandleKeyType  
)
inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

158  {
159  return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
160  hndl.value(),
161  hndl.documentation());
162 
163  }

◆ declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl,
const SG::VarHandleType  
)
inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleBase>

Definition at line 184 of file AthCommonDataStore.h.

186  {
187  return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
188  hndl.value(),
189  hndl.documentation());
190  }

◆ declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  t,
const SG::NotHandleType  
)
inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

200  {
201  return PBASE::declareProperty(t);
202  }

◆ declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name,
SG::VarHandleBase hndl,
const std::string &  doc,
const SG::VarHandleType  
)
inlineinherited

Declare a new Gaudi property.

Parameters
nameName of the property.
hndlObject holding the property value.
docDocumentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

249  {
250  this->declare(hndl.vhKey());
251  hndl.vhKey().setOwner(this);
252 
253  return PBASE::declareProperty(name,hndl,doc);
254  }

◆ declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name,
SG::VarHandleKey hndl,
const std::string &  doc,
const SG::VarHandleKeyType  
)
inlineinherited

Declare a new Gaudi property.

Parameters
nameName of the property.
hndlObject holding the property value.
docDocumentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

225  {
226  this->declare(hndl);
227  hndl.setOwner(this);
228 
229  return PBASE::declareProperty(name,hndl,doc);
230  }

◆ declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name,
SG::VarHandleKeyArray hndArr,
const std::string &  doc,
const SG::VarHandleKeyArrayType  
)
inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

263  {
264 
265  // std::ostringstream ost;
266  // ost << Algorithm::name() << " VHKA declareProp: " << name
267  // << " size: " << hndArr.keys().size()
268  // << " mode: " << hndArr.mode()
269  // << " vhka size: " << m_vhka.size()
270  // << "\n";
271  // debug() << ost.str() << endmsg;
272 
273  hndArr.setOwner(this);
274  m_vhka.push_back(&hndArr);
275 
276  Gaudi::Details::PropertyBase* p = PBASE::declareProperty(name, hndArr, doc);
277  if (p != 0) {
278  p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
279  } else {
280  ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray "
281  << name);
282  }
283 
284  return p;
285 
286  }

◆ declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name,
T &  property,
const std::string &  doc,
const SG::NotHandleType  
)
inlineinherited

Declare a new Gaudi property.

Parameters
nameName of the property.
propertyObject holding the property value.
docDocumentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

337  {
338  return PBASE::declareProperty(name, property, doc);
339  }

◆ declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name,
T &  property,
const std::string &  doc = "none" 
)
inlineinherited

Declare a new Gaudi property.

Parameters
nameName of the property.
propertyObject holding the property value.
docDocumentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

355  {
356  typedef typename SG::HandleClassifier<T>::type htype;
357  return declareProperty (name, property, doc, htype());
358  }

◆ declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T > &  t)
inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

145  {
146  typedef typename SG::HandleClassifier<T>::type htype;
148  }

◆ detStore()

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const
inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95 { return m_detStore; }

◆ energy()

int LArRawChannelBuilderToolBase::energy ( )
inlinevirtualinherited

Implements ILArRawChannelBuilderToolBase.

Definition at line 46 of file LArRawChannelBuilderToolBase.h.

46 { return m_energy; }

◆ evtStore() [1/2]

ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )
inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85 { return m_evtStore; }

◆ evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( ) const
inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 90 of file AthCommonDataStore.h.

90 { return m_evtStore; }

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase &  ExtraDeps)
protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ finalEvent()

virtual void LArRawChannelBuilderToolBaseClass::finalEvent ( )
inlinevirtualinherited

Definition at line 63 of file LArRawChannelBuilderToolBaseClass.h.

63 { };

◆ finalEventHidden()

void LArRawChannelBuilderToolBaseClass::finalEventHidden ( )
virtualinherited

Implements ILArRawChannelBuilderToolBaseClass.

Definition at line 87 of file LArRawChannelBuilderToolBaseClass.cxx.

88 {
90  finalEvent();
91 }

◆ gain()

CaloGain::CaloGain LArRawChannelBuilderToolBase::gain ( )
inlinevirtualinherited

Implements ILArRawChannelBuilderToolBase.

Definition at line 48 of file LArRawChannelBuilderToolBase.h.

48 { return m_gain; }

◆ initEvent()

virtual void LArRawChannelBuilderToolBaseClass::initEvent ( )
inlinevirtualinherited

Reimplemented in LArRawChannelBuilderToolOFCIter.

Definition at line 59 of file LArRawChannelBuilderToolBaseClass.h.

59 { };

◆ initEventHidden()

void LArRawChannelBuilderToolBase::initEventHidden ( )
inlinevirtualinherited

◆ initTool()

StatusCode LArRawChannelBuilderToolCubic::initTool ( )
virtual

Reimplemented from LArRawChannelBuilderToolBase.

Definition at line 42 of file LArRawChannelBuilderToolCubic.cxx.

43 {
44  const CaloCell_ID* idHelper = nullptr;
45  ATH_CHECK( detStore()->retrieve (idHelper, "CaloCell_ID") );
46  m_fcalId=idHelper->fcal_idHelper();
47 
48  return StatusCode::SUCCESS;
49 }

◆ initToolHidden()

StatusCode LArRawChannelBuilderToolBaseClass::initToolHidden ( LArRawChannelBuilderParams myParent)
inlinevirtualinherited

Implements ILArRawChannelBuilderToolBaseClass.

Definition at line 43 of file LArRawChannelBuilderToolBaseClass.h.

44  {
45  m_parent=myParent;
46  if ( m_isSC ) {
48  } else {
50  }
51  return initTool();
52  };

◆ inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const
overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ interfaceID()

static const InterfaceID& ILArRawChannelBuilderToolBase::interfaceID ( )
inlinestaticinherited

Definition at line 30 of file ILArRawChannelBuilderToolBase.h.

30 { return IID_ILArRawChannelBuilderToolBase; }

◆ msg() [1/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( ) const
inlineinherited

Definition at line 24 of file AthCommonMsg.h.

24  {
25  return this->msgStream();
26  }

◆ msg() [2/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( const MSG::Level  lvl) const
inlineinherited

Definition at line 27 of file AthCommonMsg.h.

27  {
28  return this->msgStream(lvl);
29  }

◆ msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level  lvl) const
inlineinherited

Definition at line 30 of file AthCommonMsg.h.

30  {
31  return this->msgLevel(lvl);
32  }

◆ operator=()

LArRawChannelBuilderToolCubic& LArRawChannelBuilderToolCubic::operator= ( const LArRawChannelBuilderToolCubic )
private

◆ outputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const
overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ printSummary()

void LArRawChannelBuilderToolBaseClass::printSummary ( )
virtualinherited

Implements ILArRawChannelBuilderToolBaseClass.

Definition at line 33 of file LArRawChannelBuilderToolBaseClass.cxx.

34 {
35  MsgStream log(msgSvc(), name());
36  ulonglong sum=0;
37  for( unsigned int i=0; i<m_helper->returnMaxErrors(); i++ )
39 
40  log << MSG::INFO << "Printing Summary for tool " << name() << " :" << endmsg;
41  log << MSG::INFO
42  << std::setw(40) << " " << " : "
43  << std::setw(12) << " total "
44  << std::setw(10) << " percent " << " "
45  << std::setw(12) << " per event "
46  << std::setw(12) << " RMS "
47  << endmsg;
48 
49  double inv_sum = sum > 0 ? 1./sum : 1;
50  for( unsigned int i=0; i<m_helper->returnMaxErrors(); i++ )
51  {
52  double fraction = 0.0;
53  double perEvent = 0.0;
54  double rmsPerEv = 0.0;
55  if(sum>0)
56  fraction=100 * double(m_helper->returnErrorCount(i)) * inv_sum;
57  if(m_helper->returnEvents()>0)
58  {
61  rmsPerEv = sqrt(std::max(0.,rmsPerEv-perEvent*perEvent));
62  }
63 
64  log << MSG::INFO
65  << std::setw(40)
66  << m_helper->returnErrorString(i) << " : "
67  << std::setw(12)
69  << std::setw(10)
70  << std::fixed
71  << std::setprecision(4)
72  << fraction
73  << " %"
74  << std::setw(12)
75  << std::fixed
76  << std::setprecision(4)
77  << perEvent
78  << std::setw(12)
79  << std::fixed
80  << std::setprecision(4)
81  << rmsPerEv
82  << endmsg;
83  }
84 }

◆ renounce()

std::enable_if_t<std::is_void_v<std::result_of_t<decltype(&T::renounce)(T)> > && !std::is_base_of_v<SG::VarHandleKeyArray, T> && std::is_base_of_v<Gaudi::DataHandle, T>, void> AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T &  h)
inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

381  {
382  h.renounce();
383  PBASE::renounce (h);
384  }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray handlesArray)
inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

364  {
365  handlesArray.renounce();
366  }

◆ sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )
overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in DerivationFramework::CfAthAlgTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and asg::AsgMetadataTool.

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )
overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ time()

int LArRawChannelBuilderToolBase::time ( )
inlinevirtualinherited

Implements ILArRawChannelBuilderToolBase.

Definition at line 47 of file LArRawChannelBuilderToolBase.h.

47 { return m_time; }

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase &  )
inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

308  {
309  // debug() << "updateVHKA for property " << p.name() << " " << p.toString()
310  // << " size: " << m_vhka.size() << endmsg;
311  for (auto &a : m_vhka) {
312  std::vector<SG::VarHandleKey*> keys = a->keys();
313  for (auto k : keys) {
314  k->setOwner(this);
315  }
316  }
317  }

Member Data Documentation

◆ m_buildIt

void(LArRawChannelBuilderToolBase::* LArRawChannelBuilderToolBase::m_buildIt) (int energy, int time, uint16_t quality, uint16_t provenance, const LArDigit *digit)
inherited

Definition at line 57 of file LArRawChannelBuilderToolBase.h.

◆ m_cablingKey

SG::ReadCondHandleKey<LArOnOffIdMapping> LArRawChannelBuilderToolBaseClass::m_cablingKey {this,"CablingKey","LArOnOffIdMap","SG Key of LArOnOffIdMapping object"}
protectedinherited

Definition at line 77 of file LArRawChannelBuilderToolBaseClass.h.

◆ m_cablingKeySC

SG::ReadCondHandleKey<LArOnOffIdMapping> LArRawChannelBuilderToolBaseClass::m_cablingKeySC {this,"SCCablingKey","LArOnOffIdMapSC","SG Key of SC LArOnOffIdMapping object"}
protectedinherited

Definition at line 78 of file LArRawChannelBuilderToolBaseClass.h.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore
privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_energy

int LArRawChannelBuilderToolBase::m_energy
protectedinherited

Definition at line 65 of file LArRawChannelBuilderToolBase.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore
privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_fcalId

const LArFCAL_ID* LArRawChannelBuilderToolCubic::m_fcalId
private

Definition at line 38 of file LArRawChannelBuilderToolCubic.h.

◆ m_gain

CaloGain::CaloGain LArRawChannelBuilderToolBase::m_gain
protectedinherited

Definition at line 67 of file LArRawChannelBuilderToolBase.h.

◆ m_helper

LArRawChannelBuilderStatistics* LArRawChannelBuilderToolBaseClass::m_helper
protectedinherited

Definition at line 82 of file LArRawChannelBuilderToolBaseClass.h.

◆ m_isSC

bool LArRawChannelBuilderToolBaseClass::m_isSC
protectedinherited

Definition at line 84 of file LArRawChannelBuilderToolBaseClass.h.

◆ m_larRawChannelContainer

LArRawChannelContainer* LArRawChannelBuilderToolBase::m_larRawChannelContainer
protectedinherited

Definition at line 64 of file LArRawChannelBuilderToolBase.h.

◆ m_minADC

int LArRawChannelBuilderToolCubic::m_minADC
private

Definition at line 39 of file LArRawChannelBuilderToolCubic.h.

◆ m_parent

LArRawChannelBuilderParams* LArRawChannelBuilderToolBaseClass::m_parent
protectedinherited

Definition at line 80 of file LArRawChannelBuilderToolBaseClass.h.

◆ m_time

int LArRawChannelBuilderToolBase::m_time
protectedinherited

Definition at line 66 of file LArRawChannelBuilderToolBase.h.

◆ m_useMaxSample

bool LArRawChannelBuilderToolCubic::m_useMaxSample
private

Definition at line 37 of file LArRawChannelBuilderToolCubic.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared
privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka
privateinherited

Definition at line 398 of file AthCommonDataStore.h.


The documentation for this class was generated from the following files:
python.PyKernel.retrieve
def retrieve(aClass, aKey=None)
Definition: PyKernel.py:110
LArRawChannelBuilderToolBase::m_time
int m_time
Definition: LArRawChannelBuilderToolBase.h:66
python.PerfMonSerializer.p
def p
Definition: PerfMonSerializer.py:743
max
#define max(a, b)
Definition: cfImp.cxx:41
SG::ReadCondHandle
Definition: ReadCondHandle.h:44
ATH_MSG_INFO
#define ATH_MSG_INFO(x)
Definition: AthMsgStreamMacros.h:31
python.SystemOfUnits.nanosecond
int nanosecond
Definition: SystemOfUnits.py:119
AtlasDetectorID::is_lar_fcal
bool is_lar_fcal(Identifier id) const
Definition: AtlasDetectorID.h:839
AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T > &t)
Definition: AthCommonDataStore.h:145
LArRawChannelBuilderParams::curr_id
Identifier curr_id
Definition: LArRawChannelBuilderParams.h:23
LArRawChannelBuilderToolBase::BuildLArCell
void BuildLArCell(int energy, int time, uint16_t quality, uint16_t provenance, const LArDigit *digit)
Definition: LArRawChannelBuilderToolBase.h:72
conifer::pow
constexpr int pow(int x)
Definition: conifer.h:20
LArRawChannelBuilderToolBaseClass::m_cablingKey
SG::ReadCondHandleKey< LArOnOffIdMapping > m_cablingKey
Definition: LArRawChannelBuilderToolBaseClass.h:77
ReadCellNoiseFromCool.cabling
cabling
Definition: ReadCellNoiseFromCool.py:154
skel.it
it
Definition: skel.GENtoEVGEN.py:423
AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore
StoreGateSvc_t m_evtStore
Pointer to StoreGate (event store by default)
Definition: AthCommonDataStore.h:390
LArRawChannelBuilderStatistics::setErrorString
void setErrorString(unsigned int nerr, const std::string &s)
Definition: LArRawChannelBuilderStatistics.cxx:69
AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka
std::vector< SG::VarHandleKeyArray * > m_vhka
Definition: AthCommonDataStore.h:398
LArRawChannelBuilderParams::m_larRawChannelContainer
LArRawChannelContainer * m_larRawChannelContainer
Definition: LArRawChannelBuilderParams.h:35
MAXINT
#define MAXINT
Definition: LArRawChannelBuilderToolCubic.cxx:20
read_hist_ntuple.t
t
Definition: read_hist_ntuple.py:5
checkRpcDigits.digit
digit
Definition: checkRpcDigits.py:186
LArRawChannelBuilderToolBaseClass::finalEvent
virtual void finalEvent()
Definition: LArRawChannelBuilderToolBaseClass.h:63
LArRawChannelBuilderStatistics
Returns various counters from the LArRawChannel building.
Definition: LArRawChannelBuilderStatistics.h:21
LArRawChannelBuilderStatistics::incrementErrorCount
void incrementErrorCount(unsigned int nerr)
Definition: LArRawChannelBuilderStatistics.cxx:34
AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore
const ServiceHandle< StoreGateSvc > & detStore() const
The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
Definition: AthCommonDataStore.h:95
SG::VarHandleKeyArray::setOwner
virtual void setOwner(IDataHandleHolder *o)=0
LArRawChannelBuilderToolBaseClass::m_cablingKeySC
SG::ReadCondHandleKey< LArOnOffIdMapping > m_cablingKeySC
Definition: LArRawChannelBuilderToolBaseClass.h:78
LArRawChannelBuilderParams::curr_shiftTimeSamples
int curr_shiftTimeSamples
Definition: LArRawChannelBuilderParams.h:31
dqt_zlumi_alleff_HIST.A
A
Definition: dqt_zlumi_alleff_HIST.py:110
LArRawChannelBuilderStatistics::returnErrorCount
ulonglong returnErrorCount(unsigned int nerr)
Definition: LArRawChannelBuilderStatistics.cxx:43
AthCommonDataStore
Definition: AthCommonDataStore.h:52
ATH_MSG_ERROR
#define ATH_MSG_ERROR(x)
Definition: AthMsgStreamMacros.h:33
convertTimingResiduals.sum
sum
Definition: convertTimingResiduals.py:55
xAOD::uint16_t
setWord1 uint16_t
Definition: eFexEMRoI_v1.cxx:88
StdJOSetup.msgSvc
msgSvc
Provide convenience handles for various services.
Definition: StdJOSetup.py:36
LArRawChannelContainer::add
void add(const LArRawChannel &rc)
Definition: LArRawChannelContainer.h:35
lumiFormat.i
int i
Definition: lumiFormat.py:92
LArRawChannel
Liquid Argon ROD output object base class.
Definition: LArRawChannel.h:40
LArRawChannelBuilderToolBase::m_larRawChannelContainer
LArRawChannelContainer * m_larRawChannelContainer
Definition: LArRawChannelBuilderToolBase.h:64
LArRawChannelBuilderToolBase::energy
int energy()
Definition: LArRawChannelBuilderToolBase.h:46
endmsg
#define endmsg
Definition: AnalysisConfig_Ntuple.cxx:63
LArRawChannelBuilderStatistics::returnErrorCountSqPerEvent
ulonglong returnErrorCountSqPerEvent(unsigned int nerr)
Definition: LArRawChannelBuilderStatistics.cxx:57
test_pyathena.parent
parent
Definition: test_pyathena.py:15
ATH_CHECK
#define ATH_CHECK
Definition: AthCheckMacros.h:40
LArRawChannelBuilderToolBase::m_gain
CaloGain::CaloGain m_gain
Definition: LArRawChannelBuilderToolBase.h:67
CaloCell_ID
Helper class for offline cell identifiers.
Definition: CaloCell_ID.h:34
LArRawChannelBuilderToolBaseClass::m_helper
LArRawChannelBuilderStatistics * m_helper
Definition: LArRawChannelBuilderToolBaseClass.h:82
AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore
StoreGateSvc_t m_detStore
Pointer to StoreGate (detector store by default)
Definition: AthCommonDataStore.h:393
LArRawChannelBuilderStatistics::returnEvents
unsigned long returnEvents() const
Definition: LArRawChannelBuilderStatistics.cxx:64
xAOD::double
double
Definition: CompositeParticle_v1.cxx:159
LArRawChannelBuilderStatistics::returnErrorCountPerEvent
ulonglong returnErrorCountPerEvent(unsigned int nerr)
Definition: LArRawChannelBuilderStatistics.cxx:50
SG::VarHandleKeyArray::renounce
virtual void renounce()=0
SG::HandleClassifier::type
std::conditional< std::is_base_of< SG::VarHandleKeyArray, T >::value, VarHandleKeyArrayType, type2 >::type type
Definition: HandleClassifier.h:54
LArRawChannelBuilderStatistics::resetErrorcountPerEvent
void resetErrorcountPerEvent()
Definition: LArRawChannelBuilderStatistics.cxx:90
LArRawChannelBuilderToolBase::m_buildIt
void(LArRawChannelBuilderToolBase::* m_buildIt)(int energy, int time, uint16_t quality, uint16_t provenance, const LArDigit *digit)
Definition: LArRawChannelBuilderToolBase.h:57
LArRawChannelBuilderParams::curr_maxsample
unsigned int curr_maxsample
Definition: LArRawChannelBuilderParams.h:29
LArRawChannelBuilderToolBaseClass::m_isSC
bool m_isSC
Definition: LArRawChannelBuilderToolBaseClass.h:84
LArRawChannelBuilderToolBaseClass::initEvent
virtual void initEvent()
Definition: LArRawChannelBuilderToolBaseClass.h:59
merge_scale_histograms.doc
string doc
Definition: merge_scale_histograms.py:9
LArRawChannelBuilderToolBase::m_energy
int m_energy
Definition: LArRawChannelBuilderToolBase.h:65
name
std::string name
Definition: Control/AthContainers/Root/debug.cxx:192
SG::CondHandleKey::initialize
StatusCode initialize(bool used=true)
LArRawChannelBuilderToolCubic::m_useMaxSample
bool m_useMaxSample
Definition: LArRawChannelBuilderToolCubic.h:37
LArRawChannelBuilderStatistics::returnMaxErrors
unsigned int returnMaxErrors() const
Definition: LArRawChannelBuilderStatistics.cxx:80
a
TList * a
Definition: liststreamerinfos.cxx:10
LArRawChannelBuilderToolBaseClass::currentID
Identifier currentID()
Definition: LArRawChannelBuilderToolBaseClass.cxx:94
h
Identifier::get_compact
value_type get_compact(void) const
Get the compact id.
python.CaloScaleNoiseConfig.type
type
Definition: CaloScaleNoiseConfig.py:78
python.CaloCondTools.log
log
Definition: CaloCondTools.py:20
SG::VarHandleBase::vhKey
SG::VarHandleKey & vhKey()
Return a non-const reference to the HandleKey.
Definition: StoreGate/src/VarHandleBase.cxx:616
MAXINT2
#define MAXINT2
Definition: LArRawChannelBuilderToolCubic.cxx:21
declareProperty
#define declareProperty(n, p, h)
Definition: BaseFakeBkgTool.cxx:15
python.SystemOfUnits.ns
int ns
Definition: SystemOfUnits.py:130
python.Bindings.keys
keys
Definition: Control/AthenaPython/python/Bindings.py:790
python.Constants.VERBOSE
int VERBOSE
Definition: Control/AthenaCommon/python/Constants.py:14
LArRawChannelBuilderStatistics::returnErrorString
std::string returnErrorString(unsigned int nerr)
Definition: LArRawChannelBuilderStatistics.cxx:74
LArRawChannelBuilderParams::curr_nsamples
unsigned int curr_nsamples
Definition: LArRawChannelBuilderParams.h:30
LArRawChannelBuilderToolBaseClass::initTool
virtual StatusCode initTool()
Definition: LArRawChannelBuilderToolBaseClass.h:54
LArRawChannelBuilderToolBase::time
int time()
Definition: LArRawChannelBuilderToolBase.h:47
LArRawChannelBuilderStatistics::returnBitPattern
unsigned int returnBitPattern() const
Definition: LArRawChannelBuilderStatistics.cxx:85
LArRawChannelBuilderParams::curr_chid
HWIdentifier curr_chid
Definition: LArRawChannelBuilderParams.h:24
LArRawChannelBuilderParams::qualityBitPattern
unsigned int qualityBitPattern
Definition: LArRawChannelBuilderParams.h:34
LArRawChannelBuilderToolBaseClass::m_parent
LArRawChannelBuilderParams * m_parent
Definition: LArRawChannelBuilderToolBaseClass.h:80
LArRawChannelBuilderToolCubic::m_fcalId
const LArFCAL_ID * m_fcalId
Definition: LArRawChannelBuilderToolCubic.h:38
AthCommonDataStore::declareGaudiProperty
Gaudi::Details::PropertyBase & declareGaudiProperty(Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
specialization for handling Gaudi::Property<SG::VarHandleKey>
Definition: AthCommonDataStore.h:156
LArRawChannelBuilderToolBase::BuildLArRawChannel
void BuildLArRawChannel(int energy, int time, uint16_t quality, uint16_t provenance, const LArDigit *digit)
Definition: LArRawChannelBuilderToolBase.h:79
LArRawChannelBuilderToolBase::LArRawChannelBuilderToolBase
LArRawChannelBuilderToolBase(const std::string &type, const std::string &name, const IInterface *parent)
Definition: LArRawChannelBuilderToolBase.cxx:8
readCCLHist.float
float
Definition: readCCLHist.py:83
LArID_Exception
Exception class for LAr Identifiers.
Definition: LArID_Exception.h:20
python.SystemOfUnits.picosecond
int picosecond
Definition: SystemOfUnits.py:123
CaloCell_ID::fcal_idHelper
const LArFCAL_ID * fcal_idHelper() const
access to FCAL idHelper
Definition: CaloCell_ID.h:75
LArRawChannelBuilderToolCubic::m_minADC
int m_minADC
Definition: LArRawChannelBuilderToolCubic.h:39
fitman.k
k
Definition: fitman.py:528
LArOnOffIdMapping
Definition: LArOnOffIdMapping.h:20