#include <LArAutoCorrValidationAlg.h>

Inheritance diagram for LArAutoCorrValidationAlg:

Collaboration diagram for LArAutoCorrValidationAlg:

Classes
class	DataPerFEB

Public Member Functions
	LArAutoCorrValidationAlg (const std::string &name, ISvcLocator *pSvcLocator)
	Regular algorithm constructor.
StatusCode	initialize ()
	Standard initialization method.
StatusCode	execute ()
	Standard execute method This method has to be emtpy since all the job is done in stop()
StatusCode	stop ()
	Standard finalize method Loops over all channels and all gains and calls the `validateChannel` method.
StatusCode	finalize ()
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Protected Types
typedef LArAutoCorrComplete::ConstConditionsMapIterator	CONTIT
typedef LArAutoCorrComplete::LArCondObj	LArCondObj
typedef LArAutoCorrComplete::MultChanCollection	MULTICHANCOLL
typedef std::vector< std::pair< HWIdentifier, bool > >	CHECKEDID_t
	Keeping track of channels failing the validation criteria (per gain)

Protected Member Functions
const std::string	channelDescription (const HWIdentifier &chid, const LArOnOffIdMapping cabling, const LArBadChannelCont bcCont, const unsigned gain=99, bool isFeb=false) const
	Textual representation of gain and location of a certain cell or FEB.
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
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.

Protected Attributes
MSG::Level	m_myMsgLvl
	Message level for reporting deviations.
int	m_myMsgLvlProp
SG::ReadCondHandleKey< LArOnOffIdMapping >	m_cablingKey
SG::ReadCondHandleKey< LArBadChannelCont >	m_BCKey
SG::ReadCondHandleKey< LArCalibLineMapping >	m_CLKey
LArBadChannelMask	m_bcMask
Gaudi::Property< std::vector< std::string > >	m_problemsToMask
Gaudi::Property< std::vector< unsigned int > >	m_patchCBs
BooleanProperty	m_isSC
const LArOnlineID_Base *	m_onlineHelper
const CaloCell_Base_ID *	m_caloId
const LArAutoCorrComplete *	m_reference
	Pointer to container with reference values.
const LArAutoCorrComplete *	m_validation
	Pointer to container to be validated.
LArAutoCorrComplete *	m_nc_validation
	Non-const pointer to container to be validated (for FEB patching)
std::string	m_validationKey
	SG key of the container to be validated (job-property)
SG::ReadCondHandleKey< LArAutoCorrComplete >	m_referenceKey
	SG key of the reference container (job-property)
bool	m_useBCInfo
	Flag set to true in order to use bad-channel info for the channel description as well as to ingore some types of bad-channels via the masking tool.
bool	m_checkCompleteness
	wether completeness shall be checked or not (job-property)
bool	m_patchMissingFEBs
	wether missing FEBS (incomplete COOL channels) should be patched
bool	m_printFailedPattern
	wether to check for FEBs and Calib-lines with many deviating channels
bool	m_doFebAverages
	wether to compare feb-averages (used only by derived class)
unsigned	m_maxmessages
	Limit for the number of messages about indiviual deviating channels (usd only by derived class)
unsigned	m_nChecked
	Number of channels that where checked (grand-total)
unsigned	m_nFailedValidation
	Number of channels for which vaildateChannel returned false.
unsigned	m_nValidated
	Number of channels for which vaildateChannel returned true.
unsigned	m_nBad
	Number of channels known to be bad according to the bad-channel tool.
unsigned	m_nNoReference
	Number of channels for which not reference channel could be found.
std::vector< CHECKEDID_t >	m_checkedIds
std::string	m_chanFileName
	File name to store list of deviating channels.
std::ofstream	m_chanFile
	File name to store list of deviating channels.
std::string	m_febFileName
	File name to store list of FEBs with deviating channels.
std::ofstream	m_febFile
	File name to store list of FEBs with deviating channels.
bool	m_useCorrChannel

