LArDigitsAccumulator Class Reference

Emulator of DSP code in accumulation pedestal mode. More...

#include <LArDigitsAccumulator.h>

Inheritance diagram for LArDigitsAccumulator:

Collaboration diagram for LArDigitsAccumulator:

Classes
class	LArAccumulated
	Class of intermediate accumulations. More...

Public Member Functions
	LArDigitsAccumulator (const std::string &name, ISvcLocator *pSvcLocator)
StatusCode	initialize ()
StatusCode	execute ()
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 std::vector< LArAccumulatedDigit * >	ACCUMDIGIT_VEC
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
ACCUMDIGIT_VEC	m_my_vec
std::string	m_AccuDigitContainerName
	LArAccumulatedDigitContainer name.
std::vector< std::string >	m_keylist
	list of key for input digit container (=gain)
unsigned int	m_NtriggersPerStep
	Number of triggers per step.
unsigned int	m_nStepTrigger
	Number of steps.
double	m_DropPercentTrig
	Percentage of the used triggers that we will skip over at the end, in order ot ensure that the accumulation is done, even if there are lots of missing events from SC.
std::vector< LArAccumulated >	m_Accumulated
	Vector (index=hash ID) of accumulation quantities.
unsigned int	m_event_counter
	Event counter.
bool	m_isSC
	Tells you wether you run on SuperCells or Cells.
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

Emulator of DSP code in accumulation pedestal mode.

Author

Sandrine Laplace lapla.nosp@m.ce@l.nosp@m.app.i.nosp@m.n2p3.nosp@m..fr

Date

18-06-2008

Definition at line 25 of file LArDigitsAccumulator.h.

Member Typedef Documentation

ACCUMDIGIT_VEC

typedef std::vector<LArAccumulatedDigit*> LArDigitsAccumulator::ACCUMDIGIT_VEC

private

Definition at line 54 of file LArDigitsAccumulator.h.

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

LArDigitsAccumulator()

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

Definition at line 13 of file LArDigitsAccumulator.cxx.

                                                                                          :
  AthAlgorithm(name, pSvcLocator),
  m_onlineHelper(nullptr),
  m_AccuDigitContainerName("LArAccumulatedDigits"),
  m_NtriggersPerStep(100),
  m_nStepTrigger(30)
{
  declareProperty("LArAccuDigitContainerName",m_AccuDigitContainerName);
  declareProperty("KeyList",m_keylist);
  declareProperty("NTriggersPerStep",m_NtriggersPerStep);
  declareProperty("StepOfTriggers",m_nStepTrigger);
  declareProperty("DropPercentTrig",m_DropPercentTrig=10);
  declareProperty("isSC",m_isSC=false);
 
  m_event_counter=0;
}

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

(

)

first check if there is a -1 and continue

Definition at line 62 of file LArDigitsAccumulator.cxx.

