SolidStateDetectorElementBase.h

Go to the documentation of this file.

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

 
#ifndef READOUTGEOMETRYBASE_SOLIDSTATEDETECTORELEMENTBASE_H
#define READOUTGEOMETRYBASE_SOLIDSTATEDETECTORELEMENTBASE_H

#include "GeoPrimitives/CLHEPtoEigenConverter.h"
#include "GeoPrimitives/GeoPrimitives.h"
#include "TrkDetElementBase/TrkDetElementBase.h"
#include "GeoModelKernel/GeoDefinitions.h"
#include "Identifier/Identifier.h"
#include "Identifier/IdentifierHash.h"
#include "ReadoutGeometryBase/InDetDD_Defs.h"
#include "ReadoutGeometryBase/SiCellId.h"
#include "ReadoutGeometryBase/SiCommonItems.h"
#include "ReadoutGeometryBase/DetectorDesign.h"
#include "ReadoutGeometryBase/SiIntersect.h"
#include "ReadoutGeometryBase/SiLocalPosition.h"
#include "TrkEventPrimitives/ParamDefs.h"
#include "CxxUtils/CachedValue.h"
 
#include "CLHEP/Geometry/Point3D.h"
 
#include <limits>
#include <memory>
 
class AtlasDetectorID;
class GeoAlignmentStore;
class GeoVFullPhysVol;
 
namespace Trk {
  class SurfaceBounds;
}
 
namespace InDetDD {
 
  class SiReadoutCellId;

 
 
  class SolidStateDetectorElementBase : public Trk::TrkDetElementBase {
 
  public:

    SolidStateDetectorElementBase(const Identifier& id,
                      const DetectorDesign* design,
                      const GeoVFullPhysVol* geophysvol,
                      const SiCommonItems* commonItems,
                      const GeoAlignmentStore* geoAlignStore=nullptr);

    virtual ~SolidStateDetectorElementBase();

    SolidStateDetectorElementBase() = delete;

    SolidStateDetectorElementBase(const SolidStateDetectorElementBase&) = delete;

    SolidStateDetectorElementBase& operator=(const SolidStateDetectorElementBase&) = delete;

    SolidStateDetectorElementBase(SolidStateDetectorElementBase&&) = delete;

    SolidStateDetectorElementBase& operator=(SolidStateDetectorElementBase&&) = delete;


    void invalidate();

    const SiCommonItems* getCommonItems() const;


    virtual Identifier identify() const override final;

    virtual IdentifierHash identifyHash() const override final;

    const AtlasDetectorID* getIdHelper() const;

    virtual Identifier identifierFromCellId(const SiCellId &cellId) const = 0;
    virtual SiCellId cellIdFromIdentifier(const Identifier& identifier) const = 0;



    Trk::Surface& surface();
    virtual const Trk::Surface& surface() const override final;
    virtual const Trk::Surface& surface(const Identifier&) const override final;

    const GeoTrf::Transform3D& transformHit() const;

    const HepGeom::Transform3D& transformCLHEP() const;
    virtual const Amg::Transform3D& transform() const override final;
    virtual const Amg::Transform3D& transform(const Identifier&) const override final;

    const HepGeom::Transform3D defTransformCLHEP() const;
    const Amg::Transform3D defTransform() const;

    const HepGeom::Transform3D recoToHitTransform() const;

    //{@

    double hitDepthDirection() const;
    double hitPhiDirection() const;
    double hitEtaDirection() const;

    const HepGeom::Vector3D<double>& phiAxisCLHEP() const;
    const Amg::Vector3D& phiAxis() const;
    const HepGeom::Vector3D<double>& etaAxisCLHEP() const;
    const Amg::Vector3D& etaAxis() const;

    virtual const Amg::Vector3D& normal() const override final;
    virtual const Amg::Vector3D& normal(const Identifier&) const override final;



    virtual const Amg::Vector3D& center() const override final;
    virtual const Amg::Vector3D& center(const Identifier&) const override final;

    virtual Trk::DetectorElemType detectorType() const override;

    HepGeom::Point3D<double> globalPositionHit(const HepGeom::Point3D<double>& simulationLocalPos) const;
    Amg::Vector3D globalPositionHit(const Amg::Vector3D& simulationLocalPos) const;

    HepGeom::Point3D<double> globalPosition(const HepGeom::Point3D<double>& localPos) const;
    Amg::Vector3D globalPosition(const Amg::Vector3D& localPos) const;

    Amg::Vector3D globalPosition(const Amg::Vector2D& localPos) const;

