MuonChannelDesign.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2022 CERN for the benefit of the ATLAS collaboration
*/
 
/***************************************************************************
 properties of a plane based detector allowing for a stereo angle
 ----------------------------------------------------------------------
***************************************************************************/
 
#ifndef MUONREADOUTGEOMETRY_MUONCHANNELDESIGN_H
#define MUONREADOUTGEOMETRY_MUONCHANNELDESIGN_H
 
#include "AthenaKernel/getMessageSvc.h"
#include "GaudiKernel/MsgStream.h"
#include "GeoPrimitives/GeoPrimitives.h"
#include "EventPrimitives/EventPrimitives.h"
#include "MuonReadoutGeometry/GlobalUtilities.h"
#include "cmath"
namespace MuonGM {
 
    struct MuonChannelDesign {
    public:
        MuonChannelDesign();
        enum class ChannelType { etaStrip, phiStrip };
        enum class DetType { MM, STGC, Other };
        ChannelType type{ ChannelType::etaStrip };
        DetType  detType{ DetType::Other };
        int nch{-1};             // total #of active strips
        double inputPitch{0.};   // we use this param to define the pitch for MM
        double inputWidth{0.};
        double inputLength{0.};
        double firstPitch{0.};   // Pitch of 1st strip or number of wires in 1st group
        double groupWidth{0.};   // Number of Wires per group
        double nGroups{0.};      // Number of Wire groups
        double wireCutout{0.};
        double thickness{0.};    // gas thickness
        int nMissedTopEta{0};    // #of strips that are not connected to any FE boards (MM)
        int nMissedBottomEta{0};
        int nMissedTopStereo{0};
        int nMissedBottomStereo{0};
        int totalStrips{0};      // total strips per MM module
        bool isConvertedFromPhaseII{false};
        double distanceToReadout(const Amg::Vector2D& pos) const;

        double distanceToChannel(const Amg::Vector2D& pos, int nChannel) const;

        int channelNumber(const Amg::Vector2D& pos) const;

        int wireGroupNumber(const Amg::Vector2D& pos) const;

        int wireNumber(const Amg::Vector2D& pos) const;

        double channelWidth() const;
       
        void defineTrapezoid(double HalfShortY, double HalfLongY, double HalfHeight);
        void defineTrapezoid(double HalfShortY, double HalfLongY, double HalfHeight, double sAngle);
        void defineDiamond(double HalfShortY, double HalfLongY, double HalfHeight, double ycutout);
        
        double stereoAngle() const { return m_sAngle; }
 
        double yCutout() const { return m_yCutout; }

        double hasStereoAngle() const {return m_hasStereo;}

        double isDiamondShape() const {return m_isDiamond;}
        
        const AmgSymMatrix(2)& rotation() const { return m_rotMat; }

        double channelLength(int channel) const;
        
        double channelHalfLength(int st, bool left) const;

        double gasGapThickness() const { return thickness; }

        bool center(int channel, Amg::Vector2D& pos) const;
        bool leftEdge(int channel, Amg::Vector2D& pos) const;
        bool rightEdge(int channel, Amg::Vector2D& pos) const;
        int numberOfMissingTopStrips() const;
        int numberOfMissingBottomStrips() const;
 
        // radial distance (active area)
        double xSize() const;
        // top length (active area)
        double maxYSize() const;
        // bottom length (active area)
        double minYSize() const;
        
        double passivatedLength(double passivWidth, bool left)  const;
        double passivatedHeight(double passivHeight, bool edge) const;

        void setFirstPos(const double pos);

        double firstPos() const;

        int positionRelativeToStrip(const Amg::Vector2D& lpos, Amg::Vector2D& rel_pos) const;
 
