MuonTrackTruthTool.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef MUON_MUONTRACKTRUTHTOOL_H
#define MUON_MUONTRACKTRUTHTOOL_H
 
#include <map>
#include <set>
#include <string>
#include <utility>
#include <vector>
 
#include "AthenaBaseComps/AthAlgTool.h"
 
 
#include "MuonIdHelpers/IMuonIdHelperSvc.h"
#include "MuonRecHelperTools/MuonEDMPrinterTool.h"
#include "MuonRecToolInterfaces/IMuonTrackTruthTool.h"
#include "MuonSimData/CscSimDataCollection.h"
#include "MuonSimData/MuonSimDataCollection.h"
#include "TrackRecord/TrackRecordCollection.h"
#include "TrkToolInterfaces/ITruthTrajectoryBuilder.h"
#include "TrkTrack/TrackCollection.h"
 
class TruthTrajectory;
 
namespace Muon {
    class MuonSegment;
}
 
namespace Trk {
    class Track;
    class MeasurementBase;
}  // namespace Trk
 
namespace Muon {

    class MuonTrackTruthTool :  public extends<AthAlgTool, IMuonTrackTruthTool> {
    public:
        struct SortResultByMatchedHits {
            bool operator()(const MatchResult& r1, const MatchResult& r2) const;
            bool operator()(const SegmentMatchResult& r1, const SegmentMatchResult& r2) const;
            bool operator()(const MuonTrackTruth& r1, const MuonTrackTruth& r2) const;
        };
 
    public:
        using base_class::base_class;
        ~MuonTrackTruthTool() = default;

        StatusCode initialize();

        ResultVec match(const TruthTree& truth_tree, const TrackCollection& tracks) const;

        SegmentResultVec match(const TruthTree& truth_tree, const std::vector<const MuonSegment*>& segments) const;

        MuonTrackTruth getTruth(const TruthTree& truth_tree, const Trk::Track& track, bool restrictedTruth = false) const;

        MuonTrackTruth getTruth(const TruthTree& truth_tree, const std::vector<const MuonSegment*>& segments,
                                bool restrictedTruth = false) const;

        MuonTrackTruth getTruth(const TruthTree& truth_tree, const Muon::MuonSegment& segment) const;

        MuonTrackTruth getTruth(const TruthTree& truth_tree, const std::vector<const Trk::MeasurementBase*>& measurements,
                                bool restrictedTruth = false) const;

        const TruthTree createTruthTree(const TrackRecordCollection* truthTrackCol, const McEventCollection* mcEventCollection,
                                        const std::vector<const MuonSimDataCollection*>& muonSimData,
                                        const CscSimDataCollection* cscSimDataMap) const;

        HepMC::ConstGenParticlePtr getMother(const TruthTrajectory& traj, const int barcodeIn) const;

        HepMC::ConstGenParticlePtr getAncestor(const TruthTrajectory& traj, const int barcodeIn) const;

        HepMC::ConstGenParticlePtr getInitial(const TruthTrajectory& traj, const int barcodeIn) const;

        unsigned int getNumberOfScatters(const TruthTrajectory& traj, const int barcodeIn) const;
 
    private:
        MuonTrackTruth getTruth(const std::vector<const Trk::MeasurementBase*>& measurements, const TruthTreeEntry& truthEntry,
                                bool restrictedTruth) const;
 
        void addSimDataToTree(TruthTree& truth_tree, std::map<int, int>& barcode_map, const MuonSimDataCollection* simDataCol) const;
        void addCscSimDataToTree(TruthTree& truth_tree, std::map<int, int>& barcode_map, const CscSimDataCollection* simDataCol) const;
 
        void addMdtTruth(MuonTechnologyTruth& trackTruth, const Identifier& id, const Trk::MeasurementBase& meas,
                         const MuonSimDataCollection& simCol) const;
 
        void addClusterTruth(MuonTechnologyTruth& trackTruth, const Identifier& id, const Trk::MeasurementBase& meas,
                             const MuonSimDataCollection& simCol) const;
        void addClusterTruth(MuonTechnologyTruth& trackTruth, const Identifier& id, const Trk::MeasurementBase& meas,
                             const CscSimDataCollection& simCol) const;
 
        void addMissedHits(MuonTechnologyTruth& truth, const std::set<Identifier>& ids, const std::set<Identifier>& chids,
                           const MuonSimDataCollection& simCol, bool restrictedTruth) const;
 
        void addMissedHits(MuonTechnologyTruth& truth, const std::set<Identifier>& ids, const std::set<Identifier>& chids,
                           const CscSimDataCollection& simCol, bool restrictedTruth) const;
 
        int manipulateBarCode(int barcode) const;
 
        bool selectPdg(int pdg) const { return m_selectedPdgs.count(pdg); }

        const std::pair<HepMC::ConstGenParticlePtr, unsigned int> getInitialPair(const TruthTrajectory& traj, const int barcodeIn) const;
 
        ServiceHandle<Muon::IMuonIdHelperSvc> m_idHelperSvc{this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"};
 
        PublicToolHandle<Muon::MuonEDMPrinterTool> m_printer{this, "Printer", "Muon::MuonEDMPrinterTool/MuonEDMPrinterTool"};
        ToolHandle<Trk::ITruthTrajectoryBuilder> m_truthTrajectoryBuilder{
            this, "TruthTrajectoryBuilder", "Muon::MuonDecayTruthTrajectoryBuilder/MuonDecayTruthTrajectoryBuilder"};
 
        Gaudi::Property<bool> m_manipulateBarCode{this, "ManipulateBarCode", false};
        Gaudi::Property<bool> m_doSummary{this, "DoSummary", false};
        Gaudi::Property<bool> m_matchAllParticles{this, "MatchAllParticles", true};
        Gaudi::Property<unsigned int> m_minHits{this, "MinHits", 4};
        Gaudi::Property<std::vector<int>> m_pdgsToBeConsidered{this, "ConsideredPDGs", {}};
 
        std::set<int> m_selectedPdgs;  // set storing particle PDG's considered for matching
    };
 
}  // namespace Muon
 
#endif  // MUON_MDTONTRACKTOOL_H