Muon::RecoToTruthAssociationAlg Class Reference

#include <RecoToTruthAssociationAlg.h>

Inheritance diagram for Muon::RecoToTruthAssociationAlg:

Collaboration diagram for Muon::RecoToTruthAssociationAlg:

Public Member Functions
StatusCode	initialize () override
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
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
void	count_chamber_layers (const xAOD::IParticle *truth_particle, const Trk::Track *ptrk, std::vector< unsigned int > &nprecHitsPerChamberLayer, std::vector< unsigned int > &nphiHitsPerChamberLayer, std::vector< unsigned int > &ntrigEtaHitsPerChamberLayer) const
void	clear_dummys (const std::vector< unsigned long long > &identifiers, std::vector< unsigned int > &vec) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
SG::ReadHandleKey< xAOD::TruthParticleContainer >	m_truthMuKey
	Key to the filtered muon truth particles.
SG::WriteDecorHandleKey< xAOD::TruthParticleContainer >	m_muonTruthRecoLink
	Decorations for the filtered muon truth particles.
SG::ReadHandleKey< xAOD::MuonContainer >	m_recoMuKey
SG::WriteDecorHandleKey< xAOD::MuonContainer >	m_muonTruthParticleLink
	Decorations for the reconstructed muon particles.
SG::WriteDecorHandleKey< xAOD::MuonContainer >	m_muonTruthParticleType
SG::WriteDecorHandleKey< xAOD::MuonContainer >	m_muonTruthParticleOrigin
SG::WriteDecorHandleKey< xAOD::MuonContainer >	m_muonTruthParticleClassification
SG::WriteDecorHandleKey< xAOD::MuonContainer >	m_muonTruthParticleNPrecMatched
SG::WriteDecorHandleKey< xAOD::MuonContainer >	m_muonTruthParticleNPhiMatched
SG::WriteDecorHandleKey< xAOD::MuonContainer >	m_muonTruthParticleNTrigEtaMatched
SG::ReadDecorHandleKeyArray< xAOD::IParticleContainer >	m_inputDecorKey
Gaudi::Property< std::vector< std::string > >	m_assocTrkContainers
Gaudi::Property< std::string >	m_recoLink {this, "RecoLinkName", "recoMuonLink" , "Decoration to the truth particle pointing to the muon"}
Gaudi::Property< bool >	m_associateWithInDetTP {this, "AssociateWithInDetTP", false, "force use of ID track particles for association"}
ServiceHandle< Muon::IMuonIdHelperSvc >	m_idHelperSvc {this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"}
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 18 of file RecoToTruthAssociationAlg.h.

Member Typedef Documentation

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Function Documentation

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

clear_dummys()

void Muon::RecoToTruthAssociationAlg::clear_dummys ( const std::vector< unsigned long long > & identifiers, std::vector< unsigned int > & vec ) const

private

If the identifiers are empty then there is no change that a dummy value could be cleared from this list

Definition at line 366 of file RecoToTruthAssociationAlg.cxx.

                                                                                                                                 {
    if (identifiers.empty()) { return; }
    for (unsigned int i = 0; i < vec.size(); ++i) {
        if (vec[i] != dummy_unsigned) continue;
        for (unsigned j = 0; j < identifiers.size(); ++j) {
            const Identifier id{identifiers[j]};
            if (m_idHelperSvc->measuresPhi(id)) {
                const auto phiIdx = static_cast<PhiIndex>(i);
                if (m_idHelperSvc->phiIndex(id) == phiIdx) {
                    vec[i] = 0;
                    break;
                }
            } else {
                const auto chIdx = static_cast<ChIndex>(i);
                if (m_idHelperSvc->chamberIndex(id) == chIdx) {
                    vec[i] = 0;
                    break;
                }
            }
        }
    }
}

count_chamber_layers()

void Muon::RecoToTruthAssociationAlg::count_chamber_layers ( const xAOD::IParticle * truth_particle, const Trk::Track * ptrk, std::vector< unsigned int > & nprecHitsPerChamberLayer, std::vector< unsigned int > & nphiHitsPerChamberLayer, std::vector< unsigned int > & ntrigEtaHitsPerChamberLayer ) const

private

Definition at line 266 of file RecoToTruthAssociationAlg.cxx.

                                                                                                               {
 
    if (!truthParticle || !truthMdtHitsAcc.isAvailable(*truthParticle)) {
        ATH_MSG_DEBUG("muon has no truth hits vector in the truth association alg");
        nprecHitsPerChamberLayer.clear();
        nphiHitsPerChamberLayer.clear();
        ntrigEtaHitsPerChamberLayer.clear();
        return;
    }
    const std::vector<unsigned long long>& mdtTruth = truthMdtHitsAcc(*truthParticle);
    std::vector<unsigned long long> cscTruth;
 
    if (m_idHelperSvc->hasCSC()) cscTruth = truthCscHitsAcc(*truthParticle);
    const std::vector<unsigned long long>& rpcTruth = truthRpcHitsAcc(*truthParticle);
    const std::vector<unsigned long long>& tgcTruth = truthTgcHitsAcc(*truthParticle);
 
    for (const Trk::TrackStateOnSurface* tsit : *ptrk->trackStateOnSurfaces()) {
        if (!tsit || !tsit->trackParameters() || !tsit->measurementOnTrack()) continue;
        const Trk::MeasurementBase* meas = tsit->measurementOnTrack();
        Identifier id;
        const Trk::RIO_OnTrack* rot = dynamic_cast<const Trk::RIO_OnTrack*>(meas);
        if (rot)
            id = rot->identify();
        else {
            const Muon::CompetingMuonClustersOnTrack* crot = dynamic_cast<const Muon::CompetingMuonClustersOnTrack*>(meas);
            if (crot && !crot->containedROTs().empty() && crot->containedROTs().front()) id = crot->containedROTs().front()->identify();
        }
        if (!m_idHelperSvc->isMuon(id)) continue;
 
        bool measPhi = m_idHelperSvc->measuresPhi(id);
        bool isTgc = m_idHelperSvc->isTgc(id);
        ChIndex chIndex = !isTgc ? m_idHelperSvc->chamberIndex(id) : ChIndex::ChUnknown;
        if (m_idHelperSvc->isMdt(id)) {
            for (unsigned int i = 0; i < mdtTruth.size(); ++i) {
                if (id == mdtTruth[i]) {
                    if (chIndex != ChIndex::ChUnknown) {
                      increment_unsigned(nprecHitsPerChamberLayer.at(toInt(chIndex)));
                    }
                    break;
                }
            }
        } else if (m_idHelperSvc->hasCSC() && m_idHelperSvc->isCsc(id)) {
            for (unsigned int i = 0; i < cscTruth.size(); ++i) {
                if (id != cscTruth[i]) continue;
                if (measPhi) {
                    PhiIndex index = m_idHelperSvc->phiIndex(id);
                    if (index != PhiIndex::PhiUnknown) {
                      increment_unsigned(nphiHitsPerChamberLayer.at(toInt(index)));
                    }
                } else {
                  if (chIndex != ChIndex::ChUnknown) {
                    increment_unsigned(nprecHitsPerChamberLayer.at(toInt(chIndex)));
                  }
                }
                break;
            }
        } else if (m_idHelperSvc->isRpc(id)) {
            for (unsigned int i = 0; i < rpcTruth.size(); ++i) {
                if (id != rpcTruth[i]) { continue; }
                PhiIndex index = m_idHelperSvc->phiIndex(id);
                if (index != PhiIndex::PhiUnknown) {
                  if (measPhi) {
                    increment_unsigned(nphiHitsPerChamberLayer.at(toInt(index)));
                  } else {
                    increment_unsigned(ntrigEtaHitsPerChamberLayer.at(toInt(index)));
                  }
                }
                break;
            }
        } else if (m_idHelperSvc->isTgc(id)) {
            for (unsigned int i = 0; i < tgcTruth.size(); ++i) {
                if (id != tgcTruth[i]) { continue; }
                PhiIndex index = m_idHelperSvc->phiIndex(id);
                if (index != PhiIndex::PhiUnknown) {
                  if (measPhi) {
                    increment_unsigned(nphiHitsPerChamberLayer.at(toInt(index)));
                  } else {
                    increment_unsigned(ntrigEtaHitsPerChamberLayer.at(toInt(index)));
                  }
                }
                break;
            }
        }
    }  // end loop over TSOS
    ATH_MSG_DEBUG("finished loop over TSOS");
 
    // now, have to check if there are non-zero truth hits in indices without reco hits
    clear_dummys(mdtTruth, nprecHitsPerChamberLayer);
    clear_dummys(cscTruth, nprecHitsPerChamberLayer);
 
    clear_dummys(cscTruth, nphiHitsPerChamberLayer);
    clear_dummys(rpcTruth, nphiHitsPerChamberLayer);
    clear_dummys(tgcTruth, nphiHitsPerChamberLayer);
 
    clear_dummys(rpcTruth, ntrigEtaHitsPerChamberLayer);
    clear_dummys(tgcTruth, ntrigEtaHitsPerChamberLayer);
}

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 Muon::RecoToTruthAssociationAlg::execute ( const EventContext & ctx ) const

override

Link the truth particle to the muon

Check first if the truth link already exists

The last judge is a simple dR cut but this will hopefully never trigger

Zero supression do not want to store meaningless zeros

Decorate the results

Patch for STACO muons: Copy the truth information from the muon back to the combined track to avoid file corruptions reported in ATLASRECTS-6454

one more thing: need to have muonlink set for all truth particles to avoid ELReset errors

Definition at line 91 of file RecoToTruthAssociationAlg.cxx.

                                                                           {
    const xAOD::TruthParticleContainer* muonTruthContainer{nullptr};
    ATH_CHECK(SG::get(muonTruthContainer, m_truthMuKey , ctx));
    std::unique_ptr<SG::WriteDecorHandle<xAOD::TruthParticleContainer, ElementLink<xAOD::MuonContainer>>> muonTruthParticleRecoLink{};
    if (!m_muonTruthRecoLink.empty()) {
        muonTruthParticleRecoLink = std::make_unique<SG::WriteDecorHandle<xAOD::TruthParticleContainer, ElementLink<xAOD::MuonContainer>>>(m_muonTruthRecoLink, ctx);
    }
 
    SG::WriteDecorHandle<xAOD::MuonContainer, ElementLink<xAOD::TruthParticleContainer> > muonTruthParticleLink(m_muonTruthParticleLink,
                                                                                                                ctx);
    if (!muonTruthParticleLink.isValid()) {
        ATH_MSG_WARNING("muon particle container not valid");
        return StatusCode::FAILURE;
    }
    SG::WriteDecorHandle<xAOD::MuonContainer, int> muonTruthParticleType(m_muonTruthParticleType, ctx);
    SG::WriteDecorHandle<xAOD::MuonContainer, int> muonTruthParticleOrigin(m_muonTruthParticleOrigin, ctx);
    SG::WriteDecorHandle<xAOD::MuonContainer, unsigned int> muonTruthParticleClassification(m_muonTruthParticleClassification, ctx);
    SG::WriteDecorHandle<xAOD::MuonContainer, std::vector<unsigned int> > muonTruthParticleNPrecMatched(m_muonTruthParticleNPrecMatched,
                                                                                                        ctx);
    SG::WriteDecorHandle<xAOD::MuonContainer, std::vector<unsigned int> > muonTruthParticleNPhiMatched(m_muonTruthParticleNPhiMatched, ctx);
    SG::WriteDecorHandle<xAOD::MuonContainer, std::vector<unsigned int> > muonTruthParticleNTrigEtaMatched(m_muonTruthParticleNTrigEtaMatched, ctx);
 
    // add link to reco muons and viceversa
    bool saw_staco = false;
    bool decor_staco = false;
 
    // loop over muons
    for (const xAOD::Muon* muon : *muonTruthParticleLink) {
        // use primary track particle to get the truth link (except for the case of STACO, where we must use the ID track particle, as the
        // combined is not truth-matched)
        ATH_MSG_DEBUG("muon with pT " << muon->pt() << " MeV, eta: " << muon->eta() << ", phi " << muon->phi() << " and author "
                                      << muon->author());
        const xAOD::TrackParticle* tp = nullptr;
        const bool useID = m_associateWithInDetTP || muon->author() == xAOD::Muon::Author::STACO || muon->author() == xAOD::Muon::Author::MuGirl;
 
        using enum xAOD::Muon::TrackParticleType;
        tp = muon->trackParticle(useID ?InnerDetectorTrackParticle : Primary);
 
        bool foundTruth{false}, setOrigin{false};
        if (tp) {
            // Associate reco with truth muon. Loop over reconstructed muons, get track particle for each one.
            // Each track particle should carry a link to the corresponding truth particle. Then compare this truth particle link with the
            // given truth muon particle
            if (acc_origin.isAvailable(*tp) && acc_origin(*tp) != 0) {
                muonTruthParticleOrigin(*muon) = acc_origin(*tp);
                muonTruthParticleType(*muon) = acc_type(*tp);
                muonTruthParticleClassification(*muon) = acc_classification(*tp);
                setOrigin = true;
            }
 
            ElementLink<xAOD::TruthParticleContainer> truthLink;
            if (acc_link.isAvailable(*tp)) {
                truthLink = acc_link(*tp);
            } else {
                ATH_MSG_DEBUG("Could not find any truth link associated with track having pt:"<<tp->pt()<<" MeV, eta: "<<tp->eta()<<", phi: "<<tp->phi()<<", charge: "<<tp->charge()<<". d0:"<<tp->d0()<<", z0: "<<tp->z0());
            }
 
            if (truthLink.isValid()) {
                ATH_MSG_VERBOSE(" Got valid truth link for muon author " << muon->author() << " uniqueID " << HepMC::uniqueID(*truthLink));
                // loop over truth particles
                for (const xAOD::TruthParticle* truthParticle : *muonTruthContainer) {
                    if (!MC::isStable(truthParticle)) continue;
                    ATH_MSG_DEBUG("Got truth muon with uniqueID " << HepMC::uniqueID(truthParticle) << " pt " << truthParticle->pt());
                    if ( !HepMC::is_sim_descendant(*truthLink, truthParticle)) {
                        ATH_MSG_VERBOSE("UniqueID truth link: " << HepMC::uniqueID(*truthLink)
                                                               << " is not decendant of " << HepMC::uniqueID(truthParticle));
                        continue;
                    }
                    ATH_MSG_VERBOSE("Truth muon uniqueID matches -> creating link with truth particle " << HepMC::uniqueID(*truthLink));
                    foundTruth = true;
                    ElementLink<xAOD::TruthParticleContainer> muonTruthLink{*muonTruthContainer,
                                                                            truthParticle->index(),
                                                                            ctx};
                    muonTruthLink.toPersistent();
                    muonTruthParticleLink(*muon) = muonTruthLink;
                    if (!setOrigin) {
                        muonTruthParticleOrigin(*muon) = acc_origin(*tp);
                        muonTruthParticleType(*muon) = acc_type(*tp);
                        muonTruthParticleClassification(*muon) = acc_classification(*tp);
                        setOrigin = true;
                    }
                    if (muonTruthParticleRecoLink && muonTruthParticleRecoLink->operator()(*truthParticle).isValid()){
                        const xAOD::Muon* decor_muon  = *muonTruthParticleRecoLink->operator()(*truthParticle);
                        ATH_MSG_VERBOSE("Truth particle is already decorated with reco muon "<<decor_muon->pt()*1.e-3
                                        <<" eta: "<<decor_muon->eta()<<" phi: "<<decor_muon->phi()<<" charge: "<<
                                        decor_muon->charge()<<" author: "<<decor_muon->author()<<" all authors: "<<
                                        decor_muon->allAuthors());
 
                        // Check first if the exiting muon has a better author
                        if (MuonCombined::authorRank(decor_muon->author()) <  MuonCombined::authorRank(muon->author())){
                            ATH_MSG_DEBUG("Author of the decorated muon is better than the one of the new candidate");
                            continue;
                        }
                        if (deltaR2(muon,truthParticle) >= deltaR2(muon, decor_muon)) continue;
                    }
 
 
                    ElementLink<xAOD::MuonContainer> muonLink{muon, *muonTruthParticleLink, ctx};

                    std::vector<unsigned int> nprecHitsPerChamberLayer(toInt(ChIndex::ChIndexMax), dummy_unsigned);
                    std::vector<unsigned int> nphiHitsPerChamberLayer(toInt(PhiIndex::PhiIndexMax), dummy_unsigned);
                    std::vector<unsigned int> ntrigEtaHitsPerChamberLayer(toInt(PhiIndex::PhiIndexMax), dummy_unsigned);
 
                    constexpr std::array<xAOD::Muon::Author, 3> author_sel{xAOD::Muon::Author::MuidCo,
                                                                           xAOD::Muon::Author::MuidSA,
                                                                           xAOD::Muon::Author::MuGirl};
                    count_chamber_layers(std::ranges::any_of(author_sel, [muon](const auto a ){ return muon->isAuthor(a); })
                                             ? truthParticle
                                             : nullptr,
                                         tp->track(), nprecHitsPerChamberLayer, nphiHitsPerChamberLayer, ntrigEtaHitsPerChamberLayer);
                    muonTruthParticleNPrecMatched(*muon) =  nprecHitsPerChamberLayer;
                    muonTruthParticleNPhiMatched(*muon) = nphiHitsPerChamberLayer;
                    muonTruthParticleNTrigEtaMatched(*muon) = ntrigEtaHitsPerChamberLayer;
 
                    if (muonTruthParticleRecoLink) (*muonTruthParticleRecoLink)(*truthParticle) = muonLink;
                    break;
                }
            } else {
                ATH_MSG_DEBUG("Invalid truth link");
            }
        } else {
            ATH_MSG_WARNING("Could not find the appropiate track particle for muon with pT: " << muon->pt() * 1.e-3 << " GeV,  eta: "
                                                                                              << muon->eta() << ", phi: " << muon->phi()
                                                                                              << " author: " << muon->author());
        }
 
        if (!setOrigin) {
            muonTruthParticleOrigin(*muon) = 0;
            muonTruthParticleType(*muon) = 0;
            muonTruthParticleClassification(*muon) = 0;
        }
        if (!foundTruth) {
            muonTruthParticleLink(*muon) = ElementLink<xAOD::TruthParticleContainer>();
            // add these empty vectors
            muonTruthParticleNPrecMatched(*muon) = std::vector<unsigned int>{};
            muonTruthParticleNPhiMatched(*muon) = std::vector<unsigned int>{};
            muonTruthParticleNTrigEtaMatched(*muon) = std::vector<unsigned int>{};
        }
        if (muon->author() == xAOD::Muon::Author::STACO) {
            const xAOD::TrackParticle* cmb_trk = muon->trackParticle(xAOD::Muon::CombinedTrackParticle);
            if (!cmb_trk){
                ATH_MSG_WARNING("Even a STACO muon should have a combined track");
                continue;
            } else {
              if (!saw_staco) {
                saw_staco = true;
                decor_staco = !dec_origin.isAvailable (*cmb_trk);
              }
              if (decor_staco) {
                dec_origin(*cmb_trk) = acc_origin(*muon);
                dec_classification(*cmb_trk) = acc_classification(*muon);
                dec_type(*cmb_trk) = acc_type(*muon);
                dec_link(*cmb_trk) = acc_link(*muon);
              }
            }
        }
    }
    if (muonTruthParticleRecoLink && !muonTruthParticleRecoLink->isAvailable()) {
        for (const xAOD::TruthParticle* truthParticle : **muonTruthParticleRecoLink) {
            ATH_MSG_DEBUG("no reco muon link set, add an empty one");
            (*muonTruthParticleRecoLink)(*truthParticle) = ElementLink<xAOD::MuonContainer>();
         }
    }
 
    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();
  }

initialize()

StatusCode Muon::RecoToTruthAssociationAlg::initialize ( )

override

Definition at line 48 of file RecoToTruthAssociationAlg.cxx.

                                                 {
    ATH_CHECK(m_idHelperSvc.retrieve());
    ATH_CHECK(m_truthMuKey.initialize());
    ATH_CHECK(m_recoMuKey.initialize());
 
    if (m_recoLink.empty()){
        m_muonTruthRecoLink = "" ;
    } else {
        m_muonTruthRecoLink = m_recoLink;
    }
 
    ATH_CHECK(m_muonTruthRecoLink.initialize(!m_recoLink.empty()));
    ATH_CHECK(m_muonTruthParticleLink.initialize());
    ATH_CHECK(m_muonTruthParticleOrigin.initialize());
    ATH_CHECK(m_muonTruthParticleType.initialize());
    ATH_CHECK(m_muonTruthParticleClassification.initialize());
    ATH_CHECK(m_muonTruthParticleNPrecMatched.initialize());
    ATH_CHECK(m_muonTruthParticleNPhiMatched.initialize());
    ATH_CHECK(m_muonTruthParticleNTrigEtaMatched.initialize());
    for (const std::string& trk_coll : m_assocTrkContainers.value()){
        m_inputDecorKey.emplace_back(trk_coll + ".truthParticleLink");
    }
 
    m_inputDecorKey.emplace_back(m_truthMuKey, SG::AuxTypeRegistry::instance().getName(acc_origin.auxid()));
    m_inputDecorKey.emplace_back(m_truthMuKey, SG::AuxTypeRegistry::instance().getName(acc_type.auxid()));
    if (m_idHelperSvc->hasMDT()) {
        m_inputDecorKey.emplace_back(m_truthMuKey, SG::AuxTypeRegistry::instance().getName(truthMdtHitsAcc.auxid()));
    }
    if (m_idHelperSvc->hasRPC()) {
        m_inputDecorKey.emplace_back(m_truthMuKey, SG::AuxTypeRegistry::instance().getName(truthRpcHitsAcc.auxid()));
    }
    if (m_idHelperSvc->hasTGC()) {
        m_inputDecorKey.emplace_back(m_truthMuKey, SG::AuxTypeRegistry::instance().getName(truthTgcHitsAcc.auxid()));
    }
    if (m_idHelperSvc->hasCSC()) {
        m_inputDecorKey.emplace_back(m_truthMuKey, SG::AuxTypeRegistry::instance().getName(truthCscHitsAcc.auxid()));
    }
 
    ATH_CHECK(m_inputDecorKey.initialize());
    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 HiveAlgBase, 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);
  }

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.

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_associateWithInDetTP

