CTB LArRawChannelBuilder: Convert ADC samples into energy. More...

#include <LArRawChannelBuilder.h>

Inheritance diagram for LArRawChannelBuilder:

Collaboration diagram for LArRawChannelBuilder:

Public Member Functions
	LArRawChannelBuilder (const std::string &name, ISvcLocator *pSvcLocator)

virtual StatusCode	initialize () override

virtual StatusCode	execute () override

virtual StatusCode	finalize () override

virtual StatusCode	sysInitialize () override
	Override sysInitialize. More...

virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies. More...

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

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

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
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
const LArOnlineID *	m_onlineHelper

SG::ReadHandleKey< LArDigitContainer >	m_dataLocation { this, "DataLocation", "FREE", "" }

SG::WriteHandleKey< LArRawChannelContainer >	m_ChannelContainerName { this, "LArRawChannelContainerName", "LArRawChannels", "" }

float	m_Ecut

int	m_initialTimeSampleShift

int	m_NOFCPhases

int	m_NOFCTimeBins

bool	m_useIntercept [4] {}

bool	m_useOFCPhase

bool	m_phaseInv

float	m_ramp_max [3]

double	m_SamplingPeriode

float	m_OFCTimeBin

bool	m_binHalfOffset

bool	m_allowTimeJump

int	m_pedestalFallbackMode

unsigned int	m_iPedestal

unsigned int	m_shapeMode

unsigned	m_skipSaturCells

short	m_AdcMax

int	m_noEnergy

int	m_noTime

int	m_noShape

int	m_noShapeDer

int	m_saturation

int	m_lastNoEnergy

int	m_lastNoTime

int	m_lastNoShape

int	m_lastNoShapeDer

float	m_aveNoEnergy

float	m_aveNoTime

float	m_aveNoShape

float	m_aveNoShapeDer

float	m_aveSaturCells

int	m_nEvents

float	m_aveChannels

double	m_SamplingPeriodeUpperLimit

double	m_SamplingPeriodeLowerLimit

const LArEM_ID *	m_emId

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

SG::ReadCondHandleKey< LArADC2MeV >	m_adc2mevKey { this, "ADC2MeVKey", "LArADC2MeV", "SG Key of the LArADC2MeV CDO" }

int	m_firstSample

std::string	m_pedestalKey

std::string	m_shapesKey

SG::ReadCondHandleKey< ILArOFC >	m_ofcKey {this, "OFCKey", "LArOFC", "SG Key of OFC conditions object" }
	Property: OFC coefficients (conditions input). More...

DataObjIDColl	m_extendedExtraObjects

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

CTB LArRawChannelBuilder: Convert ADC samples into energy.

Author: Kin Yip Kin.Y.nosp@m.ip@c.nosp@m.ern.c.nosp@m.h; Hong Ma hma@b.nosp@m.nl.g.nosp@m.ov; Walter Lampl Walte.nosp@m.r.La.nosp@m.mpl@c.nosp@m.ern..nosp@m.ch; Sandrine Laplace lapla.nosp@m.ce@l.nosp@m.app.i.nosp@m.n2p3.nosp@m..fr; Many others This code is used in CTB. In ATLAS, it is superseeded by LArRawChannelBuilderDriver.

Definition at line 36 of file LArRawChannelBuilder.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Algorithm > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ LArRawChannelBuilder()

LArRawChannelBuilder::LArRawChannelBuilder	(	const std::string &	name,
		ISvcLocator *	pSvcLocator
	)

Definition at line 27 of file LArRawChannelBuilder.cxx.

                                                                                           :
   AthAlgorithm(name, pSvcLocator),
   m_onlineHelper(nullptr),
   m_Ecut(256*MeV),
   m_initialTimeSampleShift(0),
   m_ramp_max(),
   m_noEnergy(0),
   m_noTime(0),
   m_noShape(0),
   m_noShapeDer(0),
   m_saturation(0),
   m_lastNoEnergy(0),
   m_lastNoTime(0),
   m_lastNoShape(0),
   m_lastNoShapeDer(0),
   m_aveNoEnergy(0),
   m_aveNoTime(0),
   m_aveNoShape(0),
   m_aveNoShapeDer(0),
   m_aveSaturCells(0),
   m_nEvents(0),
   m_aveChannels(0),
   m_SamplingPeriodeUpperLimit(0),
   m_SamplingPeriodeLowerLimit(0),
   m_emId(nullptr),
   m_firstSample(0)
   , m_pedestalKey("LArPedestal")
   , m_shapesKey("LArShape")
  {
    //m_useIntercept={false,false,false,false};
  declareProperty("Ecut",                      m_Ecut);
  declareProperty("UseHighGainRampIntercept",  m_useIntercept[CaloGain::LARHIGHGAIN]=false);
  declareProperty("UseMedGainRampIntercept",   m_useIntercept[CaloGain::LARMEDIUMGAIN]=false);
  declareProperty("UseLowGainRampIntercept",   m_useIntercept[CaloGain::LARLOWGAIN]=false);
  declareProperty("InitialTimeSampleShift",    m_initialTimeSampleShift);
  declareProperty("NOFCTimeBins",              m_NOFCTimeBins=25); //Number of OFC time bins in a sampling periode
  m_NOFCPhases = m_NOFCTimeBins; 
  declareProperty("NOFCPhases",                m_NOFCPhases);      //Total number of available OFC sets
  declareProperty("UseOFCPhase",               m_useOFCPhase=false);
  declareProperty("PhaseInversion",            m_phaseInv=false);
  declareProperty("SamplingPeriod",            m_SamplingPeriode=1/(40.08*megahertz));
  declareProperty("OFCTimeBin",                m_OFCTimeBin=m_SamplingPeriode/m_NOFCTimeBins);
  declareProperty("BinHalfOffset",             m_binHalfOffset=false);
  declareProperty("AllowTimeSampleJump",       m_allowTimeJump=true);
  declareProperty("PedestalFallbackMode",      m_pedestalFallbackMode=0); // 0=only DB, 1=Only if missing,
  declareProperty("PedestalSample",            m_iPedestal=0);            // 2=Low, 3=Low+Me dium, 4=All LAr
  declareProperty("ShapeMode",                 m_shapeMode=0); 
  declareProperty("SkipSaturCellsMode",        m_skipSaturCells=0);
  declareProperty("ADCMax",                    m_AdcMax=4095);
  declareProperty("firstSample",               m_firstSample,"  first sample used in shape");
  declareProperty("PedestalKey",           m_pedestalKey);
  declareProperty("ShapesKey",             m_shapesKey);
 }

