CscReadoutElement.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2023 CERN for the benefit of the ATLAS collaboration
*/
 
/***************************************************************************
 Csc Readout Element properties
 -----------------------------------------
***************************************************************************/
 
#ifndef MUONREADOUTGEOMETRY_CSCREADOUTELEMENT_H
#define MUONREADOUTGEOMETRY_CSCREADOUTELEMENT_H
 
#include "MuonIdHelpers/CscIdHelper.h"
#include "MuonReadoutGeometry/MuonClusterReadoutElement.h"
#include "MuonReadoutGeometry/MuonDetectorManager.h"
#include "CxxUtils/ArrayHelper.h"
 
namespace Muon {
    class CscAlignModule;
    class CombinedMuonAlignModule;
}  // namespace Muon
 
class CscInternalAlignmentPar;
class GeoVFullPhysVol;
 
namespace MuonGM {
 
    //<<<<<< PUBLIC DEFINES >>>>>>
    constexpr int maxwlay = 4;
 
    /*
      A CscReadoutElement corresponds to a single CSC chamber; therefore typically
      (in the final MS layout, i.e. if no detector stagein is considered) a CSC
      station contains 2 CscReadoutElements.
      CscReadoutElements are identified by StationName, StationEta, StationPhi,
      Technology=1 and ChamberLayer. Therefore the granularity of the data
      collections is not equal to the granularity of the geometry description
      (1 collection -> 2 CscReadoutElement [for final layout]; ->1 CscReadoutElement
      in the initial layout).
 
      Pointers to all CscReadoutElements are created in the build() method of the
      MuonChamber class, and are held in arrays by the MuonDetectorManager, which
      is responsible for storing, deleting and provide access to these objects.
 
      A CscReadoutElement holds properties related to its internal structure
      (i.e. number of strip panels) and general geometrical properties (size);
      it implements tracking interfaces and provides access to typical
      readout-geometry information: i.e. number of strips, strip  positions, etc.
 
      The globalToLocalCoords and globalToLocalTransform methods (+ their opposite)
      define the link between the ATLAS global reference frame and the internal
      (geo-model defined) local reference frame of any gas gap volume (which is the
      frame where local coordinates of SimHits, in output from G4, are expressed).
    */
 
    class CscReadoutElement : public MuonClusterReadoutElement {
        friend class Muon::CscAlignModule;
        friend class Muon::CombinedMuonAlignModule;
        friend class MuonChamber;
    friend class MuonChamberLite;
 
    public:
        CscReadoutElement(GeoVFullPhysVol* pv, const std::string& stName, MuonDetectorManager* mgr);
 
        virtual ~CscReadoutElement();

        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 layerHash(const Identifier& id) const override final;

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

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

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

        virtual int numberOfLayers(bool) const override final;

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

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

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

        void spacePointPosition(const Amg::Vector2D& phiPos, const Amg::Vector2D& etaPos, Amg::Vector2D& pos) const;
 
        // Id set/get methods
        int ChamberLayer() const;
        void setChamberLayer(int cl);
 
        int Ngasgaps() const;
        int NphiStripLayers() const;
        int NetaStripLayers() const;
        int NphiStrips(int gasgaplayer) const;
        int NetaStrips(int gasgaplayer) const;
        // in the following methods the chlayer argument is irrelevant
        // the first 3 will disappear
        double StripWidth(int chlayer, int measphi) const;
        double StripPitch(int chlayer, int measphi) const;
        double cathodeReadoutPitch(int chLayer, int measuresPhi) const;
        double StripWidth(int measphi) const;
        double StripPitch(int measphi) const;
        double cathodeReadoutPitch(int measuresPhi) const;
 
        double shortWidth() const;
        double length() const;
        double longWidth() const;
        int maxNumberOfStrips(int measuresPhi) const;
        int maxNumberOfStrips(int measuresPhi, double width) const;
        double activeWidth(int measuresPhi) const;
        double z0() const;
        inline double roxacellWidth() const;
        inline double lengthUpToMaxWidth() const;
        inline double excent() const;
 
