an algorithm to merge truth particles collections in the overlay store More...

#include <MergeTruthParticlesTool.h>

Inheritance diagram for MergeTruthParticlesTool:

Collaboration diagram for MergeTruthParticlesTool:

Public Member Functions
	MergeTruthParticlesTool (const std::string &type, const std::string &name, const IInterface *parent)

StatusCode	initialize () override final
	Initialize. More...

virtual StatusCode	prepareEvent (const EventContext &ctx, unsigned int nInputEvents) override final
	called before the subevts loop. More...

virtual StatusCode	mergeEvent (const EventContext &ctx) override final
	called at the end of the subevts loop. More...

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 More...

virtual StatusCode	processAllSubEvents (const EventContext &ctx) override final
	Merge the Truth TruthParticleContainers using the PileUpMergeSvc. More...

Private Member Functions
virtual StatusCode	processTruthParticleContainer (const xAOD::TruthParticleContainer inputTruthParticleContainer, xAOD::TruthParticleContainer outputTruthParticleContainer, int eventNumber)
	TruthParticleContainer Loop. More...

StatusCode	record (const xAOD::TruthParticleContainer *pTruthParticles, const std::string &truthParticleContainerName) const

Private Attributes
ServiceHandle< PileUpMergeSvc >	m_pMergeSvc {this, "PileUpMergeSvc", "PileUpMergeSvc", ""}

Gaudi::Property< std::string >	m_inputTruthParticleCollKey {this, "InputTruthParticleCollKey", "TruthPileupParticles", ""}

Gaudi::Property< std::string >	m_inTimeOutputTruthParticleCollKey {this, "InTimeOutputTruthParticleCollKey", "TruthPileupParticles", ""}

Gaudi::Property< bool >	m_includeSignalTruthParticles {this, "IncludeSignalTruthParticles", false, ""}

xAOD::TruthParticleContainer *	m_inTimeOutputTruthParticleContainer {}

bool	m_first_event {true}

structors and AlgTool implementation
virtual bool	toProcess (int bunchXing) const override
	the method this base class helps implementing More...

virtual StatusCode	processAllSubEvents (const EventContext &ctx)=0
	dummy implementation to allow compilation while all Digitization packages are migrated to use this new interface. More...

virtual bool	filterPassed () const override
	dummy implementation of passing filter More...

virtual void	resetFilter () override
	dummy implementation of filter reset More...

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 truth particles collections in the overlay store

Definition at line 23 of file MergeTruthParticlesTool.h.

Constructor & Destructor Documentation

◆ MergeTruthParticlesTool()

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

Definition at line 12 of file MergeTruthParticlesTool.cxx.

   : PileUpToolBase(type, name, parent)
 {
 }

Member Function Documentation

◆ filterPassed()

virtual bool PileUpToolBase::filterPassed ( ) const

inlineoverridevirtualinherited

dummy implementation of passing filter

Definition at line 49 of file PileUpToolBase.h.

49 { return m_filterPassed; }

◆ initialize()

StatusCode MergeTruthParticlesTool::initialize ( )

finaloverridevirtual

Initialize.

Reimplemented from PileUpToolBase.

Definition at line 19 of file MergeTruthParticlesTool.cxx.

 {
   ATH_MSG_DEBUG ( "Initializing " << name());
   ATH_CHECK(m_pMergeSvc.retrieve());
   return StatusCode::SUCCESS;
 }

◆ mergeEvent()

StatusCode MergeTruthParticlesTool::mergeEvent ( const EventContext & ctx )

finaloverridevirtual

called at the end of the subevts loop.

Not (necessarily) able to access SubEvents