    private:
        bool channelPosition(int channel, Amg::Vector2D& pos) const;
        // - For MM, it accounts for routed stereo strips by also checking the intersection with the trapezoid bases.
        // - For sTGC, it accounts for the rectangular region of QL3 returning -0.5*m_maxYSize for x > 0.
        // In case uncapped is set to true these special boundary tests are not applied,
        // and the intersection of the extended strip line with the side of the trapezoid is returned.
        bool leftInterSect(int channel, Amg::Vector2D& pos, bool uncapped = false) const;
        bool rightInterSect(int channel, Amg::Vector2D& pos, bool uncapped = false) const;
        bool geomCenter(int channel, Amg::Vector2D& pos) const;

        void setStereoAngle(double sAngle);
       
        bool m_hasStereo{false};
        bool m_isDiamond{false};
        double m_sAngle{0.};     // stereo angle
        double m_yCutout{0.};
        Amg::Vector2D m_stereoDir{0,1};        
        Amg::Vector2D m_stereoNormal{1.,0.};
        double m_firstPos{0.};
        Amg::Vector2D m_topEdge{Amg::Vector2D::Zero()};
        Amg::Vector2D m_bottomEdge{Amg::Vector2D::Zero()};
        Amg::Vector2D m_bottomLeft{Amg::Vector2D::Zero()};
        Amg::Vector2D m_bottomRight{Amg::Vector2D::Zero()};
        Amg::Vector2D m_topLeft{Amg::Vector2D::Zero()};
        Amg::Vector2D m_topRight{Amg::Vector2D::Zero()};
 
        AmgSymMatrix(2) m_rotMat{AmgSymMatrix(2)::Identity()};
 
        double m_maxHorSize{0.};   // Maximum length of the horizontal edges
        double m_xSize{0.};        // radial distance (active area)
        double m_minYSize{0.};     // bottom length (active area)
        double m_maxYSize{0.};     // top length (active area)
     
    };
 
    //============================================================================
    inline double MuonChannelDesign::distanceToChannel(const Amg::Vector2D& pos, int chNum) const {
        Amg::Vector2D cen{Amg::Vector2D::Zero()};
        if (!center(chNum, cen)) return std::numeric_limits<float>::max();
        
        return (pos - cen).x();
    }
    
 
    //============================================================================
    inline double MuonChannelDesign::distanceToReadout(const Amg::Vector2D& pos) const {
        throw std::runtime_error("MuonChannelDesign::distanceToReadout() - is not properly defined");
        return pos.dot(pos);
    }
 
 
 