        Amg::Vector3D stripLayerPos(const Identifier& id) const;
        Amg::Vector3D stripLayerPos(const IdentifierHash& id) const;
        Amg::Vector3D stripLayerPos(int chamberLayer, int wireLayer, int measPhi, int channel) const;
        Amg::Vector3D localStripLayerPos(const Identifier& id) const;
        Amg::Vector3D localStripLayerPos(const IdentifierHash& id) const;
        Amg::Vector3D localStripLayerPos(int chamberLayer, int wireLayer, int measPhi, int channel) const;
        //
        Amg::Vector3D localWireLayerPos(const Identifier& id) const;
        Amg::Vector3D localWireLayerPos(int gg) const;
        Amg::Vector3D wireLayerPos(const Identifier& id) const;
        Amg::Vector3D wireLayerPos(int gg) const;
 
        //
        Amg::Vector3D nominalStripPos(const Identifier& id) const;
        Amg::Vector3D nominalStripPos(int eta, int chamberLayer, int wireLayer, int measPhi, int channel) const;
        Amg::Vector3D stripPos(const Identifier& id) const;
        Amg::Vector3D stripPos(int eta, int chamberLayer, int wireLayer, int measPhi, int channel) const;
        Amg::Vector3D nominalGlobalPos(const Amg::Vector3D& localP) const;
        Amg::Vector3D globalPos(const Amg::Vector3D& localP) const;
        Amg::Vector3D localPos(const Amg::Vector3D& globalP) const;
        Amg::Vector3D nominalLocalStripPos(const Identifier& id) const;
 
        Amg::Vector3D nominalLocalStripPos(int eta, int chamberLayer, int wireLayer, int measPhi, int channel) const;
        Amg::Vector3D nominalLocalClusterPos(int eta, int wireLayer, int measPhi, double x0) const;
        Amg::Vector3D localStripPos(const Identifier& id) const;
        Amg::Vector3D localStripPos(int eta, int chamberLayer, int wireLayer, int measPhi, int channel) const;
        Amg::Vector3D localClusterPos(int eta, int wireLayer, int measPhi, double x0) const;
        Amg::Vector3D stripPosOnTrackingSurface(const Identifier& id) const;
        Amg::Vector3D stripPosOnTrackingSurface(int eta, int chamberLayer, int wireLayer, int measPhi, int channel) const;
        Amg::Transform3D nominalTransform(const Identifier& id) const;
        Amg::Transform3D nominalTransform(int gasGap, int measPhi) const;
        Amg::Vector3D nominalCenter(int gasGap) const;
        Amg::Vector3D originForInternalALines(int gasGap) const;
 
        double stripLength(int chamberLayer, int measuresPhi, int stripNumber, double& epsilon) const;
        double stripLength(const Identifier& id) const;
        double lengthCorrection(int measuresPhi, double stripPos) const;
 
        double anodeCathodeDistance() const;

        // local to global and viceversa
        Amg::Vector3D localToGlobalCoords(const Amg::Vector3D& x, const Identifier& id) const;
        //**< localToGlobalCoords and Transf relates gas-gap frame (SensitiveDetectors) to the Global Frame  */
        Amg::Transform3D localToGlobalTransf(const Identifier& id) const;
        //**< localToGlobalCoords and Transf relates gas-gap frame (SensitiveDetectors) to the Global Frame  */
        Amg::Transform3D localToGlobalTransf(int gasGap) const;
        //**< localToGlobalCoords and Transf relates gas-gap frame (SensitiveDetectors) to the Global Frame  */
 
        // global to local
        Amg::Vector3D globalToLocalCoords(const Amg::Vector3D& x, const Identifier& id) const;
        //**< localToGlobalCoords and Transf relates gas-gap frame (SensitiveDetectors) to the Global Frame  */
        Amg::Transform3D globalToLocalTransf(const Identifier& id) const;
        //**< localToGlobalCoords and Transf relates gas-gap frame (SensitiveDetectors) to the Global Frame  */
 
        
        void set_ngasgaps(int);
        void set_nstriplayers(int);
        void set_nwirelayers(int);
        void set_nstripsperlayer(int);
        void set_nwiresperlayer(int);
        void set_stripwidth(double);
        void set_strippitch(double);
        void set_wirepitch(double);
        void set_first_strip_localcoo(double);
        void set_first_wire_localcoo(double);
        void setCscInternalAlignmentPar(const ALinePar&);
 
        double getGasGapIntAlign_s(int gasGap) const;
        double getGasGapIntAlign_z(int gasGap) const;
        double getGasGapIntAlign_t(int gasGap) const;
        double getGasGapIntAlign_rots(int gasGap) const;
        double getGasGapIntAlign_rotz(int gasGap) const;
        double getGasGapIntAlign_rott(int gasGap) const;
 
        virtual bool containsId(const Identifier& id) const override;
 
