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

#include <MergeTrackRecordCollTool.h>

Inheritance diagram for MergeTrackRecordCollTool:

Collaboration diagram for MergeTrackRecordCollTool:

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

virtual StatusCode	initialize () override final
	Initialize tool. 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 bool	toProcess (int bunchXing) const override final
	return false if not interested in certain xing times (in ns) implemented by default in PileUpToolBase as FirstXing<=bunchXing<=LastXing More...

virtual StatusCode	processAllSubEvents (const EventContext &ctx) override final
	Propagate the TrackRecordCollections to the output StoreGate. More...

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

StringProperty	m_trRecCollKey {this, "TrackRecordCollKey", "MuonEntryLayer", ""}

SG::WriteHandleKey< TrackRecordCollection >	m_outputKey { this, "TrackRecordCollOutputKey", "MuonExitLayer", "" }

bool	m_firstSubEvent {true}

structors and AlgTool implementation
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 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 24 of file MergeTrackRecordCollTool.h.

Constructor & Destructor Documentation

◆ MergeTrackRecordCollTool()

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

Definition at line 9 of file MergeTrackRecordCollTool.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 MergeTrackRecordCollTool::initialize ( )

finaloverridevirtual

Initialize tool.

Reimplemented from PileUpToolBase.

Definition at line 16 of file MergeTrackRecordCollTool.cxx.

 {
   ATH_MSG_DEBUG( "initialize()" );
   ATH_CHECK( m_pMergeSvc.retrieve() );
   ATH_CHECK( m_outputKey.initialize() );
   return StatusCode::SUCCESS;
 }

◆ mergeEvent()

StatusCode MergeTrackRecordCollTool::mergeEvent ( const EventContext & ctx )

finaloverridevirtual

called at the end of the subevts loop.

Not (necessarily) able to access SubEvents

Definition at line 68 of file MergeTrackRecordCollTool.cxx.

 {
   //Nothing to do here;
   return StatusCode::SUCCESS;
 }

◆ prepareEvent()

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

finaloverridevirtual

called before the subevts loop.

Not (necessarily) able to access SubEvents

Definition at line 24 of file MergeTrackRecordCollTool.cxx.

 {
   ATH_MSG_DEBUG ( "Calling prepareEvent()" );
   ATH_MSG_DEBUG( "prepareEvent: there are " << nInputEvents << " subevents in this event.");
   m_firstSubEvent=true;
   return StatusCode::SUCCESS;
 }

◆ processAllSubEvents() [1/2]

StatusCode MergeTrackRecordCollTool::processAllSubEvents ( const EventContext & ctx )

finaloverridevirtual

Propagate the TrackRecordCollections to the output StoreGate.

Reimplemented from PileUpToolBase.