Private Types
typedef std::vector< std::pair< HWIdentifier, unsigned > >	FEBANDGAIN_t
typedef std::vector< std::pair< std::pair< HWIdentifier, unsigned >, unsigned > >	CBANDCHANANDGAIN_t
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
bool	validateChannel (const LArCondObj &ref, const LArCondObj &val, const HWIdentifier chid, const int gain, const LArOnOffIdMapping cabling, const LArBadChannelCont bcCont) override final
	Method to validate readout channels.
LArCondObj	getRefObj (const HWIdentifier chid, const int gain) const override final
	Method implmented in derived class to get the reference object from ref-container.
virtual StatusCode	summary (const LArOnOffIdMapping cabling, const LArBadChannelCont bcCont) override
	Summary method executed after the loop over all channels.
virtual StatusCode	preLoop () override
	Executed before the loop over all channels to reset global sums.
bool	febSummary (const LArOnOffIdMapping cabling, const LArBadChannelCont bcCont)
	Method to compare FEB averages.
bool	checkCoolChannelCompleteness (const LArOnOffIdMapping cabling, const LArCalibLineMapping clCont, const LArBadChannelCont *bcCont)
	Verify if all FEBs of each Cool-Channel is present.
bool	patchMissingFEBs (const FEBANDGAIN_t &febAndGain, const LArOnOffIdMapping cabling, const LArBadChannelCont bcCont)
	Fills channels of missing FEBs.
bool	patchMissingCalibBoards (const CBANDCHANANDGAIN_t &CBAndGain, const LArOnOffIdMapping cabling, const LArBadChannelCont bcCont)
	Fills channels of missing calib boards.
void	febOutput (const HWIdentifier &febid, const unsigned gain, const unsigned nGood, const unsigned nBad)
void	findFailedPatterns (const LArOnOffIdMapping cabling, const LArCalibLineMapping clCont, const LArBadChannelCont *bcCont)
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
std::vector< std::string >	m_covToleranceFEBInit
	Covariace tolerance of one FEB (job-Property)
CaloCellGroupList	m_covToleranceFEB
std::vector< std::string >	m_covToleranceInit
	Covariance tolerance (job-Property)
CaloCellGroupList	m_covTolerance
unsigned	m_nSamplesToCheck {}
	Number of elements of the Covariance vector that should be checked.
bool	m_checkFifthSample {}
std::vector< DataPerFEB >	m_vDataPerFEB
double	m_covGlobalVal {}
double	m_covGlobalRef {}
unsigned	m_nEntriesGlobal {}
std::vector< std::string >	m_gainMap
DataObjIDColl	m_extendedExtraObjects
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 31 of file LArAutoCorrValidationAlg.h.

Member Typedef Documentation

◆ CBANDCHANANDGAIN_t

typedef std::vector<std::pair<std::pair<HWIdentifier,unsigned>, unsigned > > LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::CBANDCHANANDGAIN_t

privateinherited

Definition at line 145 of file LArCalibValidationAlg.h.

◆ CHECKEDID_t

typedef std::vector<std::pair<HWIdentifier, bool > > LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::CHECKEDID_t

protectedinherited

Keeping track of channels failing the validation criteria (per gain)

Definition at line 233 of file LArCalibValidationAlg.h.

◆ CONTIT

typedef LArAutoCorrComplete::ConstConditionsMapIterator LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::CONTIT

protectedinherited

Definition at line 79 of file LArCalibValidationAlg.h.

◆ FEBANDGAIN_t

typedef std::vector<std::pair<HWIdentifier,unsigned> > LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::FEBANDGAIN_t

privateinherited

Definition at line 135 of file LArCalibValidationAlg.h.

◆ LArCondObj

typedef LArAutoCorrComplete::LArCondObj LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::LArCondObj

protectedinherited

Definition at line 80 of file LArCalibValidationAlg.h.

◆ MULTICHANCOLL

typedef LArAutoCorrComplete::MultChanCollection LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::MULTICHANCOLL

protectedinherited

Definition at line 81 of file LArCalibValidationAlg.h.

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ LArAutoCorrValidationAlg()

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

Regular algorithm constructor.

