MuonR4::TruthSegmentMaker Class Reference

#include <TruthSegmentMaker.h>

Inheritance diagram for MuonR4::TruthSegmentMaker:

Collaboration diagram for MuonR4::TruthSegmentMaker:

Classes
struct	WriteDecorHolder
	Helper struct to ship the write DecorHandles and the reference to the output segment container through the class methods. More...

Public Member Functions
	~TruthSegmentMaker ()=default
StatusCode	initialize () override final
StatusCode	execute (const EventContext &ctx) const override
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual bool	isClonable () const override
	Specify if the algorithm is clonable.
virtual unsigned int	cardinality () const override
	Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant.
virtual StatusCode	sysExecute (const EventContext &ctx) override
	Execute an algorithm.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
virtual bool	filterPassed (const EventContext &ctx) const
virtual void	setFilterPassed (bool state, const EventContext &ctx) const
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Private Types
using	HitPosTuple_t = std::tuple<const xAOD::MuonSimHit*, Amg::Vector3D, Amg::Vector3D>
	Tuple consisting out of pointer to the sim hit and the position & direction expressed in the chamber's frame.
using	SimHitVec_t = std::vector<HitPosTuple_t>
using	EleLink_t = ElementLink<xAOD::MuonSimHitContainer>
using	HitLinkVec_t = std::vector<EleLink_t>
using	LinkDecor_t = SG::WriteDecorHandle<xAOD::MuonSegmentContainer, HitLinkVec_t>
using	FloatDecor_t = SG::WriteDecorHandle<xAOD::MuonSegmentContainer, float>
using	SegPars_t = xAOD::MeasVector<Acts::toUnderlying(SegmentFit::ParamDefs::nPars)>
using	SegParDecor_t = SG::WriteDecorHandle<xAOD::MuonSegmentContainer, SegPars_t>
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Amg::Transform3D	toChamber (const ActsTrk::GeometryContext &gctx, const Identifier &chanId) const
	Returns the transform from the local simHit frame -> chamber frame.
xAOD::MuonSegment *	constructSegmentFromHits (const EventContext &ctx, const Amg::Transform3D &locToGlob, const SimHitVec_t &hits, WriteDecorHolder &writeShip) const
	Takes a list of related sim hits and transforms them into a truth segment.
void	buildSegmentsFromBkg (const EventContext &ctx, const Amg::Transform3D &locToGlob, const SimHitVec_t &simHits, WriteDecorHolder &writeShip) const
	Attempts to assemble truth segments from a list of loose sim hits, i.e., the hits are stemming from a muon but due to the pile-up truth record, no HepMCParticles are recorded.
float	muonPt (const xAOD::MuonSimHit &hit, const Amg::Vector3D &globDir) const
	Returns the muon pt from the sim hit.
float	hitUncertainty (const EventContext &ctx, const xAOD::MuonSimHit &hit) const
	Evaluates the hit uncertainty.
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
ServiceHandle< Muon::IMuonIdHelperSvc >	m_idHelperSvc {this, "IdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"}
	IdHelperSvc to decode the Identifiers.
SG::ReadHandleKeyArray< xAOD::MuonSimHitContainer >	m_readKeys {this, "SimHitKeys", {}}
	List of sim hit containers from which the truth segments shall be retrieved.
SG::ReadHandleKey< ActsTrk::GeometryContext >	m_geoCtxKey {this, "AlignmentKey", "ActsAlignment", "cond handle key"}
	Key to the geometry context.
SG::WriteHandleKey< xAOD::MuonSegmentContainer >	m_segmentKey {this, "WriteKey", "MuonTruthSegments"}
	Key under which the segment Container will be recorded in StoreGate.
SG::WriteDecorHandleKey< xAOD::MuonSegmentContainer >	m_eleLinkKey {this, "SimHitLink", m_segmentKey, "simHitLinks"}
	Decoration key of the associated sim hit links.
SG::WriteDecorHandleKey< xAOD::MuonSegmentContainer >	m_ptKey {this, "PtKey", m_segmentKey, "pt"}
	Decoration key of the associated particle pt.
SG::WriteDecorHandleKey< xAOD::MuonSegmentContainer >	m_locParKey {this, "LocParKey", m_segmentKey,"localSegPars"}
	Decoration key of the local parameters.
SG::WriteDecorHandleKey< xAOD::MuonSegmentContainer >	m_qKey {this, "qKey", m_segmentKey, "charge"}
	Decoration key of the muon charge.
Gaudi::Property< bool >	m_useOnlyMuonHits {this, "useOnlyMuonHits", true}
	Build segments from muon hits only.
Gaudi::Property< bool >	m_includePileUpHits {this, "includePileUpHits", true}
	Construct segments from pile-up hits without GenParticleLink.
Gaudi::Property< float >	m_pileUpHitMinE {this, "energyThresholdPileUp", 1.*Gaudi::Units::GeV}
	Minimum energy threshold for pile up hits to be converted.