    //============================================================================
    inline int MuonChannelDesign::channelNumber(const Amg::Vector2D& pos) const {
           
        int chNum{-1};
        if (type == ChannelType::etaStrip && detType == DetType::MM) {
            // ** MM strips: keeping cases outside the active area, but within the envelope, 
            // to avoid warnings from MuonPRDTest. Those channels are removed from digitization.
            const Amg::Vector2D posInEta = m_rotMat.inverse()*pos;
            const double xMid = (posInEta - firstPos()*Amg::Vector2D::UnitX()).dot(m_stereoNormal) / m_stereoNormal.x();
            const int missedBottom =  numberOfMissingBottomStrips();
 
            // first position is always 1/2 pitch above the center of the first active strip
            chNum = static_cast<int>(std::floor( xMid  / inputPitch)) + missedBottom + 2;
            if (chNum < 1 || chNum > totalStrips) chNum = -1;
 
        } else if (type == ChannelType::phiStrip && detType == DetType::STGC) {
 
            // ** sTGC wires: return the wire group
            chNum = wireGroupNumber(pos);
 
        } else {
 
            // ** All other cases
            chNum = (int)std::floor( (pos.x() - firstPos()) / inputPitch ) + 2;
            if (chNum < 1 || chNum > nch) chNum = -1;
        }
   
        return chNum;
    }
 
 
    //============================================================================
    inline int MuonChannelDesign::wireGroupNumber(const Amg::Vector2D& pos) const {
    
        // The wires in the 1st gas volume of QL1, QS1 can not be read for digits
        if (type != ChannelType::phiStrip || detType != DetType::STGC) return -1;
        
        // Get the wire number associated to the position
        int wire_number = wireNumber(pos);
        
        // Find the wire group associated to the wire number.
        // For wires, firstPitch is the number of wires in the 1st group.
        int grNumber{-1};
        if (wire_number <= firstPitch) {
            grNumber = 1;  
        } else {
            grNumber = (wire_number - 1 - firstPitch) / groupWidth + 2; // 20 wires per group,
            // Case a hit is positionned after the last wire but inside the gas volume.
            // Especially important for QL3. We still consider the digit active.
            if (grNumber > nGroups && pos.x() < 0.5 * m_maxYSize) grNumber = nGroups;
        }
 
        // If hit is in an inactive wire region of QL1/QS1, return 63 (invalid).
        // This allows better tracking of hits.
        if (wireCutout != 0. && pos.y() < 0.5 * m_xSize - wireCutout) return 63;
        if (grNumber < 1 || grNumber > nGroups) return -1;
        
        return grNumber;
    }
 
 
    //============================================================================
    inline int MuonChannelDesign::wireNumber(const Amg::Vector2D& pos) const {
    
        // Only determine wire number for sTGC wire surfaces
        int wire_number{-1};
        if (type == ChannelType::phiStrip && detType == DetType::STGC) {
            if ((pos.x() > -0.5 * m_maxYSize) && (pos.x() < firstPos())) { // before first wire
                wire_number = 1;
            } else {
                wire_number = (pos.x() - firstPos()) / inputPitch + 1;
                if (wire_number < 1 || wire_number > nch) {
                    MsgStream log(Athena::getMessageSvc(), "MuonChannelDesign");
                    if (log.level() <= MSG::DEBUG) {
                        log << MSG::DEBUG << "sTGC wire number out of range: wire number = " << wire_number << " local pos = (" << pos.x() << ", " << pos.y() << ")" << endmsg;
                    }
                }
            }
        }
 
        return wire_number;
    }
 
 
    //============================================================================
    inline int MuonChannelDesign::positionRelativeToStrip(const Amg::Vector2D& lpos, Amg::Vector2D& rel_pos) const {
 
        if (type != ChannelType::etaStrip) return -1;
 
        // if the lpos is out of bounds, express it w.r.t. the nearest active strip. 
        // it's not our job to boundary check. 
        int istrip = channelNumber(lpos);
        if (istrip < 0) return istrip;
        istrip = std::max (istrip, numberOfMissingBottomStrips() +   1);
        istrip = std::min (istrip, numberOfMissingBottomStrips() + nch);
 
        // get the intersection of the eta and stereo strips in the local reference frame
        Amg::Vector2D chan_pos{Amg::Vector2D::Zero()};
        channelPosition(istrip, chan_pos);
        chan_pos = rotation() * chan_pos;    
 
        // strip edge in the local reference frame (note that the uncapped option is set to true)
        Amg::Vector2D edge_pos{Amg::Vector2D::Zero()}; 
        (lpos.y() > 0) ? rightInterSect(istrip, edge_pos, true) : leftInterSect(istrip, edge_pos, true);
        edge_pos = rotation() * edge_pos;
 
        rel_pos[0] = (lpos - chan_pos).x() / channelWidth();
        rel_pos[1] = (lpos - chan_pos).y() / std::abs( edge_pos.y() - chan_pos.y() );
 
        return istrip;
    }
 
    
    //============================================================================
    inline bool MuonChannelDesign::channelPosition(int st, Amg::Vector2D& pos) const {
 
        if (type == ChannelType::phiStrip) {
 
            if (st < 1 || st > nch) return false;
 
            if (detType == DetType::STGC) {  
             
                if (st > nGroups || st == 63) return false; // 63 is defined as an unactive digit
 
                // calculate the end of the first wire group (accounts for staggering).
                // for wires, firstPitch is the number of wires in the first group
                double firstX = firstPos() + (firstPitch - 1) * inputPitch;  
                double locX{0.};
 
                if (st == 1) {               
                    // first group: average the starting and ending x of the group
                    locX = 0.5 * (-0.5 * m_maxYSize + firstX);
                } else if (st == nGroups)  { 
                    // last group: average the starting and ending x of the group
                    locX = 0.5 * (0.5 * m_maxYSize + firstX + (nGroups - 2) * groupWidth * inputPitch);
                } else {
                    // For the R3 geometry converted from Phase II, we are redefining the center of the wiregroup
                    // to be between the 10th and the 11th wire of the group, originally defined on the 10th wire.
                    // Hence, we are defining an offset, wireOffset to be used in the defining the local x of the wiregroup center.
                    double wireOffset{0.};
                    if (isConvertedFromPhaseII) {
                        wireOffset = 0.5 * inputPitch;
                    }
                    locX = firstX + wireOffset + groupWidth * inputPitch * (st - 1.5);
                }
 
                pos[0] = locX;
                pos[1] = 0.;
 
            }
 
        } else if (detType == DetType::MM) {
                
            const int nMissedBottom = numberOfMissingBottomStrips();
            if (st <= nMissedBottom || st > nMissedBottom + nch) return false;
            
            // firstPos is 1/2 pitch above the center of the first active strip.
            pos = (firstPos()  + inputPitch* (st - nMissedBottom - 1.5)) * Amg::Vector2D::UnitX();
        } else {

            if (st < 1 || st > nch) return false;
 
            double x = firstPos() + (st - 1.5)*inputPitch;
            if (detType == DetType::STGC) {
                if (firstPitch == inputPitch && st == nch) x -= inputWidth/4.; // case last strip is a half-strip
                if (firstPitch  < inputPitch && st ==   1) x += inputWidth/4.; // case first strip is a half-strip
            }
 
            pos[0] = x;
            pos[1] = 0;
        }
 
        return true;
    }
    
