DiscSurface.h

Go to the documentation of this file.

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

// DiscSurface.h, (c) ATLAS Detector software
 
#ifndef TRKSURFACES_DISCSURFACE_H
#define TRKSURFACES_DISCSURFACE_H
 
// Trk
#include <memory>
#include "TrkEventPrimitives/LocalParameters.h"
#include "TrkParametersBase/ParametersT.h"
#include "TrkSurfaces/NoBounds.h"
#include "TrkSurfaces/Surface.h"
#include "TrkSurfaces/SurfaceBounds.h"
// Amg
#include "EventPrimitives/EventPrimitives.h"
#include "GeoPrimitives/GeoPrimitives.h"
// std
#include <cmath> //for cos, sin etc
 
class MsgStream;
template<class SURFACE, class BOUNDS_CNV>
class BoundSurfaceCnv_p1;
template<class SURFACE, class BOUNDS_CNV>
class BoundSurfaceCnv_p2;
 
namespace Trk {
 
class DiscBounds;
class DiscTrapezoidalBounds;
class AnnulusBounds;
class AnnulusBoundsPC;
class TrkDetElementBase;
class LocalParameters;
 
template<int DIM, class T, class S>
class ParametersT;

 
class DiscSurface : public Surface
{
 
public:
  static constexpr SurfaceType staticType = SurfaceType::Disc;
  DiscSurface();

  DiscSurface(const DiscSurface& psf);

  DiscSurface& operator=(const DiscSurface& dsf);

  DiscSurface(DiscSurface&& psf) noexcept = default;

  DiscSurface& operator=(DiscSurface&& dsf) noexcept = default;

  virtual ~DiscSurface();

  DiscSurface(const Amg::Transform3D& htrans, double rmin, double rmax);

  DiscSurface(const Amg::Transform3D& htrans,
              double rmin,
              double rmax,
              double hphisec);

  DiscSurface(const Amg::Transform3D& htrans,
              double minhalfx,
              double maxhalfx,
              double maxR,
              double minR,
              double avephi,
              double stereo = 0.);

  DiscSurface(const Amg::Transform3D& htrans, std::shared_ptr<const DiscBounds> dbounds);

  DiscSurface(const Amg::Transform3D& htrans, std::shared_ptr<const DiscTrapezoidalBounds> dtbounds);

  DiscSurface(const Amg::Transform3D& htrans, std::shared_ptr<const AnnulusBoundsPC> annpcbounds);

  DiscSurface(const Amg::Transform3D& htrans, const AnnulusBounds& annbounds,
              const TrkDetElementBase* detElem = nullptr);

  DiscSurface(const Amg::Transform3D& htrans);

  DiscSurface(const TrkDetElementBase& dmnt);

  DiscSurface(const DiscSurface& psf, const Amg::Transform3D& transf);

  virtual bool operator==(const Surface& sf) const override;
  bool operator==(const DiscSurface& cf) const;

  virtual DiscSurface* clone() const override;

  virtual Surface::ChargedTrackParametersUniquePtr createUniqueTrackParameters(
    double l1,
    double l2,
    double phi,
    double theta,
    double qop,
    std::optional<AmgSymMatrix(5)> cov = std::nullopt) const override final;

  virtual Surface::ChargedTrackParametersUniquePtr createUniqueTrackParameters(
    const Amg::Vector3D& position,
    const Amg::Vector3D& momentum,
    double charge,
    std::optional<AmgSymMatrix(5)> cov = std::nullopt) const override final;

  virtual NeutralTrackParametersUniquePtr createUniqueNeutralParameters(
    double l1,
    double l2,
    double phi,
    double theta,
    double qop,
    std::optional<AmgSymMatrix(5)> cov = std::nullopt) const override final;

  virtual NeutralTrackParametersUniquePtr createUniqueNeutralParameters(
    const Amg::Vector3D& position,
    const Amg::Vector3D& momentum,
    double charge,
    std::optional<AmgSymMatrix(5)> cov = std::nullopt) const override final;

  template<int DIM, class T>
  std::unique_ptr<ParametersT<DIM, T, DiscSurface>> createUniqueParameters(
    double l1,
    double l2,
    double phi,
    double theta,
    double qop,
    std::optional<AmgSymMatrix(DIM)> cov = std::nullopt) const;

  template<int DIM, class T>
  std::unique_ptr<ParametersT<DIM, T, DiscSurface>> createUniqueParameters(
    const Amg::Vector3D& position,
    const Amg::Vector3D& momentum,
    double charge,
    std::optional<AmgSymMatrix(DIM)> cov = std::nullopt) const;

  constexpr virtual SurfaceType type() const override final;

  virtual const Amg::Vector3D& globalReferencePoint() const override final;

  const SurfaceBounds& bounds() const override final;

  virtual bool insideBounds(const Amg::Vector2D& locpos,
                            double tol1 = 0.,
                            double tol2 = 0.) const override;
  virtual bool insideBoundsCheck(
    const Amg::Vector2D& locpos,
    const BoundaryCheck& bchk) const override final;

  virtual bool isOnSurface(const Amg::Vector3D& glopo,
                           const BoundaryCheck& bchk = true,
                           double tol1 = 0.,
                           double tol2 = 0.) const override;

  virtual Amg::Vector2D localParametersToPosition(
    const LocalParameters& locpars) const override final;

  virtual void localToGlobal(const Amg::Vector2D& locp,
                             const Amg::Vector3D& mom,
                             Amg::Vector3D& glob) const override;

  virtual bool globalToLocal(const Amg::Vector3D& glob,
                             const Amg::Vector3D& mom,
                             Amg::Vector2D& loc) const override;

  virtual Intersection straightLineIntersection(
    const Amg::Vector3D& pos,
    const Amg::Vector3D& dir,
    bool forceDir = false,
    Trk::BoundaryCheck bchk = false) const override final;

  virtual DistanceSolution straightLineDistanceEstimate(
    const Amg::Vector3D& pos,
    const Amg::Vector3D& dir) const override;

  virtual DistanceSolution straightLineDistanceEstimate(
    const Amg::Vector3D& pos,
    const Amg::Vector3D& dir,
    bool Bound) const override;

  virtual std::string name() const override;
 
protected: 
  template<class SURFACE, class BOUNDS_CNV>
  friend class ::BoundSurfaceCnv_p1;
  template<class SURFACE, class BOUNDS_CNV>
  friend class ::BoundSurfaceCnv_p2;
  std::shared_ptr<const SurfaceBounds> m_bounds;
  CxxUtils::CachedUniquePtr<Amg::Vector3D> m_referencePoint;
  static const NoBounds s_boundless;
};
 
} // end of namespace
#include "TrkSurfaces/DiscSurface.icc"
 
#endif // TRKSURFACES_DISCSURFACE_H