Gaudi::Property< float >	m_pileUpHitELoss {this, "pileUpHitELoss", 5.*Gaudi::Units::MeV}
	Maximum energy loss between two pile-up hits.
Gaudi::Property< float >	m_pileUpHitAngleCone {this, "pileUpHitAngleCone", 1.*Gaudi::Units::deg}
	Maximum scattering angle between two pile-up hits.
Gaudi::Property< float >	m_pileUpHitDistance {this, "pileUpHitDistance", 2.*Gaudi::Units::m}
	Maximum separation between two pile-up hits.
Gaudi::Property< float >	m_idCylinderR {this, "IdCylinderR", 1.1*Gaudi::Units::m}
	ID / ITk cylinder radius.
Gaudi::Property< float >	m_idCylinderHalfZ {this, "IdCylinderHalfZ", 3.2*Gaudi::Units::m}
	ID / Itk cylinder half length.
const MuonGMR4::MuonDetectorManager *	m_detMgr {nullptr}
	Pointer to the muon readout geometry.
SG::ReadCondHandleKey< MuonCalib::MdtCalibDataContainer >	m_mdtCalibKey
	Data dependency on the Mdt calibration container to calculate the uncertainty.
SG::ReadCondHandleKey< NswErrorCalibData >	m_nswUncertKey
	Data dependency on the Nsw calibration container to estimate the uncertaintys.
DataObjIDColl	m_extendedExtraObjects
	Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 32 of file TruthSegmentMaker.h.

Member Typedef Documentation

EleLink_t

using MuonR4::TruthSegmentMaker::EleLink_t = ElementLink<xAOD::MuonSimHitContainer>

private

Definition at line 55 of file TruthSegmentMaker.h.

FloatDecor_t

using MuonR4::TruthSegmentMaker::FloatDecor_t = SG::WriteDecorHandle<xAOD::MuonSegmentContainer, float>

private

Definition at line 58 of file TruthSegmentMaker.h.

HitLinkVec_t

using MuonR4::TruthSegmentMaker::HitLinkVec_t = std::vector<EleLink_t>

private

Definition at line 56 of file TruthSegmentMaker.h.

HitPosTuple_t

using MuonR4::TruthSegmentMaker::HitPosTuple_t = std::tuple<const xAOD::MuonSimHit*, Amg::Vector3D, Amg::Vector3D>

private

Tuple consisting out of pointer to the sim hit and the position & direction expressed in the chamber's frame.

Definition at line 50 of file TruthSegmentMaker.h.

LinkDecor_t

using MuonR4::TruthSegmentMaker::LinkDecor_t = SG::WriteDecorHandle<xAOD::MuonSegmentContainer, HitLinkVec_t>

private

Definition at line 57 of file TruthSegmentMaker.h.

SegParDecor_t

using MuonR4::TruthSegmentMaker::SegParDecor_t = SG::WriteDecorHandle<xAOD::MuonSegmentContainer, SegPars_t>

private

Definition at line 61 of file TruthSegmentMaker.h.

SegPars_t

using MuonR4::TruthSegmentMaker::SegPars_t = xAOD::MeasVector<Acts::toUnderlying(SegmentFit::ParamDefs::nPars)>

private

Definition at line 60 of file TruthSegmentMaker.h.

SimHitVec_t

using MuonR4::TruthSegmentMaker::SimHitVec_t = std::vector<HitPosTuple_t>

private

Definition at line 51 of file TruthSegmentMaker.h.

StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

~TruthSegmentMaker()

MuonR4::TruthSegmentMaker::~TruthSegmentMaker ( )

default

Member Function Documentation

buildSegmentsFromBkg()

void MuonR4::TruthSegmentMaker::buildSegmentsFromBkg ( const EventContext & ctx, const Amg::Transform3D & locToGlob, const SimHitVec_t & simHits, WriteDecorHolder & writeShip ) const

private

Attempts to assemble truth segments from a list of loose sim hits, i.e., the hits are stemming from a muon but due to the pile-up truth record, no HepMCParticles are recorded.

Hits are paired based on kinetic energy, and line compatibility

Parameters

ctx	EventContext to access the uncertainty conditions data during segment building
locToGlob	Transform from the sector -> global frame
simHits	Collection of all sim hits in the sector without truth link
writeShip	Helper struct carrying the output segment container & the associated decorators

Closest beam spot approach

First compare the energies

Calculate the approach to the cylinder

