LArPedestalAutoCorrBuilder Class Reference

#include <LArPedestalAutoCorrBuilder.h>

Inheritance diagram for LArPedestalAutoCorrBuilder:

Collaboration diagram for LArPedestalAutoCorrBuilder:

Public Member Functions
	LArPedestalAutoCorrBuilder (const std::string &name, ISvcLocator *pSvcLocator)
	~LArPedestalAutoCorrBuilder ()
StatusCode	initialize ()
StatusCode	execute ()
virtual StatusCode	stop ()
virtual 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 Member Functions
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.

Private Types
typedef LArConditionsContainer< LArAccumulatedDigit >	ACCU
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
const LArOnlineID_Base *	m_onlineHelper
std::vector< std::string >	m_keylist
std::string	m_groupingType
ACCU	m_accu
unsigned	m_event_counter
std::string	m_pedContName
std::string	m_acContName
bool	m_doPedestal
bool	m_doAutoCorr
uint16_t	m_fatalFebErrorPattern
int	m_normalize
int	m_sample_min
int	m_sample_max
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 28 of file LArPedestalAutoCorrBuilder.h.

Member Typedef Documentation

ACCU

typedef LArConditionsContainer<LArAccumulatedDigit> LArPedestalAutoCorrBuilder::ACCU

private

Definition at line 60 of file LArPedestalAutoCorrBuilder.h.

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

LArPedestalAutoCorrBuilder()

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

Definition at line 29 of file LArPedestalAutoCorrBuilder.cxx.

  : AthAlgorithm(name, pSvcLocator),
    m_onlineHelper(nullptr),
    m_event_counter(0),
    m_fatalFebErrorPattern(0xffff)
{
  declareProperty("KeyList",         m_keylist);
  declareProperty("PedestalKey",     m_pedContName="LArPedestal");
  declareProperty("normalize",       m_normalize=1); 
  declareProperty("AutoCorrKey",     m_acContName="LArAutoCorr");
  declareProperty("GroupingType",    m_groupingType="ExtendedFeedThrough"); 
  declareProperty("doPedestal",      m_doPedestal=true);
  declareProperty("doAutoCorr",      m_doAutoCorr=true);
  declareProperty("sample_min",      m_sample_min=-1);
  declareProperty("sample_max",      m_sample_max=-1);
}

~LArPedestalAutoCorrBuilder()

LArPedestalAutoCorrBuilder::~LArPedestalAutoCorrBuilder ( )

default

Member Function Documentation

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.

{ return m_detStore; }

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.

{ return m_evtStore; }

execute()

StatusCode LArPedestalAutoCorrBuilder::execute

(

)

Definition at line 90 of file LArPedestalAutoCorrBuilder.cxx.