    Amg::Vector2D hitLocalToLocal(double xEta, double xPhi) const;
    HepGeom::Point3D<double> hitLocalToLocal3D(const HepGeom::Point3D<double>& hitPosition) const;

    Amg::Vector2D localPosition(const HepGeom::Point3D<double>& globalPosition) const;
    Amg::Vector2D localPosition(const Amg::Vector3D& globalPosition) const;

 

    double rMin() const;
    double rMax() const;
    double zMin() const;
    double zMax() const;
    double phiMin() const;
    double phiMax() const;

    void getEtaPhiRegion(double deltaZ,
                         double& etaMin, double& etaMax,
                         double& phiMin, double& phiMax,
                         double& rz) const;
    virtual double get_rz() const = 0;


 
    virtual const DetectorDesign& design() const;
 
    virtual const Trk::SurfaceBounds& bounds() const override final;
    virtual const Trk::SurfaceBounds& bounds(const Identifier&) const override final;

    double width() const;
    double minWidth() const;
    double maxWidth() const;
    double length() const;
    double thickness() const;

    double etaPitch() const;
    double phiPitch() const;

    InDetDD::CarrierType carrierType() const;

    bool swapPhiReadoutDirection() const;
    bool swapEtaReadoutDirection() const;



    SiIntersect inDetector(const Amg::Vector2D& localPosition, double phiTol, double etaTol) const;
    SiIntersect inDetector(const Amg::Vector3D& globalPosition, double phiTol, double etaTol) const;


    Identifier identifierOfPosition(const Amg::Vector2D& localPos) const;
    SiCellId cellIdOfPosition(const Amg::Vector2D& localPos) const;

    Amg::Vector2D rawLocalPositionOfCell(const SiCellId& cellId) const;
    Amg::Vector2D rawLocalPositionOfCell(const Identifier& id) const;

    int numberOfConnectedCells(const SiCellId cellId) const;
    SiCellId connectedCell(const SiCellId cellId, int number) const;

    virtual void updateCache() const;

    bool depthDirection() const;
    bool etaDirection() const;
    bool phiDirection() const;
    double depthAngle() const;
    double etaAngle() const;
    double phiAngle() const;
 
  protected:
    struct CachedVals;
  private:


    void commonConstructor();

    void getExtent(CachedVals& cache) const;

    void getCorners(HepGeom::Point3D<double>* corners) const;

    void getEtaPhiPoint(const HepGeom::Point3D<double>& point, double deltaZ,
                        double& etaMin, double& etaMax, double& phi) const;

    MsgStream& msg(MSG::Level lvl) const;

    bool msgLvl(MSG::Level lvl) const;

  protected:

    Identifier m_id{};

    const DetectorDesign* m_design{nullptr};
 
    const SiCommonItems* m_commonItems{nullptr};
    std::unique_ptr<Trk::Surface> m_surface;
    const GeoAlignmentStore* m_geoAlignStore{};

    DetectorDesign::Axis m_hitEta;
    DetectorDesign::Axis m_hitPhi;
    DetectorDesign::Axis m_hitDepth;


    IdentifierHash m_idHash{};

    struct AxisDir
    {
      bool m_depthDirection;
      bool m_phiDirection;
      bool m_etaDirection;
 
      double m_depthAngle;
      double m_phiAngle;
      double m_etaAngle;

      bool m_barrelLike;
    };
    CxxUtils::CachedValue<AxisDir> m_axisDir;


    struct CachedVals {
      Amg::Transform3D m_transformHit;
      Amg::Transform3D m_transform;
      HepGeom::Transform3D m_transformCLHEP;
      Amg::Vector3D m_normal;
      Amg::Vector3D m_etaAxis;
      HepGeom::Vector3D<double> m_etaAxisCLHEP;
      Amg::Vector3D m_phiAxis;
      HepGeom::Vector3D<double> m_phiAxisCLHEP;
      Amg::Vector3D m_center;
      HepGeom::Vector3D<double> m_centerCLHEP;
      Amg::Vector3D m_origin;
      double m_minZ;
      double m_maxZ;
      double m_minR;
      double m_maxR;
      double m_minPhi;
      double m_maxPhi;
    };
    CxxUtils::CachedValue<CachedVals> m_cache;

 
  };
 
} // namespace InDetDD

#include "ReadoutGeometryBase/SolidStateDetectorElementBase.icc"
 
#endif // INDETREADOUTGEOMETRY_SIDETECTORELEMENTBASE_H