Definition at line 9 of file LArAutoCorrValidationAlg.cxx.

                                                                                                  :
  LArAutoCorrValidationBase(name,pSvcLocator) {
 
  declareProperty("AutoCorrTolerance",m_covToleranceInit,
          "CaloCellGroup of allowed deviation of cov[i]");
  declareProperty("AutoCorrToleranceFEB",m_covToleranceFEBInit,
          "CaloCellGroup of allowed deviation of cov[i] (average over one FEB,");
 
  declareProperty("NSamplesToCheck",m_nSamplesToCheck=1, 
          "Number of samples (covr elements) to check");
 
  
  declareProperty("CheckFifthSample",m_checkFifthSample=false); 
  m_covGlobalRef=0.;
  m_covGlobalVal=0.;
  m_nEntriesGlobal=0;
}

Member Function Documentation

◆ channelDescription()

const std::string LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::channelDescription	(	const HWIdentifier &	chid,
		const LArOnOffIdMapping *	cabling,
		const LArBadChannelCont *	bcCont,
		const unsigned	gain = 99,
		bool	isFeb = false ) const

protectedinherited

Textual representation of gain and location of a certain cell or FEB.

Parameters

chid	Online identifier of the cell or FEB
gain	Gain in question, a value >2 won't be printed
iFeb	If `chid` should be interpreted as FEB identifer

Returns: string Creates a string containing the Side, Barrel-EC, FT, Slot, FEB-Channel in human-readable form

◆ checkCoolChannelCompleteness()

bool LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::checkCoolChannelCompleteness	(	const LArOnOffIdMapping *	cabling,
		const LArCalibLineMapping *	clCont,
		const LArBadChannelCont *	bcCont )

privateinherited

Verify if all FEBs of each Cool-Channel is present.

Returns: False if at least one incomplete COOL channel is found, true otherwise Calls patchMissingFEBs if m_patchMissingFebs is true

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	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());
 
  }

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty ( Gaudi::Property< T, V, H > & 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; }

AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

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

AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute()

StatusCode LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::execute ( )

inlineinherited

Standard execute method This method has to be emtpy since all the job is done in stop()

Definition at line 69 of file LArCalibValidationAlg.h.

69{return StatusCode::SUCCESS;}

LArCalibValidationAlg

Algorithm to validate LAr Autocorr;.

Definition LArCalibValidationAlg.h:47

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

◆ febOutput()

void LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::febOutput	(	const HWIdentifier &	febid,
		const unsigned	gain,
		const unsigned	nGood,
		const unsigned	nBad )

privateinherited

◆ febSummary()

bool LArAutoCorrValidationAlg::febSummary	(	const LArOnOffIdMapping *	cabling,
		const LArBadChannelCont *	bcCont )

private

Method to compare FEB averages.

Definition at line 140 of file LArAutoCorrValidationAlg.cxx.

                                                                                                           {
  unsigned nBadFebs=0;
  msg().precision(3);
  msg().setf(std::ios::fixed,std::ios::floatfield); 
  for (DataPerFEB& dataPerFeb : m_vDataPerFEB) {
    dataPerFeb.covVal/=dataPerFeb.nEntries;
    dataPerFeb.covRef/=dataPerFeb.nEntries;
 
    const Identifier id=cabling->cnvToIdentifier(dataPerFeb.chid);
    const float& covToleranceFEB=m_covToleranceFEB.valuesForCell(id)[dataPerFeb.gain];
 
    if (fabs(dataPerFeb.covVal-dataPerFeb.covRef)>covToleranceFEB){
      msg() << m_myMsgLvl << "Deviating!" << channelDescription(dataPerFeb.febid, cabling, bcCont, dataPerFeb.gain,true) << "Average AutoCorr: " 
            << dataPerFeb.covVal << " (" << dataPerFeb.covRef << ")" << endmsg;
      ++nBadFebs;
    }
  }
 
  if (nBadFebs) {
    msg() << m_myMsgLvl << "Found " << nBadFebs << " out of " << m_vDataPerFEB.size() << " FEBs deviating from reference" << endmsg;
    return false;
  }
  else {
    ATH_MSG_INFO ( "All" << m_vDataPerFEB.size() << " FEBs withing given tolerance." ) ;
    return true;
  }
}