Definition at line 111 of file TruthSegmentMaker.cxx.

                                                                             {
        
        ATH_MSG_VERBOSE("Assemble segments from "<<simHits.size()<<" background hits.");
        std::vector<char> alreadyUsed(simHits.size(), 0);
        for (std::size_t h = 0 ;h < simHits.size(); ++h) {
            if (alreadyUsed[h]) {
                continue;
            }
            const auto& [refHit, refPos, refDir] = simHits[h];
            ATH_MSG_VERBOSE("Try to find other hits on trajectory given by "<<m_idHelperSvc->toString(refHit->identify())
            <<", "<<Amg::toString(refPos)<<", "<<Amg::toString(refDir)<<", E: "<<refHit->kineticEnergy() / Gaudi::Units::GeV<<" [GeV] "
            <<", pt: "<<muonPt(*refHit, locToGlob.linear()* refDir)/ Gaudi::Units::GeV <<" [GeV].");
            std::vector<std::size_t> indicesOnSeg{h};
            for (std::size_t h1 = h +1; h1 < simHits.size(); ++h1) {
                if (alreadyUsed[h1]) {
                    continue;
                }
                const auto&[testHit, testPos, testDir] = simHits[h1];

                if (std::abs(refHit->kineticEnergy() - testHit->kineticEnergy()) > m_pileUpHitELoss) {
                    continue;
                }
                if (MC::charge(refHit) != MC::charge(testHit)){
                    continue;
                }
                const double angleDir = Amg::angle(testDir, refDir);
                const double hitSep = std::abs(Amg::signedDistance(refPos, refDir, testPos,testDir));
                ATH_MSG_VERBOSE("Test hit "<<m_idHelperSvc->toString(testHit->identify())<<", "
                              <<Amg::toString(testPos)<<", testDir: "<<Amg::toString(testDir)
                              <<", E: "<<testHit->kineticEnergy() / (Gaudi::Units::GeV)<<", angle: "
                              <<(angleDir / Gaudi::Units::deg) <<", distance: "<<hitSep<<".");
 
                if (std::abs(angleDir) > m_pileUpHitAngleCone || hitSep > m_pileUpHitDistance) {
                    continue;
                }
                indicesOnSeg.push_back(h1);
            }
            const Amg::Vector3D globPos = locToGlob * refPos;
            const Amg::Vector3D globDir = locToGlob.linear() * refDir;
            const Amg::Vector3D perigee = globPos + Amg::intersect<3>(Amg::Vector3D::Zero(), Amg::Vector3D::UnitZ(),
                                                                          globPos, globDir).value_or(0.) * globDir;
            ATH_MSG_VERBOSE("Found "<<indicesOnSeg.size()<<" matching hits. Closest perigee "
                    <<Amg::toString(perigee)<<", "<<m_idCylinderR<<", "<<m_idCylinderHalfZ);
            SimHitVec_t hitsOnSeg{};
            std::ranges::transform(indicesOnSeg,
                    std::back_inserter(hitsOnSeg), 
                    [&simHits](const auto idx) {
                        return simHits[idx];
                    });
            if (perigee.perp() > m_idCylinderR || std::abs(perigee.z()) > m_idCylinderHalfZ  ||
                constructSegmentFromHits(ctx, locToGlob, hitsOnSeg, out)){
                std::ranges::for_each(indicesOnSeg,
                        [&alreadyUsed](const auto idx) {
                             alreadyUsed[idx] = 1;
                        });
            }
        }
    }

cardinality()

unsigned int AthCommonReentrantAlgorithm< Gaudi::Algorithm >::cardinality ( ) const

overridevirtualinherited

Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant.

Override this to return 0 for reentrant algorithms.

Definition at line 75 of file AthCommonReentrantAlgorithm.cxx.

{
  return 0;
}

constructSegmentFromHits()

xAOD::MuonSegment * MuonR4::TruthSegmentMaker::constructSegmentFromHits ( const EventContext & ctx, const Amg::Transform3D & locToGlob, const SimHitVec_t & hits, WriteDecorHolder & writeShip ) const

private

Takes a list of related sim hits and transforms them into a truth segment.

If there're less than 3 precision hits, then no segment is created.

Parameters

ctx	EventContext to fetch the hit uncertainties from store gate
locToGlob	Coordinate transform from sector frame -> global frame
hits	List of hits to be combined onto a single segment
writeShip	Helper struct carrying the output segment container & the associated decorators

Find the hit which is closest to the refernce plane to express the segment at the centre plane

Express the simulated hit in the center of the chamber

Associate the hits to the segment and calculate the expected hits