Definition at line 70 of file MergeTruthParticlesTool.cxx.

 {
   ATH_MSG_VERBOSE ( "mergeEvent" );
  
   if(this->record(m_inTimeOutputTruthParticleContainer, m_inTimeOutputTruthParticleCollKey).isFailure()) { // This call also records the xAOD::TruthParticleAuxContainer.
     ATH_MSG_ERROR("mergeEvent: Failed to record InTimeOutputTruthParticleContainer");
     return StatusCode::FAILURE;
   }
   else {
     ATH_MSG_DEBUG ( "mergeEvent: Recorded " << m_inTimeOutputTruthParticleCollKey << " TruthParticleContainer with "
                     << m_inTimeOutputTruthParticleContainer->size() <<" entries." );
   }
   return StatusCode::SUCCESS;
 }

◆ prepareEvent()

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

finaloverridevirtual

called before the subevts loop.

Not (necessarily) able to access SubEvents

Definition at line 26 of file MergeTruthParticlesTool.cxx.

 {
   ATH_MSG_VERBOSE ( "prepareEvent()" );
   ATH_MSG_DEBUG ( "prepareEvent: there are " << nInputEvents << " subevents in this event." );
   m_first_event = true;
   m_inTimeOutputTruthParticleContainer = new xAOD::TruthParticleContainer();
   m_inTimeOutputTruthParticleContainer->setStore(new xAOD::TruthParticleAuxContainer);
   return StatusCode::SUCCESS;
 }

◆ processAllSubEvents() [1/2]

StatusCode MergeTruthParticlesTool::processAllSubEvents ( const EventContext & ctx )

finaloverridevirtual

Merge the Truth TruthParticleContainers using the PileUpMergeSvc.

Reimplemented from PileUpToolBase.

Definition at line 109 of file MergeTruthParticlesTool.cxx.

 {
   ATH_MSG_VERBOSE ( "processAllSubEvents()" );
  
   m_first_event = true;
   m_inTimeOutputTruthParticleContainer = new xAOD::TruthParticleContainer();
   m_inTimeOutputTruthParticleContainer->setStore(new xAOD::TruthParticleAuxContainer);
  
   typedef PileUpMergeSvc::TimedList<xAOD::TruthParticleContainer>::type TruthParticleList;
   TruthParticleList truthList;
   if ( (m_pMergeSvc->retrieveSubEvtsData(m_inputTruthParticleCollKey.value(), truthList)).isSuccess() ) {
     if (!truthList.empty()) {
       //now merge all collections into one
       TruthParticleList::const_iterator truthParticleColl_iter(truthList.begin());
       const TruthParticleList::const_iterator endOfTruthParticleColls(truthList.end());
       while (truthParticleColl_iter!=endOfTruthParticleColls) {
         const int eventNumber{static_cast<int>((truthParticleColl_iter)->first.index())}; // casting from long unsigned int to int
         //const float timeOfBCID(static_cast<float>((truthParticleColl_iter)->first.time()));
         if( static_cast<int>((truthParticleColl_iter)->first.time())!=0 || !m_first_event || m_includeSignalTruthParticles ) {
           ATH_CHECK(this->processTruthParticleContainer(&(*((truthParticleColl_iter)->second)), m_inTimeOutputTruthParticleContainer, eventNumber));
         }
         //signal is always the first event, so if the first event
         //wasn't in-time, then the signal collection was missing and
         //we should skip further checks.
         if(m_first_event) {m_first_event=false;}
         ++truthParticleColl_iter;
       }
     }
     else {
       ATH_MSG_DEBUG ( "processAllSubEvents: TruthParticleList is empty" );
     }
   }
   else {
     ATH_MSG_ERROR ( "processAllSubEvents: Can not find TruthParticleList" );
   }
  
   if( this->record(m_inTimeOutputTruthParticleContainer, m_inTimeOutputTruthParticleCollKey).isFailure() ) { // This call also records the xAOD::TruthParticleAuxContainer.
     ATH_MSG_ERROR ( "processAllSubEvents: Failed to record InTimeOutputTruthParticleContainer" );
     return StatusCode::FAILURE;
   }
   else {
     ATH_MSG_DEBUG ( "processAllSubEvents: Recorded " << m_inTimeOutputTruthParticleCollKey << " xAOD::TruthParticleContainer with "
                     << m_inTimeOutputTruthParticleContainer->size() <<" entries." );
   }
  
   return StatusCode::SUCCESS;
 }

