DetectorDesign.h

Go to the documentation of this file.

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

// DetectorDesign.h
// (c) ATLAS Detector software
 
#ifndef READOUTGEOMETRYBASE_DETECTORDESIGN_H
#define READOUTGEOMETRYBASE_DETECTORDESIGN_H
 
// base class
#include "GeoPrimitives/GeoPrimitives.h"
#include "GeoModelKernel/RCBase.h"
 
#include "ReadoutGeometryBase/SiDiodesParameters.h"
#include "ReadoutGeometryBase/InDetDD_Defs.h"
#include "CLHEP/Geometry/Point3D.h"
#include "CLHEP/Geometry/Vector3D.h"
#include "CLHEP/Geometry/Transform3D.h"
#include "AtlasDetDescr/AtlasDetectorID.h"
 
#include <list>
#include <vector>
 
namespace Trk {
class SurfaceBounds;
}
 
namespace InDetDD {
class SiReadoutCellId;
class SiCellId;
class SiDiode;
class SiReadoutCell;
class SiLocalPosition;
class SiIntersect;
 
enum DetectorShape {
  Box=0, Trapezoid, Annulus,Other,PolarAnnulus
};
 
enum DetectorType {
    Undefined=0,PixelBarrel,PixelEndcap,PixelInclined,StripBarrel,StripEndcap,BCMPrime,PLR,HGTD
};

 
class DetectorDesign: public RCBase {
public:
    enum Axis {
        xAxis=0, yAxis, zAxis
    };

    // Public methods:
public:
    DetectorDesign(double thickness,
                   bool phiSymmetric,
                   bool etaSymmetric,
                   bool depthSymmetric,
                   InDetDD::CarrierType carrierType,
                   int readoutSide);
 
    DetectorDesign(double thickness,
                   bool phiSymmetric,
                   bool etaSymmetric,
                   bool depthSymmetric,
                   InDetDD::CarrierType carrierType,
                   int readoutSide,
                   Axis stripDirection,
                   Axis depthDirection);
 
    // Destructor
    ~DetectorDesign();

    // Const methods:

    //virtual HepGeom::Point3D<double> sensorCenter() const;
    virtual Amg::Vector3D sensorCenter() const;

    virtual SiIntersect inDetector(const SiLocalPosition &localPosition, double phiTol,
                        double etaTol) const;

    void setSymmetry(bool phiSymmetric, bool etaSymmetric, bool depthSymmetric);

    Axis etaAxis() const;

    Axis phiAxis() const;

    Axis depthAxis() const;

    double thickness() const;

    InDetDD::CarrierType carrierType() const;
 
    bool phiSymmetric() const;
    bool etaSymmetric() const;
    bool depthSymmetric() const;

    int readoutSide() const;

    // Pure virtual methods:

    virtual void distanceToDetectorEdge(const SiLocalPosition &localPosition,
                                        double &etaDist, double &phiDist) const = 0;

    virtual DetectorShape shape() const;

    virtual DetectorType type() const;

    virtual double length() const = 0;

    virtual double width() const = 0;

    virtual double minWidth() const = 0;

    virtual double maxWidth() const = 0;

    virtual double phiPitch() const = 0;

    virtual double phiPitch(const SiLocalPosition &localPosition) const = 0;
 
    // ** Pitch in eta direction */
    virtual double etaPitch() const = 0;

    virtual bool swapHitPhiReadoutDirection() const = 0;
    virtual bool swapHitEtaReadoutDirection() const = 0;

    virtual const Trk::SurfaceBounds &bounds() const = 0;
 
    //Transform for "split" modules
    virtual const Amg::Transform3D moduleShift() const;

    //
    // The following will replace existing methods but are not all implemented yet
    //

    virtual SiDiodesParameters parameters(const SiCellId &cellId) const = 0;

    virtual SiLocalPosition localPositionOfCell(const SiCellId &cellId) const = 0;

    virtual int numberOfConnectedCells(const SiReadoutCellId &readoutId) const = 0;

    virtual SiCellId connectedCell(const SiReadoutCellId &readoutId,
                                   int number) const = 0;

    virtual SiReadoutCellId readoutIdOfCell(const SiCellId &cellId) const = 0;

    virtual SiReadoutCellId readoutIdOfPosition(const SiLocalPosition &localPos) const = 0;

    virtual SiCellId cellIdOfPosition(const SiLocalPosition &localPos) const = 0;

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

    virtual SiCellId cellIdInRange(const SiCellId &cellId) const = 0;

    // Private methods:
private:
    DetectorDesign();

    // Private data:
private:
    Axis m_etaAxis; // !< local axis corresponding to eta direction
    Axis m_phiAxis; // !< local axis corresponding to phi direction
    Axis m_depthAxis; // !< local axis corresponding to depth direction
    double m_thickness; // !< thickness of silicon sensor
    InDetDD::CarrierType m_carrierType; // !< carrier type that drifts towards readout
    // !< (ie holes fro SCT and electrons for pixel)
    bool m_phiSymmetric;
    bool m_etaSymmetric;
    bool m_depthSymmetric;
 
    bool m_readoutSidePosDepth; // !< Control which side readout is on.
                                // !< true = positive Depth Side, false = negative Depth
                                // Side
 
    // Disallow Copy and assignment;
    DetectorDesign(const DetectorDesign &design);
    DetectorDesign &operator = (const DetectorDesign &design);
};

// Inline methods:
 
inline DetectorDesign::Axis DetectorDesign::etaAxis() const {
    return m_etaAxis;
}
 
inline DetectorDesign::Axis DetectorDesign::phiAxis() const {
    return m_phiAxis;
}
 
inline DetectorDesign::Axis DetectorDesign::depthAxis() const {
    return m_depthAxis;
}
 
inline double DetectorDesign::thickness() const {
    return m_thickness;
}
 
inline InDetDD::CarrierType DetectorDesign::carrierType() const {
    return m_carrierType;
}
 
inline bool DetectorDesign::phiSymmetric() const {
    return m_phiSymmetric;
}
 
inline bool DetectorDesign::etaSymmetric() const {
    return m_etaSymmetric;
}
 
inline bool DetectorDesign::depthSymmetric() const {
    return m_depthSymmetric;
}
 
inline int DetectorDesign::readoutSide() const {
    return (m_readoutSidePosDepth) ? +1 : -1;
}
 
}  // namespace InDetDD
 
#endif // READOUTGEOMETRYBASE_DETECTORDESIGN_H