PerigeeSurface.h

Go to the documentation of this file.

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

// PerigeeSurface.h, (c) ATLAS Detector software
 
#ifndef TRKSURFACES_PERIGEESURFACE_H
#define TRKSURFACES_PERIGEESURFACE_H
 
// Trk
#include "TrkDetDescrUtils/GeometryStatics.h"
#include "TrkParametersBase/ParametersT.h"
#include "TrkSurfaces/NoBounds.h"
#include "TrkSurfaces/Surface.h"
// Amg
#include "CxxUtils/CachedValue.h"
#include "EventPrimitives/EventPrimitives.h"
#include "GeoPrimitives/GeoPrimitives.h"
 
class MsgStream;
 
namespace Trk {
 
class LocalParameters;
template<int DIM, class T, class S>
class ParametersT;

 
class PerigeeSurface final : public Surface
{
 
public:
  static constexpr SurfaceType staticType = SurfaceType::Perigee;

  PerigeeSurface();

  PerigeeSurface(const PerigeeSurface& pesf);

  PerigeeSurface& operator=(const PerigeeSurface& slsf);

  PerigeeSurface(PerigeeSurface&& pesf) noexcept = default;

  PerigeeSurface& operator=(PerigeeSurface&& slsf) noexcept = default;

  virtual ~PerigeeSurface() = default;

  PerigeeSurface(const Amg::Vector3D& gp);

  PerigeeSurface(const Amg::Transform3D& tTransform);

  PerigeeSurface(const PerigeeSurface& pesf, const Amg::Transform3D& transf);

  virtual PerigeeSurface* clone() const override final;

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

  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, PerigeeSurface>> 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, PerigeeSurface>> 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& normal() const override final;

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

  virtual Amg::RotationMatrix3D measurementFrame(
    const Amg::Vector3D& glopos,
    const Amg::Vector3D& glomom) const override final;

  Amg::Vector3D localToGlobal(const LocalParameters& locpos) const;

  Amg::Vector3D localToGlobal(const LocalParameters& locpos,
                              const Amg::Vector3D& glomom) const;

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

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

  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 final;

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

  virtual double pathCorrection(const Amg::Vector3D&,
                                const Amg::Vector3D&) const override final;

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

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

  const Amg::Vector3D& lineDirection() const;

  virtual const NoBounds& bounds() const override final;

  virtual std::string name() const override final;

  virtual MsgStream& dump(MsgStream& sl) const override;
  virtual std::ostream& dump(std::ostream& sl) const override;
 
protected:
  CxxUtils::CachedValue<Amg::Vector3D> m_lineDirection;
  static const NoBounds s_perigeeBounds;
};
 
} // end of namespace
#include "TrkSurfaces/PerigeeSurface.icc"
 
#endif // TRKSURFACES_PERIGEESURFACE_H