Definition at line 176 of file TruthSegmentMaker.cxx.

                                                                                 {
        auto refHit_itr = std::ranges::min_element(simHits, 
                [](const HitPosTuple_t& a, const HitPosTuple_t& b){
                    return std::abs(std::get<1>(a).z()) <std::abs(std::get<1>(b).z());
                });
                
        const auto [simHit, localPos, chamberDir] = (*refHit_itr);
        ATH_MSG_VERBOSE("Create segement from hit: "<<m_idHelperSvc->toString(simHit->identify())<<
                            " pdgId: "<<simHit->pdgId()<<", energy: "<<simHit->kineticEnergy()
                            <<", genParticle: "<<simHit->genParticleLink().cptr());
        const Identifier segId{simHit->identify()};

        const double distance = Amg::intersect<3>(localPos, chamberDir, Amg::Vector3D::UnitZ(), 0.).value_or(0.);
        const Amg::Vector3D chamberPos = localPos + distance*chamberDir;
        
        const Amg::Vector3D globPos = locToGlob * chamberPos;
        const Amg::Vector3D globDir = locToGlob.linear() * chamberDir;
        HitLinkVec_t associatedHits{};
        unsigned nMdt{0}, nRpcEta{0}, nRpcPhi{0}, nTgcEta{0}, nTgcPhi{0};
        unsigned nMm{0}, nStgcEta{0}, nStgcPhi{0};
        float chi2{0.f};
        for (const auto& [assocMe, pos, dir] : simHits) {
            chi2 += std::pow(Amg::signedDistance(pos,dir, chamberPos, chamberDir) / hitUncertainty(ctx,*assocMe), 2);
            const MuonGMR4::MuonReadoutElement* assocRE = m_detMgr->getReadoutElement(assocMe->identify());
            switch (assocRE->detectorType()) {
                case ActsTrk::DetectorType::Mdt:
                    ++nMdt;
                    break;
                case ActsTrk::DetectorType::Rpc: {
                    auto castRE{static_cast<const MuonGMR4::RpcReadoutElement*>(assocRE)};
                    if (castRE->nEtaStrips()) ++nRpcEta;
                    if (castRE->nPhiStrips()) ++nRpcPhi;
                    break;
                } case ActsTrk::DetectorType::Tgc: {
                    auto castRE{static_cast<const MuonGMR4::TgcReadoutElement*>(assocRE)};
                    const IdentifierHash gapHash = assocRE->measurementHash(assocMe->identify());
                    if (castRE->numStrips(gapHash)){
                        ++nTgcPhi;
                    } 
                    if (castRE->numWireGangs(gapHash)) {
                        ++nTgcEta;
                    }
                    break;
                } case ActsTrk::DetectorType::sTgc:{
                    ++nStgcEta;
                    ++nStgcPhi;
                    break;
                } case ActsTrk::DetectorType::Mm:{
                    ++nMm;
                    break;
                } default:
                    ATH_MSG_WARNING("Csc are not defined "<<m_idHelperSvc->toString(simHit->identify()));
            }
            ATH_MSG_VERBOSE("Associate hit "<<m_idHelperSvc->toString(assocMe->identify())
                <<" pdgId: "<<assocMe->pdgId()<<", energy: "<<assocMe->kineticEnergy()
                <<", genParticle: "<<assocMe->genParticleLink().cptr()<<", beta: "<<simHit->beta()
                <<" global time: "<<simHit->globalTime()<<", pos: "<<Amg::toString(pos)
                <<", dir: "<<Amg::toString(dir));
            EleLink_t link{*static_cast<const xAOD::MuonSimHitContainer*>(assocMe->container()), assocMe->index()};
            associatedHits.push_back(std::move(link));
        }
        int nPrecisionHits = nMdt + nMm + nStgcEta;
        int nPhiLayers     = nTgcPhi + nRpcPhi + nStgcPhi;
        // if nMdt + nMm + nStgcEta < 3, do not create a segment
        if (nPrecisionHits < 3) {
            return nullptr;
        }
 
        xAOD::MuonSegment* truthSegment = out.segments.push_back(std::make_unique<xAOD::MuonSegment>());
        out.ptDecor(*truthSegment) = muonPt(*simHit, globDir);
        out.chargeDecor(*truthSegment) = MC::charge(simHit);
        SegPars_t& locPars{out.paramDecor(*truthSegment)};
        locPars[Acts::toUnderlying(ParamDefs::x0)] = chamberPos.x();
        locPars[Acts::toUnderlying(ParamDefs::y0)] = chamberPos.y();
        constexpr float betaLowLimit = 1.e-6;
        locPars[Acts::toUnderlying(ParamDefs::t0)] = simHit->globalTime() + distance *c_inv / std::max(simHit->beta(), betaLowLimit);
        locPars[Acts::toUnderlying(ParamDefs::theta)] = chamberDir.theta();
        locPars[Acts::toUnderlying(ParamDefs::phi)]   = chamberDir.phi();
        
        truthSegment->setPosition(globPos.x(), globPos.y(), globPos.z());
        truthSegment->setDirection(globDir.x(), globDir.y(), globDir.z());
        truthSegment->setT0Error(locPars[Acts::toUnderlying(ParamDefs::t0)], 0.);
                
        truthSegment->setNHits(nPrecisionHits, nPhiLayers, nTgcEta + nRpcEta);
        truthSegment->setIdentifier(m_idHelperSvc->sector(segId), 
                                    m_idHelperSvc->chamberIndex(segId),
                                    m_idHelperSvc->stationEta(segId),
                                    m_idHelperSvc->technologyIndex(segId));
        // adding chi2 and ndof (nHits - 5 for 2 position, 2 direction and 1 time)
        if (nPhiLayers == 0){
            truthSegment->setFitQuality(chi2, (nPrecisionHits + nTgcEta + nRpcEta - 3));
        } else {
            truthSegment->setFitQuality(chi2, (nPrecisionHits + nPhiLayers + nTgcEta + nRpcEta - 5));
        }
        out.hitLinkDecor(*truthSegment) = std::move(associatedHits);
        return truthSegment;                                                            
    }

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty ( Gaudi::Property< T, V, H > & hndl, const SG::VarHandleKeyType &  )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

