MuonRecoValidationTool.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef MUON_MuonRecoValidationTool_H
#define MUON_MuonRecoValidationTool_H
 
#include <atomic>
#include <vector>
 
#include "AthenaBaseComps/AthAlgTool.h"
#include "CxxUtils/checker_macros.h"
#include "EventPrimitives/EventPrimitivesHelpers.h"
#include "GaudiKernel/IIncidentListener.h"
#include "GaudiKernel/ServiceHandle.h"
#include "GaudiKernel/ToolHandle.h"
#include "MuonCombinedEvent/CandidateSummary.h"
#include "MuonIdHelpers/IMuonIdHelperSvc.h"
#include "MuonLayerEvent/MuonSystemExtension.h"
#include "MuonLayerHough/MuonLayerHough.h"
#include "MuonRecHelperTools/IMuonEDMHelperSvc.h"
#include "MuonRecToolInterfaces/IMuonHitSummaryTool.h"
#include "MuonRecToolInterfaces/IMuonHitTimingTool.h"
#include "MuonRecToolInterfaces/IMuonRecoValidationTool.h"
#include "MuonRecToolInterfaces/IMuonTruthSummaryTool.h"
#include "MuonRecValidationNtuples/MuonInsideOutValidationNtuple.h"
#include "MuonSegmentMakerToolInterfaces/IMuonSegmentHitSummaryTool.h"
#include "MuonSegmentTaggerToolInterfaces/IMuTagMatchingTool.h"
#include "TrkExInterfaces/IExtrapolator.h"
#include "TrkMeasurementBase/MeasurementBase.h"
#include "xAODTracking/TrackParticle.h"
 
class TTree;
class TFile;
class IIncidentSvc;
 
namespace Trk {
    class Track;
}
 
namespace Muon {
    class MuonClusterOnTrack;
 
    struct MuonCandidate;
 
    class ATLAS_NOT_THREAD_SAFE MuonRecoValidationTool : public IMuonRecoValidationTool, virtual public IIncidentListener, public AthAlgTool {
    public:
        MuonRecoValidationTool(const std::string&, const std::string&, const IInterface*);

        ~MuonRecoValidationTool() = default;

        virtual StatusCode initialize() override;

        bool addTrackParticle(const xAOD::TrackParticle& indetTrackParticle, const MuonSystemExtension& muonSystemExtention) const override;

        bool add(const MuonSystemExtension::Intersection& intersection, const MuonSegment& segment, int stage) const override;

        bool add(const MuonSystemExtension::Intersection& intersection, const MuonHough::MuonLayerHough::Maximum& maximum) const override;

        bool add(const MuonSystemExtension::Intersection& intersection, const Trk::PrepRawData& prd, float expos,
                 float expos_err) const override;

        bool addTimeMeasurement(const MuonSystemExtension::Intersection& intersection, const Trk::MeasurementBase& meas) const override;

        bool addTimeMeasurement(const MuonSystemExtension::Intersection& intersection, const Identifier& id, const Amg::Vector3D& gpos,
                                float time, float errorTime) const override;

        bool addTimeMeasurements(const xAOD::TrackParticle& indetTrackParticle, const MuGirlNS::StauHits& stauHits) const override;

        bool addMuonCandidate(const xAOD::TrackParticle& indetTrackParticle, const MuonCandidate* candidate, Trk::Track* combinedTrack,
                              int ntimes, float beta, float chi2ndof, int stage) const override;

        virtual void handle(const Incident& inc) override;
 
    private:
        void clear();
 
        void extract(const MuonSegment& segment, std::set<Identifier>& ids, std::vector<const MuonClusterOnTrack*>& clusters) const;
 
        int getIndex(const MuonSystemExtension::Intersection& intersection) const {
            int index = -1;
            auto result = m_trackParticleIndexLookup.find(intersection.trackParameters.get());
            if (result != m_trackParticleIndexLookup.end()) index = result->second;
            return index;
        }
 
        // extract majority truth uniqueID out of a set of Identifiers
        int getUniqueID(const std::set<Identifier>& ids) const;
 
        ServiceHandle<Muon::IMuonIdHelperSvc> m_idHelperSvc{this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"};
        ServiceHandle<IMuonEDMHelperSvc> m_edmHelperSvc{this, "edmHelper", "Muon::MuonEDMHelperSvc/MuonEDMHelperSvc",
                                                        "Handle to the service providing the IMuonEDMHelperSvc interface"};
        ToolHandle<IMuonSegmentHitSummaryTool> m_segmentHitSummaryTool;
        ToolHandle<IMuonHitSummaryTool> m_hitSummaryTool;
        ToolHandle<IMuonTruthSummaryTool> m_truthSummaryTool;
        ToolHandle<Trk::IExtrapolator> m_extrapolator;
        ToolHandle<IMuTagMatchingTool> m_matchingTool;
        ToolHandle<IMuonHitTimingTool> m_hitTimingTool;
        ServiceHandle<IIncidentSvc> m_incidentSvc;
 
        // the following members are supposed to be used in 1-thread debugging, thus, not in production and not with mutliple threads
        mutable std::vector<const xAOD::TrackParticle*> m_trackParticles;
        mutable std::map<const Trk::TrackParameters*, unsigned int> m_trackParticleIndexLookup;
 
        mutable MuonInsideOutValidationNtuple m_ntuple;
        TTree* m_tree = nullptr;
 
        mutable std::atomic<unsigned int> m_candidateCounter;
 
        bool m_isMC;
    };
 
}  // namespace Muon
 
#endif