Definition at line 81 of file MergeTrackRecordCollTool.cxx.

 {
   ATH_MSG_VERBOSE ( "processAllSubEvents()" );
  
   typedef PileUpMergeSvc::TimedList<TrackRecordCollection>::type TimedTruthList;
   TimedTruthList truthList;
   if ( (m_pMergeSvc->retrieveSubEvtsData(m_trRecCollKey.value(), truthList)).isSuccess() ) {
     if (truthList.begin() != truthList.end()) {
       //FIXME we are forced to do a deep copy
       const TrackRecordCollection &oldColl=*(truthList.begin())->second;
  
       SG::WriteHandle<TrackRecordCollection> outputCollection(m_outputKey, ctx);
       ATH_CHECK(outputCollection.record(std::make_unique<TrackRecordCollection>()));
       if (!outputCollection.isValid()) {
         ATH_MSG_ERROR("Could not record output TrackRecordCollection " << outputCollection.name() << " to store " << outputCollection.store());
         return StatusCode::FAILURE;
       }
  
       for (const auto& trcit : oldColl) {
         outputCollection->push_back( TrackRecord(trcit) );
       }
  
       ATH_MSG_DEBUG ( "processAllSubEvents: copied original event TrackRecordCollection" );
     }
     else {
       ATH_MSG_ERROR ( "processAllSubEvents: TimedTruthList is empty" );
     }
   }
   else {
     ATH_MSG_ERROR ( "processAllSubEvents: Can not find TimedTruthList" );
   }
   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 MergeTrackRecordCollTool::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 32 of file MergeTrackRecordCollTool.cxx.

 {
   ATH_MSG_VERBOSE ( "processBunchXing()" );
   //We are only interested in the TrackRecordCollection for the original event
   if(m_firstSubEvent && bunchXing==0) {
     if (bSubEvents != eSubEvents) {
       const TrackRecordCollection* oldColl(nullptr);
       if (m_pMergeSvc->retrieveSingleSubEvtData(m_trRecCollKey.value(), oldColl,
                                                 bunchXing, bSubEvents).isSuccess()) {
         SG::WriteHandle<TrackRecordCollection> outputCollection(m_outputKey);
         ATH_CHECK(outputCollection.record(std::make_unique<TrackRecordCollection>()));
         if (!outputCollection.isValid()) {
           ATH_MSG_ERROR("Could not record output TrackRecordCollection " << outputCollection.name() << " to store " << outputCollection.store());
           return StatusCode::FAILURE;
         }
  
         for(const auto& trcit : *oldColl) {
           outputCollection->push_back( TrackRecord(trcit) );
         }
         ATH_MSG_DEBUG( "processBunchXing: copied original event TrackRecordCollection" );
         m_firstSubEvent=false;
       }
       else {
         ATH_MSG_ERROR ( "processBunchXing: TimedTruthList is empty" );
       }
     }
     else {
       ATH_MSG_ERROR ( "processBunchXing: Can not find TimedTruthList" );
     }
   }
   
   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()

bool MergeTrackRecordCollTool::toProcess ( int bunchXing ) const

finaloverridevirtual

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

Reimplemented from PileUpToolBase.

Definition at line 74 of file MergeTrackRecordCollTool.cxx.

 {
   //We are only interested in the TrackRecordCollection for the original event
   //which should be in BC 0 !
   return (bunchXing==0);
 }

Member Data Documentation

◆ m_filterPassed

bool PileUpToolBase::m_filterPassed {true}

protectedinherited

Definition at line 60 of file PileUpToolBase.h.

◆ m_firstSubEvent

bool MergeTrackRecordCollTool::m_firstSubEvent {true}

private

Definition at line 53 of file MergeTrackRecordCollTool.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_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_outputKey

SG::WriteHandleKey<TrackRecordCollection> MergeTrackRecordCollTool::m_outputKey { this, "TrackRecordCollOutputKey", "MuonExitLayer", "" }

private

Definition at line 52 of file MergeTrackRecordCollTool.h.

◆ m_pMergeSvc

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

private

Definition at line 50 of file MergeTrackRecordCollTool.h.

◆ m_trRecCollKey

StringProperty MergeTrackRecordCollTool::m_trRecCollKey {this, "TrackRecordCollKey", "MuonEntryLayer", ""}

private

Definition at line 51 of file MergeTrackRecordCollTool.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 Attributes

structors and AlgTool implementation

Detailed Description

Constructor & Destructor Documentation

◆ MergeTrackRecordCollTool()

Member Function Documentation

◆ filterPassed()

◆ initialize()

◆ mergeEvent()

◆ prepareEvent()

◆ processAllSubEvents() [1/2]

◆ processAllSubEvents() [2/2]

◆ processBunchXing()

◆ resetFilter()

◆ toProcess()

Member Data Documentation

◆ m_filterPassed

◆ m_firstSubEvent

◆ m_firstXing

◆ m_lastXing

◆ m_outputKey

◆ m_pMergeSvc

◆ m_trRecCollKey

◆ m_vetoPileUpTruthLinks