MuPatHit.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef MUPATHIT_H
#define MUPATHIT_H
 
#include <list>
#include <mutex>
 
#include "CxxUtils/atomic_fetch_minmax.h"
#include "Identifier/Identifier.h"
#include "MuonStationIndex/MuonStationIndex.h"
#include "TrkParameters/TrackParameters.h"
#include "TrkEventPrimitives/TrkObjectCounter.h"
#include "TrkMeasurementBase/MeasurementBase.h"
 
 
namespace Muon {

    class MuPatHit;
    using MuPatHitPtr = std::shared_ptr<MuPatHit>;    
    using MuPatHitList = std::vector<MuPatHitPtr>;
    using MuPatHitCit = MuPatHitList::const_iterator;
    using MuPatHitIt = MuPatHitList::iterator;
 
    class MuPatHit : public Trk::ObjectCounter<MuPatHit> {
    public:
        enum Type { UnknownType = -1, MDT = 0, RPC = 1, TGC = 2, CSC = 3, MM = 4, sTGC = 5, PREC = 6, Pseudo = 7, Scatterer = 8 };
        enum Status { UnknownStatus = -1, OnTrack = 0, Outlier, NotOnTrack };
        enum HitSelection { UnknownSelection = -1, Precise = 0, Broad = 1 };
 
        struct Info {
            Info() = default;
            Identifier id{};

            Type type{Pseudo};
            HitSelection selection{UnknownSelection};
            Status status{OnTrack};
            MuonStationIndex::StIndex stIdx{MuonStationIndex::StIndex::StUnknown};
            MuonStationIndex::ChIndex chIdx{MuonStationIndex::ChIndex::ChUnknown};
            bool isSmall{false};
            bool isEndcap{false};
            bool measuresPhi{true};
        };

        MuPatHit(std::shared_ptr<const Trk::TrackParameters> pars, 
                 std::shared_ptr<const Trk::MeasurementBase> presMeas,
                 std::shared_ptr<const Trk::MeasurementBase> broadMeas,
                 const Info& info);

        MuPatHit(const MuPatHit& hit);

        MuPatHit& operator=(const MuPatHit&);

        virtual ~MuPatHit() = default;
        
        const Trk::TrackParameters& parameters() const;

        const Trk::MeasurementBase& measurement() const;

        const Info& info() const;

        Info& info();

        std::unique_ptr<MuPatHit> clone() const { return std::make_unique<MuPatHit>(*this); }

        const Trk::MeasurementBase& preciseMeasurement() const;

        const Trk::MeasurementBase& broadMeasurement() const;
        
        void setResidual(double residual, double pull);

        double residual() const;
        double pull() const;

        static unsigned int maxNumberOfInstantiations();

        static unsigned int numberOfInstantiations();

        static unsigned int numberOfCopies();
 
    private:
        void copy(const MuPatHit& hit);
 
        // private member data
        std::shared_ptr<const Trk::TrackParameters> m_pars{};
        std::shared_ptr<const Trk::MeasurementBase> m_precisionMeas{};
        std::shared_ptr<const Trk::MeasurementBase> m_broadMeas;
        Info m_info{};
        double m_residual{0.};
        double m_pull{0.};
    };  // class MuPatHit
 
}  // namespace Muon
 
#endif