    //============================================================================
    inline double MuonChannelDesign::channelHalfLength(int st, bool left) const {
        Amg::Vector2D cen{Amg::Vector2D::Zero()}, side{Amg::Vector2D::Zero()};
        if (!geomCenter(st,cen) || (left&& !leftInterSect(st, side)) ||  (!left && !rightInterSect(st, side)))  return -0.5;
        if (type == ChannelType::etaStrip && detType == DetType::MM && (st < 1 || st > totalStrips)) return -0.5;           
        // default case:
        return (cen - side).mag();
    }
    
 
    //============================================================================
    inline double MuonChannelDesign::channelLength(int st) const {
        Amg::Vector2D left{Amg::Vector2D::Zero()}, right{Amg::Vector2D::Zero()};
        if(!leftInterSect(st,left)|| !rightInterSect(st, right)) return -0.5;
        return (left - right).mag();       
    }
 
 
    //============================================================================
    inline double MuonChannelDesign::channelWidth() const {
 
        if (detType == DetType::STGC) {
            // eta strips: return the pitch (3.2mm), not the width (2.7mm)
            // phi wires: return width of full wire group
            return (type == ChannelType::etaStrip) ? inputPitch : groupWidth * inputPitch;  
        }
 
        return inputWidth;
    }
    
    //============================================================================
    inline bool  MuonChannelDesign::geomCenter(int channel, Amg::Vector2D& pos) const {
        Amg::Vector2D l_pos{Amg::Vector2D::Zero()}, r_pos{Amg::Vector2D::Zero()};
        if (!leftInterSect(channel,l_pos) || !rightInterSect(channel,r_pos)) return false;
        pos = 0.5 * (l_pos + r_pos);
        return true;
    }
 
