SCT_ModuleSideDesign.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/

// SCT_ModuleSideDesign.h
// (c) ATLAS Detector software
 
 
#ifndef INDETREADOUTGEOMETRY_SCT_MODULESIDEDESIGN_H
#define INDETREADOUTGEOMETRY_SCT_MODULESIDEDESIGN_H
 
// Base class
#include "InDetReadoutGeometry/SiDetectorDesign.h"
 
// Data member class
#include "SCT_ReadoutGeometry/SCT_ReadoutScheme.h"
 
// Other includes
#include "ReadoutGeometryBase/InDetDD_Defs.h" //InDetDD::CarrierType enum
#include <vector>
#include <utility> //std::pair
#include <map> //data member
 
namespace InDetDD{
  class SiCellId;
}
 
namespace InDetDD {
 
class SCT_ModuleSideDesign: public SiDetectorDesign {
public:
    SCT_ModuleSideDesign(const double thickness,
                         const bool phiSymmetric,
                         const bool etaSymmetric,
                         const bool depthSymmetric,
                         const int crystals,
                         const int diodes,
                         const int cells,
                         const int shift,
                         const bool swapStripReadout,
                         InDetDD::CarrierType carrierType,
                         int readoutSide);

    SCT_ModuleSideDesign(const double thickness,
                         const bool phiSymmetric,
                         const bool etaSymmetric,
                         const bool depthSymmetric,
                         const int crystals,
                         const int diodes,
                         const int cells,
                         const int shift,
                         const bool swapStripReadout,
                         InDetDD::CarrierType carrierType,
                         int readoutSide,
                         const SiDetectorDesign::Axis stripDirection,
                         const SiDetectorDesign::Axis thicknessDirection);
 

    virtual ~SCT_ModuleSideDesign() = default;

    virtual int numberOfConnectedCells(const SiReadoutCellId &readoutId) const override;
    virtual SiCellId connectedCell(const SiReadoutCellId &readoutId, int number) const override;

    virtual SiCellId gangedCell(const SiCellId &cellId) const override;

    virtual SiReadoutCellId readoutIdOfCell(const SiCellId &cellId) const override;

    virtual SiReadoutCellId readoutIdOfPosition(const SiLocalPosition &localPos) const override;

    virtual SiLocalPosition localPositionOfCell(const SiCellId &cellId) const override = 0;
    virtual SiLocalPosition localPositionOfCluster(const SiCellId &cellId,
                                                   int cluserSize) const = 0;

    virtual SiCellId cellIdInRange(const SiCellId &cellId) const override;

    virtual void neighboursOfCell(const SiCellId &cellId,
                                  std::vector<SiCellId> &neighbours) const override;

    virtual bool inActiveArea(const SiLocalPosition &chargePos, bool checkBondGap =
                                  true) const = 0;

    virtual double scaledDistanceToNearestDiode(const SiLocalPosition &chargePos) const =
        0;

    virtual double stripPitch(const SiLocalPosition &chargePos) const = 0;

    virtual double stripPitch() const = 0;

    virtual std::pair<SiLocalPosition, SiLocalPosition>
    endsOfStrip(const SiLocalPosition &position) const override = 0;

    virtual SiLocalPosition positionFromStrip(const int stripNumber) const;

    virtual double deadAreaLength() const = 0;

    virtual double deadAreaUpperBoundary() const = 0;

    virtual double deadAreaLowerBoundary() const = 0;

    int crystals() const;

    int diodes() const;
    virtual int diodesInRow(const int row) const; // Introduced for upgrade sensors which have several rows

    int cells() const;

    int shift() const;

    virtual bool swapHitPhiReadoutDirection() const override;
    virtual bool swapHitEtaReadoutDirection() const override;
 
    virtual int row(int stripId1Dim) const;    // For SCT, is 0; otherwise takes a 1-dim strip ID and returns its row
    virtual int strip(int stripId1Dim) const;  // For SCT, returns stripId1Dim; otherwise returns strip within row.
    virtual int strip1Dim(int strip, int row) const override;   // For SCT, returns strip. Else inverse of above two.
 
