#include <MdtDigitizationTool.h>

Inheritance diagram for MuonR4::MdtDigitizationTool:

Collaboration diagram for MuonR4::MdtDigitizationTool:

Public Member Functions
	MdtDigitizationTool (const std::string &type, const std::string &name, const IInterface *pIID)

StatusCode	initialize () override final

StatusCode	processBunchXing (int bunchXing, SubEventIterator bSubEvents, SubEventIterator eSubEvents) override final

StatusCode	mergeEvent (const EventContext &ctx) override final

StatusCode	prepareEvent (const EventContext &ctx, const unsigned int) override final
	When being run from PileUpToolsAlgs, this method is called at the start of the subevts loop. More...

StatusCode	processAllSubEvents (const EventContext &ctx) override final
	alternative interface which uses the PileUpMergeSvc to obtain all the required SubEvents. More...

StatusCode	processAllSubEvents (const EventContext &ctx) const
	Reentrant version of the digitization tool. More...

Protected Types
using	TimedHit = TimedHitPtr< xAOD::MuonSimHit >

using	TimedHits = std::vector< TimedHitPtr< xAOD::MuonSimHit > >

template<class DetType >
using	OutDigitCache_t = std::vector< std::unique_ptr< DetType > >
	DigitContainers are sorted by DigitCollections which are the ensemble of all hits in a given MuonChamber. More...

using	DeadTimeMap = std::unordered_map< Identifier, double >

Protected Member Functions
StatusCode	digitize (const EventContext &ctx, const TimedHits &hitsToDigit, xAOD::MuonSimHitContainer *sdoContainer) const override final
	Digitize the time ordered hits and write them to the digit format specific for the detector technology. More...

CLHEP::HepRandomEngine *	getRandomEngine (const EventContext &ctx) const

xAOD::MuonSimHit *	addSDO (const TimedHit &hit, xAOD::MuonSimHitContainer *sdoContainer) const
	Adds the timed simHit to the output SDO container. More...

const ActsGeometryContext &	getGeoCtx (const EventContext &ctx) const
	Returns the reference to the ActsGeometryContext needed to fetch global positions from the Readout geometry. More...

template<class Container >
StatusCode	retrieveContainer (const EventContext &ctx, const SG::ReadHandleKey< Container > &key, const Container *&contPtr) const
	Helper function to retrieve a container from StoreGate. More...

template<class Container >
StatusCode	retrieveConditions (const EventContext &ctx, const SG::ReadCondHandleKey< Container > &key, const Container *&contPtr) const
	Helper function to access the conditions data. More...

template<class DigitColl >
DigitColl *	fetchCollection (const Identifier &hitId, OutDigitCache_t< DigitColl > &digitCache) const
	Helper function that provides fetches the proper DigitCollection from the DigitCache for a given hit identifier If the Collection is fetched for the first time, it's inserted into the cache first. More...

template<class DigitCont , class DigitColl >
StatusCode	writeDigitContainer (const EventContext &ctx, const SG::WriteHandleKey< DigitCont > &key, OutDigitCache_t< DigitColl > &&digitCache, unsigned int hashMax) const
	Helper function to move the collected digits into the final DigitContainer. More...

Static Protected Member Functions
static double	hitTime (const TimedHit &hit)
	Returns the global time of the hit which is the sum of eventTime & individual hit time. More...

static bool	passDeadTime (const Identifier &channelId, const double hitTime, const double deadTimeWindow, DeadTimeMap &deadTimeMap)
	Returns whether the new digit is within the dead time window. More...

Protected Attributes
const MuonGMR4::MuonDetectorManager *	m_detMgr {nullptr}

ServiceHandle< Muon::IMuonIdHelperSvc >	m_idHelperSvc

Private Types
using	DigiCache = OutDigitCache_t< MdtDigitCollection >

using	PileUpHits = PileUpMergeSvc::TimedList< xAOD::MuonSimHitContainer >::type

using	SimHitLocalCopy = std::pair< std::unique_ptr< xAOD::MuonSimHitContainer >, std::unique_ptr< xAOD::MuonSimHitAuxContainer > >
	Create a local copy of the sim hits to ensure overlayed hits across the events remain valid. More...

Private Member Functions
StatusCode	fillTimedHits (PileUpHits &&hitColl, TimedHits &timedHits) const
	Translates the PileUpHits into the timed hits format. More...

Private Attributes
SG::WriteHandleKey< MdtDigitContainer >	m_writeKey {this, "OutputObjectName", "MDT_Digits"}

SG::ReadCondHandleKey< MuonCalib::MdtCalibDataContainer >	m_calibDbKey

SG::ReadCondHandleKey< MdtCondDbData >	m_badTubeKey {this, "BadTubeKey", "MdtCondDbData", "Key of MdtCondDbData"}

SG::ReadCondHandleKey< Muon::TwinTubeMap >	m_twinTubeKey {this, "TwinTubeKey", "MdtTwinTubeMap"}

ToolHandle< IMDT_DigitizationTool >	m_digiTool {this, "DigitizationTool", ""}

Gaudi::Property< double >	m_timeResTDC {this, "ResolutionTDC", 0.5 * Gaudi::Units::ns, "TDC time resolution"}

