IMuonTrackTruthTool.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2023 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef MUON_IMUONTRACKTRUTHTOOL_H
#define MUON_IMUONTRACKTRUTHTOOL_H
 
#include <map>
#include <set>
#include <vector>
 
#include "GaudiKernel/IAlgTool.h"
#include "GeneratorObjects/McEventCollection.h"
#include "Identifier/Identifier.h"
#include "MuonSimData/CscSimDataCollection.h"
#include "MuonSimData/MuonSimDataCollection.h"
#include "TrackRecord/TrackRecordCollection.h"
#include "TrkTrack/TrackCollection.h"
 
static const InterfaceID IID_IMuonTrackTruthTool("Muon::IMuonTrackTruthTool", 1, 0);
 
class TruthTrajectory;
 
namespace Muon {
    class MuonSegment;
}
 
namespace Muon {
 
    class MuonTechnologyTruth {
    public:
        std::set<Identifier> matchedHits;
        std::set<Identifier> matchedChambers;
        std::set<Identifier> missedHits;
        std::set<Identifier> missedChambers;
        std::set<Identifier> wrongHits;
        std::set<Identifier> wrongChambers;
    };
 
    class MuonTrackTruth {
    public:
        const TrackRecord* truthTrack;
        std::shared_ptr<const TruthTrajectory> truthTrajectory;
        bool isHitMatched;
        bool isParameterMatched;
        MuonTechnologyTruth mdts;
        MuonTechnologyTruth cscs;
        MuonTechnologyTruth rpcs;
        MuonTechnologyTruth tgcs;
        MuonTechnologyTruth stgcs;
        MuonTechnologyTruth mms;
        unsigned int numberOfMatchedHits() const {
            return mdts.matchedHits.size() + tgcs.matchedHits.size() + rpcs.matchedHits.size() + cscs.matchedHits.size() +
                   stgcs.matchedHits.size() + mms.matchedHits.size();
        }
        MuonTrackTruth() : truthTrack(0), truthTrajectory(0), isHitMatched(false), isParameterMatched(false) {}
    };
 
    class MuonSegmentTruth {
    public:
        const TrackRecord* truthTrack;
        bool isHitMatched;
        MuonTechnologyTruth mdts;
        MuonTechnologyTruth cscs;
        MuonTechnologyTruth rpcs;
        MuonTechnologyTruth tgcs;
        MuonTechnologyTruth stgcs;
        MuonTechnologyTruth mm;
        MuonSegmentTruth() : truthTrack(0), isHitMatched(false) {}
    };

    class IMuonTrackTruthTool : virtual public IAlgTool {
    public:
        struct TruthTreeEntry {
            const TrackRecord* truthTrack;
            std::shared_ptr<const TruthTrajectory> truthTrajectory;
            MuonSimDataCollection mdtHits;
            CscSimDataCollection cscHits;
            MuonSimDataCollection rpcHits;
            MuonSimDataCollection tgcHits;
            MuonSimDataCollection stgcHits;
            MuonSimDataCollection mmHits;
        };
 
        typedef std::pair<const Trk::Track*, MuonTrackTruth> MatchResult;
        typedef std::vector<MatchResult> ResultVec;
 
        typedef std::pair<const Muon::MuonSegment*, MuonTrackTruth> SegmentMatchResult;
        typedef std::vector<SegmentMatchResult> SegmentResultVec;
 
        // collect track record entries per barcode
        typedef std::map<int, TruthTreeEntry> TruthTree;
        typedef TruthTree::iterator TruthTreeIt;
        typedef TruthTree::const_iterator TruthTreeConstIt;
 
    public:
        static const InterfaceID& interfaceID();

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

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

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

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

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

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

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

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

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

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

        virtual unsigned int getNumberOfScatters(const TruthTrajectory& traj, const int barcodeIn) const = 0;
    };
 
    inline const InterfaceID& IMuonTrackTruthTool::interfaceID() { return IID_IMuonTrackTruthTool; }
 
}  // namespace Muon
 
#endif