Member Function Documentation

◆ declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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; }

◆ evtStore() [1/2]

ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::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; }

◆ execute()

StatusCode LArRawChannelBuilder::execute ( )

overridevirtual

Definition at line 155 of file LArRawChannelBuilder.cxx.

 {
   const EventContext& ctx = Gaudi::Hive::currentContext();
   //Counters for errors & warnings per event
   int noEnergy   = 0; // Number of completly failed channels in a given event
   int BadTiming  = 0; // Number of channels with bad timing in a given event
   int noTime     = 0; // Number of channels without time info in a given event
   int noShape    = 0; // Number of channels without Shape (= with no quality factor) in a given event 
   int noShapeDer = 0; // Number of channels without ShapeDerivative in a given event 
   int highE      = 0; // Number of channels with 'high' (above threshold) energy in a given event 
   int saturation = 0; // Number of saturating channels in a given event   
   
   //Pointer to conditions data objects 
   const ILArPedestal* larPedestal=nullptr;
   const ILArShape* larShape=nullptr;
   //Retrieve Digit Container
  
   SG::ReadCondHandle<LArOnOffIdMapping> cablingHdl{m_cablingKey};
   const LArOnOffIdMapping* cabling{*cablingHdl};
   if(!cabling) {
      ATH_MSG_ERROR( "Do not have cabling mapping from key " << m_cablingKey.key() );
     return StatusCode::FAILURE;
   }
  
   SG::ReadCondHandle<LArADC2MeV> adc2mev (m_adc2mevKey, ctx);
  
   //Pointer to input data container
   SG::ReadHandle<LArDigitContainer> digitContainer (m_dataLocation, ctx);
   
   //Retrieve calibration data
   ATH_CHECK( detStore()->retrieve(larPedestal,m_pedestalKey) );
   ATH_CHECK( detStore()->retrieve(larShape,m_shapesKey) );
  
   ATH_MSG_DEBUG( "Retrieving LArOFC object"  );
   SG::ReadCondHandle<ILArOFC> larOFC (m_ofcKey, ctx);
  
   auto larRawChannelContainer = std::make_unique<LArRawChannelContainer>();
   larRawChannelContainer->reserve(digitContainer->size());
  
   // Average number of LArDigits per event
   m_nEvents++;
   m_aveChannels += digitContainer->size();
  
   // Now all data is available, start loop over Digit Container
   int ntot_raw=0;
  
   for (const LArDigit* digit : *digitContainer) {
  
     //Data that goes into RawChannel:
     float energy=0;
     float time=0;
     float quality=0;
  
     int OFCTimeBin=0;
     int timeSampleShift=m_initialTimeSampleShift;
  
     //Get data from LArDigit
     const std::vector<short>& samples=digit->samples();
     const unsigned nSamples=samples.size(); 
     const HWIdentifier chid=digit->channelID();
     const CaloGain::CaloGain gain=digit->gain();
     
     // to be used in case of DEBUG output
     int layer  = -99999 ;
     int eta    = -99999 ; 
     int phi    = -99999 ; 
     int region = -99999 ;    
     if (msgLvl (MSG::DEBUG)) {
       Identifier id ;
       try {
         id = cabling->cnvToIdentifier(chid);
       } catch ( LArID_Exception & except ) {
         ATH_MSG_DEBUG( "A Cabling exception was caught for channel 0x!" 
                        << MSG::hex << chid.get_compact() << MSG::dec  );
         continue ;
       }
       layer  = m_emId->sampling(id);
       eta    = m_emId->eta(id); 
       phi    = m_emId->phi(id);
       region = m_emId->region(id);    
       //log << MSG::VERBOSE << "Channex 0x" << MSG::hex << chid.get_compact() << MSG::dec 
       //                    << " [ Layer = " << layer << " - Eta = " << eta 
       //              << " - Phi = " << phi << " - Region = " << region << " ] " << endmsg ;
     }
         
     // check for saturation, in case skip channel
     int nSatur=-1 ;
     for (unsigned iSample=0;iSample<samples.size();iSample++) {
       if (samples[iSample]>=m_AdcMax) {
         nSatur++;
         break ;
       }
     }
     if ( nSatur>-1 ) {
       if (msgLvl (MSG::DEBUG))msg() << MSG::DEBUG << "Saturation on channel 0x" << MSG::hex << chid.get_compact() << MSG::dec ;         
       saturation++;
     }
     if ( m_skipSaturCells && nSatur>-1 ) {
       msg() << ". Skipping channel." << endmsg; 
       continue; // Ignore this cell, saturation on at least one sample
     } else if ( nSatur>-1 ) {
       msg() << "." << endmsg;
     }   
     
     //Get conditions data for this channel:
  
     // Pedestal
     float pedestal=larPedestal->pedestal(chid,gain);
     float pedestalAverage;
     if (pedestal <= (1.0+LArElecCalib::ERRORCODE)) {
       if( m_pedestalFallbackMode >= 1 ) {
         ATH_MSG_DEBUG( "No pedestal found for channel 0x" << MSG::hex << chid.get_compact() << MSG::dec 
                        << " Gain " << gain <<".  Using time sample " << m_iPedestal  );
         pedestalAverage=samples[m_iPedestal];
       } else {              
         ATH_MSG_DEBUG( noEnergy << ". No pedestal found for channel 0x" << MSG::hex << chid.get_compact() << MSG::dec 
                        << " [ Layer = " << layer << " - Eta = " << eta << " - Phi = " << phi << " - Region = " << region << " ]"
                        << " Gain = " << gain << ". Skipping channel."  );
     noEnergy++;
         continue;
       }
     } else {
       if( ( m_pedestalFallbackMode>=2 && gain==CaloGain::LARLOWGAIN )   ||
           ( m_pedestalFallbackMode>=3 && gain==CaloGain::LARMEDIUMGAIN ) ||
           ( m_pedestalFallbackMode>=4 && gain==CaloGain::LARHIGHGAIN )       ) {
         ATH_MSG_DEBUG( "Forcing pedestal fallback for  channel 0x" << MSG::hex << chid.get_compact()
                        << MSG::dec   << " Gain=" << gain << ". Using time sample " << m_iPedestal  );
         pedestalAverage=samples[m_iPedestal];
       } else {
         //Assume there is only one pedestal value, even the ILArPedestal object returns a vector<float>
         pedestalAverage=pedestal;
       }      
     }
  
     // Optimal Filtering Coefficients
     ILArOFC::OFCRef_t ofc_a;
     ILArOFC::OFCRef_t ofc_b;
     {// get OFC from Conditions Store
       double timeShift=0;
       if (m_useOFCPhase) {
     const double ofcTimeOffset=larOFC->timeOffset(chid,gain);
     timeShift+=ofcTimeOffset;
     if (msgLvl (MSG::VERBOSE)) msg() << MSG::VERBOSE << " OFC=" << ofcTimeOffset;
       }
  
       if (msgLvl (MSG::VERBOSE)) msg() << MSG::VERBOSE << " Total=" << timeShift << endmsg;
       
       if (m_allowTimeJump && timeShift >= m_NOFCPhases*m_OFCTimeBin ) {
     if (msgLvl (MSG::VERBOSE)) msg() << MSG::VERBOSE << "Time Sample jump: +1" << endmsg;
     timeSampleShift += 1;
     //timeShift       -= m_NOFCTimeBins*m_OFCTimeBin ;
     timeShift       -= m_SamplingPeriode ;
       }
       else if (m_allowTimeJump && timeShift < 0 ) {
     ATH_MSG_VERBOSE( "Time Sample jump: -1"  );
     timeSampleShift -= 1;
     //timeShift       += m_NOFCTimeBins*m_OFCTimeBin ;
         timeShift       += m_SamplingPeriode ;
       }
  
       if (m_allowTimeJump && ( timeShift > m_NOFCPhases*m_OFCTimeBin || timeShift < 0 ) ) {
     BadTiming++;
     noEnergy++;
     ATH_MSG_ERROR( noEnergy << ". Time offset out of range for channel 0x" << MSG::hex << chid.get_compact() << MSG::dec 
                        << " Found " << timeShift << ",  expected ( 0 - " << m_NOFCPhases*m_OFCTimeBin << ") ns. Skipping channel."  );
     continue;
       }
       
       if (m_allowTimeJump && timeSampleShift < 0) {
     BadTiming++;
     noEnergy++;
     ATH_MSG_ERROR( noEnergy << ". Negative time sample (" << timeSampleShift << ") shift for channel 0x" << MSG::hex << chid.get_compact() << MSG::dec 
                        << " Found. Skipping channel."  );
     continue;
       }
  
       OFCTimeBin = (int) ( timeShift / m_OFCTimeBin );
       
       if ( !m_phaseInv ) // if not done with PhaseTime at the beginning, invert time bin for OFC bin selection
          OFCTimeBin = ( m_NOFCTimeBins - 1 ) - OFCTimeBin;
       // do not use the following: 24<PhaseTime<25 you always get OFCTimeBin = -1!
       //else 
       //   OFCTimeBin -= 1 ; 
       
       ATH_MSG_VERBOSE( "OFC bin width = " << m_OFCTimeBin << " - OFCBin = " << OFCTimeBin << " - timeShift = " << timeShift  );
       
       if ( OFCTimeBin < 0 ) {
         ATH_MSG_ERROR( "Channel " << MSG::hex << chid.get_compact() << MSG::dec << " asks for OFC bin = " << OFCTimeBin << ". Set to 0."  );
         OFCTimeBin=0;
       } else if ( OFCTimeBin >= m_NOFCPhases ) {
         ATH_MSG_ERROR( "Channel " << MSG::hex << chid.get_compact() << MSG::dec << " asks for OFC bin = " << OFCTimeBin << ". Set to (NOFCPhases-1) =" << m_NOFCTimeBins-1  );
         OFCTimeBin = m_NOFCPhases-1;
       }
  
       ofc_a=larOFC->OFC_a(chid,gain,OFCTimeBin);
       //ofc_b=&(larOFC->OFC_b(chid,gain,OFCTimeBin)); retrieve only when needed
     }
     
     //Check if we have OFC for this channel and time bin
     if (ofc_a.size()==0) {
       noEnergy++;
       ATH_MSG_DEBUG( noEnergy << ". No OFC's found for channel 0x" << MSG::hex << chid.get_compact() << MSG::dec 
                      << " [ Layer = " << layer << " - Eta = " << eta << " - Phi = " << phi << " - Region = " << region << " ]"
                      << " Time bin = " << OFCTimeBin << ", Gain = " << gain << ". Skipping channel."  );
       continue;
     } 
     if (ofc_a.size()+timeSampleShift>nSamples) {
       BadTiming++;
       noEnergy++;
       if (msgLvl (MSG::DEBUG)) {
         if (timeSampleShift==0)
       ATH_MSG_DEBUG( "Found LArDigit with " << nSamples << " samples, but OFCs for " 
                          << ofc_a.size() << " samples. Skipping Channel " );
         else //have time sample shift
       ATH_MSG_DEBUG( "After time sample shift of " << timeSampleShift << ", " << nSamples-timeSampleShift
                          << " samples left, but have OFCs for " << ofc_a.size() << " samples. Skipping Channel " );
       }
       continue;
     } 
  
     //Now apply Optimal Filtering to get ADC peak
     float ADCPeak=0;
     for (unsigned i=0;i<(ofc_a.size());i++) 
       ADCPeak+=(samples[i+timeSampleShift]-pedestalAverage)*ofc_a.at(i);
     
     ATH_MSG_VERBOSE( "ADC Height calculated " << ADCPeak << " TimeBin=" << OFCTimeBin   );
      
     //ADC2MeV (a.k.a. Ramp)   
     LArVectorProxy ramp = adc2mev->ADC2MEV(chid,gain);
     //Check ramp coefficents
     if (ramp.size()==0) {
       noEnergy++;
       ATH_MSG_DEBUG( noEnergy << ". No ADC2MeV data found for channel 0x" << MSG::hex << chid.get_compact() << MSG::dec
                      << " [ Layer = " << layer << " - Eta = " << eta << " - Phi = " << phi << " - Region = " << region << " ]"
                      << " Gain = " << gain << ". Skipping channel."  );
       continue;
     } 
  
     // temporary fix for bad ramps... should be done in the DB
     // if(ramp[1]>500 || ramp[1]<0) {
  
     if(ramp[1]>m_ramp_max[gain] || ramp[1]<0) {
       noEnergy++;
       ATH_MSG_DEBUG( "Bad ramp for channel " << chid << " (ramp[1] = " << ramp[1] << "): skip this channel"  );
       continue;
     } 
  
     float ADCPeakPower=ADCPeak;
  
     if (m_useIntercept[gain])
       energy=ramp[0];
     //otherwise ignore intercept, E=0;
     for (unsigned i=1;i<ramp.size();i++)
       {energy+=ramp[i]*ADCPeakPower; //pow(ADCPeak,i);
        //std::cout << "Step "<< i <<":" << ramp[i] << " * " << pow(ADCPeak,i) << "Sum=" << energy << std::endl;
        ADCPeakPower*=ADCPeak;
       }
  
     //Check if energy is above threshold for time & quality calculation
     if (energy>m_Ecut) {
       highE++;
       ofc_b=larOFC->OFC_b(chid,gain,OFCTimeBin);
       if (ofc_b.size() != ofc_a.size()) {//don't have proper number of coefficients
         if (msgLvl (MSG::DEBUG)) {
       if (ofc_b.size()==0)
         ATH_MSG_DEBUG( "No time-OFC's found for channel 0x" << MSG::hex << chid.get_compact() << MSG::dec 
                            << " Gain "<< gain << " found. Time not calculated."  );
       else
         ATH_MSG_DEBUG( "OFC for time size " << ofc_b.size() 
                            << " not equal to OFC for energy size " << ofc_a.size() 
                            << "   Time not calculated "  );
         }
     noTime++;
       }else{
     for (unsigned i=0;i<(ofc_b.size());i++) 
       time+=(samples[i+timeSampleShift]-pedestalAverage)*ofc_b.at(i);
     time/=ADCPeak;
     // !! Time is now in ns with respect to calibration pulse shape
     // Used to calculate quality factor
       }
       ATH_MSG_VERBOSE( "Time calculated " << time << " TimeBin=" << OFCTimeBin   );
  
       //Calculate Quality factor
       if (larShape) { //Have shape object
     //Get Shape & Shape Derivative for this channel
  
     //const std::vector<float>& shape=larShape->Shape(chid,gain,OFCTimeBin);
     //const std::vector<float>& shapeDer=larShape->ShapeDer(chid,gain,OFCTimeBin);
         // ###
         ILArShape::ShapeRef_t shape=larShape->Shape(chid,gain,OFCTimeBin,m_shapeMode);
         ILArShape::ShapeRef_t shapeDer=larShape->ShapeDer(chid,gain,OFCTimeBin,m_shapeMode);
         // ###
         // fixing HEC to move +1 in case of 4 samples and firstSample 0
         int ihecshift=0;
         if(nSamples == 4 && m_firstSample == 0 ){
           Identifier id ;
           try {
                id = cabling->cnvToIdentifier(chid); 
                if(m_emId->is_lar_hec(id)) {
                   ihecshift=1;
                   ATH_MSG_DEBUG( "Setting firstSample to 1 for HEC channel "<< chid.get_compact()  );
                }
           } catch ( LArID_Exception & except ) {
                   ATH_MSG_DEBUG( "A Cabling exception was caught for channel 0x!"
                                  << MSG::hex << chid.get_compact() << MSG::dec );
           }
         }
     
     //Check Shape
         if ((shape.size()+m_firstSample+ihecshift) < ofc_a.size()) {
           if (msgLvl (MSG::DEBUG)) {
         if (shape.size()==0) 
               ATH_MSG_DEBUG( "No Shape found for channel 0x" << MSG::hex << chid.get_compact() << MSG::dec 
                              << " Gain "<< gain << ". Quality factor not calculated."  );
             else
               ATH_MSG_DEBUG( "Shape size " << shape.size() 
                              << "smaller than OFC size " << ofc_a.size() 
                              << "for channel 0x" << MSG::hex << chid.get_compact() 
                              << MSG::dec << ". Quality factor not calculated."  );
           }
       quality=0;  //Can't calculate chi^2, assume good hit.
       noShape++;
     }
     else {//Shape ok
       if (time!=0 && shapeDer.size()!=shape.size()) { 
         //Send warning
         ATH_MSG_DEBUG( "Shape-Derivative has different size than Shape for channel 0x" << MSG::hex << chid.get_compact() << MSG::dec 
                            << ". Derivative not taken into accout for quality factor."  );
         noShapeDer++;
       }//end-if 
       if (time==0 || shapeDer.size()!=shape.size() ) { //Calculate Q without time info
         for (unsigned i=0;i<(ofc_a.size());i++)
           quality+=((samples[i+timeSampleShift]-pedestalAverage)-shape[i+m_firstSample+ihecshift]*ADCPeak)*
                ((samples[i+timeSampleShift]-pedestalAverage)-shape[i+m_firstSample+ihecshift]*ADCPeak);
       }
       else { //All input data ok, calculate Q with time info
         for (unsigned i=0;i<(ofc_a.size());i++) 
           quality+=((samples[i+timeSampleShift]-pedestalAverage)-((shape[i+m_firstSample+ihecshift]-shapeDer[i+m_firstSample+ihecshift]*time)*ADCPeak))*
                ((samples[i+timeSampleShift]-pedestalAverage)-((shape[i+m_firstSample+ihecshift]-shapeDer[i+m_firstSample+ihecshift]*time)*ADCPeak));
       }
     } // end else (Shape ok)
  
       } //end if larShape
       else { //No Shape found at all 
     quality=0; //Can't calculate chi^2, assume good hit.
     noShape++;
       }
     }// end-if energy>Ecut
     else 
       quality=-1; //in case E<Ecut
     //time*=1000.0; 
     time=time*(nanosecond/picosecond); //Convert time to ps
     //Make LArRawChannel Object with new data
  
     uint16_t iqual=0;
     uint16_t iprov=0xA5;
     if (quality>=0) {
        iqual = ( (int)(quality) ) & 0xFFFF;
        iprov = iprov | 0x2000;
     }
  
     LArRawChannel larRawChannel(chid,(int)energy,(int)time,iqual,iprov, gain);   
     larRawChannelContainer->push_back(larRawChannel); //Add to container 
     ntot_raw++;
     ATH_MSG_VERBOSE( "Got LArRawChannel #" << ntot_raw << ", chid=0x" << MSG::hex << chid.get_compact() << MSG::dec  
                      << " e=" << energy << " t=" << time << " Q=" << quality  );
   } // End loop over LArDigits
  
   ATH_MSG_DEBUG(  ntot_raw << " channels successfully processed, (" << highE << " with high energy)"  );
  
   // deal with bad timing
   if(BadTiming>=128){
     ATH_MSG_ERROR( "Too many channels (" <<BadTiming<<  " !) have a bad timing !!"  );
     ATH_MSG_ERROR( "OFC time constants should be revisited !!!"  );
     ATH_MSG_ERROR( "Event is skipped"  );
     larRawChannelContainer->clear();
     //return StatusCode::SUCCESS;
   }
   
   // in case of at least one saturating cell, skip all event (if selected) 
   if ( saturation && m_skipSaturCells == 2 ) {
     ATH_MSG_ERROR( saturation << " saturating channels were found. Event is skipped."  );
     larRawChannelContainer->clear();
   }
   
   //Put this LArRawChannel container in the transient store
   //sc = evtStore()->record(m_larRawChannelContainer, m_ChannelContainerName);
   //if(sc.isFailure()) {
   // log << MSG::ERROR << "Can't record LArRawChannelContainer in StoreGate" << endmsg;
   //}
   //else
   //  std::cout << "Successfully recorded LArRawChannelContainer to StoreGate" << std::endl;
   
   /*
    
    Error & Warning summary *per event*
    
    Strategy: 'No Energy' is an ERROR, no time or no quality is a WARNING
    
    Missing calibration constants are most likly missing for an entire run, threfore:
    In DEBUG: Print summary for each event if something is missing
    otherwise: Print summary only for new problems (different number of missing channels) 
   
    Saturatin cells summary is shown in any case, WARNING if not skipped, ERROR if skipped
    
   */
   
   if (noEnergy)   m_noEnergy++;
   if (noTime)     m_noTime++;
   if (noShape)    m_noShape++;
   if (noShapeDer) m_noShapeDer++;
   if (saturation) m_saturation++;
   
   m_aveNoEnergy   += noEnergy;  
   m_aveNoTime     += noTime;
   m_aveNoShape    += noShape;
   m_aveNoShapeDer += noShapeDer;
   m_aveSaturCells += saturation;
   
   if ( (   noEnergy!=m_lastNoEnergy 
         || noTime!=m_lastNoTime 
         || noShape>m_lastNoShape 
         || noShapeDer>m_lastNoShapeDer 
         || saturation>0 ) 
        || ( msgSvc()->outputLevel(name()) <= MSG::DEBUG && ( noEnergy || noTime || noShape || noShapeDer || saturation ) )
       ) {
     
     m_lastNoEnergy = noEnergy;
     m_lastNoTime   = noTime;
     if (noShape>m_lastNoShape) m_lastNoShape=noShape;
     if (noShapeDer>m_lastNoShapeDer) m_lastNoShapeDer=noShapeDer;
     //m_lastSaturCells = saturation ;
  
     MSG::Level msglvl;
     if (noEnergy) 
       msglvl=MSG::ERROR;
     else if (noTime || noShape || noShapeDer || saturation)
       msglvl=MSG::WARNING;
     else
       msglvl=MSG::INFO;
  
     msg() << msglvl << " *** Error & Warning summary for this event *** " << std::endl;
     
     if ( noEnergy ) {
       msg() << msglvl << "   " << noEnergy << " out of " 
       << digitContainer->size() << " channel(s) skipped due to a lack of basic calibration constants." 
       << std::endl;       
     }
     if ( noTime ) {
       msg() << msglvl << "   " << noTime << " out of " 
       << highE << " high-enegy channel(s) have no time-info due to a lack of Optimal Filtering Coefficients." 
       << std::endl;
     }
     if ( noShape ) {
       msg() << msglvl << "   " << noShape << " out of " 
       << highE << " high-enegy channel(s) have no quality factor due to a lack of shape." 
       << std::endl;
     }
     if ( noShapeDer ) { 
       msg() << msglvl << "   " << noShapeDer << " out of " 
       << highE << " high-enegy channel(s) lack the derivative of the shape. Not taken into accout for Quality factor." 
       << std::endl;
     }
     if ( saturation ) {
       if ( m_skipSaturCells == 2 )
           msg() << MSG::ERROR << "   " << saturation << " out of " 
           << digitContainer->size() << " channel(s) showed saturations. The complete event was skipped." << std::endl;
       else if ( m_skipSaturCells == 1 )
         msg() << MSG::ERROR << "   " << saturation << " out of " 
           << digitContainer->size() << " channel(s) showed saturations and were skipped." << std::endl;
       else
         msg() << MSG::WARNING << "   " << saturation << " out of " 
           << digitContainer->size() << " channel(s) showed saturations." << std::endl;
     }
     msg() << endmsg;
   }
     
   ATH_CHECK( SG::makeHandle(m_ChannelContainerName, ctx).record (std::move (larRawChannelContainer)) );
  
   return StatusCode::SUCCESS;
 }

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::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