Gaudi::Property<bool> Muon::RecoToTruthAssociationAlg::m_associateWithInDetTP {this, "AssociateWithInDetTP", false, "force use of ID track particles for association"}

private

Definition at line 74 of file RecoToTruthAssociationAlg.h.

{this, "AssociateWithInDetTP", false, "force use of ID track particles for association"};

m_assocTrkContainers

Gaudi::Property<std::vector<std::string> > Muon::RecoToTruthAssociationAlg::m_assocTrkContainers

private

Initial value:

{this, "TrackContainers", {"CombinedMuonTrackParticles",
                                                                                            "ExtrapolatedMuonTrackParticles",
                                                                                            "MSOnlyExtrapolatedMuonTrackParticles"},
                        "Collection of track containers to be decorated before this alg can be scheduled. truthLink decoration exploited "}

Definition at line 69 of file RecoToTruthAssociationAlg.h.

                                                            {this, "TrackContainers", {"CombinedMuonTrackParticles",
                                                                                            "ExtrapolatedMuonTrackParticles",
                                                                                            "MSOnlyExtrapolatedMuonTrackParticles"},
                        "Collection of track containers to be decorated before this alg can be scheduled. truthLink decoration exploited "};

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_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_idHelperSvc

ServiceHandle<Muon::IMuonIdHelperSvc> Muon::RecoToTruthAssociationAlg::m_idHelperSvc {this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"}

private

Definition at line 76 of file RecoToTruthAssociationAlg.h.

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

m_inputDecorKey

SG::ReadDecorHandleKeyArray<xAOD::IParticleContainer> Muon::RecoToTruthAssociationAlg::m_inputDecorKey

private

Initial value:

{
        this, "TrkTruthLinkKeys", {},
        "Declare the decoration dependencies of this algorithm. Steer via TrackContainers property"}

Definition at line 66 of file RecoToTruthAssociationAlg.h.

                                                                     {
        this, "TrkTruthLinkKeys", {},
        "Declare the decoration dependencies of this algorithm. Steer via TrackContainers property"};

m_muonTruthParticleClassification

SG::WriteDecorHandleKey<xAOD::MuonContainer> Muon::RecoToTruthAssociationAlg::m_muonTruthParticleClassification

private

Initial value:

{
        this, "MuonTruthParticleClassification", m_recoMuKey, "truthClassification",
        "muon truth classification auxdata name; name will be reset in initialize() based on m_muonName"}

Definition at line 51 of file RecoToTruthAssociationAlg.h.

                                                                              {
        this, "MuonTruthParticleClassification", m_recoMuKey, "truthClassification",
        "muon truth classification auxdata name; name will be reset in initialize() based on m_muonName"};

m_muonTruthParticleLink

SG::WriteDecorHandleKey<xAOD::MuonContainer> Muon::RecoToTruthAssociationAlg::m_muonTruthParticleLink

private

Initial value:

{
        this, "MuonTruthParticleLink", m_recoMuKey, "truthParticleLink",
        "muon truth particle link auxdata name; name will be reset in initialize() based on m_muonName"}

Decorations for the reconstructed muon particles.

Definition at line 42 of file RecoToTruthAssociationAlg.h.

                                                                    {
        this, "MuonTruthParticleLink", m_recoMuKey, "truthParticleLink",
        "muon truth particle link auxdata name; name will be reset in initialize() based on m_muonName"};

m_muonTruthParticleNPhiMatched

SG::WriteDecorHandleKey<xAOD::MuonContainer> Muon::RecoToTruthAssociationAlg::m_muonTruthParticleNPhiMatched

private

Initial value:

{
        this, "MuonTruthParticleNPhiMatched", m_recoMuKey, "nphiMatchedHitsPerChamberLayer",
        "muon vector of number of phi matched hits per chamber layer auxdata name; name will be reset in initialize() based on m_muonName"}

Definition at line 58 of file RecoToTruthAssociationAlg.h.

                                                                           {
        this, "MuonTruthParticleNPhiMatched", m_recoMuKey, "nphiMatchedHitsPerChamberLayer",
        "muon vector of number of phi matched hits per chamber layer auxdata name; name will be reset in initialize() based on m_muonName"};

m_muonTruthParticleNPrecMatched

SG::WriteDecorHandleKey<xAOD::MuonContainer> Muon::RecoToTruthAssociationAlg::m_muonTruthParticleNPrecMatched

private

Initial value:

{
        this, "MuonTruthParticleNPrecMatched", m_recoMuKey, "nprecMatchedHitsPerChamberLayer",
        "muon vector of number of precision matched hits per chamber layer auxdata name; name will be reset in initialize() based on "
        "m_muonName"}

Definition at line 54 of file RecoToTruthAssociationAlg.h.

                                                                            {
        this, "MuonTruthParticleNPrecMatched", m_recoMuKey, "nprecMatchedHitsPerChamberLayer",
        "muon vector of number of precision matched hits per chamber layer auxdata name; name will be reset in initialize() based on "
        "m_muonName"};

m_muonTruthParticleNTrigEtaMatched

SG::WriteDecorHandleKey<xAOD::MuonContainer> Muon::RecoToTruthAssociationAlg::m_muonTruthParticleNTrigEtaMatched

private

Initial value:

{
        this, "MuonTruthParticleNTrigEtaMatched", m_recoMuKey, "ntrigEtaMatchedHitsPerChamberLayer",
        "muon vector of number of phi matched hits per chamber layer auxdata name; name will be reset in initialize() based on m_muonName"}

Definition at line 61 of file RecoToTruthAssociationAlg.h.

                                                                               {
        this, "MuonTruthParticleNTrigEtaMatched", m_recoMuKey, "ntrigEtaMatchedHitsPerChamberLayer",
        "muon vector of number of phi matched hits per chamber layer auxdata name; name will be reset in initialize() based on m_muonName"};

m_muonTruthParticleOrigin

SG::WriteDecorHandleKey<xAOD::MuonContainer> Muon::RecoToTruthAssociationAlg::m_muonTruthParticleOrigin

private

Initial value:

{
        this, "MuonTruthParticleOrigin", m_recoMuKey, "truthOrigin",
        "muon truth origin auxdata name; name will be reset in initialize() based on m_muonName"}

Definition at line 48 of file RecoToTruthAssociationAlg.h.

                                                                      {
        this, "MuonTruthParticleOrigin", m_recoMuKey, "truthOrigin",
        "muon truth origin auxdata name; name will be reset in initialize() based on m_muonName"};

m_muonTruthParticleType

SG::WriteDecorHandleKey<xAOD::MuonContainer> Muon::RecoToTruthAssociationAlg::m_muonTruthParticleType

private

Initial value:

{
        this, "MuonTruthParticleType", m_recoMuKey, "truthType",
        "muon truth type auxdata name; name will be reset in initialize() based on m_muonName"}

Definition at line 45 of file RecoToTruthAssociationAlg.h.

                                                                    {
        this, "MuonTruthParticleType", m_recoMuKey, "truthType",
        "muon truth type auxdata name; name will be reset in initialize() based on m_muonName"};

m_muonTruthRecoLink

SG::WriteDecorHandleKey<xAOD::TruthParticleContainer> Muon::RecoToTruthAssociationAlg::m_muonTruthRecoLink

private

Initial value:

{
        this, "MuonTruthParticleRecoLink", m_truthMuKey, "",
        "container name for muon truth particles; the full handle name, including the reco muon link auxdata, is set in initialize()"}

Decorations for the filtered muon truth particles.

Definition at line 33 of file RecoToTruthAssociationAlg.h.

                                                                         {
        this, "MuonTruthParticleRecoLink", m_truthMuKey, "",
        "container name for muon truth particles; the full handle name, including the reco muon link auxdata, is set in initialize()"};

m_recoLink

Gaudi::Property<std::string> Muon::RecoToTruthAssociationAlg::m_recoLink {this, "RecoLinkName", "recoMuonLink" , "Decoration to the truth particle pointing to the muon"}

private

Definition at line 73 of file RecoToTruthAssociationAlg.h.

{this, "RecoLinkName", "recoMuonLink" , "Decoration to the truth particle pointing to the muon"};

m_recoMuKey

SG::ReadHandleKey<xAOD::MuonContainer> Muon::RecoToTruthAssociationAlg::m_recoMuKey

private

Initial value:

{
        this, "MuonContainerName", "Muons",
        "container name for reco muon particles; the full handle name, including the reco muon link auxdata, is set in initialize()"}

Definition at line 37 of file RecoToTruthAssociationAlg.h.

                                                  {
        this, "MuonContainerName", "Muons",
        "container name for reco muon particles; the full handle name, including the reco muon link auxdata, is set in initialize()"};

m_truthMuKey

SG::ReadHandleKey<xAOD::TruthParticleContainer> Muon::RecoToTruthAssociationAlg::m_truthMuKey

private

Initial value:

{
        this, "MuonTruthParticleContainerName", "MuonTruthParticles"}

Key to the filtered muon truth particles.

Definition at line 29 of file RecoToTruthAssociationAlg.h.

                                                           {
        this, "MuonTruthParticleContainerName", "MuonTruthParticles"};

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:

• RecoToTruthAssociationAlg.h
• RecoToTruthAssociationAlg.cxx