◆ finalize()

StatusCode LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::finalize ( )

inlineinherited

Definition at line 76 of file LArCalibValidationAlg.h.

76{return StatusCode::SUCCESS;}

◆ findFailedPatterns()

void LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::findFailedPatterns	(	const LArOnOffIdMapping *	cabling,
		const LArCalibLineMapping *	clCont,
		const LArBadChannelCont *	bcCont )

privateinherited

◆ getRefObj()

LArCondObj LArAutoCorrValidationAlg::getRefObj	(	const HWIdentifier	chid,
		const int	gain ) const

inlinefinaloverrideprivatevirtual

Method implmented in derived class to get the reference object from ref-container.

Implements LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >.

Definition at line 47 of file LArAutoCorrValidationAlg.h.

                                                                                    {
      return m_reference->get(chid,gain);
  }

◆ initialize()

StatusCode LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::initialize ( )

inherited

Standard initialization method.

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

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

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

◆ patchMissingCalibBoards()

bool LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::patchMissingCalibBoards	(	const CBANDCHANANDGAIN_t &	CBAndGain,
		const LArOnOffIdMapping *	cabling,
		const LArBadChannelCont *	bcCont )

privateinherited

Fills channels of missing calib boards.

Parameters

febAndGain A vector of (CalibId,gain) pairs

Returns: True on success, false otherwise Inserts the corresponding channel from the reference container as correction channel to the validation container

◆ patchMissingFEBs()

bool LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::patchMissingFEBs	(	const FEBANDGAIN_t &	febAndGain,
		const LArOnOffIdMapping *	cabling,
		const LArBadChannelCont *	bcCont )

privateinherited

Fills channels of missing FEBs.

Parameters

febAndGain A vector of (febId,gain) pairs

Returns: True on success, false otherwise Inserts the corresponding channel from the reference container as correction channel to the validation container

◆ preLoop()

StatusCode LArAutoCorrValidationAlg::preLoop ( )

overrideprivatevirtual

Executed before the loop over all channels to reset global sums.

Reimplemented from LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >.

Definition at line 28 of file LArAutoCorrValidationAlg.cxx.

                                             {
  m_covGlobalRef=0.;
  m_covGlobalVal=0.;
  m_nEntriesGlobal=0;
 
  bool stat;
 
  ATH_MSG_INFO ( "Initialize covariance tolerances (CaloCellGroup)" ) ;
  stat=m_covTolerance.setDefinition(m_caloId,m_covToleranceInit,msg());
  if (!stat) {
    ATH_MSG_ERROR ( "Failed to initialize CaloCellGroup of covariance tolerances!" ) ;
    return StatusCode::FAILURE;
  }
  if (m_covTolerance.getDefaults().size()!=3) {
    ATH_MSG_ERROR ( "Configuration error: Expected three covariance tolerance values (one per gain), got " 
                    << m_covTolerance.getDefaults().size() ) ;
    return StatusCode::FAILURE;
  }
  if (this->msgLvl(MSG::DEBUG)) m_covTolerance.printDef();//for debugging....
 
 
  
  ATH_MSG_INFO ( "Initialize covariance FEB tolerances (CaloCellGroup)" ) ;
  stat=m_covToleranceFEB.setDefinition(m_caloId,m_covToleranceFEBInit,msg());
  if (!stat) {
    ATH_MSG_ERROR ( "Failed to initialize CaloCellGroup of covariance tolerances!" ) ;
    return StatusCode::FAILURE;
  }
  if (m_covToleranceFEB.getDefaults().size()!=3) {
    ATH_MSG_ERROR ( "Configuration error: Expected three covariance tolerance values (one per gain), got " 
                    << m_covToleranceFEB.getDefaults().size() ) ;
    return StatusCode::FAILURE;
  }
  if (this->msgLvl(MSG::DEBUG)) m_covToleranceFEB.printDef();//for debugging....
 
 
  return StatusCode::SUCCESS;
  
}

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

◆ stop()

StatusCode LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::stop ( )