{
 
  StatusCode sc;
  ++m_event_counter;
  if (m_keylist.empty()) {
    ATH_MSG_ERROR( "Key list is empty! No containers processed!" );
    return StatusCode::FAILURE;
  } 
  
  
  const LArFebErrorSummary* febErrSum=nullptr;
  if (evtStore()->contains<LArFebErrorSummary>("LArFebErrorSummary")) {
    sc=evtStore()->retrieve(febErrSum);
    if (sc.isFailure()) {
      ATH_MSG_ERROR( "Failed to retrieve FebErrorSummary object!" );
      return sc;
    }
  }
  else
    if (m_event_counter==1)
      ATH_MSG_WARNING( "No FebErrorSummaryObject found! Feb errors not checked!" );
 
 
  const LArAccumulatedDigitContainer* container = nullptr;
  //Outermost loop goes over all gains (different containers).
  int foundkey = 0;
 
  for (const std::string& key : m_keylist) {
    sc= evtStore()->retrieve(container,key);
    if (sc.isFailure() || !container) {
      ATH_MSG_DEBUG("Cannot read LArAccumulatedDigitContainer from StoreGate! key=" << key);
      if ( ( (&key == &m_keylist.back()) ) && foundkey==0 ){
    ATH_MSG_ERROR("None of the provided LArAccumulatedDigitContainer keys could be read");
    return StatusCode::FAILURE;
      }else{
    continue;
      }
    }
    foundkey+=1;
 
    // check that container is not empty
    if(container->empty() ) {
      ATH_MSG_DEBUG("LArAccumulatedDigitContainer (key=" << key << ") is empty ");
      continue;
    }else{
      ATH_MSG_DEBUG("LArAccumulatedDigitContainer (key=" << key << ") has length " << container->size());
    }
 
    HWIdentifier  lastFailedFEB(0);
    //Inner loop goes over the cells.
    for (const LArAccumulatedDigit* dg : *container) {  //Loop over all cells
      if (dg->nTrigger()==0) continue; //Don't care about empty digits
      const HWIdentifier chid=dg->hardwareID();
      const HWIdentifier febid=m_onlineHelper->feb_Id(chid);
      if (febErrSum) {
    const uint16_t febErrs=febErrSum->feb_error(febid);
    if (febErrs & m_fatalFebErrorPattern) {
      if (febid!=lastFailedFEB) {
        lastFailedFEB=febid;
        ATH_MSG_ERROR( "Event " << m_event_counter << " Feb " <<  m_onlineHelper->channel_name(febid) 
        << " reports error(s):" << febErrSum->error_to_string(febErrs) << ". Data ignored." );
      }
      continue;
    } //end if fatal feb error
      }//end if check feb error summary
 
      const CaloGain::CaloGain gain=dg->gain();
 
      LArAccumulatedDigit& accDg=m_accu.get(chid,gain);
      if (!accDg.setAddSubStep(*dg)) 
    ATH_MSG_ERROR( "Failed to accumulate sub-steps! Inconsistent number of ADC samples" );
    } //end loop over input container
  }//end loop over keys
  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()

virtual StatusCode LArPedestalAutoCorrBuilder::finalize ( )

inlinevirtual

Definition at line 49 of file LArPedestalAutoCorrBuilder.h.

{return StatusCode::SUCCESS;}

initialize()

StatusCode LArPedestalAutoCorrBuilder::initialize

(

)

Definition at line 49 of file LArPedestalAutoCorrBuilder.cxx.

{
  if (m_groupingType == "SuperCells") {
    ATH_MSG_INFO("Processing LAr SuperCells");
    const LArOnline_SuperCellID* onlID;
    ATH_CHECK(detStore()->retrieve(onlID,"LArOnline_SuperCellID"));
    m_onlineHelper=onlID; // cast to base-class
  }
  else {
    ATH_MSG_INFO("Processing regular LArCells");
    const LArOnlineID* onlID;
    ATH_CHECK(detStore()->retrieve(onlID, "LArOnlineID"));
    m_onlineHelper=onlID; // cast to base-class
  }
 
  
  
  if (!m_doPedestal && !m_doAutoCorr) {
    ATH_MSG_ERROR( "Configuration Problem: Neither doPedstal nor doAutoCorr set!" );
    return StatusCode::FAILURE;
  }
 
 if (m_keylist.empty()) // Not key list given
   {m_keylist.emplace_back("HIGH");
    m_keylist.emplace_back("MEDIUM");
    m_keylist.emplace_back("LOW");
    m_keylist.emplace_back("FREE"); //For H6....
   }
 
 //Container for internal accumulation
 m_accu.setGroupingType(m_groupingType == "SuperCells" ? LArConditionsContainerBase::SuperCells : LArConditionsContainerBase::SingleGroup);
 StatusCode sc=m_accu.initialize(); 
 if (sc.isFailure()) {
    ATH_MSG_ERROR( "Failed initialize LArConditionsContainer 'm_accu'" );
    return sc;
  }
 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()

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.

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 LArPedestalAutoCorrBuilder::stop ( )

virtual

Definition at line 170 of file LArPedestalAutoCorrBuilder.cxx.

                                            {
 
  std::unique_ptr<LArAutoCorrComplete> larAutoCorrComplete;
  std::unique_ptr<LArPedestalComplete> larPedestalComplete;
 
  if (m_doAutoCorr) { 
    //Book and initialize LArAutoCorrComplete object
    ATH_MSG_INFO("Creating LArAutoCorrComplete");
    larAutoCorrComplete = std::make_unique<LArAutoCorrComplete>();
    ATH_CHECK( larAutoCorrComplete->setGroupingType(m_groupingType,msg()) );
    ATH_CHECK( larAutoCorrComplete->initialize() );
  }
 
  if (m_doPedestal) {
    //Book and initialize LArPedestalComplete object
    ATH_MSG_INFO("Creating LArAutoPedestalComplete");
    larPedestalComplete = std::make_unique<LArPedestalComplete>();
    ATH_CHECK( larPedestalComplete->setGroupingType(m_groupingType,msg()) );
    ATH_CHECK( larPedestalComplete->initialize() );
  }
    
  //For the log output further down
  std::string objName;
  if (m_doPedestal)
    objName="pedestal";
  if (m_doAutoCorr)
    objName="autocorr";
  if (m_doAutoCorr && m_doPedestal)
    objName="pedestal & autocorr";
 
  int n_zero,n_min, n_max, n_cur;
  n_zero=0; n_max=n_min=-1;
  unsigned NCells=0;
  std::vector<float> cov;
  //Loop over gains
  for (unsigned k=0;k<(int)CaloGain::LARNGAIN;k++) {
    CaloGain::CaloGain gain=(CaloGain::CaloGain)k;
    //Loop over cells
    ACCU::ConditionsMapIterator cell_it=m_accu.begin(gain);
    ACCU::ConditionsMapIterator cell_it_e=m_accu.end(gain);
    
    if (cell_it==cell_it_e){
      continue; //No data for this gain
    }
    for (;cell_it!=cell_it_e;cell_it++) {
      const LArAccumulatedDigit& dg=*cell_it;
      n_cur = dg.nTrigger();
      if(n_cur==0) { n_zero++; continue; }
 
      HWIdentifier chid = cell_it.channelId();     
      
      if(n_cur<n_min || n_min<0) n_min=n_cur;
      if(n_cur>n_max || n_max<0) n_max=n_cur;
      
      // Fill the data class with pedestal and rms values
      if (larPedestalComplete)
    larPedestalComplete->set(chid,gain,dg.mean(m_sample_min, m_sample_max),dg.RMS(m_sample_min, m_sample_max));
      
      if (larAutoCorrComplete) {
    dg.getCov(cov,m_normalize);
    larAutoCorrComplete->set(chid,gain,cov);
      }
      NCells++;
    }//end loop over all cells  
 
    ATH_MSG_INFO( "Gain " << gain << " Number of cells with 0 events to compute "<<objName<< ": " << n_zero );
    ATH_MSG_INFO( "Gain " << gain << " Minimum number of events*samples to compute " <<objName<<": "<< n_min );
    ATH_MSG_INFO( "Gain " << gain << " Maximum number of events*samples to compute " <<objName<<": " <<n_max );
  }// End loop over all containers
  
  ATH_MSG_INFO( " Summary : Number of cells with " <<objName<<" value computed : " << NCells  );
  ATH_MSG_INFO( " Summary : Number of Barrel PS cells side A or C (connected+unconnected):   3904+ 192 =  4096 " );
  ATH_MSG_INFO( " Summary : Number of Barrel    cells side A or C (connected+unconnected):  50944+2304 = 53248 " );
  ATH_MSG_INFO( " Summary : Number of EMEC      cells side A or C (connected+unconnected):  31872+3456 = 35328 " );
  ATH_MSG_INFO( " Summary : Number of HEC       cells side A or C (connected+unconnected):   2816+ 256 =  3072 " );
  ATH_MSG_INFO( " Summary : Number of FCAL      cells side A or C (connected+unconnected):   1762+  30 =  1792 " );
    
  if (larPedestalComplete) {
    ATH_CHECK( detStore()->record(std::move(larPedestalComplete),m_pedContName) );
  }
 
 
  if (larAutoCorrComplete) {
    ATH_CHECK( detStore()->record(std::move(larAutoCorrComplete),m_acContName) );
  }
 
  return StatusCode::SUCCESS;
}

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

Member Data Documentation

m_acContName

std::string LArPedestalAutoCorrBuilder::m_acContName

private

Definition at line 66 of file LArPedestalAutoCorrBuilder.h.

m_accu

ACCU LArPedestalAutoCorrBuilder::m_accu

private

Definition at line 61 of file LArPedestalAutoCorrBuilder.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_doAutoCorr

bool LArPedestalAutoCorrBuilder::m_doAutoCorr

private

Definition at line 68 of file LArPedestalAutoCorrBuilder.h.

m_doPedestal

bool LArPedestalAutoCorrBuilder::m_doPedestal

private

Definition at line 68 of file LArPedestalAutoCorrBuilder.h.

m_event_counter

unsigned LArPedestalAutoCorrBuilder::m_event_counter

private

Definition at line 63 of file LArPedestalAutoCorrBuilder.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_fatalFebErrorPattern

uint16_t LArPedestalAutoCorrBuilder::m_fatalFebErrorPattern

private

Definition at line 70 of file LArPedestalAutoCorrBuilder.h.

m_groupingType

std::string LArPedestalAutoCorrBuilder::m_groupingType

private

Definition at line 57 of file LArPedestalAutoCorrBuilder.h.

m_keylist

std::vector<std::string> LArPedestalAutoCorrBuilder::m_keylist

private

Definition at line 54 of file LArPedestalAutoCorrBuilder.h.

m_normalize

int LArPedestalAutoCorrBuilder::m_normalize

private

Definition at line 72 of file LArPedestalAutoCorrBuilder.h.

m_onlineHelper

const LArOnlineID_Base* LArPedestalAutoCorrBuilder::m_onlineHelper

private

Definition at line 52 of file LArPedestalAutoCorrBuilder.h.

m_pedContName

std::string LArPedestalAutoCorrBuilder::m_pedContName

private

Definition at line 65 of file LArPedestalAutoCorrBuilder.h.

m_sample_max

int LArPedestalAutoCorrBuilder::m_sample_max

private

Definition at line 75 of file LArPedestalAutoCorrBuilder.h.

m_sample_min

int LArPedestalAutoCorrBuilder::m_sample_min

private

Definition at line 74 of file LArPedestalAutoCorrBuilder.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:

• LArPedestalAutoCorrBuilder.h
• LArPedestalAutoCorrBuilder.cxx