MergeGenericMuonSimHitCollTool Class Reference

an algorithm to merge MC track record collTool in the overlay store More...

#include <MergeGenericMuonSimHitCollTool.h>

Inheritance diagram for MergeGenericMuonSimHitCollTool:

Collaboration diagram for MergeGenericMuonSimHitCollTool:

Public Member Functions
	MergeGenericMuonSimHitCollTool (const std::string &type, const std::string &name, const IInterface *parent)
virtual StatusCode	initialize () override final
	called before the event loop
virtual StatusCode	prepareEvent (const EventContext &ctx, unsigned int nInputEvents) override final
	called before the subevts loop.
virtual StatusCode	mergeEvent (const EventContext &ctx) override final
	called at the end of the subevts loop.
virtual StatusCode	processBunchXing (int bunchXing, SubEventIterator bSubEvents, SubEventIterator eSubEvents) override final
	called for each active bunch-crossing to process current SubEvents bunchXing is in ns
virtual StatusCode	processAllSubEvents (const EventContext &ctx) override final
	return false if not interested in certain xing times (in ns) implemented by default in PileUpToolBase as FirstXing<=bunchXing<=LastXing

Private Member Functions
virtual void	processGenericMuonSimHitColl (const GenericMuonSimHitCollection *inputCollection, GenericMuonSimHitCollection *outputCollection, const double &timeOfBCID)
	share code between two approaches

Private Attributes
ServiceHandle< PileUpMergeSvc >	m_pMergeSvc
bool	m_firstSubEvent
std::vector< GenericMuonSimHitCollection * >	m_outputContainers
StringArrayProperty	m_SimHitContainerNamesProp
std::vector< std::string >	m_SimHitContainerNames

structors and AlgTool implementation
virtual bool	toProcess (int bunchXing) const override
	the method this base class helps implementing
virtual bool	filterPassed () const override
	dummy implementation of passing filter
virtual void	resetFilter () override
	dummy implementation of filter reset
Gaudi::Property< int >	m_firstXing
Gaudi::Property< int >	m_lastXing
Gaudi::Property< int >	m_vetoPileUpTruthLinks
bool	m_filterPassed {true}

Detailed Description

an algorithm to merge MC track record collTool in the overlay store

$Id:

Author