inherited

Standard finalize method Loops over all channels and all gains and calls the validateChannel method.

◆ summary()

StatusCode LArAutoCorrValidationAlg::summary	(	const LArOnOffIdMapping *	cabling,
		const LArBadChannelCont *	bcCont )

overrideprivatevirtual

Summary method executed after the loop over all channels.

Reimplemented from LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >.

Definition at line 167 of file LArAutoCorrValidationAlg.cxx.

                                                                                                             {
  StatusCode sc=StatusCode::SUCCESS;
  //1nd step: Check the FEB-averages:
  if (m_doFebAverages && !febSummary(cabling, bcCont))
    sc=StatusCode::RECOVERABLE;
  //2nd step: Call the summary method from base-class (single-channel summary)
  if (!LArAutoCorrValidationBase::summary(cabling, bcCont).isSuccess())
    sc=StatusCode::RECOVERABLE;
  //3rd step: Check the gobal averages:
  if (m_nEntriesGlobal) {
    m_covGlobalVal/=m_nEntriesGlobal;
    m_covGlobalRef/=m_nEntriesGlobal;
  }
  ATH_MSG_INFO ( "Global autocorr average: " << m_covGlobalVal << " Referecence:" << m_covGlobalRef
                 << " Deviation:" << m_covGlobalVal-m_covGlobalRef ) ;
  return sc;
}

◆ 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, AthHistogramAlgorithm, and PyAthena::Alg.

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);
      }
    }
  }

◆ validateChannel()

bool LArAutoCorrValidationAlg::validateChannel	(	const LArCondObj &	ref,
		const LArCondObj &	val,
		const HWIdentifier	chid,
		const int	gain,
		const LArOnOffIdMapping *	cabling,
		const LArBadChannelCont *	bcCont )

finaloverrideprivatevirtual

Method to validate readout channels.

Implements LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >.

Definition at line 68 of file LArAutoCorrValidationAlg.cxx.

                                                                                                                                                                                                      {
  
if (gain<0 || gain>2) {
     ATH_MSG_ERROR ( "Unexpected gain value " << gain ) ;
     return false;
  }
 
  if (val.m_vAutoCorr.size()==0) {
    msg() <<  this->m_myMsgLvl << "Empty! No AC found for " << channelDescription(chid,cabling, bcCont, gain) << endmsg;
    return false;
  }
  if (ref.m_vAutoCorr.size()==0) {
    ATH_MSG_WARNING ( "No reference value found for " << channelDescription(chid,cabling, bcCont, gain) ) ;
    return false;
  }
 
  const float covVal=val.m_vAutoCorr[0];
  const float covRef=ref.m_vAutoCorr[0];
 
  const Identifier id=cabling->cnvToIdentifier(chid);
 
  const float covTolerance=m_covTolerance.valuesForCell(id)[gain];
 
  
  HWIdentifier febid=m_onlineHelper->feb_Id(chid);
  DataPerFEB* dataPerFEB = m_vDataPerFEB.empty() ? nullptr : &(m_vDataPerFEB.back());
  if (!dataPerFEB || dataPerFEB->febid!=febid) {//Got to new FEB
    m_vDataPerFEB.push_back(DataPerFEB(chid,febid,gain));
    dataPerFEB=&(m_vDataPerFEB.back());
  }
  dataPerFEB->covVal+=covVal;
  dataPerFEB->covRef+=covRef;
  ++(dataPerFEB->nEntries);
 
  m_covGlobalVal+=covVal;
  m_covGlobalRef+=covRef;
  ++m_nEntriesGlobal;
  
  const size_t s=val.m_vAutoCorr.size();
  const size_t sr=ref.m_vAutoCorr.size();
  for (size_t i=0;i<s;++i) {
    const float covVal_i=val.m_vAutoCorr[i];
    if (fabs(covVal_i)>1.0) {
      msg() <<  this->m_myMsgLvl << "Unphysical! " << channelDescription(chid, cabling, bcCont, gain) << " AutoCorr[" << i << "]: " 
           <<  std::setprecision(4) << covVal_i << endmsg;
      return false;
    }
    if (m_checkFifthSample and i==5 and fabs(covVal_i)>0.13) {
      msg() <<  this->m_myMsgLvl << "LARGE Autocorr sample 5 " << channelDescription(chid, cabling, bcCont, gain) << " AutoCorr[" << i << "]: " << covVal_i << endmsg;
      return false;
    }
    if (i<m_nSamplesToCheck && i<sr) {
      const float covRef_i=ref.m_vAutoCorr[i];
      if (fabs(covVal_i-covRef_i)> covTolerance){
    if (m_nFailedValidation<m_maxmessages) {
      std::stringstream devMsg;
      devMsg.setf(std::ios::fixed,std::ios::floatfield);
      devMsg <<  "Deviating! " << channelDescription(chid, cabling, bcCont,gain) << " AutoCorr[" << i << "]: " << std::setprecision(4) << covVal_i
         <<" (" << covRef_i << ", " << std::setprecision(2) << ((covVal_i-covRef_i)/covRef_i)*100 << "%)";
      msg() << this->m_myMsgLvl << devMsg.str() << endmsg;
      ATH_MSG_DEBUG ( "Covariance Tolerance: " <<  covTolerance ) ;
    }
    if (m_nFailedValidation==m_maxmessages)
      msg() <<  this->m_myMsgLvl << "Channel deviation message has already been printed " << m_maxmessages << " times. Now silent..." << endmsg;
    return false;
      }//end if > tolerance
    }//end if nSamplesToCheck
  }// End loop over all samples
  return true;
}

