MuonDetDescr/MuonReadoutGeometry/MuonReadoutGeometry/RpcReadoutElement.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/
 
/***************************************************************************
 Rpc Readout Element properties
 -----------------------------------------
***************************************************************************/
 
#ifndef MUONREADOUTGEOMETRY_RPCREADOUTELEMENT_H
#define MUONREADOUTGEOMETRY_RPCREADOUTELEMENT_H
 
#include "MuonIdHelpers/RpcIdHelper.h"
#include "MuonReadoutGeometry/MuonClusterReadoutElement.h"
#include "MuonReadoutGeometry/MuonDetectorManager.h"
#include "MuonReadoutGeometry/MuonStripDesign.h"
#include "CxxUtils/ArrayHelper.h"
 
namespace MuonGMR4 {
    class ReadoutGeomCnvAlg;
}
 
namespace MuonGM {
 
    class RpcReadoutElement final : public MuonClusterReadoutElement {
        friend class MuonGMR4::ReadoutGeomCnvAlg;
        friend class MuonChamber;
        friend class MuonChamberLite;
 
    public:
        RpcReadoutElement(GeoVFullPhysVol* pv, const std::string& stName, int zi, int fi, bool is_mirrored, MuonDetectorManager* mgr);

        ~RpcReadoutElement();
 
        int getDoubletR() const;  
        int getDoubletZ() const;  
        int getDoubletPhi() const;  
        bool hasDEDontop() const;  

        virtual bool containsId(const Identifier& id) const override;

        bool inTheRibs() const;
 
        int nGasGapPerLay() const;            
        int NphiStripPanels() const;                
        int NphiStrips() const;                     
        int NetaStrips() const;                     
        int Nstrips(bool measphi  ) const;             
        double StripWidth(bool measphi  ) const;       
        double StripLength(bool measphi  ) const;      
        double StripPitch(bool measphi  ) const;       
        double StripPanelDead(bool measphi  ) const;   
        double stripPanelSsize(bool measphi  ) const;  
        double stripPanelZsize(bool measphi  ) const;  
        double gasGapSsize() const;                 
        double gasGapZsize() const;                 

        virtual double distanceToReadout(const Amg::Vector2D& pos, const Identifier& id) const override final;

        virtual int stripNumber(const Amg::Vector2D& pos, const Identifier& id) const override final;

        virtual bool stripPosition(const Identifier& id, Amg::Vector2D& pos) const override final;

        virtual int numberOfLayers(bool measphi   = true) const override final;
        void setNumberOfLayers(const int = 2);

        virtual int numberOfStrips(const Identifier& layerId) const override final;
        virtual int numberOfStrips(int, bool measuresPhi) const override final;

        virtual bool spacePointPosition(const Identifier& phiId, const Identifier& etaId, Amg::Vector2D& pos) const override final;

        virtual bool spacePointPosition(const Identifier& phiId, const Identifier& etaId, Amg::Vector3D& pos) const override final;

        void spacePointPosition(const Amg::Vector2D& phiPos, const Amg::Vector2D& etaPos, Amg::Vector2D& pos) const;

        const Amg::Vector3D REcenter() const;

        virtual void fillCache() override final;

        virtual int surfaceHash(const Identifier& id) const override final;

        int surfaceHash(int doubletPhi, int gasGap, bool measphi  ) const;

        virtual int layerHash(const Identifier& id) const override final;
        int layerHash(int doubletPhi, int gasGap) const;

        virtual int boundaryHash(const Identifier& id) const override final;

        virtual bool measuresPhi(const Identifier& id) const override final;

        void initDesign();
 
        void setDoubletR(int doubletR);
        void setDoubletZ(int dobuletZ);
        void setDoubletPhi(int doubletPhi);
        bool rotatedRpcModule() const;
 
        void setYTranslation(const double y);
        void setZTranslation(const double z);
 
 
        // local to global
        Amg::Vector3D localToGlobalCoords(const Amg::Vector3D& x, const Identifier& id) const;
        Amg::Transform3D localToGlobalTransf(const Identifier& id) const;
        Amg::Transform3D localToGlobalTransf(int doubletPhi, int gasGap) const;
        // global to local
    