execute()

StatusCode MuonR4::TruthSegmentMaker::execute ( const EventContext & ctx ) const

override

Definition at line 281 of file TruthSegmentMaker.cxx.

                                                                       {
        const ActsTrk::GeometryContext* gctx{nullptr};
        ATH_CHECK(SG::get(gctx, m_geoCtxKey, ctx));
        
        using HitsPerParticle = std::unordered_map<HepMC::ConstGenParticlePtr, SimHitVec_t>;
        using HitCollector = std::unordered_map<const MuonGMR4::SpectrometerSector*, HitsPerParticle>;
        HitCollector hitCollector{};
 
        for (const SG::ReadHandleKey<xAOD::MuonSimHitContainer>& key : m_readKeys) {
            const xAOD::MuonSimHitContainer* simHits{nullptr};
            ATH_CHECK(SG::get(simHits, key, ctx));        
            for (const xAOD::MuonSimHit* simHit : *simHits) {
                const MuonGMR4::MuonReadoutElement* reElement = m_detMgr->getReadoutElement(simHit->identify()); 
                const MuonGMR4::SpectrometerSector* id{reElement->msSector()};
                auto genLink = simHit->genParticleLink();
                HepMC::ConstGenParticlePtr genParticle = nullptr; 
                if (genLink.isValid()){
                    genParticle = genLink.cptr(); 
                }
                if ( (!genParticle && (!m_includePileUpHits || simHit->kineticEnergy() < m_pileUpHitMinE 
                                    || !MC::isMuon(simHit))) || (m_useOnlyMuonHits && !MC::isMuon(simHit))) {
                    ATH_MSG_VERBOSE("Skip hit "<<m_idHelperSvc->toString(simHit->identify())<<
                                  " pdgId: "<<simHit->pdgId()<<", energy: "<<simHit->kineticEnergy()
                                <<", genParticle: "<<genParticle);
                    continue;
                }
                const Amg::Transform3D toChTrf{toChamber(*gctx, simHit->identify())};
                hitCollector[id][genParticle].emplace_back(simHit, 
                                                           toChTrf *xAOD::toEigen(simHit->localPosition()),
                                                           toChTrf.linear()* xAOD::toEigen(simHit->localDirection())); 
            }
        } 
 
        SG::WriteHandle writeHandle{m_segmentKey, ctx};
        ATH_CHECK(writeHandle.record(std::make_unique<xAOD::MuonSegmentContainer>(),
                                     std::make_unique<xAOD::MuonSegmentAuxContainer>()));
 
        WriteDecorHolder writerHolder{*writeHandle,*this, ctx};
 
        for (auto& [chamber, collectedParts] : hitCollector) {
            const Amg::Transform3D& locToGlob{chamber->localToGlobalTrans(*gctx)};
            for (auto& [particle, simHits]: collectedParts) {                
                /* Sort hits by local z */
                std::ranges::stable_sort(simHits,[](const HitPosTuple_t& a, const HitPosTuple_t& b){
                    return std::get<1>(a).z() < std::get<1>(b).z();
                });
                if (!particle) {
                    buildSegmentsFromBkg(ctx, locToGlob, simHits, writerHolder);
                    continue;
                }
                constructSegmentFromHits(ctx, locToGlob, simHits, writerHolder);
            }
        }
        ATH_MSG_DEBUG("Constructed "<<writeHandle->size()<<" truth segments in total ");
        return StatusCode::SUCCESS;
    }

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

extraOutputDeps()

const DataObjIDColl & AthCommonReentrantAlgorithm< Gaudi::Algorithm >::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 94 of file AthCommonReentrantAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return BaseAlg::extraOutputDeps();
}

filterPassed()

virtual bool AthCommonReentrantAlgorithm< Gaudi::Algorithm >::filterPassed ( const EventContext & ctx ) const

inlinevirtualinherited

Definition at line 96 of file AthCommonReentrantAlgorithm.h.

                                                           {
    return execState( ctx ).filterPassed();
  }

hitUncertainty()

float MuonR4::TruthSegmentMaker::hitUncertainty ( const EventContext & ctx, const xAOD::MuonSimHit & hit ) const

private

Evaluates the hit uncertainty.

For the precision detectors, the uncertainties are fetched from the COOL DB. For the remaining detectors, the uncertainties are based on the strip pitch

Parameters

ctx	EventContext to fetch the constants from store gate
hit	Reference to the sim hit