Member Data Documentation

◆ m_BCKey

SG::ReadCondHandleKey<LArBadChannelCont> LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::m_BCKey

protectedinherited

Definition at line 168 of file LArCalibValidationAlg.h.

168{this, "BadChanKey", "LArBadChannel", "SG bad channels key"};

◆ m_bcMask

LArBadChannelMask LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::m_bcMask

protectedinherited

Definition at line 170 of file LArCalibValidationAlg.h.

◆ m_cablingKey

SG::ReadCondHandleKey<LArOnOffIdMapping> LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::m_cablingKey

protectedinherited

Definition at line 167 of file LArCalibValidationAlg.h.

167{this,"CablingKey","LArOnOffIdMap","SG Key of LArOnOffIdMapping object"};

◆ m_caloId

const CaloCell_Base_ID* LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::m_caloId

protectedinherited

Definition at line 178 of file LArCalibValidationAlg.h.

◆ m_chanFile

std::ofstream LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::m_chanFile

protectedinherited

File name to store list of deviating channels.

Definition at line 240 of file LArCalibValidationAlg.h.

◆ m_chanFileName

std::string LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::m_chanFileName

protectedinherited

File name to store list of deviating channels.

Definition at line 237 of file LArCalibValidationAlg.h.

◆ m_checkCompleteness

bool LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::m_checkCompleteness

protectedinherited

wether completeness shall be checked or not (job-property)

Definition at line 201 of file LArCalibValidationAlg.h.

◆ m_checkedIds

std::vector<CHECKEDID_t> LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::m_checkedIds

protectedinherited

Definition at line 234 of file LArCalibValidationAlg.h.

◆ m_checkFifthSample

bool LArAutoCorrValidationAlg::m_checkFifthSample {}

private

Definition at line 72 of file LArAutoCorrValidationAlg.h.

72{};

◆ m_CLKey

SG::ReadCondHandleKey<LArCalibLineMapping> LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::m_CLKey

protectedinherited

Definition at line 169 of file LArCalibValidationAlg.h.

169{this, "CalibLineKey", "LArCalibLineMap", "SG calib line key"};

◆ m_covGlobalRef

double LArAutoCorrValidationAlg::m_covGlobalRef {}

private

Definition at line 95 of file LArAutoCorrValidationAlg.h.

95{},m_covGlobalRef{};

◆ m_covGlobalVal

double LArAutoCorrValidationAlg::m_covGlobalVal {}

private

Definition at line 95 of file LArAutoCorrValidationAlg.h.

95{},m_covGlobalRef{};