◆ processAllSubEvents() [2/2]

virtual StatusCode IPileUpTool::processAllSubEvents

inherited

dummy implementation to allow compilation while all Digitization packages are migrated to use this new interface.

◆ processBunchXing()

StatusCode MergeTruthParticlesTool::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 36 of file MergeTruthParticlesTool.cxx.

 {
   ATH_MSG_VERBOSE ( "processBunchXing()" );
   SubEventIterator iEvt(bSubEvents);
   while (iEvt != eSubEvents) {
     const xAOD::TruthParticleContainer* inputTruthParticleContainer{};
     if (m_pMergeSvc->retrieveSingleSubEvtData(m_inputTruthParticleCollKey.value(), inputTruthParticleContainer,
                                               bunchXing, iEvt).isSuccess()) {
       ATH_MSG_VERBOSE("Found an xAOD::TruthParticleContainer in storeGate.");
       if ( !inputTruthParticleContainer ) {
         ATH_MSG_ERROR("Unable to retrieve input xAOD::TruthParticleContainer: " << m_inputTruthParticleCollKey);
         return StatusCode::FAILURE;
       }
       ATH_MSG_DEBUG ( "processBunchXing: bunch Crossing = " << bunchXing << " xAOD::TruthParticleContainer size = " << inputTruthParticleContainer->size());
       const int eventNumber{iEvt->index()};
       // const float timeOfBCID{static_cast<float>(iEvt->time())};
       if ( !m_first_event || m_includeSignalTruthParticles ) {
         ATH_CHECK(this->processTruthParticleContainer(&(*inputTruthParticleContainer), m_inTimeOutputTruthParticleContainer, eventNumber));
       }
     }
     else {
       ATH_MSG_DEBUG ( "processBunchXing: No TruthParticleContainer found." );
     }
     m_first_event=false;
     ++iEvt;
   }
   //signal is always the first event, so even if we didn't see
   //anything should set this to false here.
   if(m_first_event) {m_first_event=false;}
   return StatusCode::SUCCESS;
 }

◆ processTruthParticleContainer()

StatusCode MergeTruthParticlesTool::processTruthParticleContainer	(	const xAOD::TruthParticleContainer *	inputTruthParticleContainer,
		xAOD::TruthParticleContainer *	outputTruthParticleContainer,
		int	eventNumber
	)

privatevirtual

TruthParticleContainer Loop.

Definition at line 158 of file MergeTruthParticlesTool.cxx.

 {
   if (!inputTruthParticleContainer || !outputTruthParticleContainer) { return StatusCode::FAILURE; }
  
   // Set up decorators
   const static SG::AuxElement::Accessor< int > eventNumberAccessor("pileupEventNumber");
  
   for (const xAOD::TruthParticle *theParticle : *inputTruthParticleContainer) {
     xAOD::TruthParticle* xTruthParticle = new xAOD::TruthParticle();
     outputTruthParticleContainer->push_back(xTruthParticle);
     *xTruthParticle = *theParticle; // deep-copy
     // add the pile-up event number
     eventNumberAccessor(*xTruthParticle) = eventNumber;
   }
   return StatusCode::SUCCESS;
 }

◆ record()

StatusCode MergeTruthParticlesTool::record	(	const xAOD::TruthParticleContainer *	pTruthParticles,
		const std::string &	truthParticleContainerName
	)		const

private