Gaudi::Property< double >	m_timeResADC {this, "ResolutionADC", 0.5 * Gaudi::Units::ns, "ADC time resolution"}

Gaudi::Property< double >	m_deadTime {this, "DeadTime", 700., "MDT drift tube dead time"}

Gaudi::Property< bool >	m_digitizeMuonOnly {this, "ProcessTrueMuonsOnly", false, "If set to true hit with pdgId != 13 are skipped"}

Gaudi::Property< bool >	m_useTwinTube {this, "useTwinTubes", false}
	Properties to model the Twin tube signals. More...

Gaudi::Property< double >	m_resTwin {this, "ResolutionTwinTube", 1.05 * Gaudi::Units::ns, "Twin Tube resolution"}

SG::ReadHandleKey< xAOD::MuonSimHitContainer >	m_simHitKey {this, "SimHitKey", ""}

SG::ReadHandleKey< ActsGeometryContext >	m_geoCtxKey

ServiceHandle< PileUpMergeSvc >	m_mergeSvc {this, "PileUpMergeSvc", "PileUpMergeSvc", ""}

Gaudi::Property< std::string >	m_streamName {this, "StreamName", ""}

ServiceHandle< IAthRNGSvc >	m_rndmSvc {this, "RndmSvc", "AthRNGSvc", ""}

SG::WriteHandleKey< xAOD::MuonSimHitContainer >	m_sdoKey {this, "OutputSDOName", ""}

Gaudi::Property< bool >	m_onlyUseContainerName

Gaudi::Property< bool >	m_includePileUpTruth {this, "IncludePileUpTruth", true, "Include pile-up truth info"}

std::string	m_inputObjectName {""}

TimedHits	m_timedHits {}

std::vector< SimHitLocalCopy >	m_simHits {}

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	toProcess (int bunchXing) const override
	the method this base class helps implementing 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 16 of file MuonPhaseII/MuonDigitization/MdtDigitizationR4/src/MdtDigitizationTool.h.

Member Typedef Documentation

◆ DeadTimeMap

using MuonR4::MuonDigitizationTool::DeadTimeMap = std::unordered_map<Identifier, double>

protectedinherited

Definition at line 129 of file MuonDigitizationTool.h.

◆ DigiCache

using MuonR4::MdtDigitizationTool::DigiCache = OutDigitCache_t<MdtDigitCollection>

private

Definition at line 49 of file MuonPhaseII/MuonDigitization/MdtDigitizationR4/src/MdtDigitizationTool.h.

◆ OutDigitCache_t

template<class DetType >

using MuonR4::MuonDigitizationTool::OutDigitCache_t = std::vector<std::unique_ptr<DetType> >

protectedinherited

DigitContainers are sorted by DigitCollections which are the ensemble of all hits in a given MuonChamber.

To fill the final DigitContainer thread-safely, the DigitCollections shall be cached pre cached in a OutDigitCache_t vector which is later moved to the final DigitContainer

Definition at line 109 of file MuonDigitizationTool.h.

◆ PileUpHits

using MuonR4::MuonDigitizationTool::PileUpHits = PileUpMergeSvc::TimedList<xAOD::MuonSimHitContainer>::type

privateinherited

Definition at line 145 of file MuonDigitizationTool.h.

◆ SimHitLocalCopy

using MuonR4::MuonDigitizationTool::SimHitLocalCopy = std::pair<std::unique_ptr<xAOD::MuonSimHitContainer>, std::unique_ptr<xAOD::MuonSimHitAuxContainer> >

privateinherited

Create a local copy of the sim hits to ensure overlayed hits across the events remain valid.

Definition at line 172 of file MuonDigitizationTool.h.

◆ TimedHit

using MuonR4::MuonDigitizationTool::TimedHit = TimedHitPtr<xAOD::MuonSimHit>

protectedinherited

Definition at line 70 of file MuonDigitizationTool.h.

◆ TimedHits

using MuonR4::MuonDigitizationTool::TimedHits = std::vector<TimedHitPtr<xAOD::MuonSimHit> >

protectedinherited

Definition at line 71 of file MuonDigitizationTool.h.

Constructor & Destructor Documentation

◆ MdtDigitizationTool()

MdtDigitizationTool::MdtDigitizationTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	pIID
	)

Definition at line 16 of file MuonPhaseII/MuonDigitization/MdtDigitizationR4/src/MdtDigitizationTool.cxx.

16 :

17 MuonDigitizationTool{type,name, pIID} {}

Member Function Documentation

◆ addSDO()

xAOD::MuonSimHit * MuonR4::MuonDigitizationTool::addSDO	(	const TimedHit &	hit,
		xAOD::MuonSimHitContainer *	sdoContainer
	)		const

protectedinherited

Adds the timed simHit to the output SDO container.

The hit may be rejected if it's originating from pile-up and the pile-up truth skimming strategy is applied

