#include <TestPileUpTool.h>

Inheritance diagram for TestPileUpTool:

Collaboration diagram for TestPileUpTool:

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

IPileUpTool methods
std::vector< std::pair< unsigned int, int > >	m_seen
	return false if not interested in certain xing times (in ns) implemented by default in PileUpToolBase as FirstXing<=bunchXing<=LastXing More...

Gaudi::Property< bool >	m_doFiltering {this, "DoFiltering", false, ""}

Gaudi::Property< unsigned int >	m_maxInTimePileUp {this, "MaxInTimePileUp", 4, ""}

virtual StatusCode	prepareEvent (const EventContext &ctx, unsigned int nInputEvents) override final
	called before the bunchXing 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...

structors and AlgTool implementation
virtual StatusCode	initialize () override

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

virtual StatusCode	processAllSubEvents (const EventContext &) override

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

Definition at line 18 of file TestPileUpTool.h.

Constructor & Destructor Documentation

◆ TestPileUpTool()

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

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

virtual StatusCode PileUpToolBase::initialize ( )

inlineoverridevirtualinherited

Reimplemented in MdtDigitizationTool, TileHitVecToCntTool, MM_DigitizationTool, TRTDigitizationTool, LArPileUpTool, RpcDigitizationTool, HGTD_DigitizationTool, AFP_PileUpTool, CscDigitizationTool, TgcDigitizationTool, ALFA_PileUpTool, BCM_DigitizationTool, ZDC_PileUpTool, LUCID_PileUpTool, MergeMcEventCollTool, MergeCalibHitsTool, MergeGenericMuonSimHitCollTool, MergeHijingParsTool, SimpleMergeMcEventCollTool, MergeTrackRecordCollTool, MergeTruthJetsTool, MergeTruthParticlesTool, NewMergeMcEventCollTool, MuonR4::MmFastDigiTool, MuonR4::MdtDigitizationTool, MuonR4::RpcFastDigiTool, MuonR4::sTgcFastDigiTool, MuonR4::TgcFastDigiTool, HGTD_SmearedDigitizationTool, PixelDigitizationTool, MuonR4::MuonDigitizationTool, SCT_FastDigitizationTool, TRTFastDigitizationTool, PixelFastDigitizationTool, SiSmearedDigitizationTool, and sTgcDigitizationTool.

Definition at line 26 of file PileUpToolBase.h.

                                            {
     return StatusCode::SUCCESS;
   }

◆ mergeEvent()

StatusCode TestPileUpTool::mergeEvent ( const EventContext & ctx )

finaloverridevirtual

called at the end of the subevts loop.

Not (necessarily) able to access SubEvents

Definition at line 22 of file TestPileUpTool.cxx.

 {
   for (const auto& bc : m_seen)
     {
       ATH_MSG_INFO( "mergeEvent: there are " << bc.first << " events in bunch xing " << bc.second );
     }
   return StatusCode::SUCCESS;
 }

◆ prepareEvent()

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

finaloverridevirtual

called before the bunchXing loop

Definition at line 16 of file TestPileUpTool.cxx.

 {
   ATH_MSG_INFO( "prepareEvent: expect to process " << nInputEvents << " events this time." );
   return StatusCode::SUCCESS;
 }

◆ processAllSubEvents() [1/2]

virtual StatusCode PileUpToolBase::processAllSubEvents ( const EventContext & )

inlineoverridevirtualinherited

Reimplemented in MdtDigitizationTool, TRTDigitizationTool, TileHitVecToCntTool, RpcDigitizationTool, LArPileUpTool, AFP_PileUpTool, CscDigitizationTool, TgcDigitizationTool, ALFA_PileUpTool, HGTD_DigitizationTool, ZDC_PileUpTool, LUCID_PileUpTool, MuonR4::MuonDigitizationTool, MergeCalibHitsTool, MergeMcEventCollTool, MergeHijingParsTool, MergeTrackRecordCollTool, SimpleMergeMcEventCollTool, MergeGenericMuonSimHitCollTool, BCM_DigitizationTool, MergeTruthJetsTool, NewMergeMcEventCollTool, MergeTruthParticlesTool, MM_DigitizationTool, HGTD_SmearedDigitizationTool, PixelDigitizationTool, SCT_FastDigitizationTool, TRTFastDigitizationTool, PixelFastDigitizationTool, SiSmearedDigitizationTool, and sTgcDigitizationTool.

Definition at line 39 of file PileUpToolBase.h.

                                                                        {
     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 TestPileUpTool::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 31 of file TestPileUpTool.cxx.

 {
   m_seen.push_back(std::make_pair(std::distance(bSubEvents,eSubEvents), bunchXing));
   if(m_doFiltering && bunchXing==0)
     {
       if(m_maxInTimePileUp < m_seen.back().first)
         {
           ATH_MSG_INFO("Triggering filter as there were " << m_seen.back().first << " pile-up events in time.");
           m_filterPassed = false;
         }
     }
  
   SubEventIterator iEvt(bSubEvents);
   while (iEvt != eSubEvents)
     {
       StoreGateSvc& seStore(*iEvt->ptr()->evtStore());
       ATH_MSG_DEBUG("SubEvt EventInfo from StoreGate " << seStore.name() << "  : "
                    << " bunch crossing : " << bunchXing
                    << " time offset: " << iEvt->time()
                    << " event: " << iEvt->ptr()->eventNumber()
                    << " run: " << iEvt->ptr()->runNumber()
                    );
       ++iEvt;
     }
   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_doFiltering

Gaudi::Property<bool> TestPileUpTool::m_doFiltering {this, "DoFiltering", false, ""}

private

Definition at line 45 of file TestPileUpTool.h.

◆ m_filterPassed

bool PileUpToolBase::m_filterPassed {true}

protectedinherited

Definition at line 60 of file PileUpToolBase.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_maxInTimePileUp

Gaudi::Property<unsigned int> TestPileUpTool::m_maxInTimePileUp {this, "MaxInTimePileUp", 4, ""}

private

Definition at line 46 of file TestPileUpTool.h.

◆ m_seen

std::vector<std::pair<unsigned int, int> > TestPileUpTool::m_seen

private

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

Definition at line 44 of file TestPileUpTool.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

IPileUpTool methods

structors and AlgTool implementation

Detailed Description

Constructor & Destructor Documentation

◆ TestPileUpTool()

Member Function Documentation

◆ filterPassed()

◆ initialize()

◆ mergeEvent()

◆ prepareEvent()

◆ processAllSubEvents() [1/2]

◆ processAllSubEvents() [2/2]

◆ processBunchXing()

◆ resetFilter()

◆ toProcess()

Member Data Documentation

◆ m_doFiltering

◆ m_filterPassed

◆ m_firstXing

◆ m_lastXing

◆ m_maxInTimePileUp

◆ m_seen

◆ m_vetoPileUpTruthLinks