◆ extraOutputDeps()

const DataObjIDColl & AthAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 50 of file AthAlgorithm.cxx.

 {
   // If we didn't find any symlinks to add, just return the collection
   // from the base class.  Otherwise, return the extended collection.
   if (!m_extendedExtraObjects.empty()) {
     return m_extendedExtraObjects;
   }
   return Algorithm::extraOutputDeps();
 }

◆ finalize()

StatusCode LArRawChannelBuilder::finalize ( )

overridevirtual

Definition at line 637 of file LArRawChannelBuilder.cxx.

 { 
  
   if (m_noEnergy>0) m_aveNoEnergy   /= m_noEnergy;
   else m_aveNoEnergy=0;
   if (m_noTime>0) m_aveNoTime     /= m_noTime;
   else m_aveNoTime=0;
   if (m_noShape>0) m_aveNoShape    /= m_noShape;
   else m_aveNoShape=0;
   if (m_noShapeDer>0) m_aveNoShapeDer /= m_noShapeDer;
   else m_aveNoShapeDer=0;
   if (m_saturation>0) m_aveSaturCells /= m_saturation;
   else m_aveSaturCells=0;
  
   if (m_nEvents>0) m_aveChannels   /= m_nEvents;
   else m_aveChannels =0;
  
   // Error and Warning Summary for this job:
   
   ATH_MSG_DEBUG( "  LArRawChannelBuilder::finalize " 
                  << m_noEnergy << " " << m_noTime << " " << m_noShape << " " << m_noShapeDer << " " << m_saturation  );
   
   if ( m_noEnergy || m_noTime || m_noShape || m_noShapeDer || m_saturation ) {
     MSG::Level msglvl;
     if ( m_noEnergy || m_skipSaturCells ) 
       msglvl=MSG::ERROR;
     else
       msglvl=MSG::WARNING;
     msg() << msglvl << " *** Error & Warning Summary for all events *** " << std::endl ;
     
     if (m_noEnergy)
       msg() << msglvl << "   " << m_noEnergy << " events had on average " << (int)std::round(m_aveNoEnergy) 
           << " channels out of " << (int)std::round(m_aveChannels) << " without basic calibration constants." 
       << std::endl;
     
     if (m_noTime) 
       msg() << msglvl << "   " << m_noTime  << " events had on average " << (int)std::round(m_aveNoTime) 
           << " channels out of " << (int)std::round(m_aveChannels) << " without OFCs for timing." 
       << std::endl ;
    
     if (m_noShape)
       msg() << msglvl << "   " << m_noShape << " events had on average " << (int)std::round(m_aveNoShape) 
           << " channels out of " << (int)std::round(m_aveChannels) << " without shape information." 
       << std::endl;
     
     if (m_noShapeDer)
       msg() << msglvl << "   " << m_noShapeDer << " events had on average " << (int)std::round(m_aveNoShapeDer) 
           << " channels out of " << (int)std::round(m_aveChannels) << " without shape derivative." 
       << std::endl;
     
     if ( m_saturation )
       msg() << msglvl << "   " << m_saturation << " events had on average " << (int)std::round(m_aveSaturCells) 
           << " out of " << (int)std::round(m_aveChannels) << " saturating channels."  
       << std::endl ;
     
     msg() << endmsg;
   } 
   else
     ATH_MSG_INFO( "LArRawChannelBuilder finished without errors or warnings."  );
  
   //if (m_larRawChannelContainer) {
     //m_larRawChannelContainer->release();
     //m_larRawChannelContainer = 0;
   //}
  
   return StatusCode::SUCCESS;
 }