Definition at line 148 of file MuonDigitizationTool.cxx.

                                                                                                 {
         if(!sdoContainer) {
             ATH_MSG_VERBOSE("No SDO container setup of writing");
             return nullptr;
         }
         if (!m_includePileUpTruth && HepMC::ignoreTruthLink(hit->genParticleLink(), m_vetoPileUpTruthLinks)) { 
             ATH_MSG_VERBOSE("Hit "<<m_idHelperSvc->toString(hit->identify())<<" is a pile-up truth link");
             return nullptr; 
         }
         
         xAOD::MuonSimHit* sdoHit = sdoContainer->push_back(std::make_unique<xAOD::MuonSimHit>());
         (*sdoHit) = (*hit);
         static const SG::Accessor<float> acc_eventTime{"MuSim_evtTime"};
         static const SG::Accessor<unsigned short> acc_eventID{"MuSim_evtID"};
         static const SG::Accessor<unsigned short> acc_puType{"MuSim_puType"};
         acc_eventTime(*sdoHit) = hit.eventTime();
         acc_eventID(*sdoHit) = hit.eventId();
         acc_puType(*sdoHit) = hit.pileupType();
         return sdoHit;
     }

◆ digitize()

StatusCode MdtDigitizationTool::digitize	(	const EventContext &	ctx,
		const TimedHits &	hitsToDigit,
		xAOD::MuonSimHitContainer *	sdoContainer
	)		const

finaloverrideprotectedvirtual

Digitize the time ordered hits and write them to the digit format specific for the detector technology.

A new MuonSimHitContainer pointer is parsed to also create the MuonSDO. If a new SDO should be added to the container plese use the addSDO() method as defined below.

Fetch the needed conditions

Hit is masked in the database for whatever reason

Total tdc time is the sum of the drift time, the time of flight of the muon, the propgation along the wire and finally the constant t0 tube offset

Question: What happens if there're 2 digits such close by that their adc needs to be merged?

The HPTdc has 4 times higher clock frequency. Smear both

Put also in the twin tube digit

The signal for the twin tube needs to travel to the HV side & then through the complete twin tube

Total tdc time is the sum of the drift time, the time of flight of the muon, the propgation along the wire and finally the constant t0 tube offset

The digitization might have produced digits which are overlapping in time, in particular if twin tubes are hit. Filter tube digits which are produced within the dead time interval

Find the next digit which is either another tube or beyond the dead time

Write everything at the end into the final digit container

Implements MuonR4::MuonDigitizationTool.