◆ m_covTolerance

CaloCellGroupList LArAutoCorrValidationAlg::m_covTolerance

private

Definition at line 67 of file LArAutoCorrValidationAlg.h.

◆ m_covToleranceFEB

CaloCellGroupList LArAutoCorrValidationAlg::m_covToleranceFEB

private

Definition at line 62 of file LArAutoCorrValidationAlg.h.

◆ m_covToleranceFEBInit

std::vector<std::string> LArAutoCorrValidationAlg::m_covToleranceFEBInit

private

Covariace tolerance of one FEB (job-Property)

Definition at line 61 of file LArAutoCorrValidationAlg.h.

◆ m_covToleranceInit

std::vector<std::string> LArAutoCorrValidationAlg::m_covToleranceInit

private

Covariance tolerance (job-Property)

Definition at line 66 of file LArAutoCorrValidationAlg.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_doFebAverages

bool LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::m_doFebAverages

protectedinherited

wether to compare feb-averages (used only by derived class)

Definition at line 210 of file LArCalibValidationAlg.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_febFile

std::ofstream LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::m_febFile

protectedinherited

File name to store list of FEBs with deviating channels.

Definition at line 246 of file LArCalibValidationAlg.h.

◆ m_febFileName

std::string LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::m_febFileName

protectedinherited

File name to store list of FEBs with deviating channels.

Definition at line 243 of file LArCalibValidationAlg.h.

◆ m_gainMap

std::vector<std::string> LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::m_gainMap

privateinherited

Definition at line 159 of file LArCalibValidationAlg.h.

◆ m_isSC

BooleanProperty LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::m_isSC

protectedinherited

Definition at line 173 of file LArCalibValidationAlg.h.

173{this, "SuperCells", false, "Working on SuperCells ?"};

◆ m_maxmessages

unsigned LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::m_maxmessages

protectedinherited

Limit for the number of messages about indiviual deviating channels (usd only by derived class)

Definition at line 213 of file LArCalibValidationAlg.h.

◆ m_myMsgLvl

MSG::Level LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::m_myMsgLvl

protectedinherited

Message level for reporting deviations.

Definition at line 163 of file LArCalibValidationAlg.h.

◆ m_myMsgLvlProp

int LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::m_myMsgLvlProp

protectedinherited

Definition at line 164 of file LArCalibValidationAlg.h.

◆ m_nBad

unsigned LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::m_nBad

protectedinherited

Number of channels known to be bad according to the bad-channel tool.

Definition at line 227 of file LArCalibValidationAlg.h.

◆ m_nc_validation

LArAutoCorrComplete* LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::m_nc_validation

protectedinherited

Non-const pointer to container to be validated (for FEB patching)

Definition at line 188 of file LArCalibValidationAlg.h.

◆ m_nChecked

unsigned LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::m_nChecked

protectedinherited

Number of channels that where checked (grand-total)

Definition at line 218 of file LArCalibValidationAlg.h.

◆ m_nEntriesGlobal

unsigned LArAutoCorrValidationAlg::m_nEntriesGlobal {}

private

Definition at line 96 of file LArAutoCorrValidationAlg.h.

96{};

◆ m_nFailedValidation

unsigned LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::m_nFailedValidation

protectedinherited

Number of channels for which vaildateChannel returned false.

Definition at line 221 of file LArCalibValidationAlg.h.

◆ m_nNoReference

unsigned LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::m_nNoReference

protectedinherited

Number of channels for which not reference channel could be found.

Definition at line 230 of file LArCalibValidationAlg.h.

◆ m_nSamplesToCheck

unsigned LArAutoCorrValidationAlg::m_nSamplesToCheck {}

private

Number of elements of the Covariance vector that should be checked.

Definition at line 70 of file LArAutoCorrValidationAlg.h.

70{};

◆ m_nValidated

unsigned LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::m_nValidated

protectedinherited

Number of channels for which vaildateChannel returned true.

Definition at line 224 of file LArCalibValidationAlg.h.

◆ m_onlineHelper

const LArOnlineID_Base* LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::m_onlineHelper