    //============================================================================
    inline bool MuonChannelDesign::leftInterSect(int channel, Amg::Vector2D& pos, bool uncapped /*= false*/) const {
        Amg::Vector2D chanPos{Amg::Vector2D::Zero()};
        if (!channelPosition(channel, chanPos)) return false;
       
        if (!uncapped && m_isDiamond && chanPos.x() > 0) {
           pos = Amg::Vector2D(chanPos.x(), -0.5*m_maxYSize);
           return true;
        }
       
        std::optional<double>  lambda = Amg::intersect<2>(chanPos, m_stereoDir, m_bottomLeft, m_bottomEdge);
        if (!lambda) return false;
        if (!uncapped && m_hasStereo && ( (*lambda) < 0. || (*lambda) > m_maxHorSize)) { 
            const Amg::Vector2D e_y{0., 1.};          
            const std::optional<double> bottom_line = Amg::intersect<2>(m_stereoDir.x() > 0.? m_bottomLeft:  m_bottomRight, e_y, chanPos, m_stereoDir);
            if (bottom_line)  {
                pos = chanPos + (*bottom_line)* m_stereoDir;
                return true;
            }
        }
        pos = (m_bottomLeft + (*lambda) * m_bottomEdge); 
        return true;
    }
 
    //============================================================================
    inline bool MuonChannelDesign::rightInterSect(int channel, Amg::Vector2D& pos, bool uncapped /*= false*/) const {
        Amg::Vector2D chanPos{Amg::Vector2D::Zero()};
        if (!channelPosition(channel, chanPos)) return false;
        
        if (!uncapped && m_isDiamond && chanPos.x() > 0) {
           pos = Amg::Vector2D(chanPos.x(), 0.5*m_maxYSize);
           return true;
        }       
       
        const std::optional<double> lambda =Amg::intersect<2>(chanPos, m_stereoDir, m_topRight, m_topEdge);
        if (!lambda) return false;
        if (!uncapped && m_hasStereo&& ( (*lambda) < 0  || (*lambda) > m_maxHorSize)) { 
            const Amg::Vector2D e_y{0., 1.};              
            const std::optional<double> top_line =Amg::intersect<2>(m_stereoDir.x() >  0. ? m_topRight: m_topLeft, e_y, chanPos, m_stereoDir);
            if (top_line) {
                pos = chanPos + (*top_line) * m_stereoDir;
                return true;
            }
       }
       pos = (m_topRight + (*lambda) * m_topEdge);
       return true; 
    }
    
    //============================================================================
    inline int MuonChannelDesign::numberOfMissingTopStrips() const{ return !m_hasStereo  ? nMissedTopEta : nMissedTopStereo; }        
    inline int MuonChannelDesign::numberOfMissingBottomStrips() const { return !m_hasStereo ? nMissedBottomEta : nMissedBottomStereo;}
    inline double MuonChannelDesign::xSize() const {return m_xSize;}
    inline double MuonChannelDesign::maxYSize() const {return m_maxYSize;}
    inline double MuonChannelDesign::minYSize() const {return m_minYSize;}
    inline double MuonChannelDesign::firstPos() const {return m_firstPos;}
 
    //============================================================================
    inline bool MuonChannelDesign::center(int channel, Amg::Vector2D& pos) const {
        if (!geomCenter(channel, pos)) return false;
        pos = m_rotMat * pos;
        return true;
    }
    
    //============================================================================
    inline bool MuonChannelDesign::leftEdge(int channel, Amg::Vector2D& pos) const {
        if (!leftInterSect(channel, pos)) return false;
        pos = m_rotMat * pos;
        return true;
    }
 
    //============================================================================
    inline bool MuonChannelDesign::rightEdge(int channel, Amg::Vector2D& pos) const {
        if (!rightInterSect(channel, pos)) return false;
        pos = m_rotMat * pos;
        return true;
    }
    
    
    //============================================================================
    // The passivated length 
    inline double MuonChannelDesign::passivatedLength(double passivWidth, bool left)  const{
        const Amg::Vector2D& edge = (left ? m_bottomEdge : m_topEdge);
        return passivWidth * std::abs(m_stereoDir.x() *edge.y() - m_stereoDir.y()* edge.x());
    }
    
    //============================================================================
    inline double MuonChannelDesign::passivatedHeight(double passivHeight, bool edge_pcb) const{
        return passivHeight*std::abs(edge_pcb? m_stereoDir.x() : 1.);
    }
 
}  // namespace MuonGM
#endif  // MUONREADOUTGEOMETRY_MUONCHANNELDESIGN_H