◆ initialize()

StatusCode LArRawChannelBuilder::initialize ( )

overridevirtual

Definition at line 82 of file LArRawChannelBuilder.cxx.

 {
   ATH_CHECK( detStore()->retrieve(m_onlineHelper, "LArOnlineID") );
  
   ATH_CHECK( m_ofcKey.initialize() );
   ATH_CHECK( m_adc2mevKey.initialize() );
   
   // ***
   
   const CaloCell_ID* idHelper = nullptr;
   ATH_CHECK( detStore()->retrieve (idHelper, "CaloCell_ID") );
   m_emId=idHelper->em_idHelper();
   if (!m_emId) {
     ATH_MSG_ERROR( "Could not get lar EM ID helper"  );
     return StatusCode::FAILURE;
   }
   
   ATH_CHECK( m_cablingKey.initialize() );
  
  
   //Set counters for errors and warnings to zero
   m_noEnergy   = 0; // Number of events with at least completly failed channel
   m_noTime     = 0; // Number of events with at least one channel without time info
   m_noShape    = 0; // Number of events with at least one channel without Shape (=with not quality factor);
   m_noShapeDer = 0; // Number of events with at least one channel without ShapeDerivative (=not taken into accout for quality factor);
   m_saturation = 0; // Number of events with at least one saturating channel
   
   m_lastNoEnergy   = -1; // Number of completly failed channels in previous event
   m_lastNoTime     = -1; // Number of channels without time info in previous event
   m_lastNoShape    = -1; // Number of channels without Shape (=with not quality factor) in previous event
   m_lastNoShapeDer = -1; // Number of channels without ShapeDerivative in previous event
   
   //m_lastSaturCells = -1; // Number of saturating channels without in previous event (not used)
   
   m_aveNoEnergy    = 0.; // Average number of completly failed channels per event
   m_aveNoTime      = 0.; // Average number of channels without time info per event
   m_aveNoShape     = 0.; // Average number of channels without Shape (=with not quality factor) per event
   m_aveNoShapeDer  = 0.; // Average number of channels without ShapeDerivative per event
   m_aveSaturCells  = 0.; // Average number of saturating channels without per event
   
   m_nEvents        = 0 ; // Total number of processed events ;
   m_aveChannels    = 0 ; // Average number of readout channels per event
  
   if ( m_skipSaturCells > 2 ) m_skipSaturCells = 0 ;
  
   m_ramp_max[CaloGain::LARHIGHGAIN]   = 500.;
   m_ramp_max[CaloGain::LARMEDIUMGAIN] = 5000.;
   m_ramp_max[CaloGain::LARLOWGAIN]    = 50000.;
  
   // Validity range for a set of OFC's. If the time shift is larger than this number,
   // we make a ADC sample jump (e.g. from [0,5] to [1,6]. The second half of the uppermost 
   // bin should already be rounded to the 0th bin of the following ADC sample.  
   if ( m_binHalfOffset ) {
     m_SamplingPeriodeUpperLimit = m_SamplingPeriode-m_SamplingPeriode/(2*m_NOFCTimeBins);
     m_SamplingPeriodeLowerLimit = -m_SamplingPeriode/(2*m_NOFCTimeBins);
   } else {
     m_SamplingPeriodeUpperLimit = m_SamplingPeriode;
     m_SamplingPeriodeLowerLimit = 0;
   }
  
   ATH_MSG_DEBUG( "Number of OFC time bins per sampling periode=" << m_NOFCTimeBins  );
   ATH_MSG_DEBUG( "Sampling Periode=" << m_SamplingPeriode << "ns"  );
   ATH_MSG_DEBUG( "Sampling Periode Limits: (" << m_SamplingPeriodeLowerLimit
                  << "," << m_SamplingPeriodeUpperLimit << ") ns"  );
  
   ATH_CHECK( m_dataLocation.initialize() );
   ATH_CHECK( m_ChannelContainerName.initialize() );
  
   return StatusCode::SUCCESS;
 }

