LArCalibDigitMaker Class Reference

#include <LArCalibDigitMaker.h>

Inheritance diagram for LArCalibDigitMaker:

Collaboration diagram for LArCalibDigitMaker:

Public Member Functions
	LArCalibDigitMaker (const std::string &name, ISvcLocator *pSvcLocator)
	~LArCalibDigitMaker ()
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 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< LArCalibLineMapping >	m_calibMapKey {this,"CalibMapKey","LArCalibLineMap","SG Key of calib line mapping object"}
SG::ReadCondHandleKey< LArCalibLineMapping >	m_calibMapSCKey {this,"CalibMapSCKey","LArCalibIdMapSC","SG Key of calib line mapping object"}
std::vector< std::string >	m_keylist
std::vector< std::vector< double > >	m_vPattern
std::vector< std::vector< double > >	m_vDAC
std::vector< unsigned >	m_vDelay
std::vector< int >	m_nPatterns
std::vector< std::vector< double > >	m_vBoardIDs
unsigned	m_nTrigger
double	m_delayScale
bool	m_dontRun
bool	m_isSC
int	m_eventNb = 0
bool	m_skipDuplicates
std::vector< HWIdentifier >	m_pulsedChids
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 13 of file LArCalibDigitMaker.h.

Member Typedef Documentation

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

LArCalibDigitMaker()

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

Definition at line 23 of file LArCalibDigitMaker.cxx.

  : AthAlgorithm(name, pSvcLocator),
    m_nTrigger(0)
{
  //declareProperty("DigitKey",m_key="");
 declareProperty("KeyList",m_keylist);
 declareProperty("DAC",m_vDAC);
 declareProperty("Delay",m_vDelay);
 declareProperty("Pattern",m_vPattern);
 declareProperty("nPattern",m_nPatterns);
 declareProperty("NTrigger",m_nTrigger);
 declareProperty("BoardIDs",m_vBoardIDs);
 declareProperty("DelayScale",m_delayScale=(25./240.)*ns);
 declareProperty("DontRun",m_dontRun=false); //Put only Board configuration in DetectorStore
 declareProperty("isSC",m_isSC=false);
 declareProperty("skipDuplicates",m_skipDuplicates=false);
}

~LArCalibDigitMaker()

LArCalibDigitMaker::~LArCalibDigitMaker

(

)

Definition at line 41 of file LArCalibDigitMaker.cxx.

{//empty
}

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

(

)