        Amg::Vector3D globalToLocalCoords(const Amg::Vector3D& x, const Identifier& id) const;
        Amg::Transform3D globalToLocalTransf(const Identifier& id) const;
 
        Amg::Vector3D stripPos(const Identifier& id) const;
        Amg::Vector3D stripPos(int doubletPhi, int gasGap, bool measphi, int strip) const;

        Amg::Vector3D localStripPos(int doubletPhi, int gasGap, bool measphi, int strip) const;       
        Amg::Vector3D localStripPos(const Identifier& id) const;

        Amg::Vector3D localGasGapPos(const Identifier& id) const;
        Amg::Vector3D localGasGapPos(int doubletPhi, int gasGap) const;

        Amg::Vector3D gasGapPos(int doubletPhi, int gasGap) const;
        Amg::Vector3D gasGapPos(const Identifier& id) const;
 
        // Readout side infos
        // P is a point in the global reference frame
        // we want to have the distance from the side of the phi readout (length travelled along a phi strip) from a signal produced at P)
        double distanceToPhiReadout(const Amg::Vector3D& P) const;
        // P is a point in the global reference frame
        // we want to have the distance from the side of the eta readout (length travelled along a eta strip) from a signal produced at P)
        double distanceToEtaReadout(const Amg::Vector3D& P) const;
 
    
        inline bool isMirrored() const { return m_mirrored; }       
        inline bool isDescrAtNegZ() const { return m_descratzneg; }
    private: 
        double localStripSCoord(int doubletPhi, bool measphi, int strip) const;
        double localStripZCoord(bool measphi, int strip) const;
        const RpcIdHelper& m_idHelper{idHelperSvc()->rpcIdHelper()};
        bool m_mirrored{false};
        bool m_descratzneg{false};
        const MuonStripDesign* getDesign(const Identifier& id) const;
 
        int m_dbR{0};
        int m_dbZ{0};
        int m_dbPhi{0};
        bool m_hasDEDontop{false};
        int m_nlayers{2};  
        // default=2, all BI RPCs always have 3 gas gaps, need this flag since amdb only supports a maximum of 2 gas
        // gaps, so this is steering the hardcoded third gas gap for Run3/4 layouts based on amdb primary numbers
 
        bool m_inTheRibs{false};
 
        int m_nphigasgaps{-1};
 
        double m_gasgapssize{-9999.};
        double m_gasgapzsize{-9999.};
 
        int m_nphistrippanels{-1};
        int m_nphistripsperpanel{-1};
        int m_netastripsperpanel{-1};
        double m_phistripwidth{-9999.};
        double m_etastripwidth{-9999.};
        double m_phistrippitch{-9999.};
        double m_etastrippitch{-9999.};
        double m_phistriplength{-9999.};
        double m_etastriplength{-9999.};
        double m_phipaneldead{-9999.};
        double m_etapaneldead{-9999.};
        
        static constexpr int s_maxphipanels = 2;
        static constexpr int s_nLayers = 3;
        std::array<double, s_maxphipanels> m_first_phistrip_s{ make_array<double, s_maxphipanels>(-9999.)};
        std::array<double, s_maxphipanels> m_etastrip_s{make_array<double, s_maxphipanels>(-9999.)};
        std::array<double, s_nLayers>     m_gasGap_xPos{make_array<double,s_nLayers>(-9999.)};
        double m_phistrip_z{-9999.};
        double m_first_etastrip_z{-9999.};
 
        std::vector<MuonStripDesign> m_phiDesigns{};
        std::vector<MuonStripDesign> m_etaDesigns{};
 
        double m_y_translation{0.f};
        double m_z_translation{0.f};
    };
 
 
}  // namespace MuonGM
 
#include "MuonReadoutGeometry/RpcReadoutElement.icc"
 
#endif  // MUONREADOUTGEOMETRY_RPCREADOUTELEMENT_H