PileUpToolBase Class Reference

#include <PileUpToolBase.h>

Inherits extends< AthAlgTool, IPileUpTool >.

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

Collaboration diagram for PileUpToolBase:

structors and AlgTool implementation
Gaudi::Property< int >	m_firstXing
Gaudi::Property< int >	m_lastXing
Gaudi::Property< int >	m_vetoPileUpTruthLinks
bool	m_filterPassed {true}
	PileUpToolBase (const std::string &type, const std::string &name, const IInterface *parent)
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	processBunchXing (int, SubEventIterator, SubEventIterator) override
virtual bool	filterPassed () const override
	dummy implementation of passing filter More...
virtual void	resetFilter () override
	dummy implementation of filter reset 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...

Detailed Description

Definition at line 18 of file PileUpToolBase.h.

Constructor & Destructor Documentation

PileUpToolBase()

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

Definition at line 7 of file PileUpToolBase.cxx.

  : base_class(type, name, parent)
{
}

Member Function Documentation

filterPassed()

virtual bool PileUpToolBase::filterPassed ( ) const

inlineoverridevirtual

dummy implementation of passing filter

Definition at line 49 of file PileUpToolBase.h.

{ return m_filterPassed; }

initialize()

virtual StatusCode PileUpToolBase::initialize ( )

inlineoverridevirtual

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

Definition at line 26 of file PileUpToolBase.h.

                                           {
    return StatusCode::SUCCESS;
  }

processAllSubEvents() [1/2]

virtual StatusCode PileUpToolBase::processAllSubEvents ( const EventContext &  )

inlineoverridevirtual

Reimplemented in MdtDigitizationTool, TRTDigitizationTool, TileHitVecToCntTool, RpcDigitizationTool, LArPileUpTool, AFP_PileUpTool, CscDigitizationTool, TgcDigitizationTool, MuonR4::MuonDigitizationTool, ZDC_PileUpTool, HGTD_DigitizationTool, ALFA_PileUpTool, LUCID_PileUpTool, 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

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

processBunchXing()

virtual StatusCode PileUpToolBase::processBunchXing ( int  , SubEventIterator  , SubEventIterator    )

inlineoverridevirtual

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

Definition at line 43 of file PileUpToolBase.h.

                                                {
    return StatusCode::SUCCESS;
  }

resetFilter()

virtual void PileUpToolBase::resetFilter ( )

inlineoverridevirtual

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

inlineoverridevirtual

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}

protected

Definition at line 60 of file PileUpToolBase.h.

m_firstXing

Gaudi::Property<int> PileUpToolBase::m_firstXing

protected

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

protected

Initial value:

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

Definition at line 56 of file PileUpToolBase.h.

m_vetoPileUpTruthLinks

Gaudi::Property<int> PileUpToolBase::m_vetoPileUpTruthLinks

protected

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:

• PileUpToolBase.h
• PileUpToolBase.cxx