MuonPhaseII/MuonDetDescr/MuonReadoutGeometryR4/MuonReadoutGeometryR4/MdtReadoutElement.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
#ifndef MUONREADOUTGEOMETRYR4_MDTREADOUTELEMENT_H
#define MUONREADOUTGEOMETRYR4_MDTREADOUTELEMENT_H
 
#include <MuonReadoutGeometryR4/MuonReadoutElement.h>
#include <MuonReadoutGeometryR4/MdtTubeLayer.h>
 
#ifndef SIMULATIONBASE
#   include <MuonAlignmentData/BLinePar.h>
#   include <MuonAlignmentData/MdtAsBuiltPar.h>
#   include "Acts/Utilities/BoundFactory.hpp"
#endif
 
namespace MuonGMR4 {
 
class MdtReadoutElement : public MuonReadoutElement {
 
   public:
        struct parameterBook {
            // the number of tubes of the first layer
            std::vector<MdtTubeLayerPtr> tubeLayers{};
 
            std::set<IdentifierHash> removedTubes{};

            double tubeWall{0.};
            double tubeInnerRad{0.};
            double tubePitch{0.};
            double wireTension{0.};
            double endPlugLength{0.};
            double deadLength{0.};
            double radLengthX0{0.};
            double shortHalfX{0.};
            double longHalfX{0.};
            double halfY{0.};
            double halfHeight{0.};
            double readoutSide{1.};
    #ifndef SIMULATIONBASE
            std::shared_ptr<Acts::SurfaceBoundFactory> boundFactory;
    #endif
 
        };
 
        struct defineArgs : public MuonReadoutElement::defineArgs,
                            public parameterBook {};
 
        MdtReadoutElement(defineArgs&& args);
        virtual ~MdtReadoutElement();
        const parameterBook& getParameters() const;
        ActsTrk::DetectorType detectorType() const override final {
            return ActsTrk::DetectorType::Mdt;
        }

        double thickness() const override final;
 
        StatusCode initElement() override final;
        unsigned int multilayer() const;
        unsigned int numLayers() const;
        unsigned int numTubesInLay() const;

        static unsigned int tubeNumber(const IdentifierHash& hash);
        static  unsigned int layerNumber(const IdentifierHash& hash);
        static IdentifierHash measurementHash(unsigned int layerNumber, unsigned int tubeNumber);
 

        IdentifierHash measurementHash(const Identifier& measId) const override final;
        IdentifierHash layerHash(const Identifier& measId) const override final;
        static IdentifierHash layerHash(const IdentifierHash& measHash);
        Identifier measurementId(const IdentifierHash& measHash) const override final;
 
        bool isValid(const IdentifierHash& measHash) const;
        bool isBarrel() const;
        double tubePitch() const;
        double innerTubeRadius() const;
        double tubeRadius() const;
        double moduleWidthS() const;
        double moduleWidthL() const;
        double moduleHeight() const;
        double moduleThickness() const;

        Amg::Vector3D globalTubePos(const ActsTrk::GeometryContext& ctx,
                                    const Identifier& measId) const;
 
        Amg::Vector3D globalTubePos(const ActsTrk::GeometryContext& ctx,
                                    const IdentifierHash& hash) const;

        Amg::Vector3D readOutPos(const ActsTrk::GeometryContext& ctx,
                                const Identifier& measId) const;
 
        Amg::Vector3D readOutPos(const ActsTrk::GeometryContext& ctx,
                                const IdentifierHash& measId) const;

        Amg::Vector3D highVoltPos(const ActsTrk::GeometryContext& ctx,
                                const Identifier& measId) const;
        Amg::Vector3D highVoltPos(const ActsTrk::GeometryContext& ctx,
                                const IdentifierHash& measId) const;
        double distanceToReadout(const ActsTrk::GeometryContext& ctx,
                                const Identifier& measId,
                                const Amg::Vector3D& globPoint) const;
        double distanceToReadout(const ActsTrk::GeometryContext& ctx,
                                const IdentifierHash& measHash,
                                const Amg::Vector3D& globPoint) const;

        double distanceToReadout(const IdentifierHash& measHash,
                                const Amg::Vector3D& localPoint) const;
 
        double activeTubeLength(const IdentifierHash& hash) const;
  
        double tubeLength(const IdentifierHash& hash) const;
        
        double wireLength(const IdentifierHash& hash) const;
        double uncutTubeLength(const IdentifierHash& tubeHash) const;
 
 
        friend ActsTrk::TransformCacheDetEle<MdtReadoutElement>;

        void setComplementaryReadoutEle(const MdtReadoutElement* other);
        Amg::Vector3D bLineReferencePoint() const;

        Amg::Vector3D localTubePos(const IdentifierHash& hash) const;
        Amg::Transform3D asBuiltRefFrame() const;
        const MdtReadoutElement* complementaryRE() const;
    private:
        Amg::Transform3D toChamberLayer(const IdentifierHash& hash) const;
        Amg::Transform3D toTubeFrame(const IdentifierHash& hash) const;
        Amg::Transform3D fromIdealToDeformed(const IdentifierHash& tubeHash,
                                             const ActsTrk::DetectorAlignStore* store) const;
                                             
 #ifndef SIMULATIONBASE 
        using tubeSide_t = MdtAsBuiltPar::tubeSide_t;
        Amg::Vector3D wireEndpointAsBuilt(const MdtAsBuiltPar&  asBuilt,
                                           const IdentifierHash& tubeHash,
                                           const Amg::Vector3D& nominalEnd, 
                                           const tubeSide_t side) const;
        
        Amg::Vector3D applyBlineCorrections(const BLinePar& bline,
                                            const Amg::Vector3D& localTubeEndPoint,
                                            const Amg::Vector3D& fixedPoint,
                                            const double thickness) const;
 
#endif        
        parameterBook m_pars{};
        const MdtIdHelper& m_idHelper{idHelperSvc()->mdtIdHelper()};
        int m_stML{m_idHelper.multilayer(identify())};
        bool m_isBarrel{m_idHelper.isBarrel(identify())};
        const MdtReadoutElement* m_reOtherMl{this};
};
 
std::ostream& operator<<(std::ostream& ostr, const MdtReadoutElement::parameterBook& pars);
}  // namespace MuonGMR4
 
namespace ActsTrk{
    template <> Amg::Transform3D 
        TransformCacheDetEle<MuonGMR4::MdtReadoutElement>::fetchTransform(const DetectorAlignStore* store) const;
    template <> Identifier
        TransformCacheDetEle<MuonGMR4::MdtReadoutElement>::identify() const;
}
 
#include <MuonReadoutGeometryR4/MdtReadoutElement.icc>
#endif