Definition at line 27 of file MuonPhaseII/MuonDigitization/MdtDigitizationR4/src/MdtDigitizationTool.cxx.

                                                                                           {
         
       
         const MdtIdHelper& idHelper{m_idHelperSvc->mdtIdHelper()};
         // Prepare the temporary cache
         
         using DigitSDOPair = std::pair<std::unique_ptr<MdtDigit>, TimedHit>;
         const MuonCalib::MdtCalibDataContainer* calibData{nullptr};
         ATH_CHECK(retrieveConditions(ctx, m_calibDbKey, calibData));
         const MdtCondDbData* badTubes{nullptr};
         ATH_CHECK(retrieveConditions(ctx, m_badTubeKey, badTubes));
         const Muon::TwinTubeMap* twinTubes{nullptr};
         ATH_CHECK(retrieveConditions(ctx, m_twinTubeKey, twinTubes));
         CLHEP::HepRandomEngine* rndEngine = getRandomEngine(ctx);
         
         DigiCache digitCache{};
  
         xAOD::ChamberViewer viewer{hitsToDigit, m_idHelperSvc.get()};
         do {
             Identifier lastTube{};
             double deadTime{0.};
             std::vector<DigitSDOPair> digitsInChamber{};
         
             for (const TimedHitPtr<xAOD::MuonSimHit>& simHit : viewer) {
                 const Identifier hitId{simHit->identify()};
                 if (!badTubes->isGood(hitId)) {
                     ATH_MSG_VERBOSE("Hit "<<m_idHelperSvc->toString(hitId)<<" is rejected due to masking in DB.");
                     continue;
                 }
                 const MuonGMR4::MdtReadoutElement* readOutEle = m_detMgr->getMdtReadoutElement(hitId);
                 const IdentifierHash measHash{readOutEle->measurementHash(hitId)};
                 if (m_digitizeMuonOnly && std::abs(simHit->pdgId()) != 13) {
                     ATH_MSG_VERBOSE("Hit is not from a muon");
                     continue;
                 }
  
                 const Amg::Vector3D locPos{xAOD::toEigen(simHit->localPosition())};
                 const double distRO = readOutEle->distanceToReadout(measHash, locPos);
  
                 const MdtDigiToolInput digiInput(std::abs(locPos.perp()), distRO, 0., 0., 0., 0., hitId);
                 const MdtDigiToolOutput digiOutput(m_digiTool->digitize(ctx, digiInput, rndEngine));
                 if (!digiOutput.wasEfficient()) {
                     ATH_MSG_VERBOSE("Hit "<<m_idHelperSvc->toString(hitId)<<" is rejected due to inefficiency modelling.");
                     continue;
                 }
                 const double arrivalTime{simHit->globalTime()};
  
                 const MuonCalib::MdtFullCalibData* tubeConstants = calibData->getCalibData(hitId, msgStream());
                 assert(tubeConstants != nullptr);
                 assert(tubeConstants->tubeCalib.get()  != nullptr);
                 assert(tubeConstants->tubeCalib->getCalib(hitId) != nullptr);
  
                 const MuonCalib::MdtTubeCalibContainer::SingleTubeCalib& tubeCalib{*tubeConstants->tubeCalib->getCalib(hitId)};
             
                 const double sigPropTime = tubeCalib.inversePropSpeed*distRO;
                 ATH_MSG_VERBOSE(m_idHelperSvc->toString(hitId)<<" "<<Amg::toString(locPos)<<" distance to readout: "<<distRO<<" --> "<<sigPropTime);
                 const double totalTdcTime = digiOutput.driftTime() + arrivalTime + tubeCalib.t0 + sigPropTime;
                 if (lastTube != hitId || deadTime < totalTdcTime) {
                     lastTube = hitId;
                     deadTime = totalTdcTime + m_deadTime;
                 } else {
                     ATH_MSG_VERBOSE("Hit "<<m_idHelperSvc->toString(hitId)<<" has been produced within dead time");
                     continue;
                 }
  
                 const bool hasHPTdc = m_idHelperSvc->hasHPTDC(hitId);
                 const uint16_t tdcCounts = timeToTdcCnv*(hasHPTdc ? 4 : 1)*CLHEP::RandGaussZiggurat::shoot(rndEngine, totalTdcTime, m_timeResTDC);
                 const uint16_t adcCounts = (hasHPTdc ? 4 : 1) *CLHEP::RandGaussZiggurat::shoot(rndEngine, digiOutput.adc(), m_timeResADC);
  
                 auto digit = std::make_unique<MdtDigit>(hitId, tdcCounts, adcCounts, false);
                 ATH_MSG_VERBOSE("Add digit "<<m_idHelperSvc->toString(digit->identify())<<", tdc: "<<digit->tdc()<<", adc: "<<digit->adc());
                 digitsInChamber.push_back(std::make_pair(std::move(digit), simHit));
                 if (!twinTubes || !twinTubes->isTwinTubeLayer(hitId)) {
                     continue;
                 }
                 const Identifier twinId{twinTubes->twinId(hitId)};
                 if (twinId == hitId) {
                     ATH_MSG_VERBOSE("The hit "<<m_idHelperSvc->toString(hitId)<<" has no twins.");
                     continue;
                 }
                 const IdentifierHash twinHash{readOutEle->measurementHash(twinId)};
                 if (!readOutEle->isValid(twinHash)) {
                     ATH_MSG_VERBOSE("Reject "<<m_idHelperSvc->toString(twinId)<<" as there's no tube ");
                     continue;
                 }
                 const double twinDist = readOutEle->activeTubeLength(measHash) - distRO + 
                                         readOutEle->activeTubeLength(twinHash);
             
                 ATH_MSG_VERBOSE("Twin hit :"<<m_idHelperSvc->toString(twinId)<< ", local Z: "<<simHit->localPosition().z()
                               <<", tube length: "<<readOutEle->activeTubeLength(measHash)<<", distRO: "<<distRO
                               <<", twin length: "<<readOutEle->activeTubeLength(twinHash)
                               <<", twin distance: "<<twinDist);
                 const MuonCalib::MdtTubeCalibContainer::SingleTubeCalib& twinCalib{*tubeConstants->tubeCalib->getCalib(twinId)};
             
                 const double twinPropTime = tubeCalib.inversePropSpeed*twinDist;
                 const double twinTdcTime = digiOutput.driftTime() + arrivalTime + twinPropTime 
                                          + twinCalib.t0 + twinTubes->hvDelayTime(twinId);
  
                 const uint16_t twinTdcCounts = timeToTdcCnv*(hasHPTdc ? 4 : 1)*CLHEP::RandGaussZiggurat::shoot(rndEngine, twinTdcTime, m_resTwin);
                 const uint16_t twinAdcCoutns = (hasHPTdc ? 4 : 1) *CLHEP::RandGaussZiggurat::shoot(rndEngine, digiOutput.adc(), m_timeResADC);
                 digit = std::make_unique<MdtDigit>(twinId, twinTdcCounts, twinAdcCoutns, false);
                 ATH_MSG_VERBOSE("Add twin digit "<<m_idHelperSvc->toString(digit->identify())<<", tdc: "<<digit->tdc()
                                 <<", adc: "<<digit->adc()<<", local z: "<<simHit->localPosition().z());
                 digitsInChamber.push_back(std::make_pair(std::move(digit), simHit));
             }
             std::ranges::sort(digitsInChamber,[](const DigitSDOPair&a, const DigitSDOPair& b){
                         if (a.first->identify() != b.first->identify()) {
                            return a.first->identify() < b.first->identify();
                         }
                         return a.first->tdc() < b.first->tdc();
                     });
       
             for (std::vector<DigitSDOPair>::iterator saveMe = digitsInChamber.begin(); saveMe != digitsInChamber.end() ; ) {
                 addSDO(saveMe->second, sdoContainer);
                 const MdtDigit* saved = fetchCollection(saveMe->first->identify(), digitCache)->push_back(std::move(saveMe->first));
                 const uint16_t deadInterval = saved->tdc() + timeToTdcCnv*(m_idHelperSvc->hasHPTDC(saved->identify()) ?4 : 1)*m_deadTime;
                 saveMe = std::find_if(saveMe +1, digitsInChamber.end(),
                                       [deadInterval, saved](const DigitSDOPair& digitized) {
                                          return saved->identify() != digitized.first->identify() || deadInterval < digitized.first->tdc();
                                       });
             }
         } while (viewer.next());
         ATH_CHECK(writeDigitContainer(ctx, m_writeKey, std::move(digitCache), idHelper.module_hash_max()));
         return StatusCode::SUCCESS;
     }

