StraightLineSurface.h

Go to the documentation of this file.

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

// StraightLineSurface.h, (c) ATLAS Detector software
 
#ifndef TRKSURFACES_STRAIGHTLINESURFACE_H
#define TRKSURFACES_STRAIGHTLINESURFACE_H
// Amg
#include "EventPrimitives/EventPrimitives.h"
#include "GeoPrimitives/GeoPrimitives.h"
 
// Trk
#include "CxxUtils/CachedValue.h"
#include <memory>
#include "TrkParametersBase/ParametersT.h"
#include "TrkSurfaces/CylinderBounds.h"
#include "TrkSurfaces/NoBounds.h"
#include "TrkSurfaces/Surface.h"
 
class Identifier;
class MsgStream;
template<class SURFACE, class BOUNDS_CNV>
class BoundSurfaceCnv_p1;
template<class SURFACE, class BOUNDS_CNV>
class BoundSurfaceCnv_p2;
 
namespace Trk {
 
class TrkDetElementBase;
class LocalParameters;
template<int DIM, class T, class S>
class ParametersT;

 
class StraightLineSurface : public Surface
{
 
public:
  static constexpr SurfaceType staticType = SurfaceType::Line;
  StraightLineSurface();

  StraightLineSurface(const StraightLineSurface& slsf);

  StraightLineSurface& operator=(const StraightLineSurface& slsf);

  StraightLineSurface(StraightLineSurface&& slsf) noexcept = default;

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

  virtual ~StraightLineSurface() = default;

  StraightLineSurface(const Amg::Transform3D& htrans);

  StraightLineSurface(const Amg::Transform3D& htrans, double radius, double halez);

  StraightLineSurface(
    const TrkDetElementBase& detelement,
    const Identifier& id);

  StraightLineSurface(
    const StraightLineSurface& slsf,
    const Amg::Transform3D& transf);

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

  virtual StraightLineSurface* clone() const override final;

  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, StraightLineSurface>>
  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, StraightLineSurface>>
  createUniqueParameters(
    const Amg::Vector3D& position,
    const Amg::Vector3D& momentum,
    double charge,
    std::optional<AmgSymMatrix(DIM)> cov = std::nullopt) const;

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

  constexpr virtual SurfaceType type() const override final;

  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;

  Amg::Vector3D localToGlobal(
    const Trk::LocalParameters& locpars,
    const Amg::Vector3D& glomom,
    double locZ) const;

  const Amg::Vector3D& lineDirection() const;

  virtual Intersection straightLineIntersection(
    const Amg::Vector3D& pos,
    const Amg::Vector3D& dir,
    bool forceDir,
    Trk::BoundaryCheck bchk) 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 const SurfaceBounds& bounds() 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;

  virtual std::string name() const override final;
 
protected: 
  template<class SURFACE, class BOUNDS_CNV>
  friend class ::BoundSurfaceCnv_p1;
  template<class SURFACE, class BOUNDS_CNV>
  friend class ::BoundSurfaceCnv_p2;
  CxxUtils::CachedValue<Amg::Vector3D> m_lineDirection;
  std::shared_ptr<const CylinderBounds> m_bounds;
  static const NoBounds s_boundless;
};
} // end of namespace
 
#include "TrkSurfaces/StraightLineSurface.icc"
#endif // TRKSURFACES_STRAIGHTLINESURFACE_H