◆ inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< Algorithm > >::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.

◆ msg() [1/2]

MsgStream& AthCommonMsg< Algorithm >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

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

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

◆ msgLvl()

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

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                                {
     return this->msgLevel(lvl);
   }

◆ outputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< Algorithm > >::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.

◆ 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< Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                           {
     handlesArray.renounce();
   }

◆ sysInitialize()

StatusCode AthAlgorithm::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Algorithm > >.

Reimplemented in AthAnalysisAlgorithm, AthFilterAlgorithm, PyAthena::Alg, and AthHistogramAlgorithm.

Definition at line 66 of file AthAlgorithm.cxx.

                                        {
   StatusCode sc=AthCommonDataStore<AthCommonMsg<Algorithm>>::sysInitialize();
  
   if (sc.isFailure()) {
     return sc;
   }
   ServiceHandle<ICondSvc> cs("CondSvc",name());
   for (auto h : outputHandles()) {
     if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
       // do this inside the loop so we don't create the CondSvc until needed
       if ( cs.retrieve().isFailure() ) {
         ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
         return StatusCode::SUCCESS;
       }
       if (cs->regHandle(this,*h).isFailure()) {
         sc = StatusCode::FAILURE;
         ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                       << " with CondSvc");
       }
     }
   }
   return sc;
 }

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Algorithm > >::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.

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::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_adc2mevKey