◆ fetchCollection()

template<class DigitColl >

DigitColl* MuonR4::MuonDigitizationTool::fetchCollection	(	const Identifier &	hitId,
		OutDigitCache_t< DigitColl > &	digitCache
	)		const

protectedinherited

Helper function that provides fetches the proper DigitCollection from the DigitCache for a given hit identifier If the Collection is fetched for the first time, it's inserted into the cache first.

◆ fillTimedHits()

StatusCode MuonR4::MuonDigitizationTool::fillTimedHits	(	PileUpHits &&	hitColl,
		TimedHits &	timedHits
	)		const

privateinherited

Translates the PileUpHits into the timed hits format.

Definition at line 50 of file MuonDigitizationTool.cxx.

                                                                                                    {
         for (const auto& [timeIndex, simHitColl] : hitColl) {
             timedHits.reserve(timedHits.capacity() + simHitColl->size());
             for (const xAOD::MuonSimHit* simHit : *simHitColl) {
                 timedHits.emplace_back(timeIndex.time(), timeIndex.index(), simHit, timeIndex.type());
             }           
         }
         std::sort(timedHits.begin(), timedHits.end(), 
                  [](const TimedHit& a, const TimedHit& b){
                     if (a->identify() != b->identify()){
                         return a->identify() < b->identify();
                     }
                     if (a.eventId() != b.eventId()) {
                        return a.eventId() < b.eventId();
                     } 
                     return a.eventTime() < b.eventTime(); 
                 }); 
         return StatusCode::SUCCESS;
     }

◆ filterPassed()

virtual bool PileUpToolBase::filterPassed ( ) const

inlineoverridevirtualinherited

dummy implementation of passing filter

Definition at line 49 of file PileUpToolBase.h.

49 { return m_filterPassed; }

◆ getGeoCtx()

const ActsGeometryContext & MuonR4::MuonDigitizationTool::getGeoCtx ( const EventContext & ctx ) const

protectedinherited

Returns the reference to the ActsGeometryContext needed to fetch global positions from the Readout geometry.

Definition at line 141 of file MuonDigitizationTool.cxx.

                                                                                             {
         const ActsGeometryContext* gctx{};
         if (!retrieveContainer(ctx, m_geoCtxKey, gctx).isSuccess()) {
             THROW_EXCEPTION("Failed to retrieve the geometry context "<<m_geoCtxKey.fullKey());
         }
         return *gctx;
     }

◆ getRandomEngine()

CLHEP::HepRandomEngine * MuonR4::MuonDigitizationTool::getRandomEngine ( const EventContext & ctx ) const

protectedinherited

Definition at line 135 of file MuonDigitizationTool.cxx.

                                                                                             {
         ATHRNG::RNGWrapper* rngWrapper = m_rndmSvc->getEngine(this, m_streamName);
         std::string rngName = m_streamName;
         rngWrapper->setSeed(rngName, ctx);
         return rngWrapper->getEngine(ctx);
     }

◆ hitTime()

double MuonR4::MuonDigitizationTool::hitTime ( const TimedHit & hit )

staticprotectedinherited

Returns the global time of the hit which is the sum of eventTime & individual hit time.

Definition at line 69 of file MuonDigitizationTool.cxx.

                                                             {
         return hit.eventTime() + hit->globalTime();
     }

◆ initialize()

StatusCode MdtDigitizationTool::initialize ( )

finaloverridevirtual

Reimplemented from PileUpToolBase.

Definition at line 19 of file MuonPhaseII/MuonDigitization/MdtDigitizationR4/src/MdtDigitizationTool.cxx.

                                                {
         ATH_CHECK(MuonDigitizationTool::initialize());
         ATH_CHECK(m_writeKey.initialize());
         ATH_CHECK(m_calibDbKey.initialize());
         ATH_CHECK(m_badTubeKey.initialize());
         ATH_CHECK(m_twinTubeKey.initialize(m_useTwinTube));
         return StatusCode::SUCCESS;
     }

◆ mergeEvent()

StatusCode MuonR4::MuonDigitizationTool::mergeEvent ( const EventContext & ctx )

finaloverrideinherited

Definition at line 98 of file MuonDigitizationTool.cxx.

                                                                        {
         ATH_MSG_DEBUG("mergeEvent()");
         
         SG::WriteHandle<xAOD::MuonSimHitContainer> sdoContainer{};
         if (!m_sdoKey.empty()) {
              sdoContainer = SG::WriteHandle<xAOD::MuonSimHitContainer>{m_sdoKey, ctx};
              ATH_CHECK(sdoContainer.record(std::make_unique<xAOD::MuonSimHitContainer>(),
                                            std::make_unique<xAOD::MuonSimHitAuxContainer>()));
         }
         ATH_CHECK(digitize(ctx, m_timedHits, !m_sdoKey.empty() ? sdoContainer.ptr() : nullptr));
         m_timedHits.clear();
         m_simHits.clear();
         return StatusCode::SUCCESS;
     }

◆ passDeadTime()

bool MuonR4::MuonDigitizationTool::passDeadTime	(	const Identifier &	channelId,
		const double	hitTime,
		const double	deadTimeWindow,
		DeadTimeMap &	deadTimeMap
	)