Definition at line 52 of file TruthSegmentMaker.cxx.

                                                                                                    {
        const Identifier hitId{hit.identify()};
        switch (const auto techIdx = m_idHelperSvc->technologyIndex(hitId)) {
            using enum Muon::MuonStationIndex::TechnologyIndex;
            case MDT:  {
                const MuonCalib::MdtCalibDataContainer* calibCont{nullptr};
                if (!SG::get(calibCont, m_mdtCalibKey, ctx).isSuccess()) {
                    THROW_EXCEPTION("Failed to retrieve Mdt calib constants");
                }
                const auto& rtCalib{calibCont->getCalibData(hitId, msgStream())->rtRelation};
                const double driftTime = rtCalib->tr()->driftTime(hit.localPosition().perp()).value_or(rtCalib->tr()->maxRadius());
                return rtCalib->rtRes()->resolution(driftTime);
            } case RPC: {
                const auto* re = m_detMgr->getRpcReadoutElement(hitId);
                return re->stripEtaPitch() / std::sqrt(12.);
            } case TGC: {
                const auto* re = m_detMgr->getTgcReadoutElement(hitId);
                const IdentifierHash measHash = re->measurementHash(hitId);
                const auto& design = re->wireGangLayout(measHash);
                return design.stripPitch()  / std::sqrt(12.);
            } case STGC:
              case MM: {
                const NswErrorCalibData* errorCalibDB{nullptr};
                if (!SG::get(errorCalibDB, m_nswUncertKey, ctx).isSuccess()) {
                    THROW_EXCEPTION("Failed to retrieve the STGC calibration constants");
                }
                NswErrorCalibData::Input errorCalibInput{};
                errorCalibInput.stripId= hitId;
                errorCalibInput.locTheta = M_PI - hit.localDirection().theta();
                if (techIdx == STGC) {
                    errorCalibInput.clusterAuthor = 3; // centroid
                } else {
                    errorCalibInput.clusterAuthor=66; // cluster time projection method
                }
                return errorCalibDB->clusterUncertainty(errorCalibInput);
            } 
            default:
                break;
        }
        return 0.;
    }

initialize()

StatusCode MuonR4::TruthSegmentMaker::initialize ( )

finaloverride

Definition at line 31 of file TruthSegmentMaker.cxx.

                                             {
        ATH_CHECK(m_idHelperSvc.retrieve());
        ATH_CHECK(m_readKeys.initialize());
        if (m_readKeys.empty()){
            ATH_MSG_ERROR("No simulated hit containers have been parsed to build the segments from ");
            return StatusCode::FAILURE;
        }
        ATH_CHECK(m_mdtCalibKey.initialize(m_idHelperSvc->hasMDT()));
        ATH_CHECK(m_nswUncertKey.initialize(m_idHelperSvc->hasMM() || m_idHelperSvc->hasSTGC()));
        
        ATH_CHECK(m_segmentKey.initialize());
        ATH_CHECK(m_eleLinkKey.initialize());
        ATH_CHECK(m_ptKey.initialize());
 
        ATH_CHECK(m_locParKey.initialize());
        ATH_CHECK(m_qKey.initialize());
 
        ATH_CHECK(m_geoCtxKey.initialize());
        ATH_CHECK(detStore()->retrieve(m_detMgr));
        return StatusCode::SUCCESS;
    }

inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

isClonable()

bool AthCommonReentrantAlgorithm< Gaudi::Algorithm >::isClonable ( ) const

overridevirtualinherited

Specify if the algorithm is clonable.

Reentrant algorithms are clonable.

Reimplemented in InDet::GNNSeedingTrackMaker, InDet::SCT_Clusterization, InDet::SiSPGNNTrackMaker, InDet::SiSPSeededTrackFinder, InDet::SiTrackerSpacePointFinder, ITkPixelCablingAlg, ITkStripCablingAlg, RoIBResultToxAOD, SCT_ByteStreamErrorsTestAlg, SCT_CablingCondAlgFromCoraCool, SCT_CablingCondAlgFromText, SCT_ConditionsParameterTestAlg, SCT_ConditionsSummaryTestAlg, SCT_ConfigurationConditionsTestAlg, SCT_FlaggedConditionTestAlg, SCT_LinkMaskingTestAlg, SCT_MajorityConditionsTestAlg, SCT_ModuleVetoTestAlg, SCT_MonitorConditionsTestAlg, SCT_PrepDataToxAOD, SCT_RawDataToxAOD, SCT_ReadCalibChipDataTestAlg, SCT_ReadCalibDataTestAlg, SCT_RODVetoTestAlg, SCT_SensorsTestAlg, SCT_SiliconConditionsTestAlg, SCT_StripVetoTestAlg, SCT_TdaqEnabledTestAlg, SCT_TestCablingAlg, SCTEventFlagWriter, SCTRawDataProvider, SCTSiLorentzAngleTestAlg, SCTSiPropertiesTestAlg, and Simulation::BeamEffectsAlg.

Definition at line 68 of file AthCommonReentrantAlgorithm.cxx.

{
  // Reentrant algorithms are clonable.
  return true;
}

msg()

MsgStream & AthCommonMsg< Gaudi::Algorithm >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msgLvl()

bool AthCommonMsg< Gaudi::Algorithm >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

muonPt()

float MuonR4::TruthSegmentMaker::muonPt ( const xAOD::MuonSimHit & hit, const Amg::Vector3D & globDir ) const

private

Returns the muon pt from the sim hit.