SG::ReadCondHandleKey<LArADC2MeV> LArRawChannelBuilder::m_adc2mevKey { this, "ADC2MeVKey", "LArADC2MeV", "SG Key of the LArADC2MeV CDO" }

private

Definition at line 108 of file LArRawChannelBuilder.h.

◆ m_AdcMax

short LArRawChannelBuilder::m_AdcMax

private

Definition at line 74 of file LArRawChannelBuilder.h.

◆ m_allowTimeJump

bool LArRawChannelBuilder::m_allowTimeJump

private

Definition at line 68 of file LArRawChannelBuilder.h.

◆ m_aveChannels

float LArRawChannelBuilder::m_aveChannels

private

Definition at line 97 of file LArRawChannelBuilder.h.

◆ m_aveNoEnergy

float LArRawChannelBuilder::m_aveNoEnergy

private

Definition at line 90 of file LArRawChannelBuilder.h.

◆ m_aveNoShape

float LArRawChannelBuilder::m_aveNoShape

private

Definition at line 92 of file LArRawChannelBuilder.h.

◆ m_aveNoShapeDer

float LArRawChannelBuilder::m_aveNoShapeDer

private

Definition at line 93 of file LArRawChannelBuilder.h.

◆ m_aveNoTime

float LArRawChannelBuilder::m_aveNoTime