staticprotectedinherited

Returns whether the new digit is within the dead time window.

channelId: Identifier of the fired channel

hitTime: Current hit time

deadTimeWindow: Dead time to pass before the next hit may be accepted

deadTimeMap: Map storing the last hit times from each Identifier

Channel not seen before

Update dead time map & accept hit

Definition at line 169 of file MuonDigitizationTool.cxx.

                                                                       {
         auto insertItr = deadTimeMap.insert(std::make_pair(channelId,hitTime));
         if (insertItr.second) {
             return true;
         }
         if (hitTime - insertItr.first->second < deadTimeWindow) {
             return false;
         }
         insertItr.first->second = hitTime;
         return true;
     }

◆ prepareEvent()

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

finaloverrideinherited

When being run from PileUpToolsAlgs, this method is called at the start of the subevts loop.

Not able to access SubEvents

Definition at line 41 of file MuonDigitizationTool.cxx.

                                                                              {
  
         ATH_MSG_DEBUG("prepareEvent() called for " << nInputEvents << " input events");
         m_timedHits.clear();
         m_simHits.clear();
         return StatusCode::SUCCESS;
     }

◆ processAllSubEvents() [1/3]

StatusCode MuonR4::MuonDigitizationTool::processAllSubEvents ( const EventContext & ctx ) const

inherited

Reentrant version of the digitization tool.

In case of single hits container just load the collection using read handles

Definition at line 77 of file MuonDigitizationTool.cxx.

                                                                                       {
         PileUpHits hitCollList{};
         TimedHits timedHits{};
         if (!m_onlyUseContainerName) {            
             const xAOD::MuonSimHitContainer* hitCollection{nullptr};
             ATH_CHECK(retrieveContainer(ctx, m_simHitKey, hitCollection));
             hitCollList.emplace_back(PileUpTimeEventIndex(0), hitCollection);
          } else {
             ATH_CHECK(m_mergeSvc->retrieveSubEvtsData(m_inputObjectName, hitCollList));
         }
         ATH_CHECK(fillTimedHits(std::move(hitCollList), timedHits));
         SG::WriteHandle<xAOD::MuonSimHitContainer> sdoContainer{};
         if (!m_sdoKey.empty()) {
              sdoContainer = SG::WriteHandle<xAOD::MuonSimHitContainer>{m_sdoKey, ctx};
              ATH_CHECK(sdoContainer.record(std::make_unique<xAOD::MuonSimHitContainer>(),
                                            std::make_unique<xAOD::MuonSimHitAuxContainer>()));
         }
         ATH_CHECK(digitize(ctx, timedHits, !m_sdoKey.empty() ? sdoContainer.ptr() : nullptr));
         return StatusCode::SUCCESS;
     }

◆ processAllSubEvents() [2/3]

StatusCode MuonR4::MuonDigitizationTool::processAllSubEvents ( const EventContext & ctx )

finaloverridevirtualinherited

alternative interface which uses the PileUpMergeSvc to obtain all the required SubEvents.

Reimplemented from PileUpToolBase.

Definition at line 72 of file MuonDigitizationTool.cxx.

                                                                                 {
         const MuonDigitizationTool* digiTool = this;
         return digiTool->processAllSubEvents(ctx);
     }

◆ processAllSubEvents() [3/3]

virtual StatusCode IPileUpTool::processAllSubEvents

inherited

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

◆ processBunchXing()

StatusCode MuonR4::MuonDigitizationTool::processBunchXing	(	int	bunchXing,
		SubEventIterator	bSubEvents,
		SubEventIterator	eSubEvents
	)

finaloverridevirtualinherited

Reimplemented from PileUpToolBase.

Definition at line 114 of file MuonDigitizationTool.cxx.

                                                                                    {        
         ATH_MSG_DEBUG("processBunchXing()" << bunchXing);
         PileUpHits hitList{}, hitListPermanent{};
         ATH_CHECK(m_mergeSvc->retrieveSubSetEvtData(m_inputObjectName, hitList, bunchXing, bSubEvents, eSubEvents));
         ATH_MSG_VERBOSE(hitList.size() << " hits in  xAODMuonSimHitContainer " << m_inputObjectName << " found");
         for (auto& [hitPtr, hitContainer] : hitList) {
             auto copyContainer = std::make_unique<xAOD::MuonSimHitContainer>();
             auto copyAuxContainer = std::make_unique<xAOD::MuonSimHitAuxContainer>();
             copyContainer->setStore(copyAuxContainer.get());
             for (const xAOD::MuonSimHit* copyMe : *hitContainer) {
                (*copyContainer->push_back(std::make_unique<xAOD::MuonSimHit>())) = (*copyMe);
             }
             hitListPermanent.emplace_back(hitPtr, copyContainer.get());
             m_simHits.emplace_back(std::move(copyContainer), std::move(copyAuxContainer));
         } 
         ATH_CHECK(fillTimedHits(std::move(hitListPermanent), m_timedHits));
         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; }

◆ retrieveConditions()

template<class Container >

StatusCode MuonR4::MuonDigitizationTool::retrieveConditions	(	const EventContext &	ctx,
		const SG::ReadCondHandleKey< Container > &	key,
		const Container *&	contPtr
	)		const

