MdtDriftCircleOnTrack.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2023 CERN for the benefit of the ATLAS collaboration
*/
#ifndef MUONRIO_ONTRACK_MDTDRIFTCIRCLEONTRACK_H
#define MUONRIO_ONTRACK_MDTDRIFTCIRCLEONTRACK_H
 
// Base classes
#include "TrkRIO_OnTrack/RIO_OnTrack.h"
#include "MuonPrepRawData/MdtPrepData.h"
 
 
#include "TrkEventPrimitives/DriftCircleSide.h"
#include "TrkEventPrimitives/DriftCircleStatus.h"
 
#include "MuonPrepRawData/MdtPrepDataContainer.h"
#include "AthLinks/ElementLink.h"
#include "MuonRIO_OnTrack/MuonDriftCircleErrorStrategy.h"
#include "CxxUtils/CachedUniquePtr.h"
 
 
#include <cassert>
 
using ElementLinkToIDC_MDT_Container = ElementLink<Muon::MdtPrepDataContainer>;
 
namespace Trk{
    class LocalParameters;
    class ITrkEventCnvTool;
}
 
namespace Muon
{
    class MuonEventCnvTool;
    class MdtDriftCircleOnTrackCreator;

class MdtDriftCircleOnTrack final: public Trk::RIO_OnTrack {
public:
 
    friend class  Trk::ITrkEventCnvTool;
    friend class Muon::MuonEventCnvTool;
    friend class Muon::MdtDriftCircleOnTrackCreator;

    MdtDriftCircleOnTrack() = default;
 
    MdtDriftCircleOnTrack(const MdtDriftCircleOnTrack &);
    MdtDriftCircleOnTrack &operator=(const MdtDriftCircleOnTrack &);
 
    MdtDriftCircleOnTrack(MdtDriftCircleOnTrack&&) = default;
    MdtDriftCircleOnTrack &operator=(MdtDriftCircleOnTrack&&) = default;
 
 

    MdtDriftCircleOnTrack(const MdtPrepData* RIO,
                          Trk::LocalParameters&& locPos,
                          Amg::MatrixX&& errDriftRadius,
                          const double driftTime,
                          const Trk::DriftCircleStatus status,
                          const Amg::Vector3D& globDir,
                          const double positionAlongWire,
                          const MuonDriftCircleErrorStrategy& errorStrategy);

    MdtDriftCircleOnTrack(const MdtPrepData* RIO,
                          Trk::LocalParameters&& locPos,
                          Amg::MatrixX&& errDriftRadius,
                          const double driftTime,
                          const Trk::DriftCircleStatus status,
                          const double positionAlongWire,
                          const MuonDriftCircleErrorStrategy& errorStrategy);
 
 
     // Alternate constructor that doesn't dereference the RIO link.
    MdtDriftCircleOnTrack(const ElementLinkToIDC_MDT_Container& RIO,
                          Trk::LocalParameters&& locPos,
                          Amg::MatrixX&& errDriftRadius,
                          const Identifier& id,
                          const MuonGM::MdtReadoutElement* detEl,
                          const double  driftTime,
                          const Trk::DriftCircleStatus status,
                          const double positionAlongWire,
                          const double localAngle,
                          const MuonDriftCircleErrorStrategy& errorStrategy);

    virtual ~MdtDriftCircleOnTrack() = default;

    Trk::DriftCircleSide side() const;

    Trk::DriftCircleStatus status() const;

    virtual MdtDriftCircleOnTrack* clone() const override final;

    virtual const MdtPrepData* prepRawData() const override final;
    const ElementLinkToIDC_MDT_Container& prepRawDataLink() const;

    IdentifierHash collectionHash() const;

    virtual IdentifierHash idDE() const override final{ return IdentifierHash(); }

    virtual const MuonGM::MdtReadoutElement* detectorElement() const override final;

    virtual const Trk::StraightLineSurface& associatedSurface() const override final;

    virtual const Amg::Vector3D& globalPosition() const override final;
 
    virtual bool rioType(Trk::RIO_OnTrackType::Type type) const override final {
      return (type == Trk::RIO_OnTrackType::MdtDriftCircle);
    }

    double driftRadius() const;

    double driftTime() const;

    double positionAlongWire() const;

    double localAngle() const;

    const MuonDriftCircleErrorStrategy& errorStrategy() const;

