ATLAS Offline Software
DiscSurface.h
Go to the documentation of this file.
1 /*
2  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
3 */
4 
6 // DiscSurface.h, (c) ATLAS Detector software
8 
9 #ifndef TRKSURFACES_DISCSURFACE_H
10 #define TRKSURFACES_DISCSURFACE_H
11 
12 // Trk
13 #include <memory>
16 #include "TrkSurfaces/NoBounds.h"
17 #include "TrkSurfaces/Surface.h"
19 // Amg
22 // std
23 #include <cmath> //for cos, sin etc
24 
25 class MsgStream;
26 template<class SURFACE, class BOUNDS_CNV>
27 class BoundSurfaceCnv_p1;
28 template<class SURFACE, class BOUNDS_CNV>
29 class BoundSurfaceCnv_p2;
30 
31 namespace Trk {
32 
33 class DiscBounds;
34 class DiscTrapezoidalBounds;
35 class AnnulusBounds;
36 class AnnulusBoundsPC;
37 class TrkDetElementBase;
38 class LocalParameters;
39 
40 template<int DIM, class T, class S>
41 class ParametersT;
42 
53 class DiscSurface : public Surface
54 {
55 
56 public:
59  DiscSurface();
60 
62  DiscSurface(const DiscSurface& psf);
63 
65  DiscSurface& operator=(const DiscSurface& dsf);
66 
68  DiscSurface(DiscSurface&& psf) noexcept = default;
69 
71  DiscSurface& operator=(DiscSurface&& dsf) noexcept = default;
72 
74  virtual ~DiscSurface() = default;
75 
78  DiscSurface(const Amg::Transform3D& htrans, double rmin, double rmax);
79 
82  DiscSurface(const Amg::Transform3D& htrans,
83  double rmin,
84  double rmax,
85  double hphisec);
86 
89  DiscSurface(const Amg::Transform3D& htrans,
90  double minhalfx,
91  double maxhalfx,
92  double maxR,
93  double minR,
94  double avephi,
95  double stereo = 0.);
96 
98  DiscSurface(const Amg::Transform3D& htrans, std::shared_ptr<const DiscBounds> dbounds);
99 
101  DiscSurface(const Amg::Transform3D& htrans, std::shared_ptr<const DiscTrapezoidalBounds> dtbounds);
102 
105  DiscSurface(const Amg::Transform3D& htrans, std::shared_ptr<const AnnulusBoundsPC> annpcbounds);
106 
119  DiscSurface(const Amg::Transform3D& htrans, const AnnulusBounds& annbounds,
120  const TrkDetElementBase* detElem = nullptr);
121 
124  DiscSurface(const Amg::Transform3D& htrans);
125 
127  DiscSurface(const TrkDetElementBase& dmnt);
128 
130  DiscSurface(const DiscSurface& psf, const Amg::Transform3D& transf);
131 
133  virtual bool operator==(const Surface& sf) const override;
134  bool operator==(const DiscSurface& cf) const;
135 
137  virtual DiscSurface* clone() const override;
138 
142  double l1,
143  double l2,
144  double phi,
145  double theta,
146  double qop,
147  std::optional<AmgSymMatrix(5)> cov = std::nullopt) const override final;
148 
152  const Amg::Vector3D& position,
153  const Amg::Vector3D& momentum,
154  double charge,
155  std::optional<AmgSymMatrix(5)> cov = std::nullopt) const override final;
156 
160  double l1,
161  double l2,
162  double phi,
163  double theta,
164  double qop,
165  std::optional<AmgSymMatrix(5)> cov = std::nullopt) const override final;
166 
170  const Amg::Vector3D& position,
171  const Amg::Vector3D& momentum,
172  double charge,
173  std::optional<AmgSymMatrix(5)> cov = std::nullopt) const override final;
174 
176  template<int DIM, class T>
177  std::unique_ptr<ParametersT<DIM, T, DiscSurface>> createUniqueParameters(
178  double l1,
179  double l2,
180  double phi,
181  double theta,
182  double qop,
183  std::optional<AmgSymMatrix(DIM)> cov = std::nullopt) const;
184 
186  template<int DIM, class T>
187  std::unique_ptr<ParametersT<DIM, T, DiscSurface>> createUniqueParameters(
188  const Amg::Vector3D& position,
189  const Amg::Vector3D& momentum,
190  double charge,
191  std::optional<AmgSymMatrix(DIM)> cov = std::nullopt) const;
192 
194  constexpr virtual SurfaceType type() const override final;
195 
200  virtual const Amg::Vector3D& globalReferencePoint() const override final;
201 
203  const SurfaceBounds& bounds() const override final;
204 
206  virtual bool insideBounds(const Amg::Vector2D& locpos,
207  double tol1 = 0.,
208  double tol2 = 0.) const override;
209  virtual bool insideBoundsCheck(
210  const Amg::Vector2D& locpos,
211  const BoundaryCheck& bchk) const override final;
212 
216  virtual bool isOnSurface(const Amg::Vector3D& glopo,
217  const BoundaryCheck& bchk = true,
218  double tol1 = 0.,
219  double tol2 = 0.) const override;
220 
223  const LocalParameters& locpars) const override final;
224 
227  virtual void localToGlobal(const Amg::Vector2D& locp,
228  const Amg::Vector3D& mom,
229  Amg::Vector3D& glob) const override;
230 
234  virtual bool globalToLocal(const Amg::Vector3D& glob,
235  const Amg::Vector3D& mom,
236  Amg::Vector2D& loc) const override;
237 
259  const Amg::Vector3D& pos,
260  const Amg::Vector3D& dir,
261  bool forceDir = false,
262  Trk::BoundaryCheck bchk = false) const override final;
263 
266  const Amg::Vector3D& pos,
267  const Amg::Vector3D& dir) const override;
268 
271  const Amg::Vector3D& pos,
272  const Amg::Vector3D& dir,
273  bool Bound) const override;
274 
276  virtual std::string name() const override;
277 
278 protected:
279  template<class SURFACE, class BOUNDS_CNV>
280  friend class ::BoundSurfaceCnv_p1;
281  template<class SURFACE, class BOUNDS_CNV>
282  friend class ::BoundSurfaceCnv_p2;
284  std::shared_ptr<const SurfaceBounds> m_bounds;
289 };
290 
291 } // end of namespace
292 #include "TrkSurfaces/DiscSurface.icc"
293 
294 #endif // TRKSURFACES_DISCSURFACE_H
Trk::DiscSurface::insideBoundsCheck
virtual bool insideBoundsCheck(const Amg::Vector2D &locpos, const BoundaryCheck &bchk) const override final
Trk::LocalParameters
Definition: LocalParameters.h:98
Trk::DiscSurface::m_bounds
std::shared_ptr< const SurfaceBounds > m_bounds
reference Point on the Surface
Definition: DiscSurface.h:284
Trk::DiscSurface::localParametersToPosition
virtual Amg::Vector2D localParametersToPosition(const LocalParameters &locpars) const override final
Specialized for DiscSurface : LocalParameters to Vector2D.
Trk::DiscSurface::insideBounds
virtual bool insideBounds(const Amg::Vector2D &locpos, double tol1=0., double tol2=0.) const override
This method calls the inside method of the bounds.
Trk::Intersection
Definition: Intersection.h:24
Trk::DiscSurface::operator=
DiscSurface & operator=(DiscSurface &&dsf) noexcept=default
Assignement operator.
CxxUtils::CachedUniquePtr
CachedUniquePtrT< const T > CachedUniquePtr
Definition: CachedUniquePtr.h:114
Surface.h
Trk::DistanceSolution
Definition: DistanceSolution.h:25
Trk::Surface::ChargedTrackParametersUniquePtr
std::unique_ptr< ParametersBase< 5, Trk::Charged > > ChargedTrackParametersUniquePtr
Unique ptr types.
Definition: Tracking/TrkDetDescr/TrkSurfaces/TrkSurfaces/Surface.h:129
Amg::Vector2D
Eigen::Matrix< double, 2, 1 > Vector2D
Definition: GeoPrimitives.h:48
Trk::DiscSurface::isOnSurface
virtual bool isOnSurface(const Amg::Vector3D &glopo, const BoundaryCheck &bchk=true, double tol1=0., double tol2=0.) const override
This method returns true if the GlobalPosition is on the Surface for both, within or without check of...
Definition: DiscSurface.cxx:287
Trk::SurfaceBounds
Definition: SurfaceBounds.h:47
BoundSurfaceCnv_p2
Definition: ConeSurface.h:27
Trk::AnnulusBounds
Definition: AnnulusBounds.h:45
Trk::DiscSurface::operator=
DiscSurface & operator=(const DiscSurface &dsf)
Assignement operator.
Definition: DiscSurface.cxx:149
Trk::DiscSurface::clone
virtual DiscSurface * clone() const override
Virtual constructor.
taskman.template
dictionary template
Definition: taskman.py:314
plotBeamSpotVxVal.cov
cov
Definition: plotBeamSpotVxVal.py:200
Trk::DiscSurface::m_referencePoint
CxxUtils::CachedUniquePtr< Amg::Vector3D > m_referencePoint
static member for boundless approach
Definition: DiscSurface.h:286
Trk::SurfaceType
SurfaceType
Definition: SurfaceTypes.h:17
Trk::Surface::NeutralTrackParametersUniquePtr
std::unique_ptr< ParametersBase< 5, Trk::Neutral > > NeutralTrackParametersUniquePtr
Definition: Tracking/TrkDetDescr/TrkSurfaces/TrkSurfaces/Surface.h:131
Trk::TrkDetElementBase
Definition: TrkDetElementBase.h:52
Trk::DiscSurface
Definition: DiscSurface.h:54
const
bool const RAWDATA *ch2 const
Definition: LArRodBlockPhysicsV0.cxx:560
Trk::DiscSurface::globalReferencePoint
virtual const Amg::Vector3D & globalReferencePoint() const override final
Returns a global reference point: For the Disc this is Where denote the r(), averagePhi() of the Bo...
Definition: DiscSurface.cxx:209
Trk::DiscSurface::DiscSurface
DiscSurface()
Default Constructor.
Definition: DiscSurface.cxx:26
Trk::DiscSurface::~DiscSurface
virtual ~DiscSurface()=default
Destructor.
Trk::DiscSurface::straightLineIntersection
virtual Intersection straightLineIntersection(const Amg::Vector3D &pos, const Amg::Vector3D &dir, bool forceDir=false, Trk::BoundaryCheck bchk=false) const override final
fast straight line intersection schema - standard: provides closest intersection and (signed) path le...
Definition: DiscSurface.cxx:260
Trk::AmgSymMatrix
AmgSymMatrix(5) &GXFTrackState
Definition: GXFTrackState.h:156
BoundSurfaceCnv_p1
Definition: ConeSurface.h:25
GeoPrimitives.h
SurfaceBounds.h
skel.l2
l2
Definition: skel.GENtoEVGEN.py:410
ParticleGun_EoverP_Config.mom
mom
Definition: ParticleGun_EoverP_Config.py:63
ParticleGun_EoverP_Config.momentum
momentum
Definition: ParticleGun_EoverP_Config.py:63
Trk::DiscSurface::name
virtual std::string name() const override
Return properly formatted class name for screen output.
Trk::theta
@ theta
Definition: ParamDefs.h:66
Trk::DiscSurface::operator==
bool operator==(const DiscSurface &cf) const
ParametersT.h
Amg::Transform3D
Eigen::Affine3d Transform3D
Definition: GeoPrimitives.h:46
CxxUtils
Definition: aligned_vector.h:29
Trk::DiscSurface::createUniqueParameters
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
Use the Surface as a ParametersBase constructor, from global parameters.
Trk::DiscSurface::bounds
const SurfaceBounds & bounds() const override final
This method returns the bounds by reference.
Trk::DiscSurface::DiscSurface
DiscSurface(DiscSurface &&psf) noexcept=default
Copy Constructor.
beamspotman.dir
string dir
Definition: beamspotman.py:619
Trk::DiscSurface::staticType
static constexpr SurfaceType staticType
Definition: DiscSurface.h:57
EventPrimitives.h
Trk
Ensure that the ATLAS eigen extensions are properly loaded.
Definition: FakeTrackBuilder.h:9
Amg
Definition of ATLAS Math & Geometry primitives (Amg)
Definition: AmgStringHelpers.h:19
protected
#define protected
Definition: GenEventCnv_p1.h:26
Trk::DiscSurface::createUniqueTrackParameters
virtual Surface::ChargedTrackParametersUniquePtr createUniqueTrackParameters(double l1, double l2, double phi, double theta, double qop, std::optional< AmgSymMatrix(5)> cov=std::nullopt) const override final
Use the Surface as a ParametersBase constructor, from local parameters - charged.
Definition: DiscSurface.cxx:172
charge
double charge(const T &p)
Definition: AtlasPID.h:991
Amg::Vector3D
Eigen::Matrix< double, 3, 1 > Vector3D
Definition: GeoPrimitives.h:47
LocalParameters.h
Trk::DiscSurface::operator==
virtual bool operator==(const Surface &sf) const override
Equality operator.
Definition: DiscSurface.cxx:160
python.LumiBlobConversion.pos
pos
Definition: LumiBlobConversion.py:16
Trk::NoBounds
Definition: NoBounds.h:30
Trk::DiscSurface::createUniqueNeutralParameters
virtual NeutralTrackParametersUniquePtr createUniqueNeutralParameters(double l1, double l2, double phi, double theta, double qop, std::optional< AmgSymMatrix(5)> cov=std::nullopt) const override final
Use the Surface as a ParametersBase constructor, from local parameters - neutral.
Definition: DiscSurface.cxx:191
Trk::DiscSurface::type
constexpr virtual SurfaceType type() const override final
Return the surface type.
mapkey::sf
@ sf
Definition: TElectronEfficiencyCorrectionTool.cxx:38
Trk::DiscSurface::globalToLocal
virtual bool globalToLocal(const Amg::Vector3D &glob, const Amg::Vector3D &mom, Amg::Vector2D &loc) const override
Specialized for DiscSurface: GlobalToLocal method without dynamic memory allocation - boolean checks ...
Definition: DiscSurface.cxx:250
Trk::BoundaryCheck
Definition: BoundaryCheck.h:51
Trk::SurfaceType::Disc
@ Disc
Trk::phi
@ phi
Definition: ParamDefs.h:75
skel.l1
l1
Definition: skel.GENtoEVGEN.py:409
Trk::DiscSurface::localToGlobal
virtual void localToGlobal(const Amg::Vector2D &locp, const Amg::Vector3D &mom, Amg::Vector3D &glob) const override
Specialized for DiscSurface: LocalToGlobal method without dynamic memory allocation.
Definition: DiscSurface.cxx:236
Trk::Surface
Definition: Tracking/TrkDetDescr/TrkSurfaces/TrkSurfaces/Surface.h:79
Trk::DiscSurface::createUniqueParameters
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
Use the Surface as a ParametersBase constructor, from local parameters.
NoBounds.h
Trk::DiscSurface::s_boundless
static const NoBounds s_boundless
Definition: DiscSurface.h:288
Trk::DiscSurface::straightLineDistanceEstimate
virtual DistanceSolution straightLineDistanceEstimate(const Amg::Vector3D &pos, const Amg::Vector3D &dir) const override
fast straight line distance evaluation to Surface
Definition: DiscSurface.cxx:304