protectedinherited

Definition at line 177 of file LArCalibValidationAlg.h.

◆ m_patchCBs

Gaudi::Property<std::vector<unsigned int> > LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::m_patchCBs

protectedinherited

Definition at line 172 of file LArCalibValidationAlg.h.

172{this, "PatchCBs", {}, "List of missing CalibBoards to patch using values from reference container."};

◆ m_patchMissingFEBs

bool LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::m_patchMissingFEBs

protectedinherited

wether missing FEBS (incomplete COOL channels) should be patched

Definition at line 204 of file LArCalibValidationAlg.h.

◆ m_printFailedPattern

bool LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::m_printFailedPattern

protectedinherited

wether to check for FEBs and Calib-lines with many deviating channels

Definition at line 207 of file LArCalibValidationAlg.h.

◆ m_problemsToMask

Gaudi::Property<std::vector<std::string> > LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::m_problemsToMask

protectedinherited

Definition at line 171 of file LArCalibValidationAlg.h.

171{this,"ProblemsToMask",{}, "Bad-Channel categories to mask"};

◆ m_reference

const LArAutoCorrComplete* LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::m_reference

protectedinherited

Pointer to container with reference values.

Definition at line 182 of file LArCalibValidationAlg.h.

◆ m_referenceKey

SG::ReadCondHandleKey<LArAutoCorrComplete> LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::m_referenceKey

protectedinherited

SG key of the reference container (job-property)

Definition at line 194 of file LArCalibValidationAlg.h.

194{this,"ReferenceKey","", "SG key of the LArConditionsContainer used as reference"};

◆ m_useBCInfo

bool LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::m_useBCInfo

protectedinherited

Flag set to true in order to use bad-channel info for the channel description as well as to ingore some types of bad-channels via the masking tool.

Definition at line 198 of file LArCalibValidationAlg.h.

◆ m_useCorrChannel

bool LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::m_useCorrChannel

protectedinherited

Definition at line 248 of file LArCalibValidationAlg.h.

◆ m_validation

const LArAutoCorrComplete* LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::m_validation

protectedinherited

Pointer to container to be validated.

Definition at line 185 of file LArCalibValidationAlg.h.

◆ m_validationKey

std::string LArCalibValidationAlg< LArAutoCorrComplete, LArAutoCorrComplete >::m_validationKey

protectedinherited

SG key of the container to be validated (job-property)

Definition at line 191 of file LArCalibValidationAlg.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vDataPerFEB

std::vector<DataPerFEB> LArAutoCorrValidationAlg::m_vDataPerFEB

private

Definition at line 92 of file LArAutoCorrValidationAlg.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:

Classes

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ CBANDCHANANDGAIN_t

◆ CHECKEDID_t

◆ CONTIT

◆ FEBANDGAIN_t

◆ LArCondObj

◆ MULTICHANCOLL

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ LArAutoCorrValidationAlg()

Member Function Documentation

◆ channelDescription()

◆ checkCoolChannelCompleteness()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ febOutput()

◆ febSummary()

◆ finalize()

◆ findFailedPatterns()

◆ getRefObj()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ patchMissingCalibBoards()

◆ patchMissingFEBs()

◆ preLoop()

◆ renounce()

◆ renounceArray()

◆ stop()

◆ summary()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

◆ validateChannel()

Member Data Documentation

◆ m_BCKey

◆ m_bcMask

◆ m_cablingKey

◆ m_caloId

◆ m_chanFile

◆ m_chanFileName

◆ m_checkCompleteness

◆ m_checkedIds

◆ m_checkFifthSample

◆ m_CLKey

◆ m_covGlobalRef

◆ m_covGlobalVal

◆ m_covTolerance

◆ m_covToleranceFEB

◆ m_covToleranceFEBInit

◆ m_covToleranceInit

◆ m_detStore

◆ m_doFebAverages

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_febFile

◆ m_febFileName

◆ m_gainMap

◆ m_isSC

◆ m_maxmessages

◆ m_myMsgLvl

◆ m_myMsgLvlProp

◆ m_nBad

◆ m_nc_validation