    virtual MsgStream&    dump( MsgStream&    stream) const override final;

    virtual std::ostream& dump( std::ostream& stream) const override final;
 
    // /////////////////////////////////////////////////////////////////
    // Private data:
    // /////////////////////////////////////////////////////////////////
private:
    virtual void setLocalParameters( const Trk::LocalParameters& locPos);

    virtual void setValues(const Trk::TrkDetElementBase*,
                           const Trk::PrepRawData*) override final;

    void setGlobalPosition(Amg::Vector3D&& loc3Dframe) const;
 
    //Sets the error strategy, only used by the Muon::MdtDriftCircleOnTrackCreator
    void setErrorStrategy(const MuonDriftCircleErrorStrategy& strategy);

    Trk::DriftCircleStatus m_status{Trk::DriftCircleStatus::UNDECIDED};

    ElementLinkToIDC_MDT_Container m_rio{};

    CxxUtils::CachedUniquePtr<Amg::Vector3D> m_globalPosition{};

    double m_localAngle{0.};

    double m_positionAlongWire{0.};

    double m_driftTime{0.};

    MuonDriftCircleErrorStrategy m_errorStrategy{};
 
    /*** Pointer to the detector element. Needed if no prepData is present*/
    const MuonGM::MdtReadoutElement* m_detEl{nullptr};
 
};
 
// /////////////////////////////////////////////////////////////////
// Inline methods:
// /////////////////////////////////////////////////////////////////:
 
inline Trk::DriftCircleSide MdtDriftCircleOnTrack::side() const {
    if (m_status == Trk::UNDECIDED) return Trk::NONE;
    if (localParameters()[Trk::driftRadius] < 0. ) return Trk::LEFT;
    return Trk::RIGHT;
}
 
inline Trk::DriftCircleStatus MdtDriftCircleOnTrack::status() const { return m_status; }
inline MdtDriftCircleOnTrack* MdtDriftCircleOnTrack::clone() const { return new MdtDriftCircleOnTrack(*this); }
inline const MdtPrepData* MdtDriftCircleOnTrack::prepRawData() const {
    if (m_rio.isValid()) return m_rio.cachedElement();
    return nullptr;
}
 
inline const ElementLinkToIDC_MDT_Container& MdtDriftCircleOnTrack::prepRawDataLink() const { return m_rio; }
 
inline IdentifierHash MdtDriftCircleOnTrack::collectionHash() const {
    return prepRawData()->collectionHash();
}
 
inline const MuonGM::MdtReadoutElement* MdtDriftCircleOnTrack::detectorElement() const {
    return prepRawData() ? prepRawData()->detectorElement() : m_detEl;
}
inline const Trk::StraightLineSurface& MdtDriftCircleOnTrack::associatedSurface() const {
    return detectorElement()->surface(identify());
}
 
inline void MdtDriftCircleOnTrack::setLocalParameters(const Trk::LocalParameters& locParams) { m_localParams = locParams; }
inline void MdtDriftCircleOnTrack::setErrorStrategy(const MuonDriftCircleErrorStrategy& strategy) { m_errorStrategy= strategy; }
inline double MdtDriftCircleOnTrack::driftRadius() const {
    return localParameters().get(Trk::driftRadius);
}
inline double MdtDriftCircleOnTrack::driftTime() const { return m_driftTime; }
inline double MdtDriftCircleOnTrack::positionAlongWire() const { return m_positionAlongWire; }
inline double MdtDriftCircleOnTrack::localAngle() const { return m_localAngle; }
inline const MuonDriftCircleErrorStrategy& MdtDriftCircleOnTrack::errorStrategy() const {
    return m_errorStrategy;
}
inline void MdtDriftCircleOnTrack::setValues(const Trk::TrkDetElementBase* detEl,
                                             const Trk::PrepRawData* prd) {
 
    m_detEl = dynamic_cast<const MuonGM::MdtReadoutElement*>(detEl);
    if (!prd) return;
    if (!prd->type(Trk::PrepRawDataType::MdtPrepData)) {
        throw std::runtime_error("No Mdt prd given to MdtDriftCircleOnTrack");
    }
    m_rio.setElement(static_cast<const MdtPrepData*>(prd));
}
 
}
 
#endif // MUONRIOONTRACK_MUONDRIFTCIRCLEONTRACK_H