Definition at line 93 of file TruthSegmentMaker.cxx.

                                                                                              {
        const auto& link = hit.genParticleLink();
        if (link.isValid()) {
            return link->momentum().perp();
        }
        const float e{hit.kineticEnergy()},m{hit.mass()};
        return std::sqrt(std::max(e*e - m*m, 0.f)) * std::sin(globDir.theta());
    }

outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

renounceArray()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

setFilterPassed()

virtual void AthCommonReentrantAlgorithm< Gaudi::Algorithm >::setFilterPassed ( bool state, const EventContext & ctx ) const

inlinevirtualinherited

Definition at line 100 of file AthCommonReentrantAlgorithm.h.

                                                                            {
    execState( ctx ).setFilterPassed( state );
  }

sysExecute()

StatusCode AthCommonReentrantAlgorithm< Gaudi::Algorithm >::sysExecute ( const EventContext & ctx )

overridevirtualinherited

Execute an algorithm.

We override this in order to work around an issue with the Algorithm base class storing the event context in a member variable that can cause crashes in MT jobs.

Definition at line 85 of file AthCommonReentrantAlgorithm.cxx.

{
  return BaseAlg::sysExecute (ctx);
}

sysInitialize()

StatusCode AthCommonReentrantAlgorithm< Gaudi::Algorithm >::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >.

Reimplemented in HypoBase, and InputMakerBase.

Definition at line 61 of file AthCommonReentrantAlgorithm.cxx.

                                                               {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<BaseAlg>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }      
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;  
}

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

toChamber()

Amg::Transform3D MuonR4::TruthSegmentMaker::toChamber ( const ActsTrk::GeometryContext & gctx, const Identifier & chanId ) const

private

Returns the transform from the local simHit frame -> chamber frame.

Parameters

gctx	Geometry context to align the chambers within ATLAS
chanId	Identifier of the channel for which the transform shall be fetched

Definition at line 101 of file TruthSegmentMaker.cxx.

                                                                                  {
        const MuonGMR4::MuonReadoutElement* reEle = m_detMgr->getReadoutElement(chanId);
        const IdentifierHash trfHash{reEle->detectorType() == ActsTrk::DetectorType::Mdt ?
                                                    reEle->measurementHash(chanId) :
                                                    reEle->layerHash(chanId)};
        return reEle->msSector()->globalToLocalTrans(gctx) * reEle->localToGlobalTrans(gctx, trfHash);
 
    }

updateVHKA()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

m_detMgr

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

private

Pointer to the muon readout geometry.

Definition at line 155 of file TruthSegmentMaker.h.

{nullptr};

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

m_eleLinkKey

SG::WriteDecorHandleKey<xAOD::MuonSegmentContainer> MuonR4::TruthSegmentMaker::m_eleLinkKey {this, "SimHitLink", m_segmentKey, "simHitLinks"}

private

Decoration key of the associated sim hit links.

Definition at line 131 of file TruthSegmentMaker.h.

{this, "SimHitLink", m_segmentKey, "simHitLinks"};

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

m_extendedExtraObjects

DataObjIDColl AthCommonReentrantAlgorithm< Gaudi::Algorithm >::m_extendedExtraObjects

privateinherited

Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.

Empty if no symlinks were found.

Definition at line 114 of file AthCommonReentrantAlgorithm.h.

m_geoCtxKey

SG::ReadHandleKey<ActsTrk::GeometryContext> MuonR4::TruthSegmentMaker::m_geoCtxKey {this, "AlignmentKey", "ActsAlignment", "cond handle key"}

private

Key to the geometry context.

Needed to align the hits inside ATLAS

Definition at line 127 of file TruthSegmentMaker.h.

{this, "AlignmentKey", "ActsAlignment", "cond handle key"};

m_idCylinderHalfZ

Gaudi::Property<float> MuonR4::TruthSegmentMaker::m_idCylinderHalfZ {this, "IdCylinderHalfZ", 3.2*Gaudi::Units::m}

private

ID / Itk cylinder half length.

Definition at line 153 of file TruthSegmentMaker.h.

{this, "IdCylinderHalfZ", 3.2*Gaudi::Units::m};

m_idCylinderR

Gaudi::Property<float> MuonR4::TruthSegmentMaker::m_idCylinderR {this, "IdCylinderR", 1.1*Gaudi::Units::m}

private

ID / ITk cylinder radius.

Definition at line 151 of file TruthSegmentMaker.h.

{this, "IdCylinderR", 1.1*Gaudi::Units::m};

m_idHelperSvc

ServiceHandle<Muon::IMuonIdHelperSvc> MuonR4::TruthSegmentMaker::m_idHelperSvc {this, "IdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"}

private

IdHelperSvc to decode the Identifiers.

Definition at line 123 of file TruthSegmentMaker.h.

{this, "IdHelperSvc",  "Muon::MuonIdHelperSvc/MuonIdHelperSvc"};

m_includePileUpHits

Gaudi::Property<bool> MuonR4::TruthSegmentMaker::m_includePileUpHits {this, "includePileUpHits", true}

private

Construct segments from pile-up hits without GenParticleLink.

Definition at line 141 of file TruthSegmentMaker.h.