DCost.nosp@m.anzo.nosp@m.@bnl..nosp@m.gov (from Paolo's MergeMcEventCollTool)

Definition at line 25 of file MergeGenericMuonSimHitCollTool.h.

Constructor & Destructor Documentation

MergeGenericMuonSimHitCollTool()

MergeGenericMuonSimHitCollTool::MergeGenericMuonSimHitCollTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

Definition at line 9 of file MergeGenericMuonSimHitCollTool.cxx.

                                                                                         :
  PileUpToolBase(type, name, parent),
  m_pMergeSvc("PileUpMergeSvc", name),
  m_firstSubEvent(true)
{
  declareProperty("SimHitContainerNames",  m_SimHitContainerNamesProp);
}

Member Function Documentation

filterPassed()

virtual bool PileUpToolBase::filterPassed ( ) const

inlineoverridevirtualinherited

dummy implementation of passing filter

Definition at line 49 of file PileUpToolBase.h.

{ return m_filterPassed; }

initialize()

StatusCode MergeGenericMuonSimHitCollTool::initialize ( )

finaloverridevirtual

called before the event loop

Reimplemented from PileUpToolBase.

Definition at line 19 of file MergeGenericMuonSimHitCollTool.cxx.

                                                      {
  ATH_MSG_VERBOSE ( "initialize()" );
  // list of CaloCalibrationHit containers
  if (m_SimHitContainerNamesProp.value().empty()) {
    m_SimHitContainerNames.reserve(2);
    m_SimHitContainerNames.push_back("MM_Hits");
    m_SimHitContainerNames.push_back("sTGC_Hits");
  }
  else {
    m_SimHitContainerNames = m_SimHitContainerNamesProp.value();
  }
  m_outputContainers.reserve(m_SimHitContainerNames.size());
  return StatusCode::SUCCESS;
}

mergeEvent()

StatusCode MergeGenericMuonSimHitCollTool::mergeEvent ( const EventContext & ctx )

finaloverridevirtual

called at the end of the subevts loop.

Not (necessarily) able to access SubEvents

Definition at line 77 of file MergeGenericMuonSimHitCollTool.cxx.

                                                                           {
  for (unsigned int iHitContainer=0;iHitContainer<m_SimHitContainerNames.size();++iHitContainer) {
    if ( m_outputContainers[iHitContainer]==0 ) { continue; } //don't bother recording unused containers!
    if (!(evtStore()->record(m_outputContainers[iHitContainer],m_SimHitContainerNames[iHitContainer]).isSuccess())) {
      ATH_MSG_ERROR ( " Cannot record new GenericMuonSimHitCollection in overlayed event " );
      return StatusCode::FAILURE;
    }
  }   // end of loop over the various types of calo calibration hits
  return StatusCode::SUCCESS;
}

prepareEvent()

StatusCode MergeGenericMuonSimHitCollTool::prepareEvent ( const EventContext & ctx, unsigned int nInputEvents )

finaloverridevirtual

called before the subevts loop.

Not (necessarily) able to access SubEvents

Definition at line 34 of file MergeGenericMuonSimHitCollTool.cxx.

                                                                                                        {
  ATH_MSG_DEBUG ( "Calling prepareEvent()" );
  ATH_MSG_DEBUG( "prepareEvent: there are " << nInputEvents << " subevents in this event.");
  m_firstSubEvent = true;
  //clean up pointers from the last event
  m_outputContainers.clear();
  for (unsigned int iHitContainer=0;iHitContainer<m_SimHitContainerNames.size(); ++iHitContainer) {
    m_outputContainers.push_back(NULL);
  }
  return StatusCode::SUCCESS;
}

processAllSubEvents()

StatusCode MergeGenericMuonSimHitCollTool::processAllSubEvents ( const EventContext & ctx )

finaloverridevirtual

return false if not interested in certain xing times (in ns) implemented by default in PileUpToolBase as FirstXing<=bunchXing<=LastXing

Merge the GenericMuonSimHitColl

Reimplemented from PileUpToolBase.

Definition at line 88 of file MergeGenericMuonSimHitCollTool.cxx.

{
  ATH_MSG_VERBOSE ( "processAllSubEvents()" );
  if(!m_pMergeSvc) {
    if (!(m_pMergeSvc.retrieve()).isSuccess()) {
      ATH_MSG_FATAL ( "processAllSubEvents: Could not find PileUpMergeSvc" );
      return StatusCode::FAILURE;
    }
  }
 
  // loop over containers
  for (unsigned int iHitContainer=0;iHitContainer<m_SimHitContainerNames.size();iHitContainer++) {
 
    ATH_MSG_DEBUG(" Process CalibrationHit container " << m_SimHitContainerNames[iHitContainer]);
    typedef PileUpMergeSvc::TimedList<GenericMuonSimHitCollection>::type SimHitList;
    SimHitList simHitList;
    if ( (m_pMergeSvc->retrieveSubEvtsData(m_SimHitContainerNames[iHitContainer], simHitList)).isSuccess() ) {
      GenericMuonSimHitCollection* newContainer = new GenericMuonSimHitCollection(m_SimHitContainerNames[iHitContainer]);
      if (!simHitList.empty()) {
        //now merge all collections into one
        SimHitList::const_iterator simHitColl_iter(simHitList.begin());
        const SimHitList::const_iterator endOfSimHitColls(simHitList.end());
        while (simHitColl_iter!=endOfSimHitColls) {
          const double timeOfBCID(static_cast<double>((simHitColl_iter)->first.time()));
          this->processGenericMuonSimHitColl(&(*((simHitColl_iter)->second)), m_outputContainers[iHitContainer], timeOfBCID);
        }
      }
      // record new container in overlayed event
      if (!(evtStore()->record(newContainer,m_SimHitContainerNames[iHitContainer]).isSuccess())) {
        ATH_MSG_ERROR(" Cannot record new GenericMuonSimHitCollection in overlayed event ");
        delete newContainer;
        return StatusCode::FAILURE;
      }
    }
  }   // end of loop over the various types of calo calibration hits
  return StatusCode::SUCCESS;
}

processBunchXing()

StatusCode MergeGenericMuonSimHitCollTool::processBunchXing ( int bunchXing, SubEventIterator bSubEvents, SubEventIterator eSubEvents )

finaloverridevirtual

called for each active bunch-crossing to process current SubEvents bunchXing is in ns

Reimplemented from PileUpToolBase.

Definition at line 45 of file MergeGenericMuonSimHitCollTool.cxx.

{
  StatusCode sc(StatusCode::SUCCESS);
  //if this is the first SubEvent for this Event then create the hitContainers;
  ATH_MSG_VERBOSE ( "processBunchXing()" );
  SubEventIterator iEvt(bSubEvents);
  while (iEvt != eSubEvents) {
    // loop over containers
    for (unsigned int iHitContainer=0;iHitContainer<m_SimHitContainerNames.size();++iHitContainer) {
      ATH_MSG_VERBOSE ( " Bunch Crossing: " <<bunchXing << ". Process GenericMuonSimHitCollection " << m_SimHitContainerNames[iHitContainer] );
      const GenericMuonSimHitCollection* hitCont = nullptr;
      if (!m_pMergeSvc->retrieveSingleSubEvtData(m_SimHitContainerNames[iHitContainer], hitCont,
                         bunchXing, iEvt).isSuccess()){
    ATH_MSG_ERROR("GenericMuonSimHitCollection not found for event key " << m_SimHitContainerNames[iHitContainer]);
    return StatusCode::FAILURE;
      }
 
      //if this is the first SubEvent for this Event then create the hitContainers;
      if(m_firstSubEvent) {
        m_outputContainers[iHitContainer] = new GenericMuonSimHitCollection(m_SimHitContainerNames[iHitContainer]);
      }
      const double timeOfBCID(static_cast<double>(iEvt->time()));
      this->processGenericMuonSimHitColl(hitCont, m_outputContainers[iHitContainer], timeOfBCID);
    }
    ++iEvt;
    m_firstSubEvent=false;
  }
  return sc;
}

processGenericMuonSimHitColl()

void MergeGenericMuonSimHitCollTool::processGenericMuonSimHitColl ( const GenericMuonSimHitCollection * inputCollection, GenericMuonSimHitCollection * outputCollection, const double & timeOfBCID )

privatevirtual

share code between two approaches

Definition at line 126 of file MergeGenericMuonSimHitCollTool.cxx.

{
  for (GenericMuonSimHitCollection::const_iterator simhitIter = inputCollection->begin(); simhitIter != inputCollection->end(); ++simhitIter) {
    const int idHit = simhitIter->GenericId();
    outputCollection->Emplace(idHit, simhitIter->globalTime()+timeOfBCID, simhitIter->globalpreTime()+timeOfBCID, simhitIter->globalPosition(), simhitIter->localPosition(), simhitIter->globalPrePosition(),simhitIter->localPrePosition(), simhitIter->particleEncoding(),simhitIter->kineticEnergy(), simhitIter->globalDirection(),simhitIter->depositEnergy(), simhitIter->StepLength(),simhitIter->truthBarcode() );
  }
  return;
}

resetFilter()

virtual void PileUpToolBase::resetFilter ( )

inlineoverridevirtualinherited

dummy implementation of filter reset

Reimplemented in MergeTruthJetsTool.

Definition at line 51 of file PileUpToolBase.h.

{ m_filterPassed=true; }

toProcess()

virtual bool PileUpToolBase::toProcess ( int bunchXing ) const

inlineoverridevirtualinherited

the method this base class helps implementing

Reimplemented in MergeHijingParsTool, and MergeTrackRecordCollTool.

Definition at line 32 of file PileUpToolBase.h.

                                                       {
    //closed interval [m_firstXing,m_lastXing]
    return !((m_firstXing > bunchXing) || (bunchXing > m_lastXing));
  }

Member Data Documentation

m_filterPassed

bool PileUpToolBase::m_filterPassed {true}

protectedinherited

Definition at line 60 of file PileUpToolBase.h.

{true}; 

m_firstSubEvent

bool MergeGenericMuonSimHitCollTool::m_firstSubEvent

private

Definition at line 52 of file MergeGenericMuonSimHitCollTool.h.

m_firstXing

Gaudi::Property<int> PileUpToolBase::m_firstXing

protectedinherited

Initial value:

{this, "FirstXing", -999,
      "First bunch-crossing in which det is live"}

Definition at line 54 of file PileUpToolBase.h.

                                {this, "FirstXing", -999,
      "First bunch-crossing in which det is live"};

m_lastXing

Gaudi::Property<int> PileUpToolBase::m_lastXing

protectedinherited

Initial value:

{this, "LastXing", 999,
      "Last bunch-crossing in which det is live"}

Definition at line 56 of file PileUpToolBase.h.

                                {this, "LastXing", 999,
      "Last bunch-crossing in which det is live"};

m_outputContainers

std::vector<GenericMuonSimHitCollection*> MergeGenericMuonSimHitCollTool::m_outputContainers

private

Definition at line 53 of file MergeGenericMuonSimHitCollTool.h.

m_pMergeSvc

ServiceHandle<PileUpMergeSvc> MergeGenericMuonSimHitCollTool::m_pMergeSvc

private

Definition at line 51 of file MergeGenericMuonSimHitCollTool.h.

m_SimHitContainerNames

std::vector<std::string> MergeGenericMuonSimHitCollTool::m_SimHitContainerNames

private

Definition at line 55 of file MergeGenericMuonSimHitCollTool.h.

m_SimHitContainerNamesProp

StringArrayProperty MergeGenericMuonSimHitCollTool::m_SimHitContainerNamesProp

private

Definition at line 54 of file MergeGenericMuonSimHitCollTool.h.

m_vetoPileUpTruthLinks

Gaudi::Property<int> PileUpToolBase::m_vetoPileUpTruthLinks

protectedinherited

Initial value:

{this, "VetoPileUpTruthLinks", true,
      "Ignore links to suppressed pile-up truth"}

Definition at line 58 of file PileUpToolBase.h.

                                           {this, "VetoPileUpTruthLinks", true,
      "Ignore links to suppressed pile-up truth"};

---

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

• MergeGenericMuonSimHitCollTool.h
• MergeGenericMuonSimHitCollTool.cxx