        // compute sin(stereo angle) at a given position:
        double sinStereo(const Identifier& stripId) const;
 
        virtual void fillCache() override;
        double xCoordinateInTrackingFrame(const Identifier& id) const;
 
    private:
        void doTests();
 
    private:
        double m_excent{-9999.};
        double m_roxacellwidth{-9999.};
        double m_RlengthUpToMaxWidth{-9999.};
        double m_anodecathode_distance{-9999.};
        int m_chamberlayer{-1};
        int m_ngasgaps{-1};
        int m_nstriplayers{-1};
        int m_nwirelayers{-1};
        int m_nPhistripsperlayer{-1};
        int m_nEtastripsperlayer{-1};
        int m_nwiresperlayer{-1};
        double m_Phistripwidth{-9999.};
        double m_Phistrippitch{-9999.};
        double m_Etastripwidth{-9999.};
        double m_Etastrippitch{-9999.};
        double m_wirepitch{-9999.};
        double m_first_strip_localcoo{-9999.};
        double m_first_wire_localcoo{-9999.};
        std::array<double, maxwlay> m_wireplanez{make_array<double, maxwlay>(-9999.)};
 
        // internal alignment
        double m_cscIntTransl[4][3]{};  // first index is wireLayer, second = 0,1,2 for    s,z,t
        double m_cscIntRot[4][3]{};     // first index is wireLayer, second = 0,1,2 for rots,z,t
    };
 
    inline int CscReadoutElement::ChamberLayer() const { return m_chamberlayer; }
 
    inline void CscReadoutElement::setChamberLayer(int cl) { m_chamberlayer = cl; }
 
    inline double CscReadoutElement::shortWidth() const { return getSsize(); }
 
    inline double CscReadoutElement::length() const { return getRsize(); }
 
    inline double CscReadoutElement::longWidth() const { return getLongSsize(); }
 
    inline double CscReadoutElement::roxacellWidth() const { return m_roxacellwidth; }
 
    inline double CscReadoutElement::lengthUpToMaxWidth() const { return m_RlengthUpToMaxWidth; }
 
    inline double CscReadoutElement::excent() const { return m_excent; }
 
    inline double CscReadoutElement::anodeCathodeDistance() const { return m_anodecathode_distance; }
 
    inline int CscReadoutElement::Ngasgaps() const { return m_ngasgaps; }
 
    inline int CscReadoutElement::NphiStripLayers() const { return m_ngasgaps; }
 
    inline int CscReadoutElement::NetaStripLayers() const { return m_ngasgaps; }
 
    inline int CscReadoutElement::NphiStrips(int) const { return m_nPhistripsperlayer; }
 
    inline int CscReadoutElement::NetaStrips(int) const { return m_nEtastripsperlayer; }
 
    inline int CscReadoutElement::layerHash(const Identifier& id) const { return manager()->cscIdHelper()->wireLayer(id) - 1; }
 
    inline int CscReadoutElement::surfaceHash(const Identifier& id) const {
        return 2 * (manager()->cscIdHelper()->wireLayer(id) - 1) + (manager()->cscIdHelper()->measuresPhi(id) ? 0 : 1);
    }
 
    inline int CscReadoutElement::boundaryHash(const Identifier& id) const { return (measuresPhi(id) ? 0 : 1); }
 
    inline bool CscReadoutElement::measuresPhi(const Identifier& id) const { return manager()->cscIdHelper()->measuresPhi(id); }
 
    inline int CscReadoutElement::numberOfLayers(bool) const { return Ngasgaps(); }
    inline int CscReadoutElement::numberOfStrips(const Identifier&) const { return NphiStrips(1); }
    inline int CscReadoutElement::numberOfStrips(int, bool) const { return NphiStrips(1); }
 
    inline bool CscReadoutElement::spacePointPosition(const Identifier& phiId, const Identifier& etaId, Amg::Vector3D& pos) const {
        Amg::Vector2D lpos;
        spacePointPosition(phiId, etaId, lpos);
        surface(phiId).localToGlobal(lpos, pos, pos);
        return true;
    }
 
    inline void CscReadoutElement::spacePointPosition(const Amg::Vector2D& phiPos, const Amg::Vector2D& etaPos, Amg::Vector2D& pos) const {
        pos[0] = phiPos.x();
        pos[1] = etaPos.x();
    }
 
}  // namespace MuonGM
 
#endif  // MUONREADOUTGEOMETRY_CSCREADOUTELEMENT_H