GeometricDet.h

Go to the documentation of this file.

#ifndef Geometry_TrackerNumberingBuilder_GeometricDet_H
#define Geometry_TrackerNumberingBuilder_GeometricDet_H

#include "CondFormats/GeometryObjects/interface/PGeometricDet.h"
#include "DetectorDescription/DDCMS/interface/DDSolidShapes.h"
#include "DataFormats/GeometrySurface/interface/Surface.h"
#include "DataFormats/GeometrySurface/interface/Bounds.h"
#include "DataFormats/DetId/interface/DetId.h"
#include "FWCore/MessageLogger/interface/MessageLogger.h"
#include "FWCore/ParameterSet/interface/types.h"

#include <DD4hep/Shapes.h>
#include <Math/Rotation3D.h>
#include <Math/Vector3D.h>

#include <vector>
#include <memory>
#include <ext/pool_allocator.h>

class DDFilteredView;

namespace cms {
  class DDFilteredView;
}

class GeometricDet {
public:
  using NavRange = std::pair<int const*, size_t>;
  using ConstGeometricDetContainer = std::vector<GeometricDet const*>;
  using GeometricDetContainer = std::vector<GeometricDet*>;
  using RotationMatrix = ROOT::Math::Rotation3D;
  using Translation = ROOT::Math::DisplacementVector3D<ROOT::Math::Cartesian3D<double> >;

#ifdef PoolAlloc
  using nav_type = std::vector<int, PoolAlloc<int> >;
#else
  using nav_type = std::vector<int>;
#endif

  using Position = Surface::PositionType;
  using Rotation = Surface::RotationType;

  typedef enum GDEnumType {
    unknown = 100,
    Tracker = 0,
    PixelBarrel = 1,
    PixelEndCap = 2,
    TIB = 3,
    TID = 4,
    TOB = 5,
    TEC = 6,
    layer = 8,
    wheel = 9,
    strng = 10,
    rod = 11,
    petal = 12,
    ring = 13,
    ladder = 14,
    mergedDet = 15,
    DetUnit = 16,
    disk = 17,
    panel = 18,
    PixelPhase1Barrel = 101,
    PixelPhase1EndCap = 102,
    PixelPhase1Disk = 117,
    OTPhase2EndCap = 204,
    OTPhase2Barrel = 205,
    OTPhase2Layer = 208,
    OTPhase2Stack = 215,
    PixelPhase2Barrel = 201,
    PixelPhase2EndCap = 202,
    OTPhase2Wheel = 209,
    PixelPhase2FullDisk = 217,
    PixelPhase2ReducedDisk = 227,
    PixelPhase2TDRDisk = 237,
    PixelPhase2DoubleDisk = 347,
    PixelPhase2SubDisk = 357
  } GeometricEnumType;

  // Constructors from Filtered View (called while looping over DD).
  GeometricDet(DDFilteredView* fv, GeometricEnumType dd);
  GeometricDet(cms::DDFilteredView* fv, GeometricEnumType dd);
  // Constructors from persistent data (from DB)
  GeometricDet(const PGeometricDet::Item& onePGD, GeometricEnumType dd);

  // ACCESS GENERAL INFO
  const std::string& name() const { return ddname_; }
  const GeometricEnumType& type() const { return type_; }

  // NAVIGATION related info
  const nav_type& navType() const { return ddd_; }
  NavRange navpos() const { return NavRange(&ddd_.front(), ddd_.size()); }
  const DetId& geographicalId() const { return geographicalID_; }
  void setGeographicalID(DetId id) { geographicalID_ = id; }

  // VOLUME POSITION in CMS frame of reference
  const Translation& translation() const { return trans_; }  // in mm
  double rho() const { return rho_; }                        // in mm
  double phi() const { return phi_; }
  const RotationMatrix& rotation() const { return rot_; }

  // BOUNDS
  std::unique_ptr<Bounds> bounds() const;
  Position positionBounds() const;  // in cm
  Rotation rotationBounds() const;