{
  if ( m_event_counter < 100 || m_event_counter%100==0 )
    ATH_MSG_INFO( "Processing event " << m_event_counter );
  ++m_event_counter;
 
  
  // pointer to input container
  const LArDigitContainer* DigitContainer=nullptr;
 
 
  // retrieve input Digits
  
  //Loop over all containers that are to be processed (e.g. different gains)
  for (const std::string& key : m_keylist) {
     
    ATH_CHECK( evtStore()->retrieve(DigitContainer,key) );
 
    // store LArAccumulatedDigits
    ACCUMDIGIT_VEC& vAccum = m_my_vec;
    if(vAccum.empty()) vAccum.resize(m_onlineHelper->channelHashMax());
 
    // Loop over DigitContainer
 
    if(DigitContainer->empty()) {
      ATH_MSG_DEBUG( "LArDigitContainer with key=" << key << " is empty "  );
    }else{
      ATH_MSG_DEBUG( "LArDigitContainer with key=" << key << " has size =  " << DigitContainer->size()  );
    }
 
    //unsigned int iStepTrigger=0;
 
    // output container
    auto larAccuDigitContainer = std::make_unique<LArAccumulatedDigitContainer>(SG::VIEW_ELEMENTS);
    //Loop over all cells
    for (const LArDigit* digit : *DigitContainer) {
 
      // identificators
      HWIdentifier chid=digit->hardwareID();      
      const IdentifierHash hashid = m_onlineHelper->channel_Hash(chid);
      
      if( m_isSC ){
    bool hasInvalid=false;
    for(auto s : digit->samples()){
      if(s<0){
        hasInvalid=true;
        break;
      }
    }
    if(hasInvalid) continue;
      }
 
 
      CaloGain::CaloGain gain=digit->gain();
      if (gain<0 || gain>CaloGain::LARNGAIN)
      {
        ATH_MSG_ERROR( "Found not-matching gain number ("<< (int)gain <<")"  );
        return StatusCode::FAILURE;
      }
 
      // object to be filled for each cell
      LArAccumulated& cellAccumulated = m_Accumulated[hashid];
      cellAccumulated.m_onlineId=chid.get_identifier32().get_compact();
      
      // trigger counter for each cell
      cellAccumulated.m_ntrigger++;
 
      //ATH_MSG_DEBUG( "chid = " << chid << ", trigger = " << cellAccumulated.m_ntrigger << ", sample 0 = "<< digit->samples()[0]  );
 
      // at first trigger, initialize vectors
      unsigned int sizeSamples = digit->samples().size();
      //ATH_MSG_DEBUG( "# of samples = " << sizeSamples  );
 
      LArAccumulatedDigit* accuDigit;
 
      if(m_event_counter==1){
    accuDigit = new LArAccumulatedDigit(chid);
    vAccum[hashid]=accuDigit;   
      }
      
      if(cellAccumulated.m_ntrigger==1){
    //  std::cout << "resizing to 0 "<< std::endl;
    cellAccumulated.m_samplesum.clear();
    cellAccumulated.m_samplesum.resize(sizeSamples,0);
    cellAccumulated.m_matrix.clear();
    cellAccumulated.m_matrix.resize(sizeSamples,0);
      }
      accuDigit = m_my_vec[hashid];
      
      unsigned int l= 0;
      for(unsigned int j=0;j<sizeSamples;j++){
    cellAccumulated.m_samplesum[j] += digit->samples()[j];
    for(unsigned int k=j;k<sizeSamples;k++)
      {
        l=k-j;
        cellAccumulated.m_matrix[l] += digit->samples()[j]*digit->samples()[k];
        //      std::cout << "accumulation, l =  "<< l << ", j = "<< j << ", k = "<< k << ", matrix = "<< cellAccumulated.m_matrix[l] <<", sum = "<< cellAccumulated.m_samplesum <<  std::endl;
        l++;
      }
      }
 
      //ATH_MSG_DEBUG( "Sum = " << cellAccumulated.m_samplesum  );
      //ATH_MSG_DEBUG( "Matrix = " << cellAccumulated.m_matrix[0]  );
 
      // when reached total number of triggers for this step, fill LArAccumulatedDigit and reset number of triggers
      
      unsigned int ntrigUsed = m_NtriggersPerStep;
      if ( m_isSC && m_DropPercentTrig != 0 ){
    ntrigUsed -= ntrigUsed*(m_DropPercentTrig/100);    
      }
 
      if(cellAccumulated.m_ntrigger==ntrigUsed){
 
    ATH_MSG_DEBUG( "filling LArAccumulatedDigit "  );
    ATH_MSG_DEBUG( "chid = " << chid << ", gain = " << gain << ", trigPerStep = " << m_NtriggersPerStep  );
    
    accuDigit->setAddSubStep(gain,chid,cellAccumulated.m_samplesum,cellAccumulated.m_matrix,ntrigUsed);
      
    larAccuDigitContainer->push_back(accuDigit);
 
    cellAccumulated.m_nused = cellAccumulated.m_ntrigger;
    cellAccumulated.m_ntrigger = 0;
 
      }
      
    }// loop over cells in container
 
    ATH_MSG_DEBUG( "Finished loop over channels "  );
 
    const std::string SGkey=key+m_AccuDigitContainerName;
    ATH_CHECK( evtStore()->record(std::move(larAccuDigitContainer),SGkey,false) );
    ATH_MSG_INFO( "Recorded succesfully LArAccumulatedDigitContainer with key " << SGkey   );
    
 
  } // loop over key container
  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 LArDigitsAccumulator::finalize

(

)

Definition at line 202 of file LArDigitsAccumulator.cxx.

                                         {
 
  if ( !m_isSC ) return StatusCode::SUCCESS;
  int ntrigUsed = m_NtriggersPerStep - m_NtriggersPerStep*(m_DropPercentTrig/100);
  for(auto &sc : m_Accumulated){
    if(sc.m_onlineId && sc.m_nused != ntrigUsed){
      ATH_MSG_WARNING("Not enough triggers for channel OnlineID " << sc.m_onlineId << " ntriggers " << sc.m_ntrigger );
    }
  }
 
  return StatusCode::SUCCESS;
 
}

initialize()

StatusCode LArDigitsAccumulator::initialize

(

)

Definition at line 31 of file LArDigitsAccumulator.cxx.

{
  StatusCode sc;
  if(m_isSC){
     const LArOnline_SuperCellID *scid;
     sc = detStore()->retrieve(scid, "LArOnline_SuperCellID");
     if (sc.isFailure()) {
        ATH_MSG_ERROR( "Could not get LArOnline_SuperCellID helper !" );
        return sc;
     } else {
        m_onlineHelper = static_cast<const LArOnlineID_Base*>(scid);
        ATH_MSG_DEBUG("Found the LArOnlineID helper");
     }
  } else { 
     const LArOnlineID* ll;
     sc = detStore()->retrieve(ll, "LArOnlineID");
     if (sc.isFailure()) {
        ATH_MSG_ERROR( "Could not get LArOnlineID helper !" );
        return sc;
     } else {
        m_onlineHelper = static_cast<const LArOnlineID_Base*>(ll);
        ATH_MSG_DEBUG(" Found the LArOnlineID helper. ");
     }
  } //m_isSC
 
  m_Accumulated.resize(m_onlineHelper->channelHashMax());
  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();
  }

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_AccuDigitContainerName

std::string LArDigitsAccumulator::m_AccuDigitContainerName

private

LArAccumulatedDigitContainer name.

Definition at line 60 of file LArDigitsAccumulator.h.

m_Accumulated

std::vector<LArAccumulated> LArDigitsAccumulator::m_Accumulated

private

Vector (index=hash ID) of accumulation quantities.

Definition at line 88 of file LArDigitsAccumulator.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_DropPercentTrig

double LArDigitsAccumulator::m_DropPercentTrig

private

Percentage of the used triggers that we will skip over at the end, in order ot ensure that the accumulation is done, even if there are lots of missing events from SC.

Definition at line 82 of file LArDigitsAccumulator.h.

m_event_counter

unsigned int LArDigitsAccumulator::m_event_counter

private

Event counter.

Definition at line 93 of file LArDigitsAccumulator.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_isSC

bool LArDigitsAccumulator::m_isSC

private

Tells you wether you run on SuperCells or Cells.

Definition at line 98 of file LArDigitsAccumulator.h.

m_keylist

std::vector<std::string> LArDigitsAccumulator::m_keylist

private

list of key for input digit container (=gain)

Definition at line 65 of file LArDigitsAccumulator.h.

m_my_vec

ACCUMDIGIT_VEC LArDigitsAccumulator::m_my_vec

private

Definition at line 55 of file LArDigitsAccumulator.h.

m_nStepTrigger

unsigned int LArDigitsAccumulator::m_nStepTrigger

private

Number of steps.

Definition at line 75 of file LArDigitsAccumulator.h.

m_NtriggersPerStep

unsigned int LArDigitsAccumulator::m_NtriggersPerStep

private

Number of triggers per step.

Definition at line 70 of file LArDigitsAccumulator.h.

m_onlineHelper

const LArOnlineID_Base* LArDigitsAccumulator::m_onlineHelper

private

Definition at line 52 of file LArDigitsAccumulator.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:

• LArDigitsAccumulator.h
• LArDigitsAccumulator.cxx