protectedinherited

Helper function to access the conditions data.

If the key is empty, the conditions object is assigned to be a nullptr Otherwise, a failure is returned if the Conditions data are not available in the event.

◆ retrieveContainer()

template<class Container >

StatusCode MuonR4::MuonDigitizationTool::retrieveContainer	(	const EventContext &	ctx,
		const SG::ReadHandleKey< Container > &	key,
		const Container *&	contPtr
	)		const

protectedinherited

Helper function to retrieve a container from StoreGate.

If the readHandleKey is empty, the container is assigned to be a nullptr and the operation is marked as success. Otherwise, a failure is returned if the Container cannot be fetched from StoreGate

◆ 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));
   }

◆ writeDigitContainer()

template<class DigitCont , class DigitColl >

StatusCode MuonR4::MuonDigitizationTool::writeDigitContainer	(	const EventContext &	ctx,
		const SG::WriteHandleKey< DigitCont > &	key,
		OutDigitCache_t< DigitColl > &&	digitCache,
		unsigned int	hashMax
	)		const

protectedinherited

Helper function to move the collected digits into the final DigitContainer.

The function needs the maximal size of the container in advance which is provided by calling the module_hash_max() function of the corresponding MuonIdHelper.

Member Data Documentation

◆ m_badTubeKey

SG::ReadCondHandleKey<MdtCondDbData> MuonR4::MdtDigitizationTool::m_badTubeKey {this, "BadTubeKey", "MdtCondDbData", "Key of MdtCondDbData"}

private

Definition at line 34 of file MuonPhaseII/MuonDigitization/MdtDigitizationR4/src/MdtDigitizationTool.h.

◆ m_calibDbKey

SG::ReadCondHandleKey<MuonCalib::MdtCalibDataContainer> MuonR4::MdtDigitizationTool::m_calibDbKey

private

Initial value:

{this, "CalibDataKey", "MdtCalibConstants",

"Conditions object containing the calibrations"}

Definition at line 30 of file MuonPhaseII/MuonDigitization/MdtDigitizationR4/src/MdtDigitizationTool.h.

◆ m_deadTime

Gaudi::Property<double> MuonR4::MdtDigitizationTool::m_deadTime {this, "DeadTime", 700., "MDT drift tube dead time"}

private

Definition at line 42 of file MuonPhaseII/MuonDigitization/MdtDigitizationR4/src/MdtDigitizationTool.h.

◆ m_detMgr

const MuonGMR4::MuonDetectorManager* MuonR4::MuonDigitizationTool::m_detMgr {nullptr}

protectedinherited

Definition at line 140 of file MuonDigitizationTool.h.

◆ m_digitizeMuonOnly

Gaudi::Property<bool> MuonR4::MdtDigitizationTool::m_digitizeMuonOnly {this, "ProcessTrueMuonsOnly", false, "If set to true hit with pdgId != 13 are skipped"}

private

Definition at line 43 of file MuonPhaseII/MuonDigitization/MdtDigitizationR4/src/MdtDigitizationTool.h.

◆ m_digiTool

ToolHandle<IMDT_DigitizationTool> MuonR4::MdtDigitizationTool::m_digiTool {this, "DigitizationTool", ""}

private

Definition at line 38 of file MuonPhaseII/MuonDigitization/MdtDigitizationR4/src/MdtDigitizationTool.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_geoCtxKey

SG::ReadHandleKey<ActsGeometryContext> MuonR4::MuonDigitizationTool::m_geoCtxKey

privateinherited

Initial value:

{this, "AlignmentKey", "ActsAlignment",

"Geometry context"}

Definition at line 152 of file MuonDigitizationTool.h.

◆ m_idHelperSvc

ServiceHandle<Muon::IMuonIdHelperSvc> MuonR4::MuonDigitizationTool::m_idHelperSvc

protectedinherited

Initial value:

{this, "MuonIdHelperSvc",

"Muon::MuonIdHelperSvc/MuonIdHelperSvc"}

Definition at line 142 of file MuonDigitizationTool.h.

◆ m_includePileUpTruth

Gaudi::Property<bool> MuonR4::MuonDigitizationTool::m_includePileUpTruth {this, "IncludePileUpTruth", true, "Include pile-up truth info"}

privateinherited

Definition at line 166 of file MuonDigitizationTool.h.

◆ m_inputObjectName

std::string MuonR4::MuonDigitizationTool::m_inputObjectName {""}

privateinherited

Definition at line 168 of file MuonDigitizationTool.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_mergeSvc

ServiceHandle<PileUpMergeSvc> MuonR4::MuonDigitizationTool::m_mergeSvc {this, "PileUpMergeSvc", "PileUpMergeSvc", ""}

privateinherited

Definition at line 155 of file MuonDigitizationTool.h.

◆ m_onlyUseContainerName

Gaudi::Property<bool> MuonR4::MuonDigitizationTool::m_onlyUseContainerName

privateinherited

Initial value:

{this, "OnlyUseContainerName", false,

"Don't use the ReadHandleKey directly. Just extract the container name from it."}

Definition at line 163 of file MuonDigitizationTool.h.

◆ m_resTwin

