LArPedestalMaker Class Reference

#include <LArPedestalMaker.h>

Inheritance diagram for LArPedestalMaker:

Collaboration diagram for LArPedestalMaker:

Public Member Functions
	LArPedestalMaker (const std::string &name, ISvcLocator *pSvcLocator)
	~LArPedestalMaker ()
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< LArPedestal >	LARPEDMAP
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
std::vector< std::string >	m_keylist
std::string	m_keyoutput
std::string	m_groupingType
int	m_nref
double	m_rms_cut
int	m_which_sample
int	m_sample_min
int	m_sample_max
LARPEDMAP	m_pedestal
std::vector< float >	m_mean
std::vector< float >	m_rms
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 34 of file LArPedestalMaker.h.

Member Typedef Documentation

LARPEDMAP

typedef LArConditionsContainer<LArPedestal> LArPedestalMaker::LARPEDMAP

private

Definition at line 77 of file LArPedestalMaker.h.

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

LArPedestalMaker()

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

Definition at line 33 of file LArPedestalMaker.cxx.

  : AthAlgorithm(name, pSvcLocator),
    m_groupingType("SubDetector") // SubDetector, Single, FeedThrough
{
  m_nref = 50;
  m_rms_cut = 5.0;
  declareProperty("KeyList",         m_keylist);
  declareProperty("KeyOutput",       m_keyoutput="LArPedestal");
  declareProperty("events_ref",      m_nref);
  declareProperty("nsigma",          m_rms_cut);
  declareProperty("which_sample",    m_which_sample=-1);
  declareProperty("sample_min",      m_sample_min=-1);
  declareProperty("sample_max",      m_sample_max=-1);
  declareProperty("GroupingType",    m_groupingType); 
}

~LArPedestalMaker()

LArPedestalMaker::~LArPedestalMaker ( )

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

(

)

Definition at line 74 of file LArPedestalMaker.cxx.