    void setMother(SCT_ModuleSideDesign* mother);
    const SCT_ModuleSideDesign * getMother() const;
    const std::map<int, const SCT_ModuleSideDesign *>& getChildren() const;
    void addChildDesign(int index, const SCT_ModuleSideDesign * element);
    virtual std::pair<int,int> getStripRow(SiCellId id) const;
    virtual SiIntersect inDetector(const SiLocalPosition &localPosition, double phiTol, double etaTol) const override;
 
private:
    SCT_ModuleSideDesign();
 
    // Copy constructor:
    SCT_ModuleSideDesign(const SCT_ModuleSideDesign &design);
 
    // Assignment operator:
    SCT_ModuleSideDesign &operator = (const SCT_ModuleSideDesign &design);
 
protected:
    SCT_ReadoutScheme m_scheme; // !< connection between diodes and readout cells
    InDetDD::DetectorType m_detectorType{Undefined};
 

    // Private data:
private:
    bool m_swapStripReadout;    // !< Flag to indicate if readout direction is opposite
                                // !< to hit local phi direction
    
    //container design for split sensors - owned by DetectorManager
    const SCT_ModuleSideDesign * m_motherDesign{nullptr};
    //if this design *is* a mother design, these are its children
    std::map<int, const SCT_ModuleSideDesign *>  m_childDesigns;
};

// Inline methods:
inline int SCT_ModuleSideDesign::crystals() const {
    return m_scheme.crystals();
}
 
inline int SCT_ModuleSideDesign::diodes() const {
    return m_scheme.diodes();
}
 
inline int SCT_ModuleSideDesign::diodesInRow(const int /* row */) const {
    return m_scheme.diodes();
}
 
inline int SCT_ModuleSideDesign::cells() const {
    return m_scheme.cells();
}
 
inline int SCT_ModuleSideDesign::shift() const {
    return m_scheme.shift();
}
 
inline int SCT_ModuleSideDesign::numberOfConnectedCells(const SiReadoutCellId &readoutId)
const {
    return m_scheme.numberOfConnectedCells(readoutId);
}
 
inline SiCellId SCT_ModuleSideDesign::connectedCell(const SiReadoutCellId &readoutId,
                                                    int number) const {
    return m_scheme.connectedCell(readoutId, number);
}
 
inline SiCellId SCT_ModuleSideDesign::gangedCell(const SiCellId &) const {
    // No ganged cells in SCT so always return invalid id.
    return SiCellId();
}
 
inline SiReadoutCellId SCT_ModuleSideDesign::readoutIdOfCell(const SiCellId &cellId) const
{
    return m_scheme.readoutIdOfCell(cellId);
}
 
inline SiReadoutCellId SCT_ModuleSideDesign::readoutIdOfPosition(
    const SiLocalPosition &localPos) const {
    // Get the cellId then convert it to a readoutId.
    // NEED to think about active area and bond gap check
    return readoutIdOfCell(cellIdOfPosition(localPos));
}
 
inline bool SCT_ModuleSideDesign::swapHitPhiReadoutDirection() const {
    return m_swapStripReadout;
}
 
inline bool SCT_ModuleSideDesign::swapHitEtaReadoutDirection() const {
    return false;
}
 
inline int SCT_ModuleSideDesign::row(int /*stripId1Dim not used */) const {
    return -1; // Use -1 to realise this is an SCT module without rows
}
 
inline int SCT_ModuleSideDesign::strip(int stripId1Dim) const {
    return stripId1Dim;
}
 
inline int SCT_ModuleSideDesign::strip1Dim(int strip, int /*row not used */) const {
    return strip;
}
 
 inline const SCT_ModuleSideDesign * SCT_ModuleSideDesign::getMother() const {
   return m_motherDesign;
 }
 
 inline const std::map<int, const SCT_ModuleSideDesign *>& SCT_ModuleSideDesign::getChildren() const {
   return m_childDesigns;
 }
 
 
 inline void SCT_ModuleSideDesign::addChildDesign(int index, const SCT_ModuleSideDesign * child) {
   m_childDesigns.emplace(index,child);
 }
 
} // namespace InDetDD
#endif // INDETREADOUTGEOMETRY_SCT_MODULESIDEDESIGN_H