private

Definition at line 91 of file LArRawChannelBuilder.h.

◆ m_aveSaturCells

float LArRawChannelBuilder::m_aveSaturCells

private

Definition at line 94 of file LArRawChannelBuilder.h.

◆ m_binHalfOffset

bool LArRawChannelBuilder::m_binHalfOffset

private

Definition at line 67 of file LArRawChannelBuilder.h.

◆ m_cablingKey

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

private

Definition at line 107 of file LArRawChannelBuilder.h.

◆ m_ChannelContainerName

SG::WriteHandleKey<LArRawChannelContainer> LArRawChannelBuilder::m_ChannelContainerName { this, "LArRawChannelContainerName", "LArRawChannels", "" }

private

Definition at line 54 of file LArRawChannelBuilder.h.

◆ m_dataLocation

SG::ReadHandleKey<LArDigitContainer> LArRawChannelBuilder::m_dataLocation { this, "DataLocation", "FREE", "" }

private

Definition at line 52 of file LArRawChannelBuilder.h.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_Ecut

float LArRawChannelBuilder::m_Ecut

private

Definition at line 56 of file LArRawChannelBuilder.h.

◆ m_emId

const LArEM_ID* LArRawChannelBuilder::m_emId

private

Definition at line 106 of file LArRawChannelBuilder.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects

privateinherited

Definition at line 79 of file AthAlgorithm.h.

◆ m_firstSample

int LArRawChannelBuilder::m_firstSample

private

Definition at line 111 of file LArRawChannelBuilder.h.