{this, "includePileUpHits", true};

m_locParKey

SG::WriteDecorHandleKey<xAOD::MuonSegmentContainer> MuonR4::TruthSegmentMaker::m_locParKey {this, "LocParKey", m_segmentKey,"localSegPars"}

private

Decoration key of the local parameters.

Definition at line 135 of file TruthSegmentMaker.h.

{this, "LocParKey", m_segmentKey,"localSegPars"};

m_mdtCalibKey

SG::ReadCondHandleKey<MuonCalib::MdtCalibDataContainer> MuonR4::TruthSegmentMaker::m_mdtCalibKey

private

Initial value:

{this, "MdtCalibKey", "MdtCalibConstants",
                                                                                "Conditions object containing the calibrations"}

Data dependency on the Mdt calibration container to calculate the uncertainty.

Definition at line 157 of file TruthSegmentMaker.h.

                                                                           {this, "MdtCalibKey", "MdtCalibConstants",
                                                                                "Conditions object containing the calibrations"};

m_nswUncertKey

SG::ReadCondHandleKey<NswErrorCalibData> MuonR4::TruthSegmentMaker::m_nswUncertKey

private

Initial value:

{this, "NswErrorKey", "NswUncertData", 
                                                                  "Key of the parametrized NSW uncertainties"}

Data dependency on the Nsw calibration container to estimate the uncertaintys.

Definition at line 160 of file TruthSegmentMaker.h.

                                                               {this, "NswErrorKey", "NswUncertData", 
                                                                  "Key of the parametrized NSW uncertainties"};

m_pileUpHitAngleCone

Gaudi::Property<float> MuonR4::TruthSegmentMaker::m_pileUpHitAngleCone {this, "pileUpHitAngleCone", 1.*Gaudi::Units::deg}

private

Maximum scattering angle between two pile-up hits.

Definition at line 147 of file TruthSegmentMaker.h.

{this, "pileUpHitAngleCone", 1.*Gaudi::Units::deg};

m_pileUpHitDistance

Gaudi::Property<float> MuonR4::TruthSegmentMaker::m_pileUpHitDistance {this, "pileUpHitDistance", 2.*Gaudi::Units::m}

private

Maximum separation between two pile-up hits.

Definition at line 149 of file TruthSegmentMaker.h.

{this, "pileUpHitDistance", 2.*Gaudi::Units::m};

m_pileUpHitELoss

Gaudi::Property<float> MuonR4::TruthSegmentMaker::m_pileUpHitELoss {this, "pileUpHitELoss", 5.*Gaudi::Units::MeV}

private

Maximum energy loss between two pile-up hits.

Definition at line 145 of file TruthSegmentMaker.h.

{this, "pileUpHitELoss", 5.*Gaudi::Units::MeV};

m_pileUpHitMinE

Gaudi::Property<float> MuonR4::TruthSegmentMaker::m_pileUpHitMinE {this, "energyThresholdPileUp", 1.*Gaudi::Units::GeV}

private

Minimum energy threshold for pile up hits to be converted.

Definition at line 143 of file TruthSegmentMaker.h.

{this, "energyThresholdPileUp", 1.*Gaudi::Units::GeV};

m_ptKey

SG::WriteDecorHandleKey<xAOD::MuonSegmentContainer> MuonR4::TruthSegmentMaker::m_ptKey {this, "PtKey", m_segmentKey, "pt"}

private

Decoration key of the associated particle pt.

Definition at line 133 of file TruthSegmentMaker.h.

{this, "PtKey", m_segmentKey, "pt"};

m_qKey

SG::WriteDecorHandleKey<xAOD::MuonSegmentContainer> MuonR4::TruthSegmentMaker::m_qKey {this, "qKey", m_segmentKey, "charge"}

private

Decoration key of the muon charge.

Definition at line 137 of file TruthSegmentMaker.h.

{this, "qKey", m_segmentKey, "charge"};

m_readKeys

SG::ReadHandleKeyArray<xAOD::MuonSimHitContainer> MuonR4::TruthSegmentMaker::m_readKeys {this, "SimHitKeys", {}}

private

List of sim hit containers from which the truth segments shall be retrieved.

Definition at line 125 of file TruthSegmentMaker.h.

{this, "SimHitKeys", {}};

m_segmentKey

SG::WriteHandleKey<xAOD::MuonSegmentContainer> MuonR4::TruthSegmentMaker::m_segmentKey {this, "WriteKey", "MuonTruthSegments"}

private

Key under which the segment Container will be recorded in StoreGate.

Definition at line 129 of file TruthSegmentMaker.h.

{this, "WriteKey", "MuonTruthSegments"};

m_useOnlyMuonHits

Gaudi::Property<bool> MuonR4::TruthSegmentMaker::m_useOnlyMuonHits {this, "useOnlyMuonHits", true}

private

Build segments from muon hits only.

Definition at line 139 of file TruthSegmentMaker.h.

{this, "useOnlyMuonHits", true};

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

---

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

• TruthSegmentMaker.h
• TruthSegmentMaker.cxx