MuPatCandidateBase.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef MUPATCANDIDATEBASE_H
#define MUPATCANDIDATEBASE_H
 
#include <set>
 
#include "Identifier/Identifier.h"
#include "MuPatPrimitives/MuPatHit.h"
#include "MuonStationIndex/MuonStationIndex.h"
#include "TrkParameters/TrackParameters.h"
#include "TrkMeasurementBase/MeasurementBase.h"
 
namespace Muon {

    class MuPatCandidateBase {
        friend class MuPatCandidateTool;
 
    public:
        using MeasVec = std::vector<const Trk::MeasurementBase*>;
 
    public:
        MuPatCandidateBase() = default;

        MuPatCandidateBase(const MeasVec& etaHits, const MeasVec& phiHits, const MeasVec& fakePhiHits, const MeasVec& allHits);

        virtual ~MuPatCandidateBase() = default;

        const MeasVec& etaHits() const;

        const MeasVec& phiHits() const;

        const MeasVec& fakePhiHits() const;

        const MeasVec& hits() const;

        bool hasSmallChamber() const;

        bool hasLargeChamber() const;

        bool hasSLOverlap() const;

        virtual const Trk::TrackParameters& entryPars() const = 0;

        bool hasEndcap() const;

        void hasEndcap(bool hasEC);

        bool hasMomentum() const;

        const std::set<MuonStationIndex::StIndex>& stations() const;

        const std::set<MuonStationIndex::ChIndex>& chambers() const;

        bool containsChamber(MuonStationIndex::ChIndex chIndex) const;

        bool containsStation(MuonStationIndex::StIndex chIndex) const;

        const MuPatHitList& hitList() const { return m_hitList; }

        const std::set<Identifier>& chamberIds() const;

        bool shareChambers(const MuPatCandidateBase& entry) const;

        const Trk::MeasurementBase* addToTrash(std::unique_ptr<const Trk::MeasurementBase> meas);
        void addToTrash(const std::vector<std::shared_ptr<const Trk::MeasurementBase>>& measurements);
        const std::vector<std::shared_ptr<const Trk::MeasurementBase>>& garbage() const;
    protected:
        // all non-const functions protected, only accessible by derived classes and MCTBEntryHandler and MuPatHitHandler

        void hasSLOverlap(bool hasSL);

        void hasSmallChamber(bool hasSmall);

        void hasLargeChamber(bool hasLarge);

        void setEtaHits(const MeasVec& hits);

        void setPhiHits(const MeasVec& hits);

        void setFakePhiHits(const MeasVec& hits);

        void setAllHits(const MeasVec& hits);

        MuPatHitList& hitList() { return m_hitList; }

        std::set<Identifier>& chamberIds();

        void clearChambers();

        void addChamber(MuonStationIndex::ChIndex chIndex);

        void setChambers(const std::set<MuonStationIndex::ChIndex>& chambers);
 
    private:
        MeasVec m_etaHits;      //<! vector containing all eta measurements
        MeasVec m_phiHits;      //<! vector containing all phi measurements
        MeasVec m_fakePhiHits;  //<! vector containing all fake phi measurements
        MeasVec m_allHits;      //<! vector containing all measurements (except fake phi measurements)
 
        MuPatHitList m_hitList;
 
        std::set<Identifier> m_chamberIds;  //<! set to store chamber Ids of hits associated with candidate
 
    protected:
        std::set<MuonStationIndex::ChIndex> m_chambers;  //<! set to store chamber indices of segments associated with candidate
        std::set<MuonStationIndex::StIndex> m_stations;  //<! set to store station indices of segments associated with candidate
        bool m_hasMomentum{false};
 
    public:
        unsigned int nmdtHitsMl1{0};
        unsigned int nmdtHitsMl2{0};
        unsigned int ncscHitsEta{0};
        unsigned int ncscHitsPhi{0};
        unsigned int nrpcHitsEta{0};
        unsigned int nrpcHitsPhi{0};
        unsigned int ntgcHitsEta{0};
        unsigned int ntgcHitsPhi{0};
 
    private:
        bool m_hasEndcap{false};
        bool m_hasSmallChamber{false};
        bool m_hasLargeChamber{false};
        bool m_hasSLOverlap{false};
 
        std::vector<std::shared_ptr<const Trk::MeasurementBase>> m_garbage{};
    };
 
}  // namespace Muon
 
#endif