Definition at line 85 of file MergeTruthParticlesTool.cxx.

 {
   const xAOD::TruthParticleAuxContainer* pTruthParticlesAux =
     dynamic_cast<const xAOD::TruthParticleAuxContainer*>(pTruthParticles->getConstStore());
   ATH_MSG_DEBUG("Check Aux store: " << pTruthParticles << " ... " << &pTruthParticles->auxbase() << " ... " << pTruthParticlesAux );
   if ( !pTruthParticlesAux ) {
     ATH_MSG_ERROR("Unable to retrieve xAOD::TruthParticleAuxContainer");
     return StatusCode::FAILURE;
   }
   ATH_MSG_VERBOSE("Recording new xAOD::TruthParticleAuxContainer.");
   if ( evtStore()->record(pTruthParticlesAux, truthParticleContainerName+"Aux.").isFailure() ) {
     ATH_MSG_ERROR("Unable to write new xAOD::TruthParticleAuxContainer to event store: " << truthParticleContainerName);
     return StatusCode::FAILURE;
   }
   ATH_MSG_VERBOSE("Recording new xAOD::TruthParticleContainer.");
   if ( evtStore()->record(pTruthParticles, truthParticleContainerName).isFailure() ) {
     ATH_MSG_ERROR("Unable to write new xAOD::TruthParticleContainer to event store: " << truthParticleContainerName);
     return StatusCode::FAILURE;
   }
   ATH_MSG_DEBUG("Created new xAOD::TruthParticleContainer in event store: " << truthParticleContainerName);
   return StatusCode::SUCCESS;
 }

◆ resetFilter()

virtual void PileUpToolBase::resetFilter ( )

inlineoverridevirtualinherited

dummy implementation of filter reset

Reimplemented in MergeTruthJetsTool.

Definition at line 51 of file PileUpToolBase.h.

51 { 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.

◆ m_first_event

bool MergeTruthParticlesTool::m_first_event {true}

private

Definition at line 55 of file MergeTruthParticlesTool.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.

◆ m_includeSignalTruthParticles

Gaudi::Property<bool> MergeTruthParticlesTool::m_includeSignalTruthParticles {this, "IncludeSignalTruthParticles", false, ""}

private

Definition at line 53 of file MergeTruthParticlesTool.h.

◆ m_inputTruthParticleCollKey

Gaudi::Property<std::string> MergeTruthParticlesTool::m_inputTruthParticleCollKey {this, "InputTruthParticleCollKey", "TruthPileupParticles", ""}

private

Definition at line 51 of file MergeTruthParticlesTool.h.

◆ m_inTimeOutputTruthParticleCollKey

Gaudi::Property<std::string> MergeTruthParticlesTool::m_inTimeOutputTruthParticleCollKey {this, "InTimeOutputTruthParticleCollKey", "TruthPileupParticles", ""}

private

Definition at line 52 of file MergeTruthParticlesTool.h.

◆ m_inTimeOutputTruthParticleContainer

xAOD::TruthParticleContainer* MergeTruthParticlesTool::m_inTimeOutputTruthParticleContainer {}

private

Definition at line 54 of file MergeTruthParticlesTool.h.

◆ 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.

◆ m_pMergeSvc

ServiceHandle<PileUpMergeSvc> MergeTruthParticlesTool::m_pMergeSvc {this, "PileUpMergeSvc", "PileUpMergeSvc", ""}

private

Definition at line 50 of file MergeTruthParticlesTool.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.

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

Public Member Functions

Private Member Functions

Private Attributes

structors and AlgTool implementation

Detailed Description

Constructor & Destructor Documentation

◆ MergeTruthParticlesTool()

Member Function Documentation

◆ filterPassed()

◆ initialize()

◆ mergeEvent()

◆ prepareEvent()

◆ processAllSubEvents() [1/2]

◆ processAllSubEvents() [2/2]

◆ processBunchXing()

◆ processTruthParticleContainer()

◆ record()

◆ resetFilter()

◆ toProcess()

Member Data Documentation

◆ m_filterPassed

◆ m_first_event

◆ m_firstXing

◆ m_includeSignalTruthParticles

◆ m_inputTruthParticleCollKey

◆ m_inTimeOutputTruthParticleCollKey

◆ m_inTimeOutputTruthParticleContainer

◆ m_lastXing

◆ m_pMergeSvc

◆ m_vetoPileUpTruthLinks