{
  if (m_keylist.empty()) {
    ATH_MSG_ERROR ( "Key list is empty! No containers to process!" );
    return StatusCode::FAILURE;
  } 
  const LArDigitContainer* larDigitContainer = nullptr;
 
  for (const std::string& key : m_keylist) {
    StatusCode sc= evtStore()->retrieve(larDigitContainer,key);
    if (sc.isFailure() || !larDigitContainer) {
      ATH_MSG_DEBUG ( "Cannot read LArCalibDigitContainer from StoreGate! key=" << key );
      continue;
    }
    if(larDigitContainer->empty()) {
      ATH_MSG_DEBUG ( "Got empty LArDigitContainer (key=" << key << ")." );
      continue;
    }
    for (const LArDigit* digit : *larDigitContainer) {
      const HWIdentifier chid=digit->hardwareID();
      const CaloGain::CaloGain gain=digit->gain();
      //LArPedestal& thisPed=m_pedestal[gain][chid];
      LArPedestal& thisPed=m_pedestal.get(chid,gain);
      //log << MSG::DEBUG << "Cell: " << icell << " with gain " << gain << endmsg;
      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();
      if (thisPed.get_max()!=-1) //Have already boundaries set
    {//Check samples are in range
      std::vector<short>::const_iterator s_it=samples.begin();
      std::vector<short>::const_iterator s_it_e=samples.end();
      const short& min=thisPed.get_min();
      const short& max=thisPed.get_max();
      for (;s_it!=s_it_e && *s_it>=min && *s_it<=max;++s_it)
            ; //Loop over samples to check....
      if (s_it==s_it_e) //Reached end of loop?
        thisPed.add(samples);
    }
      else {//number of entries smaller or equal to than m_nref
    thisPed.add(samples);
    if (thisPed.get_nentries()==m_nref && m_nref>0) { //Set window size
      const double mean  = thisPed.get_mean();
      const double noise = thisPed.get_rms();
      const short min = (short)floor(mean - m_rms_cut*noise);
      const short max =  (short)ceil(mean + m_rms_cut*noise);
      thisPed.set_min(min);
      thisPed.set_max(max);
      thisPed.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 LArPedestalMaker::finalize ( )

inline

Definition at line 53 of file LArPedestalMaker.h.

{return StatusCode::SUCCESS;}

initialize()

StatusCode LArPedestalMaker::initialize

(

)

Definition at line 52 of file LArPedestalMaker.cxx.

{
  ATH_MSG_INFO ( ">>> Initialize" );
 
  m_mean.resize(1);
  m_rms.resize(1);  
  
 // m_fullFolderName="/lar/"+m_folderName+"/LArPedestal";
 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....
   }
  //m_EventCounters.resize(CaloGain::LARNGAIN,0); //Initialize Event counters, one per container
 m_pedestal.setGroupingType(LArConditionsContainerBase::SingleGroup);
 ATH_CHECK( m_pedestal.initialize() );
 return StatusCode::SUCCESS;
}

inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

msg()

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 LArPedestalMaker::stop

(

)

Definition at line 134 of file LArPedestalMaker.cxx.

{
  ATH_MSG_INFO ( ">>> Stop" );
 
  if (m_keylist.empty()) {
    ATH_MSG_ERROR ( "Key list is empty! No containers processed!" );
    return StatusCode::FAILURE;
  } 
  
  // Create the LArPedestalComplete object
  auto larPedestalComplete = std::make_unique<LArPedestalComplete>();
 
  ATH_CHECK( larPedestalComplete->setGroupingType(m_groupingType,msg()) );
  ATH_CHECK( larPedestalComplete->initialize() );
 
 //Outermost loop goes over all gains (different containers).
 for (int gain=0;gain<(int)CaloGain::LARNGAIN;gain++) {
   //log << MSG::INFO << "Gain " << gain << ", m_pedestal size for this gain = " <<  m_pedestal[gain].size() << endmsg;
 
   LARPEDMAP::ConditionsMapIterator cell_it=m_pedestal.begin(gain);
   LARPEDMAP::ConditionsMapIterator cell_it_e=m_pedestal.end(gain);
 
   //Inner loop goes over the cells.
   int n_zero,n_min, n_max, n_cur;
   n_zero=0; n_max=n_min=-1;
   for (;cell_it!=cell_it_e;cell_it++) {
     // Check number of entries
     LArPedestal thisPed=*cell_it;
     if(thisPed.get_nentries()==0) { n_zero++; continue; }
     // Get the mean and rms
      if (m_sample_min >=0 ) {
    m_mean[0] = thisPed.get_mean(m_sample_min, m_sample_max);
    m_rms[0]  = thisPed.get_rms(m_sample_max, m_sample_max);
      }
      else if (m_which_sample==-1 || m_which_sample>=(int)thisPed.get_nsamples()) {
    m_mean[0] = thisPed.get_mean();
    m_rms[0]  = thisPed.get_rms();
      }
      else {
    m_mean[0] = thisPed.get_mean(m_which_sample);
    m_rms[0]  = thisPed.get_rms(m_which_sample);
      }
      n_cur = thisPed.get_nentries();
      if(n_cur<n_min || n_min<0) n_min=n_cur;
      if(n_cur>n_max || n_max<0) n_max=n_cur;
 
     HWIdentifier ch_id = cell_it.channelId();
        
     // Fill the data class with pedestal and rms values
     if (ch_id!=0)
       larPedestalComplete->set(ch_id,gain,m_mean[0],m_rms[0]);
   }
 
   ATH_MSG_INFO ( "Gain " << gain << " Number of cells with 0 events to compute pedestal: " <<  n_zero );
   ATH_MSG_INFO ( "Gain " << gain << " Minimum number of events|samples to compute pedestal: " <<  n_min );
   ATH_MSG_INFO ( "Gain " << gain << " Maximum number of events|samples to compute pedestal: " <<  n_max );
 }
 
 ATH_MSG_INFO ( " Summary : Number of cells with a pedestal value computed : " << larPedestalComplete->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 LArPedestalComplete
 ATH_CHECK( detStore()->record(std::move(larPedestalComplete),m_keyoutput) );
 
 ATH_MSG_INFO ( ">>> End of finalize" );
 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_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 LArPedestalMaker::m_groupingType

private

Definition at line 61 of file LArPedestalMaker.h.

m_keylist

std::vector<std::string> LArPedestalMaker::m_keylist

private

Definition at line 57 of file LArPedestalMaker.h.

m_keyoutput

std::string LArPedestalMaker::m_keyoutput

private

Definition at line 58 of file LArPedestalMaker.h.

m_mean

std::vector<float> LArPedestalMaker::m_mean

private

Definition at line 81 of file LArPedestalMaker.h.

m_nref

int LArPedestalMaker::m_nref

private

Definition at line 64 of file LArPedestalMaker.h.

m_pedestal

LARPEDMAP LArPedestalMaker::m_pedestal

private

Definition at line 78 of file LArPedestalMaker.h.

m_rms

std::vector<float> LArPedestalMaker::m_rms

private

Definition at line 82 of file LArPedestalMaker.h.

m_rms_cut

double LArPedestalMaker::m_rms_cut

private

Definition at line 67 of file LArPedestalMaker.h.

m_sample_max

int LArPedestalMaker::m_sample_max

private

Definition at line 73 of file LArPedestalMaker.h.

m_sample_min

int LArPedestalMaker::m_sample_min

private

Definition at line 72 of file LArPedestalMaker.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.

m_which_sample

int LArPedestalMaker::m_which_sample

private

Definition at line 70 of file LArPedestalMaker.h.

---

The documentation for this class was generated from the following files:

• LArPedestalMaker.h
• LArPedestalMaker.cxx