◆ m_initialTimeSampleShift

int LArRawChannelBuilder::m_initialTimeSampleShift

private

Definition at line 57 of file LArRawChannelBuilder.h.

◆ m_iPedestal

unsigned int LArRawChannelBuilder::m_iPedestal

private

Definition at line 70 of file LArRawChannelBuilder.h.

◆ m_lastNoEnergy

int LArRawChannelBuilder::m_lastNoEnergy

private

Definition at line 84 of file LArRawChannelBuilder.h.

◆ m_lastNoShape

int LArRawChannelBuilder::m_lastNoShape

private

Definition at line 86 of file LArRawChannelBuilder.h.

◆ m_lastNoShapeDer

int LArRawChannelBuilder::m_lastNoShapeDer

private

Definition at line 87 of file LArRawChannelBuilder.h.

◆ m_lastNoTime

int LArRawChannelBuilder::m_lastNoTime

private

Definition at line 85 of file LArRawChannelBuilder.h.

◆ m_nEvents

int LArRawChannelBuilder::m_nEvents

private

Definition at line 96 of file LArRawChannelBuilder.h.

◆ m_noEnergy

int LArRawChannelBuilder::m_noEnergy

private

Definition at line 77 of file LArRawChannelBuilder.h.

◆ m_NOFCPhases

int LArRawChannelBuilder::m_NOFCPhases

private

Definition at line 58 of file LArRawChannelBuilder.h.

◆ m_NOFCTimeBins

int LArRawChannelBuilder::m_NOFCTimeBins

private

Definition at line 59 of file LArRawChannelBuilder.h.

◆ m_noShape

int LArRawChannelBuilder::m_noShape

private

Definition at line 79 of file LArRawChannelBuilder.h.

◆ m_noShapeDer

int LArRawChannelBuilder::m_noShapeDer

private

Definition at line 80 of file LArRawChannelBuilder.h.

◆ m_noTime

int LArRawChannelBuilder::m_noTime

private

Definition at line 78 of file LArRawChannelBuilder.h.

◆ m_ofcKey

SG::ReadCondHandleKey<ILArOFC> LArRawChannelBuilder::m_ofcKey {this, "OFCKey", "LArOFC", "SG Key of OFC conditions object" }

private

Property: OFC coefficients (conditions input).

Definition at line 116 of file LArRawChannelBuilder.h.

◆ m_OFCTimeBin

float LArRawChannelBuilder::m_OFCTimeBin

private

Definition at line 66 of file LArRawChannelBuilder.h.

◆ m_onlineHelper

const LArOnlineID* LArRawChannelBuilder::m_onlineHelper

private

Definition at line 47 of file LArRawChannelBuilder.h.

◆ m_pedestalFallbackMode

int LArRawChannelBuilder::m_pedestalFallbackMode

private

Definition at line 69 of file LArRawChannelBuilder.h.

◆ m_pedestalKey

std::string LArRawChannelBuilder::m_pedestalKey

private

Definition at line 112 of file LArRawChannelBuilder.h.

◆ m_phaseInv

bool LArRawChannelBuilder::m_phaseInv

private

Definition at line 62 of file LArRawChannelBuilder.h.

◆ m_ramp_max

float LArRawChannelBuilder::m_ramp_max[3]

private

Definition at line 63 of file LArRawChannelBuilder.h.

◆ m_SamplingPeriode

double LArRawChannelBuilder::m_SamplingPeriode

private

Definition at line 65 of file LArRawChannelBuilder.h.

◆ m_SamplingPeriodeLowerLimit

double LArRawChannelBuilder::m_SamplingPeriodeLowerLimit

private

Definition at line 100 of file LArRawChannelBuilder.h.

◆ m_SamplingPeriodeUpperLimit

double LArRawChannelBuilder::m_SamplingPeriodeUpperLimit

private

Definition at line 100 of file LArRawChannelBuilder.h.

◆ m_saturation

int LArRawChannelBuilder::m_saturation

private

Definition at line 81 of file LArRawChannelBuilder.h.

◆ m_shapeMode

unsigned int LArRawChannelBuilder::m_shapeMode

private

Definition at line 71 of file LArRawChannelBuilder.h.

◆ m_shapesKey

std::string LArRawChannelBuilder::m_shapesKey

private

Definition at line 113 of file LArRawChannelBuilder.h.

◆ m_skipSaturCells

unsigned LArRawChannelBuilder::m_skipSaturCells

private

Definition at line 73 of file LArRawChannelBuilder.h.

◆ m_useIntercept

bool LArRawChannelBuilder::m_useIntercept[4] {}

private

Definition at line 60 of file LArRawChannelBuilder.h.

◆ m_useOFCPhase

bool LArRawChannelBuilder::m_useOFCPhase

private

Definition at line 61 of file LArRawChannelBuilder.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Algorithm > >::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

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ LArRawChannelBuilder()

Member Function Documentation

◆ 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()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_adc2mevKey

◆ m_AdcMax

◆ m_allowTimeJump

◆ m_aveChannels

◆ m_aveNoEnergy

◆ m_aveNoShape

◆ m_aveNoShapeDer

◆ m_aveNoTime

◆ m_aveSaturCells

◆ m_binHalfOffset

◆ m_cablingKey

◆ m_ChannelContainerName

◆ m_dataLocation

◆ m_detStore

◆ m_Ecut

◆ m_emId

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_firstSample

◆ m_initialTimeSampleShift

◆ m_iPedestal

◆ m_lastNoEnergy

◆ m_lastNoShape

◆ m_lastNoShapeDer

◆ m_lastNoTime

◆ m_nEvents

◆ m_noEnergy

◆ m_NOFCPhases

◆ m_NOFCTimeBins

◆ m_noShape

◆ m_noShapeDer

◆ m_noTime

◆ m_ofcKey

◆ m_OFCTimeBin

◆ m_onlineHelper

◆ m_pedestalFallbackMode

◆ m_pedestalKey

◆ m_phaseInv

◆ m_ramp_max

◆ m_SamplingPeriode