  // SOLID SHAPE
  // old DD
  LegacySolidShape shape() const { return cms::dd::value(cms::LegacySolidShapeMap, shape_); }
  // DD4hep
  const cms::DDSolidShape& shape_dd4hep() const { return shape_; }
  // solid shape parameters
  const std::vector<double>& params() const {
    if (shape_ != cms::DDSolidShape::ddbox && shape_ != cms::DDSolidShape::ddtrap &&
        shape_ != cms::DDSolidShape::ddtubs) {
      edm::LogError("GeometricDet::params()")
          << "Called on a shape which is neither a box, a trap, nor a tub. This is not supported!";
    }
    return params_;
  }  // in mm

  // RADIATION LENGTH AND ENERGY LOSS
  double radLength() const { return radLength_; }
  double xi() const { return xi_; }

  // SENSOR INFO
  // Only return meaningful results for pixels.
  double pixROCRows() const { return pixROCRows_; }
  double pixROCCols() const { return pixROCCols_; }
  double pixROCx() const { return pixROCx_; }
  double pixROCy() const { return pixROCy_; }
  // Only return meaningful results for Outer Trackers.
  bool stereo() const { return stereo_; }
  bool isLowerSensor() const { return isLowerSensor_; }
  bool isUpperSensor() const { return isUpperSensor_; }
  double siliconAPVNum() const { return siliconAPVNum_; }

  // DETECTOR DESCRIPTION ORIGIN INFO
  bool isFromDD4hep() const { return isFromDD4hep_; }

  // CHILDREN INFO
  GeometricDet* component(size_t index) { return const_cast<GeometricDet*>(container_[index]); }
  bool isLeaf() const { return container_.empty(); }
  // direct children only
  // if the current GeometricDet is a leaf, it returns nothing.
  ConstGeometricDetContainer& components() { return container_; }
  const ConstGeometricDetContainer& components() const { return container_; }
  // all descendants
  // if the current GeometricDet is a leaf, it returns itself!
  ConstGeometricDetContainer deepComponents() const;
  void deepComponents(ConstGeometricDetContainer& cont) const;

  // PUBLIC SETTERS (they should obviously be as few as possible!!)
  void addComponents(GeometricDetContainer const& cont);
  void addComponents(ConstGeometricDetContainer const& cont);
  void addComponent(GeometricDet*);
  void clearComponents() { container_.clear(); }  // only empties the container, THE CHILDREN ARE NOT DELETED!
  void deleteComponents();                        // EXPLICITLY DELETES THE CHILDREN

  // CUSTOM DESTRUCTOR
  ~GeometricDet();

  // Utility function
  static std::string printNavType(int const* n, size_t sz);

private:
  std::vector<double> computeLegacyShapeParameters(const cms::DDSolidShape& mySolidShape,
                                                   const dd4hep::Solid& mySolid) const;

  std::string ddname_;
  GeometricEnumType type_;

  nav_type ddd_;
  DetId geographicalID_ = 0;

  Translation trans_;  // in mm
  double rho_ = 0.;    // in mm
  double phi_ = 0.;
  RotationMatrix rot_;

  cms::DDSolidShape shape_;
  std::vector<double> params_;  // in mm

  double radLength_ = 0.;
  double xi_ = 0.;
  double pixROCRows_ = 0.;
  double pixROCCols_ = 0.;
  double pixROCx_ = 0.;
  double pixROCy_ = 0.;
  bool stereo_ = false;
  bool isLowerSensor_ = false;
  bool isUpperSensor_ = false;
  double siliconAPVNum_ = 0.;

  bool isFromDD4hep_ = false;

  ConstGeometricDetContainer container_;
};

namespace geometric_det_ns {
  inline std::ostream& operator<<(std::ostream& os, const GeometricDet::NavRange& n) {
    os << GeometricDet::printNavType(n.first, n.second);
    return os;
  }
}  // namespace geometric_det_ns

#undef PoolAlloc
#endif