MuonPhaseII/MuonDetDescr/MuonReadoutGeometryR4/MuonReadoutGeometryR4/sTgcReadoutElement.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
#ifndef MUONREADOUTGEOMETRYR4_STGCREADOUTELEMENT_H
#define MUONREADOUTGEOMETRYR4_STGCREADOUTELEMENT_H
 
#include <MuonReadoutGeometryR4/MuonReadoutElement.h>
#include <MuonReadoutGeometryR4/StripDesign.h>
#include <MuonReadoutGeometryR4/WireGroupDesign.h>
#include <MuonReadoutGeometryR4/PadDesign.h>
#include <MuonReadoutGeometryR4/StripLayer.h>
#include <bit>
 
#ifndef SIMULATIONBASE
#   include "Acts/Utilities/BoundFactory.hpp"
#endif
 
namespace MuonGMR4 {
 
class sTgcReadoutElement : public MuonReadoutElement {
 
   public:
    
     enum ReadoutChannelType  {
        Pad = sTgcIdHelper::sTgcChannelTypes::Pad,
        Strip = sTgcIdHelper::sTgcChannelTypes::Strip,
        Wire  = sTgcIdHelper::sTgcChannelTypes::Wire,
        WireInGrp,
 
    };

    struct parameterBook {
        
        double halfChamberHeight{0.}; //Length
        double sHalfChamberLength{0.}; //sWidth
        double lHalfChamberLength{0.}; //lWidth
        double halfChamberTck{0.}; //Tck
        double sFrameWidth{0.};
        double lFrameWidth{0.};
        double gasTck{0.};
        unsigned int numLayers{0};
        unsigned int nChTypes{0};
        double yCutout{0.};
        std::vector<double> firstStripPitch{};
 
        std::vector<StripLayer> stripLayers{};
        std::vector<StripLayer> wireGroupLayers{};
        std::vector<StripLayer> padLayers{};
 
        StripDesignPtr stripDesign{nullptr};
        WireDesignPtr wireGroupDesign{nullptr};
        PadDesignPtr padDesign{nullptr};
 
#ifndef SIMULATIONBASE
        std::shared_ptr<Acts::SurfaceBoundFactory> layerBounds{};
#endif
 
    };
 
    struct defineArgs : public MuonReadoutElement::defineArgs,
                        public parameterBook {};
 
    sTgcReadoutElement(defineArgs&& args);
    virtual ~sTgcReadoutElement();
 
    const parameterBook& getParameters() const;
    ActsTrk::DetectorType detectorType() const override final {
        return ActsTrk::DetectorType::sTgc;
    }
 
    StatusCode initElement() override final;

    double chamberHeight() const; //Length
    double sChamberLength() const; //sWidth
    double lChamberLength() const; //lWidth
    double gasGapPitch() const;

    double thickness() const override final; //chamberTck
    double sFrameWidth() const;
    double lFrameWidth() const;
    int multilayer() const;
    unsigned int numLayers() const;
    double gasGapThickness() const;

    double firstStripPitch(const Identifier& measId) const;
    double firstStripPitch(const IdentifierHash& measHash) const;
        
    
    unsigned int numChannels(const Identifier& measId) const;
    unsigned int numChannels(const IdentifierHash& measHash) const;

    double stripLength(const Identifier& measId) const;
    double stripLength(const IdentifierHash& measHash) const;
    unsigned int nChTypes() const;