Definition at line 116 of file LArCalibDigitMaker.cxx.

                                       {
 
 if (m_dontRun) return StatusCode::SUCCESS;
 
 const EventContext& ctx = Gaudi::Hive::currentContext();
 
 
 const LArCalibLineMapping *clcabling=nullptr;
 if(m_isSC) {
   ATH_MSG_DEBUG ( "======== LArCalibDigitMaker: using SC calib line map" );
   SG::ReadCondHandle<LArCalibLineMapping> clHdl{m_calibMapSCKey};
   clcabling=*clHdl;
 } else {
   SG::ReadCondHandle<LArCalibLineMapping> clHdl{m_calibMapKey};
   clcabling=*clHdl;
 }
 
 
 if(!clcabling) {
    ATH_MSG_ERROR( "Do not have cabling mapping from key " << m_calibMapKey.key() );
    return StatusCode::FAILURE;
 }
 
 const unsigned eventNb=(ctx.eventID().event_number())&0xffffff ;        // Are we sure?
 
 ATH_MSG_DEBUG ( "======== executing event "<< eventNb << " ========" );
 
 const LArCalibParams* calibParams = nullptr;
 ATH_CHECK( detStore()->retrieve(calibParams,"LArCalibParams") );
 
 for (const std::string& key : m_keylist) { //Loop over all containers that are to be processed (e.g. different gains)
   ATH_MSG_DEBUG ( "Retrieving LArDigitContainer. Key= " << key );
   const LArDigitContainer* larDigitCont;
   StatusCode sc = evtStore()->retrieve(larDigitCont,key);
   if (sc.isFailure())  {
     ATH_MSG_DEBUG ( "Cannot read LArDigitContainer from StoreGate! key=" << key );
     continue; //Try next container
   }
   if (larDigitCont->empty()) {
     ATH_MSG_DEBUG ( "LArDigitContainer with key '" << key << "' is empty. Ignored." );
     continue; //Try next container
   }
   if (!m_pulsedChids.empty()) m_pulsedChids.clear();
   //Iterate over LArDigitContainer and build LArCalibDigitContainer
   auto calibDigitContainer=std::make_unique<LArCalibDigitContainer>();
   calibDigitContainer->setDelayScale(m_delayScale);
   for (const LArDigit* digit : *larDigitCont) {
     HWIdentifier chid=digit->hardwareID();
     
     if(std::find(m_pulsedChids.begin(), m_pulsedChids.end(), chid) != m_pulsedChids.end()) {
       if(m_skipDuplicates) continue; // skip this channel if it was already pulsed
       m_pulsedChids.push_back(chid);
     }
 
     //Get data members of LArDigit
     const std::vector<short>& samples=digit->samples();
     CaloGain::CaloGain gain=digit->gain();
     const std::vector<HWIdentifier>& calibChannelIDs=clcabling->calibSlotLine(chid);
     if (calibChannelIDs.empty()) {
       continue; //Disconnected channel
     }
     //For the time being, I assume we are in H8 and have only one calib channel per FEB channel
     std::vector<HWIdentifier>::const_iterator csl_it=calibChannelIDs.begin();
     //Now the CalibBoard settings:
     //Get data to build LArCalibDigit:
     unsigned ddac=calibParams->DAC(eventNb,*csl_it);
     if(ddac==kmaxDAC) {
        ATH_MSG_WARNING("SKIP "<<chid<<" "<<gain<<" "<<ddac<<"  event no "<<eventNb);
        continue;
     }
     uint16_t dac=ddac;
     uint16_t delay=calibParams->Delay(eventNb,*csl_it);
 
     bool ispulsed=false;
     for(; csl_it != calibChannelIDs.end(); ++csl_it) {
       if(calibParams->isPulsed(eventNb,*csl_it)){
     ispulsed=true;
     break;
       }
     }
     //build LArCalibDigit:
     if ( ispulsed ){
       ATH_MSG_VERBOSE("HERE!! "<<chid<<" "<<gain<<" "<<dac<<" "<<delay<<" "<<ispulsed<<" event no "<<eventNb<<" "<<calibChannelIDs.size()<<" calib lines, first is "<<*csl_it);
 
     }
     LArCalibDigit* calibDigit=new LArCalibDigit(chid,gain, samples, dac, delay, ispulsed);
     calibDigitContainer->push_back(calibDigit);
   } //End iteration to build calibDigits
   ATH_MSG_DEBUG("Trying to store with key "<<key);
   ATH_CHECK( evtStore()->record(std::move(calibDigitContainer),key) );
   ATH_MSG_DEBUG ("LArCalibDigitContainer recorded to StoreGate. key=" << key );
 } //End loop key list
 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 LArCalibDigitMaker::finalize ( )

inline

Definition at line 23 of file LArCalibDigitMaker.h.

{return StatusCode::SUCCESS;}

initialize()

StatusCode LArCalibDigitMaker::initialize

(

)

Definition at line 45 of file LArCalibDigitMaker.cxx.

{
 
  //m_oldeventNb=-999;
  m_eventNb=-1;
 
  ATH_MSG_DEBUG ( "======== LArCalibDigitMaker Initialize ========" );
  // bool containsKeySC = false;
  for (unsigned int i = 0; i < m_keylist.size(); ++i) {
    if (m_keylist.at(i).compare("SC") == 0) {
       m_isSC = true;
       ATH_MSG_DEBUG ( "======== LArCalibDigitMaker isSC is True  ========" );
    }
  }
  ATH_CHECK( m_calibMapSCKey.initialize(m_isSC) );
  ATH_CHECK( m_calibMapKey.initialize(!m_isSC) );
    
  //if we have calib board params as jobOpts, set them
 
  std::vector<std::vector<unsigned>> theseBoardIDs;
  std::vector<std::vector<unsigned>> thesePatterns;
  std::vector<std::vector<unsigned>> theseDACs;
  theseBoardIDs.reserve(m_vBoardIDs.size());
  thesePatterns.reserve(m_vPattern.size());
  theseDACs.reserve(m_vDAC.size());
  for (const auto& elem : m_vBoardIDs) {
    theseBoardIDs.emplace_back(elem.begin(), elem.end());
  }
  for (const auto& elem : m_vPattern) {
    thesePatterns.emplace_back(elem.begin(), elem.end());
  }
  for (const auto& elem : m_vDAC) {
    theseDACs.emplace_back(elem.begin(), elem.end());
  }
  std::vector<unsigned> cutPattern;
 
  auto calibParams = std::make_unique<LArCalibParams>();
  ATH_CHECK( calibParams->initialize() ); 
  for( long unsigned int i=0; i < theseBoardIDs.size(); i++ ){
    if (!theseBoardIDs[i].empty() && !m_vDAC[i].empty() && !m_vDelay.empty() && !thesePatterns[i].empty() && m_nTrigger) {
      cutPattern = thesePatterns[i];
 
      if (thesePatterns[i].size() != ((unsigned int)m_nPatterns[i])){
    ATH_MSG_WARNING("Going to change pattern length from "<<thesePatterns[i].size()<<" to "<<m_nPatterns[i]);
    cutPattern.resize(m_nPatterns[i]);
      }
      if (thesePatterns[i].size()%4) {
    ATH_MSG_ERROR ( "Problem with jobOptions! One Pattern must conists of 4 32bit values! Pattern "<< i );
    return StatusCode::FAILURE;
      }
      for (unsigned id : theseBoardIDs[i]) {
    const HWIdentifier calibBoardHWID(id);
    calibParams->set(calibBoardHWID,m_nTrigger,cutPattern,theseDACs[i],m_vDelay);
      }
    }
  }
 
  ATH_CHECK( detStore()->record(std::move(calibParams),"LArCalibParams") );
  // End set calib board parameters
 
  if (m_keylist.empty()) {
    m_keylist.emplace_back("HIGH");
    m_keylist.emplace_back("MEDIUM");
    m_keylist.emplace_back("LOW");
  }
 
  ATH_MSG_DEBUG ( "======== LArCalibDigitMaker initialize successfully ========" );
  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_calibMapKey

SG::ReadCondHandleKey<LArCalibLineMapping> LArCalibDigitMaker::m_calibMapKey {this,"CalibMapKey","LArCalibLineMap","SG Key of calib line mapping object"}

private

Definition at line 25 of file LArCalibDigitMaker.h.

{this,"CalibMapKey","LArCalibLineMap","SG Key of calib line mapping object"};

m_calibMapSCKey

SG::ReadCondHandleKey<LArCalibLineMapping> LArCalibDigitMaker::m_calibMapSCKey {this,"CalibMapSCKey","LArCalibIdMapSC","SG Key of calib line mapping object"}

private

Definition at line 26 of file LArCalibDigitMaker.h.

{this,"CalibMapSCKey","LArCalibIdMapSC","SG Key of calib line mapping object"};

m_delayScale

double LArCalibDigitMaker::m_delayScale

private

Definition at line 34 of file LArCalibDigitMaker.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_dontRun

bool LArCalibDigitMaker::m_dontRun

private

Definition at line 35 of file LArCalibDigitMaker.h.

m_eventNb

int LArCalibDigitMaker::m_eventNb = 0

private

Definition at line 37 of file LArCalibDigitMaker.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 LArCalibDigitMaker::m_isSC

private

Definition at line 36 of file LArCalibDigitMaker.h.

m_keylist

std::vector<std::string> LArCalibDigitMaker::m_keylist

private

Definition at line 27 of file LArCalibDigitMaker.h.

m_nPatterns

std::vector<int> LArCalibDigitMaker::m_nPatterns

private

Definition at line 31 of file LArCalibDigitMaker.h.

m_nTrigger

unsigned LArCalibDigitMaker::m_nTrigger

private

Definition at line 33 of file LArCalibDigitMaker.h.

m_pulsedChids

std::vector<HWIdentifier> LArCalibDigitMaker::m_pulsedChids

private

Definition at line 39 of file LArCalibDigitMaker.h.

m_skipDuplicates

bool LArCalibDigitMaker::m_skipDuplicates

private

Definition at line 38 of file LArCalibDigitMaker.h.

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vBoardIDs

std::vector<std::vector<double> > LArCalibDigitMaker::m_vBoardIDs

private

Definition at line 32 of file LArCalibDigitMaker.h.

m_vDAC

std::vector<std::vector<double> > LArCalibDigitMaker::m_vDAC

private

Definition at line 29 of file LArCalibDigitMaker.h.

m_vDelay

std::vector<unsigned> LArCalibDigitMaker::m_vDelay

private

Definition at line 30 of file LArCalibDigitMaker.h.

m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Algorithm > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

m_vPattern

std::vector<std::vector<double> > LArCalibDigitMaker::m_vPattern

private

Definition at line 28 of file LArCalibDigitMaker.h.

---

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

• LArCalibDigitMaker.h
• LArCalibDigitMaker.cxx