LArAutoCorrMaker Class Reference

#include <LArAutoCorrMaker.h>

Inheritance diagram for LArAutoCorrMaker:

Collaboration diagram for LArAutoCorrMaker:

Public Member Functions
	LArAutoCorrMaker (const std::string &name, ISvcLocator *pSvcLocator)
	~LArAutoCorrMaker ()
StatusCode	initialize ()
StatusCode	execute ()
StatusCode	stop ()
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< LArAutoCorr >	LARACMAP
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
SG::ReadCondHandleKey< BunchCrossingCondData >	m_bcDataKey {this, "BunchCrossingCondDataKey", "BunchCrossingData" ,"SG Key of BunchCrossing CDO"}
int	m_bunchCrossingsFromFront
std::vector< std::string >	m_keylist
std::vector< std::string >	m_keylistproperty
std::string	m_keyoutput
std::string	m_groupingType
int	m_nref
int	m_rms_cut
int	m_nsamples = 0
int	m_normalize
int	m_physics
LARACMAP	m_autocorr
unsigned	m_nEvents
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 38 of file LArAutoCorrMaker.h.

Member Typedef Documentation

LARACMAP

typedef LArConditionsContainer<LArAutoCorr> LArAutoCorrMaker::LARACMAP

private

Definition at line 85 of file LArAutoCorrMaker.h.

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

LArAutoCorrMaker()

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

Definition at line 41 of file LArAutoCorrMaker.cxx.

  : AthAlgorithm(name, pSvcLocator), 
    m_groupingType("ExtendedSubDetector"), // SubDetector, Single, FeedThrough  
    m_nEvents(0)
{
  declareProperty("KeyList",      m_keylistproperty);
  declareProperty("KeyOutput",    m_keyoutput="LArAutoCorr");
  declareProperty("events_ref",   m_nref=50);
  declareProperty("nsigma",       m_rms_cut=5);
  declareProperty("normalize",    m_normalize=1); 
  declareProperty("physics",      m_physics=0); 
  declareProperty("GroupingType", m_groupingType); 
  declareProperty("MinBCFromFront",m_bunchCrossingsFromFront=0);
}

~LArAutoCorrMaker()

LArAutoCorrMaker::~LArAutoCorrMaker ( )

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 LArAutoCorrMaker::execute

(

)

Definition at line 89 of file LArAutoCorrMaker.cxx.

