Obtain ADC_max by an iterating optimal filtering. More...

#include <LArRawChannelBuilderToolOFCIter.h>

Inheritance diagram for LArRawChannelBuilderToolOFCIter:

Collaboration diagram for LArRawChannelBuilderToolOFCIter:

Public Member Functions
	LArRawChannelBuilderToolOFCIter (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	initEvent ()

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	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
LArRawChannelContainer *	m_larRawChannelContainer

int	m_energy

int	m_time

CaloGain::CaloGain	m_gain

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

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

LArRawChannelBuilderParams *	m_parent

LArRawChannelBuilderStatistics *	m_helper

bool	m_isSC

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
const std::vector< float > &	OFC_a ()

const std::vector< float > &	OFC_b ()

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
float	m_Ecut

bool	m_skipSaturatedCells

unsigned short	m_AdcMax

bool	m_doQual

bool	m_doIter

float	m_defaultPhase

unsigned int	m_minADCforIter

float	m_minADCforIterInSigma

unsigned int	m_minSample

unsigned int	m_maxSample

unsigned int	m_nIterProp

std::vector< float >	m_OFCtmp

std::vector< float >	m_signal

bool	m_doMC

bool	m_storeTiming

LArOFIterResultsContainer *	m_larOFIterCont

std::string	m_timingContKey

ServiceHandle< StoreGateSvc >	m_storeGate

ToolHandle< LArOFPeakRecoTool >	m_peakReco

SG::ReadCondHandleKey< ILArPedestal >	m_pedestalRMSKey { this, "PedestalRMSKey", "", "SG key for pedestal object. Needed only if 'minADCforIterInSigma' is set (for the RMS)" }

SG::ReadCondHandleKey< ILArNoise >	m_larNoiseKey { this, "LArNoiseKey", "LArNoise", "SG Key of ILArNoise object" }

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 an iterating optimal filtering.

Author: Bernardo Resende

Definition at line 29 of file LArRawChannelBuilderToolOFCIter.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

◆ LArRawChannelBuilderToolOFCIter()

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

Definition at line 24 of file LArRawChannelBuilderToolOFCIter.cxx.

                                                           :
   LArRawChannelBuilderToolBase(type,name,parent),
   m_larOFIterCont(nullptr),
   m_storeGate("StoreGateSvc", name),
   m_peakReco("LArOFPeakRecoTool") {
   m_helper = new LArRawChannelBuilderStatistics( 3,      // number of possible errors
                            0x05);  // bit pattern special for this tool,
                                                        // to be stored in "uint16_t provenance"
   m_helper->setErrorString(0, "no errors");
   m_helper->setErrorString(1, "channel saturated");
   m_helper->setErrorString(2, "OFC not valid");
   
   declareProperty("ADCMax",                    m_AdcMax=4095);
   declareProperty("Skip",                      m_skipSaturatedCells=false);
   declareProperty("ECut",                      m_Ecut=50);
   declareProperty("doQual",                    m_doQual=true);
   declareProperty("doIter",                    m_doIter=true);
   declareProperty("defaultPhase",              m_defaultPhase=0);
   declareProperty("minADCforIter",             m_minADCforIter=30);
   declareProperty("minADCforIterInSigma",      m_minADCforIterInSigma=-1);
   declareProperty("minSample",                 m_minSample=0);
   declareProperty("maxSample",                 m_maxSample=31);
   declareProperty("nIterations",               m_nIterProp=10);
   declareProperty("StoreTiming",               m_storeTiming=false,
           "Create container of LArOFIterResults in StoreGate");
   declareProperty("TimingContainerKey",        m_timingContKey="LArOFIterResult",
           "Key of the LArOFIterResultsContainer in StoreGate");
   declareProperty("doMC",                      m_doMC=false,
                   " take noise from LArNoise instead of LArPedestal");
  
 }

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.

                                                                                                              {
         m_energy = energy;
         m_time   = time;
         m_gain   = digit->gain();
 }

◆ 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.

                                                                                                                                   {
         // It is assumed that m_larRawChannelContainer exists
         LArRawChannel larRawChannel(digit->channelID(),
                     energy,time,
                     quality,provenance,digit->gain());
         m_larRawChannelContainer->add(larRawChannel);
 }

◆ buildRawChannel()

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

virtual

Implements LArRawChannelBuilderToolBase.

Definition at line 110 of file LArRawChannelBuilderToolOFCIter.cxx.

 {
   const HWIdentifier chid=m_parent->curr_chid;
   const CaloGain::CaloGain gain=m_parent->curr_gain;
   const EventContext& ctx = Gaudi::Hive::currentContext();
  
   uint16_t iprovenance=0;
  
   bool debugPrint=false;
   if (bool(pLog)) {
     if (pLog->level() <= MSG::DEBUG) debugPrint=true;
   }
  
   if(debugPrint)
     (*pLog) << MSG::DEBUG << "Start " <<MSG::hex<< chid.get_compact() <<MSG::dec<< endmsg;
  
  
   // Loop over samples, to find maximum, check for saturation and subtract pedestal
   const std::vector<short>& samples = digit->samples();
   unsigned int sampsize = (unsigned int) samples.size();
   float peakval = -999.;
   unsigned int ipeak = 0;  
   //static std::vector<float> signal(sampsize); //Pedestal-subtracted
   m_signal.resize(sampsize);
   float currval = 0.;
   for (unsigned int ii = 0; ii < sampsize; ii++) {
     if (samples[ii]==0 || samples[ii]>=m_AdcMax) { //Check for saturation
       if(debugPrint) (*pLog) << MSG::DEBUG 
                  << "Saturation on channel 0x" << MSG::hex << chid.get_compact() << MSG::dec 
                  << " ADC=" << samples[ii];
       if ( m_skipSaturatedCells ) {
       if(debugPrint) (*pLog) << " Skipping channel." << endmsg; 
       m_helper->incrementErrorCount(1);
       return false;
       }
       else
     if(debugPrint) (*pLog) << endmsg;
  
       iprovenance = iprovenance | 0x0400;
     } //end if saturated
     currval = (float)(samples[ii] - pedestal);
     m_signal[ii]=currval;
     if ((ii >= m_minSample)&&(ii <= m_maxSample)&&(currval > peakval)) { ipeak = ii; peakval = currval; }
   }
  
   if(debugPrint) (*pLog) << MSG::DEBUG << "Peak value: " << peakval << ", peak sample:" << ipeak << endmsg;
  
   int nIteration = m_nIterProp;
   bool doIter=false;
   if (m_doIter) {
     if (m_minADCforIterInSigma>0) {//threshold given in terms of pedestal-rms, get pedestal
        if (m_doMC) {
          SG::ReadCondHandle<ILArNoise> larNoise (m_larNoiseKey, ctx);
          float sigma = larNoise->noise(chid,gain);
          if (peakval > (sigma*m_minADCforIterInSigma)) doIter=true;
        }
        else {
          SG::ReadCondHandle<ILArPedestal> larPedestal (m_pedestalRMSKey, ctx);
          float vRMS=larPedestal->pedestalRMS(chid,gain);
          if (vRMS >= (1.0+LArElecCalib::ERRORCODE)) { 
        if (peakval > (vRMS*m_minADCforIterInSigma)) doIter=true;//enough signal...
          }
          else { //no pedestal found, use adc threshold
        if (peakval > m_minADCforIter) doIter=true;//enough signal...
          }
        }
     }//end if threshold given in terms of pedestal rms
     else
       if (peakval >= m_minADCforIter) doIter=true;//enough signal...
   }//end if doIter
  
  
   if (!doIter) {//No iteration, insufficient signal
     nIteration=1;
     ipeak = m_parent->curr_shiftTimeSamples + 2 ; 
   }
  
  
   if (ipeak > sampsize - 3) ipeak = sampsize - 3 ; 
   if (ipeak < 2) ipeak = 2; 
  
  
   unsigned int peak_min = ipeak - 1 ; 
   unsigned int peak_max = ipeak + 1 ; 
  
   float ADCPeak=0;
   float time=0.;
   const LArOFPeakRecoTool::Result results = m_peakReco->peak(m_signal, chid, gain, 
                                                             m_defaultPhase,
                                                             nIteration,
                                                             ipeak,peak_min, peak_max
                                                             );
  
   if (m_larOFIterCont) {
     //the iteration works always on teh same copy of the results object. Need to do a deep-copy in order to publish...
     //LArOFIterResults* res=new LArOFIterResults(results);
     m_larOFIterCont->push_back(results);
   }
   if (results.getValid()) {
     ADCPeak = results.getAmplitude();
     // this should be ~0 if the peak is at curr_shiftTimeSamples
  
     // FIXME: this time definition still misses the tstart from the OFC to be absolutely computed
     time = (25.*((int)(results.getPeakSample_final())-2-m_parent->curr_shiftTimeSamples)-(results.getDelay_final()-results.getTau()));
     //log << MSG::DEBUG << "Peak and time properly retrieved with OFPeakRecoTool:";
     //log << MSG::DEBUG << "ADCPeak = " << ADCPeak <<", time = "<< time << endmsg;
   }
   else {
   //  log << MSG::DEBUG << ". OFC iteration not valid for channel 0x"
   //    << MSG::hex << chid.get_compact() << MSG::dec 
   //    << " Gain = " << gain << ". Skipping channel." << endmsg;
     m_helper->incrementErrorCount(2);
     return false;
   }
  
   float power=1;
   float energy=0;
   for( unsigned int i=0; i<ramps.size(); i++)
     {
       energy += ramps[i] * power;
       power  *= ADCPeak;
     }
   
  
  
   //log << MSG::DEBUG << "ADCPeak = " << ADCPeak <<", time = "<< time<<
   //    " energy "<<energy <<endmsg;
  
   uint16_t iquality=0;
  
   if ((m_doQual) && (std::fabs(energy)>m_Ecut) && (results.getValid()))  {
     int iqua = (int)(results.getQuality());
     if (iqua > 0xFFFF) iqua=0xFFFF;
     iquality = (uint16_t)(iqua & 0xFFFF);
     iprovenance = iprovenance | 0x2000;
   }
   
  
   //Reminder: Bit-pattern 
   //ppcc bbbb sqqq qqqq qqqq
  
   iprovenance |= (m_parent->qualityBitPattern & 0x00FF);
   iprovenance |= (m_helper->returnBitPattern() & 0x00FF);
   if (results.getConverged())
     iprovenance |= 0x0100;
   iprovenance = iprovenance & 0x3FFF;
  
   time=time*(nanosecond/picosecond); //Convert time to ps
  
   const float fMAXINT = static_cast<float>(MAXINT);
   const float fMAXINT2 = static_cast<float>(MAXINT2);
  
   if (time>fMAXINT) time=fMAXINT;
   if (time<fMAXINT2) time=fMAXINT2;
  
   if (energy>fMAXINT) energy=fMAXINT;
   if (energy<fMAXINT2) energy=fMAXINT2;
  
  
   // Suppress false positive seen wth gcc.
 #if __GNUC__ >= 11 && __GNUC__ <= 13
 # pragma GCC diagnostic push
 # pragma GCC diagnostic ignored "-Wmaybe-uninitialized"
 #endif
   (this->*m_buildIt)((int)(floor(energy+0.5)),(int)floor(time+0.5),iquality,iprovenance,digit);
 #if __GNUC__ >= 11 && __GNUC__ <= 13
 # pragma GCC diagnostic pop
 #endif
    
   
   m_helper->incrementErrorCount(0);
  
   
   return true;
 }

◆ currentID()

Identifier LArRawChannelBuilderToolBaseClass::currentID ( )

inherited

Definition at line 94 of file LArRawChannelBuilderToolBaseClass.cxx.

 {
   const LArOnOffIdMapping *cabling=nullptr;
   if(m_isSC) {
     SG::ReadCondHandle<LArOnOffIdMapping> cablingHdl{m_cablingKeySC};
     cabling = *cablingHdl;
   } else {
     SG::ReadCondHandle<LArOnOffIdMapping> cablingHdl{m_cablingKey};
     cabling = *cablingHdl;
   }   
   if(!cabling) {
      m_parent->curr_id=0;
   } else {
     if(m_parent->curr_id==0) {
       try {
         m_parent->curr_id = cabling->cnvToIdentifier(m_parent->curr_chid);
       } catch ( LArID_Exception & except ) {
         ATH_MSG_INFO("Cabling exception was caught for channel 0x!"
         << MSG::hex << m_parent->curr_chid.get_compact() << MSG::dec );
         m_parent->curr_id=0;
       }
     }
   }
   return m_parent->curr_id;
 }

◆ 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.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
  
   }