Gaudi::Property<double> MuonR4::MdtDigitizationTool::m_resTwin {this, "ResolutionTwinTube", 1.05 * Gaudi::Units::ns, "Twin Tube resolution"}

private

Definition at line 46 of file MuonPhaseII/MuonDigitization/MdtDigitizationR4/src/MdtDigitizationTool.h.

◆ m_rndmSvc

ServiceHandle<IAthRNGSvc> MuonR4::MuonDigitizationTool::m_rndmSvc {this, "RndmSvc", "AthRNGSvc", ""}

privateinherited

Definition at line 159 of file MuonDigitizationTool.h.

◆ m_sdoKey

SG::WriteHandleKey<xAOD::MuonSimHitContainer> MuonR4::MuonDigitizationTool::m_sdoKey {this, "OutputSDOName", ""}

privateinherited

Definition at line 161 of file MuonDigitizationTool.h.

◆ m_simHitKey

SG::ReadHandleKey<xAOD::MuonSimHitContainer> MuonR4::MuonDigitizationTool::m_simHitKey {this, "SimHitKey", ""}

privateinherited

Definition at line 150 of file MuonDigitizationTool.h.

◆ m_simHits

std::vector<SimHitLocalCopy> MuonR4::MuonDigitizationTool::m_simHits {}

privateinherited

Definition at line 174 of file MuonDigitizationTool.h.

◆ m_streamName

Gaudi::Property<std::string> MuonR4::MuonDigitizationTool::m_streamName {this, "StreamName", ""}

privateinherited

Definition at line 157 of file MuonDigitizationTool.h.

◆ m_timedHits

TimedHits MuonR4::MuonDigitizationTool::m_timedHits {}

privateinherited

Definition at line 170 of file MuonDigitizationTool.h.

◆ m_timeResADC

Gaudi::Property<double> MuonR4::MdtDigitizationTool::m_timeResADC {this, "ResolutionADC", 0.5 * Gaudi::Units::ns, "ADC time resolution"}

private

Definition at line 41 of file MuonPhaseII/MuonDigitization/MdtDigitizationR4/src/MdtDigitizationTool.h.

◆ m_timeResTDC

Gaudi::Property<double> MuonR4::MdtDigitizationTool::m_timeResTDC {this, "ResolutionTDC", 0.5 * Gaudi::Units::ns, "TDC time resolution"}

private

Definition at line 40 of file MuonPhaseII/MuonDigitization/MdtDigitizationR4/src/MdtDigitizationTool.h.

◆ m_twinTubeKey

SG::ReadCondHandleKey<Muon::TwinTubeMap> MuonR4::MdtDigitizationTool::m_twinTubeKey {this, "TwinTubeKey", "MdtTwinTubeMap"}

private

Definition at line 36 of file MuonPhaseII/MuonDigitization/MdtDigitizationR4/src/MdtDigitizationTool.h.

◆ m_useTwinTube

Gaudi::Property<bool> MuonR4::MdtDigitizationTool::m_useTwinTube {this, "useTwinTubes", false}

private

Properties to model the Twin tube signals.

Definition at line 45 of file MuonPhaseII/MuonDigitization/MdtDigitizationR4/src/MdtDigitizationTool.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.

◆ m_writeKey

SG::WriteHandleKey<MdtDigitContainer> MuonR4::MdtDigitizationTool::m_writeKey {this, "OutputObjectName", "MDT_Digits"}

private

Definition at line 28 of file MuonPhaseII/MuonDigitization/MdtDigitizationR4/src/MdtDigitizationTool.h.

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

Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

structors and AlgTool implementation

Detailed Description

Member Typedef Documentation

◆ DeadTimeMap

◆ DigiCache

◆ OutDigitCache_t

◆ PileUpHits

◆ SimHitLocalCopy

◆ TimedHit

◆ TimedHits

Constructor & Destructor Documentation

◆ MdtDigitizationTool()

Member Function Documentation

◆ addSDO()

◆ digitize()

◆ fetchCollection()

◆ fillTimedHits()

◆ filterPassed()

◆ getGeoCtx()

◆ getRandomEngine()

◆ hitTime()

◆ initialize()

◆ mergeEvent()

◆ passDeadTime()

◆ prepareEvent()

◆ processAllSubEvents() [1/3]

◆ processAllSubEvents() [2/3]

◆ processAllSubEvents() [3/3]

◆ processBunchXing()

◆ resetFilter()

◆ retrieveConditions()

◆ retrieveContainer()

◆ toProcess()

◆ writeDigitContainer()

Member Data Documentation

◆ m_badTubeKey

◆ m_calibDbKey

◆ m_deadTime

◆ m_detMgr

◆ m_digitizeMuonOnly

◆ m_digiTool

◆ m_filterPassed

◆ m_firstXing

◆ m_geoCtxKey

◆ m_idHelperSvc

◆ m_includePileUpTruth

◆ m_inputObjectName

◆ m_lastXing

◆ m_mergeSvc

◆ m_onlyUseContainerName

◆ m_resTwin

◆ m_rndmSvc

◆ m_sdoKey

◆ m_simHitKey

◆ m_simHits

◆ m_streamName

◆ m_timedHits

◆ m_timeResADC

◆ m_timeResTDC

◆ m_twinTubeKey

◆ m_useTwinTube

◆ m_vetoPileUpTruthLinks

◆ m_writeKey