{
  StatusCode sc;
  if (m_bunchCrossingsFromFront>0) {
    const xAOD::EventInfo* eventInfo = nullptr;
    ATH_CHECK( evtStore()->retrieve( eventInfo ) );
 
    SG::ReadCondHandle<BunchCrossingCondData> bccd (m_bcDataKey);
    const BunchCrossingCondData* bunchCrossing=*bccd;
    if (!bunchCrossing) {
      ATH_MSG_ERROR("Failed to retrieve Bunch Crossing obj");
      return StatusCode::FAILURE;
    }
 
    uint32_t bcid = eventInfo->bcid();
    const int nBCsFromFront=bunchCrossing->distanceFromFront(bcid,BunchCrossingCondData:: BunchCrossings);
    if (nBCsFromFront < m_bunchCrossingsFromFront) {
      ATH_MSG_DEBUG("BCID " << bcid << " only " << nBCsFromFront << " BCs from front of BunchTrain. Event ignored. (min=" <<m_bunchCrossingsFromFront 
            << ", type= " << bunchCrossing->bcType(bcid) << ")" );
      return StatusCode::SUCCESS; //Ignore this event
    }
    else
     ATH_MSG_DEBUG("BCID " << bcid << " is " << nBCsFromFront << " BCs from front of BunchTrain. Event accepted.(min=" <<m_bunchCrossingsFromFront << ")");
  }
 
  const LArDigitContainer* larDigitContainer = nullptr;
 
  for (const std::string& key : m_keylist) {
    ATH_MSG_DEBUG("Reading LArDigitContainer from StoreGate! key=" << key);
    sc= evtStore()->retrieve(larDigitContainer,key);
    if (sc.isFailure() || !larDigitContainer) {
      ATH_MSG_DEBUG("Cannot read LArDigitContainer from StoreGate! key=" << key);
      continue;
    }
    if(larDigitContainer->empty()) {
      ATH_MSG_DEBUG("Got empty LArDigitContainer (key=" << key << ").");
      continue;
    }
    ATH_MSG_DEBUG("Got LArDigitContainer with key " << key <<", size="  << larDigitContainer->size());
    ++m_nEvents;
    m_nsamples = (*larDigitContainer->begin())->nsamples();
    ATH_MSG_DEBUG("NSAMPLES (from digit container) = " << m_nsamples );
 
    for (const LArDigit* digit : *larDigitContainer) {
      const HWIdentifier chid=digit->hardwareID();
      const CaloGain::CaloGain gain=digit->gain();
      if (gain<0 || gain>CaloGain::LARNGAIN) {
    ATH_MSG_ERROR( "Found odd gain number ("<< (int)gain <<")" );
    return StatusCode::FAILURE;
      }
      const std::vector<short> & samples = digit->samples();
      //      LArAutoCorr& thisAC=m_autocorr[gain][chid];
      LArAutoCorr& thisAC=m_autocorr.get(chid,gain);
 
      if(thisAC.get_max()!=-1){ //Have already boundaries set
      std::vector<short>::const_iterator s_it=samples.begin();
      std::vector<short>::const_iterator s_it_e=samples.end();
      const short &  min = thisAC.get_min();
      const short &  max = thisAC.get_max();
      
      for (;s_it!=s_it_e && *s_it>=min && *s_it<=max;++s_it)
            ;
      if (s_it==s_it_e) 
        thisAC.add(samples,m_nsamples);
      }
      else {
      thisAC.add(samples,m_nsamples);
      if (thisAC.get_nentries()==m_nref && m_nref>0) { //Set window size
        // Define the window (min, max)according to pedestal and noise
        // computed for a number of events = m_nref  
        const double mean  = thisAC.get_mean();
        const double noise = thisAC.get_rms();
        const short min = (short)floor(mean - m_rms_cut*noise);
        const short max = (short)ceil(mean + m_rms_cut*noise);
        thisAC.set_min(min);
        thisAC.set_max(max);
        thisAC.correl_zero();
      } //end if nentries==m_nref
    } // end else
    }//End loop over all cells
  }// End loop over all containers
  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 LArAutoCorrMaker::finalize ( )

inline

Definition at line 57 of file LArAutoCorrMaker.h.

{ return StatusCode::SUCCESS;}

initialize()

StatusCode LArAutoCorrMaker::initialize

(

)

Definition at line 60 of file LArAutoCorrMaker.cxx.

                                        {
 
  ATH_MSG_INFO( ">>> Initialize" );
  
  if (m_keylistproperty.empty()) // Not key list given
    {m_keylistproperty.emplace_back("HIGH");
    m_keylistproperty.emplace_back("MEDIUM");
    m_keylistproperty.emplace_back("LOW");
    m_keylistproperty.emplace_back("FREE"); // For H6...
    }
 
  m_keylist=m_keylistproperty;
  if (m_keylist.empty()) {
    ATH_MSG_ERROR( "Key list is empty!" );
    return StatusCode::FAILURE;
  }
 
  m_autocorr.setGroupingType(LArConditionsContainerBase::SingleGroup);
  StatusCode sc=m_autocorr.initialize();
  if (sc.isFailure()) {
    ATH_MSG_ERROR( "Failed initialize intermediate AutoCorr object" );
    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 LArAutoCorrMaker::stop

(

)

Definition at line 176 of file LArAutoCorrMaker.cxx.

{
  StatusCode sc;
  ATH_MSG_INFO( ">>> Stop()" );
 
  if (m_keylist.empty()) {
    ATH_MSG_ERROR( "Key list is empty! No containers processed!" );
    return StatusCode::FAILURE;
  }
 
  // Create the LArAutoCorrComplete object
  auto larAutoCorrComplete = std::make_unique<LArAutoCorrComplete>();
 
  sc=larAutoCorrComplete->setGroupingType(m_groupingType,msg());
  if (sc.isFailure()) {
    ATH_MSG_ERROR( "Failed to set groupingType for LArAutoCorrComplete object" );
    return sc;
  }
 
  sc=larAutoCorrComplete->initialize(); 
  if (sc.isFailure()) {
    ATH_MSG_ERROR( "Failed initialize LArAutoCorrComplete object" );
    return sc;
  }
 
  for (int gain=0;gain<(int)CaloGain::LARNGAIN;gain++)  {
      LARACMAP::ConditionsMapIterator cell_it=m_autocorr.begin(gain);
      LARACMAP::ConditionsMapIterator cell_it_e=m_autocorr.end(gain);
      
      //Inner loop goes over the cells.
      for (;cell_it!=cell_it_e;cell_it++) {
    LArAutoCorr autocorr = *cell_it;
    // Check number of entries
    if(autocorr.get_nentries()==0) continue;
        
    // Get the autocorrelation matrix
 
 
    //MGV implement normalization switch
    const  std::vector<double> & cov = autocorr.get_cov(m_normalize,m_physics);
 
    //The AutoCorr is stored as float -> convert
    std::vector<float> cov_flt;
    cov_flt.reserve(cov.size());
    std::vector<double>::const_iterator it=cov.begin();
    std::vector<double>::const_iterator it_e=cov.end();
    for (;it!=it_e;++it)
      cov_flt.push_back((float)*it);
    HWIdentifier ch_id = cell_it.channelId();
        
    // Fill the data class with autocorrelation elements
    if (ch_id!=0) {
      larAutoCorrComplete->set(ch_id,gain,cov_flt);
    }
      }
    }
  
  ATH_MSG_INFO( "AutoCorrelation based on " << m_nEvents << " events." );
  ATH_MSG_INFO( " Summary : Number of cells with a autocorr value computed : " << larAutoCorrComplete->totalNumberOfConditions()  );
  ATH_MSG_INFO( " Summary : Number of Barrel PS cells side A or C (connected+unconnected):  4096 " );
  ATH_MSG_INFO( " Summary : Number of Barrel    cells side A or C (connected+unconnected): 53248 " );
  ATH_MSG_INFO( " Summary : Number of EMEC      cells side A or C (connected+unconnected): 35328 " );
  ATH_MSG_INFO( " Summary : Number of HEC       cells side A or C (connected+unconnected):  3072 ");
  ATH_MSG_INFO( " Summary : Number of FCAL      cells side A or C (connected+unconnected):  1792 " );
  
  // Record LArAutoCorrComplete
  ATH_CHECK( detStore()->record(std::move(larAutoCorrComplete),m_keyoutput) );
  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_autocorr

LARACMAP LArAutoCorrMaker::m_autocorr

private

Definition at line 86 of file LArAutoCorrMaker.h.

m_bcDataKey

SG::ReadCondHandleKey<BunchCrossingCondData> LArAutoCorrMaker::m_bcDataKey {this, "BunchCrossingCondDataKey", "BunchCrossingData" ,"SG Key of BunchCrossing CDO"}

private

Definition at line 61 of file LArAutoCorrMaker.h.

{this, "BunchCrossingCondDataKey", "BunchCrossingData" ,"SG Key of BunchCrossing CDO"};

m_bunchCrossingsFromFront

int LArAutoCorrMaker::m_bunchCrossingsFromFront

private

Definition at line 63 of file LArAutoCorrMaker.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_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_groupingType

std::string LArAutoCorrMaker::m_groupingType

private

Definition at line 70 of file LArAutoCorrMaker.h.

m_keylist

std::vector<std::string> LArAutoCorrMaker::m_keylist

private

Definition at line 66 of file LArAutoCorrMaker.h.

m_keylistproperty

std::vector<std::string> LArAutoCorrMaker::m_keylistproperty

private

Definition at line 66 of file LArAutoCorrMaker.h.

m_keyoutput

std::string LArAutoCorrMaker::m_keyoutput

private

Definition at line 67 of file LArAutoCorrMaker.h.

m_nEvents

unsigned LArAutoCorrMaker::m_nEvents

private

Definition at line 90 of file LArAutoCorrMaker.h.

m_normalize

int LArAutoCorrMaker::m_normalize

private

Definition at line 80 of file LArAutoCorrMaker.h.

m_nref

int LArAutoCorrMaker::m_nref

private

Definition at line 73 of file LArAutoCorrMaker.h.

m_nsamples

int LArAutoCorrMaker::m_nsamples = 0

private

Definition at line 77 of file LArAutoCorrMaker.h.

m_physics

int LArAutoCorrMaker::m_physics

private

Definition at line 83 of file LArAutoCorrMaker.h.

m_rms_cut

int LArAutoCorrMaker::m_rms_cut

private

Definition at line 76 of file LArAutoCorrMaker.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:

• LArAutoCorrMaker.h
• LArAutoCorrMaker.cxx