◆ 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.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
  
   }

◆ 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.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
   }

◆ 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.

   {
     return PBASE::declareProperty(t);
   }

◆ 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

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation 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.

   {
     this->declare(hndl.vhKey());
     hndl.vhKey().setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ 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

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation 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.

   {
     this->declare(hndl);
     hndl.setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ 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.

   {
  
     // std::ostringstream ost;
     // ost << Algorithm::name() << " VHKA declareProp: " << name 
     //     << " size: " << hndArr.keys().size() 
     //     << " mode: " << hndArr.mode() 
     //     << "  vhka size: " << m_vhka.size()
     //     << "\n";
     // debug() << ost.str() << endmsg;
  
     hndArr.setOwner(this);
     m_vhka.push_back(&hndArr);
  
     Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
     if (p != 0) {
       p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
     } else {
       ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                     << name);
     }
  
     return p;
  
   }

◆ 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

name	Name of the property.
property	Object holding the property value.
doc	Documentation 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.

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

◆ 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

name	Name of the property.
property	Object holding the property value.
doc	Documentation 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.

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

◆ declareProperty() [6/6]

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

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                  {
     typedef typename SG::HandleClassifier<T>::type htype;
     return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
   }

◆ 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.

 {
   m_helper->resetErrorcountPerEvent();
   finalEvent();
 }

◆ gain()

CaloGain::CaloGain LArRawChannelBuilderToolBase::gain ( )

inlinevirtualinherited

Implements ILArRawChannelBuilderToolBase.

Definition at line 48 of file LArRawChannelBuilderToolBase.h.

48 { return m_gain; }

◆ initEvent()

void LArRawChannelBuilderToolOFCIter::initEvent ( )

virtual

Reimplemented from LArRawChannelBuilderToolBaseClass.

Definition at line 95 of file LArRawChannelBuilderToolOFCIter.cxx.

                                                 {
   //std::cout << "in  LArRawChannelBuilderToolOFCIter::initEvent()" << std::endl;
   if (m_storeTiming) {
     m_larOFIterCont= new LArOFIterResultsContainer;
     StatusCode sc=m_storeGate->record(m_larOFIterCont,m_timingContKey);
     if (sc.isFailure()) {
       MsgStream log(msgSvc(), name());
       log << MSG::ERROR << "Failed to record a LArOFIterResultsContainer with key " << m_timingContKey << " to StoreGate." << endmsg;
       delete m_larOFIterCont;
       m_larOFIterCont=nullptr;
     }
   }
 }

◆ initEventHidden()

void LArRawChannelBuilderToolBase::initEventHidden ( )

inlinevirtualinherited

Implements LArRawChannelBuilderToolBaseClass.

Definition at line 39 of file LArRawChannelBuilderToolBase.h.

     { m_larRawChannelContainer=m_parent->m_larRawChannelContainer;
       if ( m_larRawChannelContainer !=NULL )
         m_buildIt = &LArRawChannelBuilderToolBase::BuildLArRawChannel;
       else
         m_buildIt = &LArRawChannelBuilderToolBase::BuildLArCell;
       initEvent(); }

◆ initTool()

StatusCode LArRawChannelBuilderToolOFCIter::initTool ( )

virtual

Reimplemented from LArRawChannelBuilderToolBase.

Definition at line 58 of file LArRawChannelBuilderToolOFCIter.cxx.

 {
   MsgStream log(msgSvc(), name());
   
   StatusCode sc=m_peakReco.retrieve();
   
   if( sc.isFailure() ) {
     log << MSG::ERROR << "Unable to retrieve LArOFPeakRecoTool" <<endmsg;
     return StatusCode::FAILURE;
   }
   
   sc = m_storeGate.retrieve();
   if (sc.isFailure()) {
     log << MSG::ERROR << "StoreGate service not found" << endmsg;
     return sc;
   }
  
   if (m_minADCforIterInSigma>0) {//threshold given in terms of pedestal-rms, get pedestal
     if (m_doMC) {
       log << MSG::INFO << " Min ADC for iteration " << m_minADCforIterInSigma << "* LArNoise " <<endmsg;
     }
     else {
       log << MSG::INFO << " Min ADC for iteration " << m_minADCforIterInSigma << "* pedestalRMS " <<endmsg;
     }
   }
   else
     log << MSG::INFO << " Min ADC for iteration "<<m_minADCforIter <<endmsg;
  
   log << MSG::INFO << " DefaultPhase  "<<m_defaultPhase <<endmsg;
   log << MSG::INFO << " Min and Max Sample "<<m_minSample<< " "<<m_maxSample<<endmsg;
  
   ATH_CHECK( m_larNoiseKey.initialize (m_doIter && m_minADCforIterInSigma>0 && m_doMC) );
   ATH_CHECK( m_pedestalRMSKey.initialize (m_doIter && m_minADCforIterInSigma>0 && !m_doMC) );
  
   return StatusCode::SUCCESS;
 }

◆ initToolHidden()

StatusCode LArRawChannelBuilderToolBaseClass::initToolHidden ( LArRawChannelBuilderParams * myParent )

inlinevirtualinherited

Implements ILArRawChannelBuilderToolBaseClass.

Definition at line 43 of file LArRawChannelBuilderToolBaseClass.h.

     {
       m_parent=myParent; 
       if ( m_isSC ) {
          ATH_CHECK( m_cablingKeySC.initialize() );
       } else {
          ATH_CHECK( m_cablingKey.initialize() );
       }
       return initTool();
     };

◆ 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.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

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

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

◆ msgLvl()

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

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                                {
     return this->msgLevel(lvl);
   }

◆ OFC_a()

const std::vector<float>& LArRawChannelBuilderToolOFCIter::OFC_a ( )

private

◆ OFC_b()

const std::vector<float>& LArRawChannelBuilderToolOFCIter::OFC_b ( )

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.

 {
   MsgStream log(msgSvc(), name());
   ulonglong sum=0;
   for( unsigned int i=0; i<m_helper->returnMaxErrors(); i++ )
     sum+=m_helper->returnErrorCount(i);
   
   log << MSG::INFO << "Printing Summary for tool " << name() << " :" << endmsg;
   log << MSG::INFO
       << std::setw(40) << " " << " : "
       << std::setw(12) << " total "
       << std::setw(10) << " percent " << "  "
       << std::setw(12) << " per event "
       << std::setw(12) << " RMS "
       << endmsg;
  
   double inv_sum = sum > 0 ? 1./sum : 1;
   for( unsigned int i=0; i<m_helper->returnMaxErrors(); i++ )
     {
       double fraction = 0.0;
       double perEvent = 0.0;
       double rmsPerEv = 0.0;
       if(sum>0)
         fraction=100 * double(m_helper->returnErrorCount(i)) * inv_sum;
       if(m_helper->returnEvents()>0)
         {
           perEvent = double(m_helper->returnErrorCountPerEvent(i)) / double(m_helper->returnEvents());
           rmsPerEv = double(m_helper->returnErrorCountSqPerEvent(i)) / double(m_helper->returnEvents());
           rmsPerEv = sqrt(std::max(0.,rmsPerEv-perEvent*perEvent));
         }
       
       log << MSG::INFO
       << std::setw(40)
       << m_helper->returnErrorString(i) << " : "
       << std::setw(12)
       << m_helper->returnErrorCount(i)
       << std::setw(10)
       << std::fixed
       << std::setprecision(4)
       << fraction
       << " %"
       << std::setw(12)
       << std::fixed
       << std::setprecision(4)
       << perEvent
       << std::setw(12)
       << std::fixed
       << std::setprecision(4)
       << rmsPerEv
       << endmsg;
     }
 }

◆ 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.

   {
     h.renounce();
     PBASE::renounce (h);
   }

◆ 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.

                                                           {
     handlesArray.renounce();
   }

◆ 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.

                                                {
     // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
     //         << "  size: " << m_vhka.size() << endmsg;
     for (auto &a : m_vhka) {
       std::vector<SG::VarHandleKey*> keys = a->keys();
       for (auto k : keys) {
         k->setOwner(this);
       }
     }
   }

Member Data Documentation

◆ m_AdcMax

unsigned short LArRawChannelBuilderToolOFCIter::m_AdcMax

private

Definition at line 53 of file LArRawChannelBuilderToolOFCIter.h.

◆ 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_defaultPhase

float LArRawChannelBuilderToolOFCIter::m_defaultPhase

private

Definition at line 56 of file LArRawChannelBuilderToolOFCIter.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_doIter

bool LArRawChannelBuilderToolOFCIter::m_doIter

private

Definition at line 55 of file LArRawChannelBuilderToolOFCIter.h.

◆ m_doMC

bool LArRawChannelBuilderToolOFCIter::m_doMC

private

Definition at line 64 of file LArRawChannelBuilderToolOFCIter.h.

◆ m_doQual

bool LArRawChannelBuilderToolOFCIter::m_doQual

private

Definition at line 54 of file LArRawChannelBuilderToolOFCIter.h.

◆ m_Ecut

float LArRawChannelBuilderToolOFCIter::m_Ecut

private

Definition at line 51 of file LArRawChannelBuilderToolOFCIter.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_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_larNoiseKey

SG::ReadCondHandleKey<ILArNoise> LArRawChannelBuilderToolOFCIter::m_larNoiseKey { this, "LArNoiseKey", "LArNoise", "SG Key of ILArNoise object" }

private

Definition at line 76 of file LArRawChannelBuilderToolOFCIter.h.

◆ m_larOFIterCont

LArOFIterResultsContainer* LArRawChannelBuilderToolOFCIter::m_larOFIterCont

private

Definition at line 67 of file LArRawChannelBuilderToolOFCIter.h.

◆ m_larRawChannelContainer

LArRawChannelContainer* LArRawChannelBuilderToolBase::m_larRawChannelContainer

protectedinherited

Definition at line 64 of file LArRawChannelBuilderToolBase.h.

◆ m_maxSample

unsigned int LArRawChannelBuilderToolOFCIter::m_maxSample

private

Definition at line 60 of file LArRawChannelBuilderToolOFCIter.h.

◆ m_minADCforIter

unsigned int LArRawChannelBuilderToolOFCIter::m_minADCforIter

private

Definition at line 57 of file LArRawChannelBuilderToolOFCIter.h.

◆ m_minADCforIterInSigma

float LArRawChannelBuilderToolOFCIter::m_minADCforIterInSigma

private

Definition at line 58 of file LArRawChannelBuilderToolOFCIter.h.

◆ m_minSample

unsigned int LArRawChannelBuilderToolOFCIter::m_minSample

private

Definition at line 59 of file LArRawChannelBuilderToolOFCIter.h.

◆ m_nIterProp

unsigned int LArRawChannelBuilderToolOFCIter::m_nIterProp

private

Definition at line 61 of file LArRawChannelBuilderToolOFCIter.h.

◆ m_OFCtmp

std::vector<float> LArRawChannelBuilderToolOFCIter::m_OFCtmp

private

Definition at line 62 of file LArRawChannelBuilderToolOFCIter.h.

◆ m_parent

LArRawChannelBuilderParams* LArRawChannelBuilderToolBaseClass::m_parent

protectedinherited

Definition at line 80 of file LArRawChannelBuilderToolBaseClass.h.

◆ m_peakReco

ToolHandle<LArOFPeakRecoTool> LArRawChannelBuilderToolOFCIter::m_peakReco

private

Definition at line 71 of file LArRawChannelBuilderToolOFCIter.h.

◆ m_pedestalRMSKey

SG::ReadCondHandleKey<ILArPedestal> LArRawChannelBuilderToolOFCIter::m_pedestalRMSKey { this, "PedestalRMSKey", "", "SG key for pedestal object. Needed only if 'minADCforIterInSigma' is set (for the RMS)" }

private

Definition at line 74 of file LArRawChannelBuilderToolOFCIter.h.

◆ m_signal

std::vector<float> LArRawChannelBuilderToolOFCIter::m_signal

private

Definition at line 63 of file LArRawChannelBuilderToolOFCIter.h.

◆ m_skipSaturatedCells

bool LArRawChannelBuilderToolOFCIter::m_skipSaturatedCells

private

Definition at line 52 of file LArRawChannelBuilderToolOFCIter.h.

◆ m_storeGate

ServiceHandle<StoreGateSvc> LArRawChannelBuilderToolOFCIter::m_storeGate

private

Definition at line 69 of file LArRawChannelBuilderToolOFCIter.h.

◆ m_storeTiming

bool LArRawChannelBuilderToolOFCIter::m_storeTiming

private

Definition at line 66 of file LArRawChannelBuilderToolOFCIter.h.

◆ m_time

int LArRawChannelBuilderToolBase::m_time

protectedinherited

Definition at line 66 of file LArRawChannelBuilderToolBase.h.

◆ m_timingContKey

std::string LArRawChannelBuilderToolOFCIter::m_timingContKey

private

Definition at line 68 of file LArRawChannelBuilderToolOFCIter.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:

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ LArRawChannelBuilderToolOFCIter()

Member Function Documentation

◆ BuildLArCell()

◆ BuildLArRawChannel()

◆ buildRawChannel()

◆ currentID()

◆ declareGaudiProperty() [1/4]

◆ declareGaudiProperty() [2/4]

◆ declareGaudiProperty() [3/4]

◆ declareGaudiProperty() [4/4]

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ detStore()

◆ energy()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ extraDeps_update_handler()

◆ finalEvent()

◆ finalEventHidden()

◆ gain()

◆ initEvent()

◆ initEventHidden()

◆ initTool()

◆ initToolHidden()

◆ inputHandles()

◆ interfaceID()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ OFC_a()

◆ OFC_b()

◆ outputHandles()

◆ printSummary()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ time()

◆ updateVHKA()

Member Data Documentation

◆ m_AdcMax

◆ m_buildIt

◆ m_cablingKey

◆ m_cablingKeySC

◆ m_defaultPhase

◆ m_detStore

◆ m_doIter

◆ m_doMC

◆ m_doQual

◆ m_Ecut

◆ m_energy

◆ m_evtStore

◆ m_gain

◆ m_helper

◆ m_isSC

◆ m_larNoiseKey

◆ m_larOFIterCont

◆ m_larRawChannelContainer

◆ m_maxSample

◆ m_minADCforIter

◆ m_minADCforIterInSigma

◆ m_minSample

◆ m_nIterProp

◆ m_OFCtmp