    unsigned int numPadEta(const Identifier& measId) const;
    unsigned int numPadEta(const IdentifierHash& measHash) const;
    unsigned int numPadPhi(const Identifier& measId) const;
    unsigned int numPadPhi(const IdentifierHash& measHash) const;
    double padHeight(const Identifier& measId) const;
    double padHeight(const IdentifierHash& measHash) const;   
    double padPhiShift(const Identifier& measId) const;
    double padPhiShift(const IdentifierHash& measHash) const; 
    double anglePadPhi(const Identifier& measId) const;
    double anglePadPhi(const IdentifierHash& measHash) const; 
    unsigned int maxPadEta(const Identifier& measId) const;
    unsigned int maxPadEta(const IdentifierHash& measHash) const; 
    unsigned int padNumberSeq(const Identifier& measId) const;
    unsigned int padNumberSeq(const IdentifierHash& measHash) const;
    std::pair<uint, uint> padEtaPhi(const Identifier& measId) const;
    std::pair<uint, uint> padEtaPhi(const IdentifierHash& measHash) const;   
    unsigned int padEta(const Identifier& measId) const;
    unsigned int padEta(const IdentifierHash& measHash) const;
    unsigned int padPhi(const Identifier& measId) const;
    unsigned int padPhi(const IdentifierHash& measHash) const;
    double beamlineRadius(const Identifier& measId) const;
    double beamlineRadius(const IdentifierHash& measHash) const;
    using localCornerArray = std::array<Amg::Vector2D, 4>;
    localCornerArray localPadCorners(const Identifier& measId) const;
    localCornerArray localPadCorners(const IdentifierHash& measHash) const;
    using globalCornerArray = std::array<Amg::Vector3D, 4>;
    globalCornerArray globalPadCorners(const ActsTrk::GeometryContext& ctx, const Identifier& measId) const;
    globalCornerArray globalPadCorners(const ActsTrk::GeometryContext& ctx, const IdentifierHash& measHash) const;  
    int padNumber(const Amg::Vector2D& hitPos, const Identifier& measId) const;
    int padNumber(const Amg::Vector2D& hitPos, const IdentifierHash& measHash) const;
       
    const StripDesign& stripDesign(const Identifier& measId) const;
    const StripDesign& stripDesign(const IdentifierHash& measHash) const;

    const WireGroupDesign& wireDesign(const Identifier& measId) const;
    const WireGroupDesign& wireDesign(const IdentifierHash& measHash) const;
    const PadDesign& padDesign(const Identifier& measId) const;
    const PadDesign& padDesign(const IdentifierHash& measHash) const;

    Amg::Vector3D globalChannelPosition(const ActsTrk::GeometryContext& ctx, const Identifier& measId) const;
    Amg::Vector3D globalChannelPosition(const ActsTrk::GeometryContext& ctx, const IdentifierHash& measHash) const;
    Amg::Vector2D localChannelPosition(const Identifier& measId) const;
    Amg::Vector2D localChannelPosition(const IdentifierHash& measHash) const;
 
    // Returns the global left/right edge position of strip or wire
    Amg::Vector3D leftStripEdge(const ActsTrk::GeometryContext& ctx, const IdentifierHash& measHash) const;
    Amg::Vector3D rightStripEdge(const ActsTrk::GeometryContext& ctx, const IdentifierHash& measHash) const;

    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;
 
    const StripLayer& stripLayer(const Identifier& measId) const;
    const StripLayer& stripLayer(const IdentifierHash& measId) const;
    
    
    static IdentifierHash createHash(const unsigned int gasGap, 
                                     const unsigned int channelType, 
                                     const unsigned int channel,
                                     const unsigned int wireInGrp = 0);
    friend class ActsTrk::TransformCacheDetEle<sTgcReadoutElement>;
 
    bool isEtaZero(const IdentifierHash& measurementHash, const Amg::Vector2D& localPosition) const;
 
   private:
        static unsigned int channelNumber(const IdentifierHash& measHash);
        static unsigned int chType(const IdentifierHash& measHash);
        static unsigned int gasGapNumber(const IdentifierHash& measHash);
        Amg::Transform3D fromGapToChamOrigin(const IdentifierHash& layerHash) const;
        Amg::Vector3D chamberStripPos(const IdentifierHash& measHash) const;
 
        parameterBook m_pars{};
        const sTgcIdHelper& m_idHelper{idHelperSvc()->stgcIdHelper()};
        const int m_multiLayer{m_idHelper.multilayer(identify())};
        double m_gasGapPitch{-1.};

        const unsigned int m_hashShiftChType = 2*std::popcount(static_cast<unsigned int>(numLayers()));
};
 
std::ostream& operator<<(std::ostream& ostr, const MuonGMR4::sTgcReadoutElement::parameterBook& pars);
}  // namespace MuonGMR4
 
namespace ActsTrk{
    template <> Amg::Transform3D 
        TransformCacheDetEle<MuonGMR4::sTgcReadoutElement>::fetchTransform(const DetectorAlignStore* store) const;
    template <> Identifier
        TransformCacheDetEle<MuonGMR4::sTgcReadoutElement>::identify() const;
}
 
#include <MuonReadoutGeometryR4/sTgcReadoutElement.icc>
#endif