#include <SubtractedDiscSurface.h>

Inheritance diagram for Trk::SubtractedDiscSurface:

Collaboration diagram for Trk::SubtractedDiscSurface:

Public Types
using	ChargedTrackParametersUniquePtr = std::unique_ptr< ParametersBase< 5, Trk::Charged > >
	Unique ptr types. More...

using	NeutralTrackParametersUniquePtr = std::unique_ptr< ParametersBase< 5, Trk::Neutral > >

Public Member Functions
	SubtractedDiscSurface ()
	Default Constructor - needed for persistency. More...

	SubtractedDiscSurface (const SubtractedDiscSurface &psf)
	Copy Constructor. More...

	SubtractedDiscSurface (const SubtractedDiscSurface &psf, const Amg::Transform3D &shift)
	Copy Constructor. More...

	SubtractedDiscSurface (const DiscSurface &ps, AreaExcluder *vol, bool shared)
	Constructor. More...

virtual	~SubtractedDiscSurface ()
	Destructor. More...

SubtractedDiscSurface &	operator= (const SubtractedDiscSurface &psf)
	Assignment operator. More...

virtual bool	operator== (const Surface &sf) const override
	Equality operator. More...

bool	shared () const
	This method indicates the subtraction mode. More...

virtual bool	insideBounds (const Amg::Vector2D &locpos, double tol1=0., double tol2=0.) const override final
	This method calls the inside() method of the Bounds. More...

SharedObject< AreaExcluder >	subtractedVolume () const
	This method allows access to the subtracted part. More...

virtual std::string	name () const override final
	Return properly formatted class name for screen output. More...

bool	operator== (const DiscSurface &cf) const

virtual DiscSurface *	clone () const override
	Virtual constructor. More...

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. More...

virtual Surface::ChargedTrackParametersUniquePtr	createUniqueTrackParameters (const Amg::Vector3D &position, const Amg::Vector3D &momentum, double charge, std::optional< AmgSymMatrix(5)> cov=std::nullopt) const override final
	Use the Surface as a ParametersBase constructor, from global parameters - charged. More...

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. More...

virtual NeutralTrackParametersUniquePtr	createUniqueNeutralParameters (const Amg::Vector3D &position, const Amg::Vector3D &momentum, double charge, std::optional< AmgSymMatrix(5)> cov=std::nullopt) const override final
	Use the Surface as a ParametersBase constructor, from global parameters - neutral. More...

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
	Use the Surface as a ParametersBase constructor, from local parameters. More...

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
	Use the Surface as a ParametersBase constructor, from global parameters. More...

constexpr virtual SurfaceType	type () const override final
	Return the surface type. More...

virtual const Amg::Vector3D &	globalReferencePoint () const override final
	Returns a global reference point: For the Disc this is \( (Rcos(\phi), Rsin(\phi),0)*transform() \) Where \( r, \phi \) denote the r(), averagePhi() of the Bounds. More...

const SurfaceBounds &	bounds () const override final
	This method returns the bounds by reference. More...

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
	This method returns true if the GlobalPosition is on the Surface for both, within or without check of whether the local position is inside boundaries or not. More...

virtual Amg::Vector2D	localParametersToPosition (const LocalParameters &locpars) const override final
	Specialized for DiscSurface : LocalParameters to Vector2D. More...

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. More...

Amg::Vector3D	localToGlobal (const Amg::Vector2D &locpos) const
	This method returns the GlobalPosition from a LocalPosition uses the per surface localToGlobal. More...

Amg::Vector3D	localToGlobal (const Amg::Vector2D &locpos, const Amg::Vector3D &glomom) const
	This method returns the GlobalPosition from a LocalPosition The LocalPosition can be outside Surface bounds - for generality with momentum. More...

Amg::Vector3D	localToGlobal (const LocalParameters &locpars) const
	This method returns the GlobalPosition from LocalParameters The LocalParameters can be outside Surface bounds. More...

Amg::Vector3D	localToGlobal (const LocalParameters &locpars, const Amg::Vector3D &glomom) const
	This method returns the GlobalPosition from LocalParameters The LocalParameters can be outside Surface bounds - for generality with momentum. More...

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 if on surface. More...

std::optional< Amg::Vector2D >	globalToLocal (const Amg::Vector3D &glopos, double tol=0.) const
	This method returns the LocalPosition from a provided GlobalPosition. More...

std::optional< Amg::Vector2D >	globalToLocal (const Amg::Vector3D &glopos, const Amg::Vector3D &glomom) const
	This method returns the LocalPosition from a provided GlobalPosition. More...

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 length forceDir is to provide the closest forward solution More...

template<class T >
Intersection	straightLineIntersection (const T &pars, bool forceDir=false, const Trk::BoundaryCheck &bchk=false) const
	fst straight line intersection schema - templated for charged and neutral parameters More...

virtual DistanceSolution	straightLineDistanceEstimate (const Amg::Vector3D &pos, const Amg::Vector3D &dir) const override
	fast straight line distance evaluation to Surface More...

virtual DistanceSolution	straightLineDistanceEstimate (const Amg::Vector3D &pos, const Amg::Vector3D &dir, bool Bound) const override
	fast straight line distance evaluation to Surface - with bound option More...

bool	operator!= (const Surface &sf) const
	Non-equality operator. More...

std::unique_ptr< Surface >	uniqueClone () const
	NVI method returning unique_ptr clone. More...

const Amg::Transform3D *	cachedTransform () const
	Return the cached transformation directly. More...

const Amg::Transform3D &	transform () const
	Returns HepGeom::Transform3D by reference. More...

const Amg::Vector3D &	center () const
	Returns the center position of the Surface. More...

virtual const Amg::Vector3D &	normal () const
	Returns the normal vector of the Surface (i.e. More...

virtual Amg::Vector3D	normal (const Amg::Vector2D &lp) const
	Returns a normal vector at a specific local position. More...

const TrkDetElementBase *	associatedDetectorElement () const
	return associated Detector Element More...

Identifier	associatedDetectorElementIdentifier () const
	return Identifier of the associated Detector Element More...

const Trk::Layer *	associatedLayer () const
	return the associated Layer More...

const Trk::Layer *	materialLayer () const
	return the material Layer More...

Trk::Layer *	materialLayer ()

virtual const Trk::Surface *	baseSurface () const
	return the base surface (simplified for persistification) More...

std::optional< Amg::Vector2D >	positionOnSurface (const Amg::Vector3D &glopo, const BoundaryCheck &bchk=true, double tol1=0., double tol2=0.) const
	positionOnSurface() returns the LocalPosition on the Surface, If BoundaryCheck==false it just returns the value of globalToLocal (including nullptr possibility), if BoundaryCheck==true it checks whether the point is inside bounds or not (returns std::nullopt in this case). More...

template<class T >
bool	onSurface (const T &parameters, const BoundaryCheck &bchk=BoundaryCheck(true)) const
	The templated Parameters OnSurface method - checks on surface pointer first. More...

virtual double	pathCorrection (const Amg::Vector3D &pos, const Amg::Vector3D &mom) const
	the pathCorrection for derived classes with thickness - it reflects if the direction projection is positive or negative More...

virtual Amg::RotationMatrix3D	measurementFrame (const Amg::Vector3D &glopos, const Amg::Vector3D &glomom) const
	Return the measurement frame - this is needed for alignment, in particular for StraightLine and Perigee Surface. More...

bool	isFree () const
	Returns 'true' if this surface is 'free', i.e. More...

bool	isActive () const
	Return 'true' if this surface is owned by the detector element. More...

void	setTransform (const Amg::Transform3D &trans)
	Set the transform updates center and normal. More...

void	setOwner (SurfaceOwner x)
	set Ownership More...

SurfaceOwner	owner () const
	return ownership More...

void	setMaterialLayer (std::shared_ptr< Layer > mlay)
	set material layer More...

virtual MsgStream &	dump (MsgStream &sl) const
	Output Method for MsgStream, to be overloaded by child classes. More...

virtual std::ostream &	dump (std::ostream &sl) const
	Output Method for std::ostream, to be overloaded by child classes. More...

void	associateLayer (const Layer &lay)
	method to associate the associated Trk::Layer which is alreay owned More...

Static Public Member Functions
static std::size_t	numberOfInstantiations ()

Static Public Attributes
static constexpr SurfaceType	staticType = SurfaceType::Disc

static std::atomic_size_t	s_numberOfInstantiations

Protected Member Functions
Amg::Transform3D	inverseTransformHelper () const
	Helper method to factorize in one place common operations calculate inverse transofrm and multiply with position. More...

Amg::Vector3D	inverseTransformMultHelper (const Amg::Vector3D &glopos) const

Protected Attributes
SharedObject< AreaExcluder >	m_subtrVol

bool	m_shared

SharedObject< const SurfaceBounds >	m_bounds
	reference Point on the Surface More...

CxxUtils::CachedUniquePtr< Amg::Vector3D >	m_referencePoint
	static member for boundless approach More...

std::unique_ptr< Transforms >	m_transforms {}

const TrkDetElementBase *	m_associatedDetElement {}
	Not owning Pointer to the TrkDetElementBase. More...

Identifier	m_associatedDetElementId {}
	Identifier for the TrkDetElementBase. More...

const Layer *	m_associatedLayer {}
	The associated layer Trk::Layer. More...

std::shared_ptr< Layer >	m_materialLayer {}
	Possibility to attach a material descrption. More...

SurfaceOwner	m_owner {SurfaceOwner::noOwn}
	enum for surface owner : 0 free surface More...

Static Protected Attributes
static const NoBounds	s_boundless

static constexpr double	s_onSurfaceTolerance = 10e-5
	Tolerance for being on Surface. More...

Detailed Description

Class for a planar subtracted/shared surface in the ATLAS detector. It owns its surface bounds and subtracted volume.

Author: Sarka.nosp@m..Tod.nosp@m.orova.nosp@m.@cer.nosp@m.n.ch

Definition at line 32 of file SubtractedDiscSurface.h.

Member Typedef Documentation

◆ ChargedTrackParametersUniquePtr

using Trk::Surface::ChargedTrackParametersUniquePtr = std::unique_ptr<ParametersBase<5, Trk::Charged> >

inherited

Unique ptr types.

Definition at line 124 of file Tracking/TrkDetDescr/TrkSurfaces/TrkSurfaces/Surface.h.

◆ NeutralTrackParametersUniquePtr

using Trk::Surface::NeutralTrackParametersUniquePtr = std::unique_ptr<ParametersBase<5, Trk::Neutral> >

inherited

Definition at line 126 of file Tracking/TrkDetDescr/TrkSurfaces/TrkSurfaces/Surface.h.

Constructor & Destructor Documentation

◆ SubtractedDiscSurface() [1/4]

Trk::SubtractedDiscSurface::SubtractedDiscSurface ( )

Default Constructor - needed for persistency.

Definition at line 18 of file SubtractedDiscSurface.cxx.

   : Trk::DiscSurface()
   , m_subtrVol()
   , m_shared(true)
 {}

◆ SubtractedDiscSurface() [2/4]

Trk::SubtractedDiscSurface::SubtractedDiscSurface ( const SubtractedDiscSurface & psf )

default

Copy Constructor.

◆ SubtractedDiscSurface() [3/4]

Trk::SubtractedDiscSurface::SubtractedDiscSurface	(	const SubtractedDiscSurface &	psf,
		const Amg::Transform3D &	shift
	)

Copy Constructor.

Definition at line 30 of file SubtractedDiscSurface.cxx.

   : Trk::DiscSurface(psf, shift)
   , m_subtrVol(psf.m_subtrVol)
   , m_shared(psf.m_shared)
 {}

◆ SubtractedDiscSurface() [4/4]

Trk::SubtractedDiscSurface::SubtractedDiscSurface	(	const DiscSurface &	ps,
		AreaExcluder *	vol,
		bool	shared
	)

Constructor.

Definition at line 37 of file SubtractedDiscSurface.cxx.

   : Trk::DiscSurface(ps)
   , m_subtrVol(Trk::SharedObject<AreaExcluder>(vol))
   , m_shared(shared)
 {}

◆ ~SubtractedDiscSurface()

Trk::SubtractedDiscSurface::~SubtractedDiscSurface ( )

virtualdefault

Destructor.

Member Function Documentation

◆ associatedDetectorElement()

const TrkDetElementBase* Trk::Surface::associatedDetectorElement ( ) const

inherited

return associated Detector Element

◆ associatedDetectorElementIdentifier()

Identifier Trk::Surface::associatedDetectorElementIdentifier ( ) const

inherited

return Identifier of the associated Detector Element

◆ associatedLayer()

const Trk::Layer* Trk::Surface::associatedLayer ( ) const

inherited

return the associated Layer

◆ associateLayer()

void Trk::Surface::associateLayer ( const Layer & lay )

inherited

method to associate the associated Trk::Layer which is alreay owned

only allowed by LayerBuilder
only done if no Layer is set already

◆ baseSurface()

virtual const Trk::Surface* Trk::Surface::baseSurface ( ) const

virtualinherited

return the base surface (simplified for persistification)

◆ bounds()

const SurfaceBounds& Trk::DiscSurface::bounds ( ) const

finaloverridevirtualinherited

This method returns the bounds by reference.

Implements Trk::Surface.

◆ cachedTransform()

const Amg::Transform3D* Trk::Surface::cachedTransform ( ) const

inherited

Return the cached transformation directly.

Don't try to make a new transform if it's not here.

◆ center()

const Amg::Vector3D& Trk::Surface::center ( ) const

inherited

Returns the center position of the Surface.

◆ clone()

virtual DiscSurface* Trk::DiscSurface::clone ( ) const

overridevirtualinherited

Virtual constructor.

Implements Trk::Surface.

Reimplemented in Trk::SlidingDiscSurface.

◆ createUniqueNeutralParameters() [1/2]

Trk::Surface::NeutralTrackParametersUniquePtr Trk::DiscSurface::createUniqueNeutralParameters	(	const Amg::Vector3D &	position,
		const Amg::Vector3D &	momentum,
		double	charge,
		std::optional< AmgSymMatrix(5)>	cov = `std::nullopt`
	)		const

finaloverridevirtualinherited

Use the Surface as a ParametersBase constructor, from global parameters - neutral.

Implements Trk::Surface.

Definition at line 200 of file DiscSurface.cxx.

                                             {
   return std::make_unique<ParametersT<5, Neutral, DiscSurface>>(
       position, momentum, charge, *this, std::move(cov));
 }

◆ createUniqueNeutralParameters() [2/2]

Trk::Surface::NeutralTrackParametersUniquePtr Trk::DiscSurface::createUniqueNeutralParameters	(	double	l1,
		double	l2,
		double	phi,
		double	theta,
		double	qop,
		std::optional< AmgSymMatrix(5)>	cov = `std::nullopt`
	)		const

finaloverridevirtualinherited

Use the Surface as a ParametersBase constructor, from local parameters - neutral.

Implements Trk::Surface.

Definition at line 190 of file DiscSurface.cxx.

                                             {
   return std::make_unique<ParametersT<5, Neutral, DiscSurface>>(
       l1, l2, phi, theta, qop, *this, std::move(cov));
 }

◆ createUniqueParameters() [1/2]

template<int DIM, class T >

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

inherited

Use the Surface as a ParametersBase constructor, from global parameters.

◆ createUniqueParameters() [2/2]

template<int DIM, class T >

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

inherited

Use the Surface as a ParametersBase constructor, from local parameters.

◆ createUniqueTrackParameters() [1/2]

Trk::Surface::ChargedTrackParametersUniquePtr Trk::DiscSurface::createUniqueTrackParameters	(	const Amg::Vector3D &	position,
		const Amg::Vector3D &	momentum,
		double	charge,
		std::optional< AmgSymMatrix(5)>	cov = `std::nullopt`
	)		const

finaloverridevirtualinherited

Use the Surface as a ParametersBase constructor, from global parameters - charged.

Implements Trk::Surface.

Definition at line 180 of file DiscSurface.cxx.

                                             {
   return std::make_unique<ParametersT<5, Charged, DiscSurface>>(
       position, momentum, charge, *this, std::move(cov));
 }

◆ createUniqueTrackParameters() [2/2]

Trk::Surface::ChargedTrackParametersUniquePtr Trk::DiscSurface::createUniqueTrackParameters	(	double	l1,
		double	l2,
		double	phi,
		double	theta,
		double	qop,
		std::optional< AmgSymMatrix(5)>	cov = `std::nullopt`
	)		const

finaloverridevirtualinherited

Use the Surface as a ParametersBase constructor, from local parameters - charged.

Implements Trk::Surface.

Definition at line 171 of file DiscSurface.cxx.

                                             {
   return std::make_unique<ParametersT<5, Charged, DiscSurface>>(
       l1, l2, phi, theta, qop, *this, std::move(cov));
 }

◆ dump() [1/2]

MsgStream & Surface::dump ( MsgStream & sl ) const

virtualinherited

Output Method for MsgStream, to be overloaded by child classes.

Reimplemented in Trk::PerigeeSurface, and Trk::DetElementSurface.

Definition at line 143 of file Surface.cxx.

 {
   sl << std::setiosflags(std::ios::fixed);
   sl << std::setprecision(4);
   sl << name() << std::endl;
   if (associatedDetectorElement()!=nullptr){
     sl<<"     Detector Type              = "<<associatedDetectorElement()->detectorTypeString()<<std::endl;
   }
   sl << "     Center position  (x, y, z) = (" << center().x() << ", " << center().y() << ", " << center().z() << ")"
      << std::endl;
   Amg::RotationMatrix3D rot(transform().rotation());
   Amg::Vector3D rotX(rot.col(0));
   Amg::Vector3D rotY(rot.col(1));
   Amg::Vector3D rotZ(rot.col(2));
   sl << std::setprecision(6);
   sl << "     Rotation:             colX = (" << rotX(0) << ", " << rotX(1) << ", " << rotX(2) << ")" << std::endl;
   sl << "                           colY = (" << rotY(0) << ", " << rotY(1) << ", " << rotY(2) << ")" << std::endl;
   sl << "                           colZ = (" << rotZ(0) << ", " << rotZ(1) << ", " << rotZ(2) << ")" << std::endl;
   sl << "     Bounds  : " << bounds();
   sl << std::setprecision(-1);
   return sl;
 }

◆ dump() [2/2]

std::ostream & Surface::dump ( std::ostream & sl ) const

virtualinherited

Output Method for std::ostream, to be overloaded by child classes.

Reimplemented in Trk::PerigeeSurface, and Trk::DetElementSurface.

Definition at line 168 of file Surface.cxx.

 {
   sl << std::setiosflags(std::ios::fixed);
   sl << std::setprecision(4);
   sl << name() << std::endl;
   if (associatedDetectorElement()!=nullptr){
     sl<<"     Detector Type              = "<<associatedDetectorElement()->detectorTypeString()<<std::endl;
   }
   sl << "     Center position  (x, y, z) = (" << center().x() << ", " << center().y() << ", " << center().z() << ")"
      << std::endl;
   Amg::RotationMatrix3D rot(transform().rotation());
   Amg::Vector3D rotX(rot.col(0));
   Amg::Vector3D rotY(rot.col(1));
   Amg::Vector3D rotZ(rot.col(2));
   sl << std::setprecision(6);
   sl << "     Rotation:             colX = (" << rotX(0) << ", " << rotX(1) << ", " << rotX(2) << ")" << std::endl;
   sl << "                           colY = (" << rotY(0) << ", " << rotY(1) << ", " << rotY(2) << ")" << std::endl;
   sl << "                           colZ = (" << rotZ(0) << ", " << rotZ(1) << ", " << rotZ(2) << ")" << std::endl;
   sl << "     Bounds  : " << bounds();
   sl << std::setprecision(-1);
   return sl;
 }

◆ globalReferencePoint()

const Amg::Vector3D & Trk::DiscSurface::globalReferencePoint ( ) const

finaloverridevirtualinherited

Returns a global reference point: For the Disc this is \( (R*cos(\phi), R*sin(\phi),0)*transform() \) Where \( r, \phi \) denote the r(), averagePhi() of the Bounds.

Reimplemented from Trk::Surface.

Definition at line 208 of file DiscSurface.cxx.

 {
   if (!m_referencePoint) {
     const Trk::DiscBounds* dbo =
       dynamic_cast<const Trk::DiscBounds*>(&(bounds()));
     if (dbo) {
       double rMedium = bounds().r();
       double phi = dbo->averagePhi();
       Amg::Vector3D gp(rMedium * cos(phi), rMedium * sin(phi), 0.);
       m_referencePoint.set(std::make_unique<Amg::Vector3D>(transform() * gp));
     } else {
       const Trk::DiscTrapezoidalBounds* dtbo =
         dynamic_cast<const Trk::DiscTrapezoidalBounds*>(&(bounds()));
       // double rMedium = dtbo ? bounds().r() : dtbo->rCenter() ; //nonsense, or
       // logic inverted?
       double rMedium = bounds().r();
       double phi = dtbo ? dtbo->averagePhi() : 0.;
       Amg::Vector3D gp(rMedium * cos(phi), rMedium * sin(phi), 0.);
       m_referencePoint.set(std::make_unique<Amg::Vector3D>(transform() * gp));
     }
   }
   return (*m_referencePoint);
 }

◆ globalToLocal() [1/3]

bool Trk::DiscSurface::globalToLocal	(	const Amg::Vector3D &	glob,
		const Amg::Vector3D &	mom,
		Amg::Vector2D &	loc
	)		const

overridevirtualinherited

Specialized for DiscSurface: GlobalToLocal method without dynamic memory allocation - boolean checks if on surface.

local<->global transformation in case of polar local coordinates

Implements Trk::Surface.

Reimplemented in Trk::SlidingDiscSurface.

Definition at line 249 of file DiscSurface.cxx.

 {
   Amg::Vector3D loc3Dframe = inverseTransformMultHelper(glopos);
   locpos = Amg::Vector2D(loc3Dframe.perp(), loc3Dframe.phi());
   return (std::fabs(loc3Dframe.z()) <= s_onSurfaceTolerance);
 }

◆ globalToLocal() [2/3]

std::optional<Amg::Vector2D> Trk::Surface::globalToLocal	(	const Amg::Vector3D &	glopos,
		const Amg::Vector3D &	glomom
	)		const

inherited

This method returns the LocalPosition from a provided GlobalPosition.

If the GlobalPosition is not on the Surface, it returns a nullopt This method does not check if the calculated LocalPosition is inside surface bounds. If this check is needed, use positionOnSurface - for generality with momentum

◆ globalToLocal() [3/3]

std::optional<Amg::Vector2D> Trk::Surface::globalToLocal	(	const Amg::Vector3D &	glopos,
		double	tol = `0.`
	)		const

inherited

This method returns the LocalPosition from a provided GlobalPosition.

If the GlobalPosition is not on the Surface, it returns nullopt This method does not check if the calculated LocalPosition is inside surface bounds. If this check is needed, use positionOnSurface - only for planar, cylinder surface fully defined

◆ insideBounds()

bool Trk::SubtractedDiscSurface::insideBounds	(	const Amg::Vector2D &	locpos,
		double	tol1 = `0.`,
		double	tol2 = `0.`
	)		const

inlinefinaloverridevirtual

This method calls the inside() method of the Bounds.

Reimplemented from Trk::DiscSurface.

Definition at line 80 of file SubtractedDiscSurface.h.

 {
   // no subtracted Volume exists
   if (!m_subtrVol.get()) {
     return (this->bounds().inside(locpos, tol1, tol2));
   }
   // subtracted Volume exists, needs to be checked
   double rPos = locpos[Trk::locR];
   double phiPos = locpos[Trk::locPhi];
   Amg::Vector3D gp(rPos * cos(phiPos), rPos * sin(phiPos), 0.);
   if (m_shared) {
     return (this->bounds().inside(locpos, tol1, tol2) &&
             m_subtrVol.get()->inside(gp, 0.));
   }
   bool in(this->bounds().inside(locpos, tol1, tol2) &&
           !m_subtrVol.get()->inside(gp, 0.));
  
   return in;
 }

◆ insideBoundsCheck()

virtual bool Trk::DiscSurface::insideBoundsCheck	(	const Amg::Vector2D &	locpos,
		const BoundaryCheck &	bchk
	)		const

finaloverridevirtualinherited

Implements Trk::Surface.

◆ inverseTransformHelper()

Amg::Transform3D Trk::Surface::inverseTransformHelper ( ) const

protectedinherited

Helper method to factorize in one place common operations calculate inverse transofrm and multiply with position.

◆ inverseTransformMultHelper()

Amg::Vector3D Trk::Surface::inverseTransformMultHelper ( const Amg::Vector3D & glopos ) const

protectedinherited

◆ isActive()

bool Trk::Surface::isActive ( ) const

inherited

Return 'true' if this surface is owned by the detector element.

◆ isFree()

bool Trk::Surface::isFree ( ) const

inherited

Returns 'true' if this surface is 'free', i.e.

it does not belong to a detector element (and returns false otherwise

◆ isOnSurface()

bool Trk::DiscSurface::isOnSurface	(	const Amg::Vector3D &	glopo,
		const BoundaryCheck &	bchk = `true`,
		double	tol1 = `0.`,
		double	tol2 = `0.`
	)		const

overridevirtualinherited

This method returns true if the GlobalPosition is on the Surface for both, within or without check of whether the local position is inside boundaries or not.

Reimplemented from Trk::Surface.

Reimplemented in Trk::SlidingDiscSurface.

Definition at line 286 of file DiscSurface.cxx.

 {
   Amg::Vector3D loc3Dframe = inverseTransformMultHelper(glopo);
   if (std::abs(loc3Dframe.z()) > (s_onSurfaceTolerance + tol1)) {
     return false;
   }
   return (bchk
             ? bounds().inside(
                 Amg::Vector2D(loc3Dframe.perp(), loc3Dframe.phi()), tol1, tol2)
             : true);
 }

◆ localParametersToPosition()

virtual Amg::Vector2D Trk::DiscSurface::localParametersToPosition ( const LocalParameters & locpars ) const

finaloverridevirtualinherited

Specialized for DiscSurface : LocalParameters to Vector2D.

Reimplemented from Trk::Surface.

◆ localToGlobal() [1/5]

ATH_FLATTEN void Trk::DiscSurface::localToGlobal	(	const Amg::Vector2D &	locp,
		const Amg::Vector3D &	mom,
		Amg::Vector3D &	glob
	)		const

overridevirtualinherited

Specialized for DiscSurface: LocalToGlobal method without dynamic memory allocation.

Implements Trk::Surface.

Reimplemented in Trk::SlidingDiscSurface.

Definition at line 235 of file DiscSurface.cxx.

 {
   // create the position in the local 3d frame
   Amg::Vector3D loc3Dframe(locpos[Trk::locR] * cos(locpos[Trk::locPhi]),
                            locpos[Trk::locR] * sin(locpos[Trk::locPhi]),
                            0.);
   // transport it to the globalframe
   glopos = transform() * loc3Dframe;
 }

◆ localToGlobal() [2/5]

Amg::Vector3D Trk::Surface::localToGlobal ( const Amg::Vector2D & locpos ) const

inherited

This method returns the GlobalPosition from a LocalPosition uses the per surface localToGlobal.

◆ localToGlobal() [3/5]

Amg::Vector3D Trk::Surface::localToGlobal	(	const Amg::Vector2D &	locpos,
		const Amg::Vector3D &	glomom
	)		const

inherited

This method returns the GlobalPosition from a LocalPosition The LocalPosition can be outside Surface bounds - for generality with momentum.

◆ localToGlobal() [4/5]

Amg::Vector3D Trk::Surface::localToGlobal ( const LocalParameters & locpars ) const

inherited

This method returns the GlobalPosition from LocalParameters The LocalParameters can be outside Surface bounds.

◆ localToGlobal() [5/5]

Amg::Vector3D Trk::Surface::localToGlobal	(	const LocalParameters &	locpars,
		const Amg::Vector3D &	glomom
	)		const

inherited

This method returns the GlobalPosition from LocalParameters The LocalParameters can be outside Surface bounds - for generality with momentum.

◆ materialLayer() [1/2]

Trk::Layer* Trk::Surface::materialLayer ( )

inherited

◆ materialLayer() [2/2]

const Trk::Layer* Trk::Surface::materialLayer ( ) const

inherited

return the material Layer

◆ measurementFrame()

Amg::RotationMatrix3D Surface::measurementFrame	(	const Amg::Vector3D &	glopos,
		const Amg::Vector3D &	glomom
	)		const

virtualinherited

Return the measurement frame - this is needed for alignment, in particular for StraightLine and Perigee Surface.

the default implementation is the the RotationMatrix3D of the transform

Reimplemented in Trk::CylinderSurface, Trk::ConeSurface, Trk::StraightLineSurface, and Trk::PerigeeSurface.

Definition at line 135 of file Surface.cxx.

 {
   return transform().rotation();
 }

◆ name()

virtual std::string Trk::SubtractedDiscSurface::name ( ) const

inlinefinaloverridevirtual

Return properly formatted class name for screen output.

Reimplemented from Trk::DiscSurface.

Definition at line 69 of file SubtractedDiscSurface.h.

   {
     return "Trk::SubtractedDiscSurface";
   }

◆ normal() [1/2]

virtual const Amg::Vector3D& Trk::Surface::normal ( ) const

virtualinherited

Returns the normal vector of the Surface (i.e.

in generall z-axis of rotation)

Reimplemented in Trk::PerigeeSurface.

◆ normal() [2/2]

virtual Amg::Vector3D Trk::Surface::normal ( const Amg::Vector2D & lp ) const

virtualinherited

Returns a normal vector at a specific local position.

Reimplemented in Trk::PerigeeSurface, Trk::CylinderSurface, and Trk::ConeSurface.

◆ numberOfInstantiations()

static std::size_t Trk::ObjectCounter< Trk::Surface >::numberOfInstantiations ( )

inlinestaticinherited

Definition at line 25 of file TrkObjectCounter.h.

   {
 #ifndef NDEBUG
     return s_numberOfInstantiations.load();
 #endif
     return 0;
   }

◆ onSurface()

template<class T >

bool Trk::Surface::onSurface	(	const T &	parameters,
		const BoundaryCheck &	bchk = `BoundaryCheck(true)`
	)		const

inherited

The templated Parameters OnSurface method - checks on surface pointer first.

◆ operator!=()

bool Trk::Surface::operator!= ( const Surface & sf ) const

inherited

Non-equality operator.

◆ operator=()

Trk::SubtractedDiscSurface & Trk::SubtractedDiscSurface::operator= ( const SubtractedDiscSurface & psf )

Assignment operator.

Definition at line 47 of file SubtractedDiscSurface.cxx.

 {
  
   if (this != &psf) {
     Trk::DiscSurface::operator=(psf);
     m_subtrVol = psf.m_subtrVol;
     m_shared = psf.m_shared;
   }
   return *this;
 }

◆ operator==() [1/2]

bool Trk::DiscSurface::operator== ( const DiscSurface & cf ) const

inherited

◆ operator==() [2/2]

bool Trk::SubtractedDiscSurface::operator== ( const Surface & sf ) const

overridevirtual

Equality operator.

Reimplemented from Trk::DiscSurface.

Definition at line 59 of file SubtractedDiscSurface.cxx.

 {
   // first check the type not to compare apples with oranges
   const Trk::SubtractedDiscSurface* sdsf = dynamic_cast<const Trk::SubtractedDiscSurface*>(&sf);
   if (!sdsf)
     return false;
   bool surfaceEqual = Trk::DiscSurface::operator==(sf);
   bool sharedEqual = (surfaceEqual) ? (shared() == sdsf->shared()) : false;
   return sharedEqual;
 }

◆ owner()

SurfaceOwner Trk::Surface::owner ( ) const

inherited

return ownership

◆ pathCorrection()

virtual double Trk::Surface::pathCorrection	(	const Amg::Vector3D &	pos,
		const Amg::Vector3D &	mom
	)		const

virtualinherited

the pathCorrection for derived classes with thickness - it reflects if the direction projection is positive or negative

Reimplemented in Trk::CylinderSurface, Trk::StraightLineSurface, Trk::PerigeeSurface, and Trk::ConeSurface.

◆ positionOnSurface()

std::optional< Amg::Vector2D > Surface::positionOnSurface	(	const Amg::Vector3D &	glopo,
		const BoundaryCheck &	bchk = `true`,
		double	tol1 = `0.`,
		double	tol2 = `0.`
	)		const

inherited

positionOnSurface() returns the LocalPosition on the Surface,
If BoundaryCheck==false it just returns the value of globalToLocal (including nullptr possibility), if BoundaryCheck==true it checks whether the point is inside bounds or not (returns std::nullopt in this case).

Definition at line 106 of file Surface.cxx.

 {
   std::optional<Amg::Vector2D> posOnSurface = globalToLocal(glopo, tol1);
   if (!bchk){
     return posOnSurface;
   }
   if (posOnSurface && insideBounds(*posOnSurface, tol1, tol2)){
     return posOnSurface;
   }
   return std::nullopt;
 }

◆ setMaterialLayer()

void Trk::Surface::setMaterialLayer ( std::shared_ptr< Layer > mlay )

inherited

set material layer

◆ setOwner()

void Trk::Surface::setOwner ( SurfaceOwner x )

inherited

set Ownership

◆ setTransform()

void Trk::Surface::setTransform ( const Amg::Transform3D & trans )

inherited

Set the transform updates center and normal.

◆ shared()

bool Trk::SubtractedDiscSurface::shared ( ) const

inline

This method indicates the subtraction mode.

Definition at line 103 of file SubtractedDiscSurface.h.

 {
   return m_shared;
 }

◆ straightLineDistanceEstimate() [1/2]

Trk::DistanceSolution Trk::DiscSurface::straightLineDistanceEstimate	(	const Amg::Vector3D &	pos,
		const Amg::Vector3D &	dir
	)		const

overridevirtualinherited

fast straight line distance evaluation to Surface

distance to surface

Implements Trk::Surface.

Reimplemented in Trk::SlidingDiscSurface.

Definition at line 303 of file DiscSurface.cxx.

 {
   double tol = 0.001;
  
   const Amg::Vector3D& C = center();
   const Amg::Vector3D& N = normal();
  
   double S = C.dot(N);
   double b = S < 0. ? -1 : 1;
   double d = (pos - C).dot(N); // distance to surface
  
   double A = b * dir.dot(N);
   if (A == 0.) { // direction parallel to surface
     if (fabs(d) < tol) {
       return {1, 0., true, 0.};
     }
     return {0, d, true, 0.};
   }
  
   double D = b * (S - (pos.dot(N))) / A;
   return {1, d, true, D};
 }

◆ straightLineDistanceEstimate() [2/2]

Trk::DistanceSolution Trk::DiscSurface::straightLineDistanceEstimate	(	const Amg::Vector3D &	pos,
		const Amg::Vector3D &	dir,
		bool	Bound
	)		const

overridevirtualinherited

fast straight line distance evaluation to Surface - with bound option

Implements Trk::Surface.

Reimplemented in Trk::SlidingDiscSurface.

Definition at line 328 of file DiscSurface.cxx.

 {
   const Amg::Transform3D& T = transform();
   const double Az[3] = { T(0, 2), T(1, 2), T(2, 2) };
  
   // Transformation to cylinder system coordinates
   //
   const double dx = pos[0] - T(0, 3);
   const double dy = pos[1] - T(1, 3);
   const double dz = pos[2] - T(2, 3);
   const double z = dx * Az[0] + dy * Az[1] + dz * Az[2];
   const double az = dir[0] * Az[0] + dir[1] * Az[1] + dir[2] * Az[2];
  
   // Step to surface
   //
   int ns = 0;
   double s = 0.;
   if (az != 0.) {
     s = -z / az;
     ns = 1;
   }
   double dist = std::abs(z);
   if (!bound) {
     return {ns, dist, true, s};
   }
  
   // Min distance to surface
   //
   const double x = dx * T(0, 0) + dy * T(1, 0) + dz * T(2, 0);
   const double y = dx * T(0, 1) + dy * T(1, 1) + dz * T(2, 1);
  
   Amg::Vector2D lp(sqrt(x * x + y * y), atan2(y, x));
  
   double d = bounds().minDistance(lp);
   if (d > 0.) {
     dist = std::sqrt(dist * dist + d * d);
   }
  
   return {ns, dist, true, s};
 }

◆ straightLineIntersection() [1/2]

Trk::Intersection Trk::DiscSurface::straightLineIntersection	(	const Amg::Vector3D &	pos,
		const Amg::Vector3D &	dir,
		bool	forceDir = `false`,
		Trk::BoundaryCheck	bchk = `false`
	)		const

finaloverridevirtualinherited

fast straight line intersection schema - standard: provides closest intersection and (signed) path length forceDir is to provide the closest forward solution

mathematical motivation:

the equation of the plane is given by:
\( \vec n \cdot \vec x = \vec n \cdot \vec p,\)
where \( \vec n = (n_{x}, n_{y}, n_{z})\) denotes the normal vector of the plane, \( \vec p = (p_{x}, p_{y}, p_{z})\) one specific point on the plane and \( \vec x = (x,y,z) \) all possible points on the plane.
Given a line with:
\( \vec l(u) = \vec l_{1} + u \cdot \vec v \),
the solution for \( u \) can be written: \( u = \frac{\vec n (\vec p - \vec l_{1})}{\vec n \vec v}\)
If the denominator is 0 then the line lies:

either in the plane
perpenticular to the normal of the plane

Implements Trk::Surface.

Definition at line 259 of file DiscSurface.cxx.

                                                                         {
   double denom = dir.dot(normal());
   if (denom) {
     double u = (normal().dot((center() - pos))) / (denom);
     Amg::Vector3D intersectPoint(pos + u * dir);
     // evaluate the intersection in terms of direction
     bool isValid = forceDir ? (u > 0.) : true;
     // evaluate (if necessary in terms of boundaries)
     isValid = bchk ? (isValid && isOnSurface(intersectPoint)) : isValid;
     // return the result
     return Trk::Intersection(intersectPoint, u, isValid);
   }
   return Trk::Intersection(pos, 0., false);
 }

◆ straightLineIntersection() [2/2]

template<class T >

Intersection Trk::Surface::straightLineIntersection	(	const T &	pars,
		bool	forceDir = `false`,
		const Trk::BoundaryCheck &	bchk = `false`
	)		const

inlineinherited

fst straight line intersection schema - templated for charged and neutral parameters

Definition at line 351 of file Tracking/TrkDetDescr/TrkSurfaces/TrkSurfaces/Surface.h.

   {
     return straightLineIntersection(
       pars.position(), pars.momentum().unit(), forceDir, bchk);
   }

◆ subtractedVolume()

SharedObject< AreaExcluder > Trk::SubtractedDiscSurface::subtractedVolume ( ) const

inline

This method allows access to the subtracted part.

Definition at line 109 of file SubtractedDiscSurface.h.

 {
   return m_subtrVol;
 }

◆ transform()

const Amg::Transform3D& Trk::Surface::transform ( ) const

inherited

Returns HepGeom::Transform3D by reference.

◆ type()

constexpr virtual SurfaceType Trk::DiscSurface::type ( ) const

constexprfinaloverridevirtualinherited

Return the surface type.

Implements Trk::Surface.

◆ uniqueClone()

std::unique_ptr<Surface> Trk::Surface::uniqueClone ( ) const

inherited

NVI method returning unique_ptr clone.

Member Data Documentation

◆ m_associatedDetElement

const TrkDetElementBase* Trk::Surface::m_associatedDetElement {}

protectedinherited

Not owning Pointer to the TrkDetElementBase.

Definition at line 439 of file Tracking/TrkDetDescr/TrkSurfaces/TrkSurfaces/Surface.h.

◆ m_associatedDetElementId

Identifier Trk::Surface::m_associatedDetElementId {}

protectedinherited

Identifier for the TrkDetElementBase.

Definition at line 442 of file Tracking/TrkDetDescr/TrkSurfaces/TrkSurfaces/Surface.h.

◆ m_associatedLayer

const Layer* Trk::Surface::m_associatedLayer {}

protectedinherited

The associated layer Trk::Layer.

layer in which the Surface is embedded (not owning pointed)

Definition at line 448 of file Tracking/TrkDetDescr/TrkSurfaces/TrkSurfaces/Surface.h.

◆ m_bounds

SharedObject<const SurfaceBounds> Trk::DiscSurface::m_bounds

protectedinherited

reference Point on the Surface

Definition at line 285 of file DiscSurface.h.

◆ m_materialLayer

std::shared_ptr<Layer> Trk::Surface::m_materialLayer {}

protectedinherited

Possibility to attach a material descrption.

potentially given as the associated material layer (not owning pointer)

Definition at line 453 of file Tracking/TrkDetDescr/TrkSurfaces/TrkSurfaces/Surface.h.

◆ m_owner

SurfaceOwner Trk::Surface::m_owner {SurfaceOwner::noOwn}

protectedinherited

enum for surface owner : 0 free surface

Definition at line 455 of file Tracking/TrkDetDescr/TrkSurfaces/TrkSurfaces/Surface.h.

◆ m_referencePoint

CxxUtils::CachedUniquePtr<Amg::Vector3D> Trk::DiscSurface::m_referencePoint

protectedinherited

static member for boundless approach

Definition at line 287 of file DiscSurface.h.

◆ m_shared

bool Trk::SubtractedDiscSurface::m_shared

protected

Definition at line 76 of file SubtractedDiscSurface.h.

◆ m_subtrVol

SharedObject<AreaExcluder> Trk::SubtractedDiscSurface::m_subtrVol

protected

Definition at line 75 of file SubtractedDiscSurface.h.

◆ m_transforms

std::unique_ptr<Transforms> Trk::Surface::m_transforms {}

protectedinherited

Definition at line 436 of file Tracking/TrkDetDescr/TrkSurfaces/TrkSurfaces/Surface.h.

◆ s_boundless

const Trk::NoBounds Trk::DiscSurface::s_boundless

staticprotectedinherited

Definition at line 289 of file DiscSurface.h.

◆ s_numberOfInstantiations

std::atomic_size_t Trk::ObjectCounter< Trk::Surface >::s_numberOfInstantiations

inlinestaticinherited

Definition at line 22 of file TrkObjectCounter.h.

◆ s_onSurfaceTolerance

constexpr double Trk::Surface::s_onSurfaceTolerance = 10e-5

staticconstexprprotectedinherited

Tolerance for being on Surface.

Definition at line 458 of file Tracking/TrkDetDescr/TrkSurfaces/TrkSurfaces/Surface.h.

◆ staticType

constexpr SurfaceType Trk::DiscSurface::staticType = SurfaceType::Disc

staticconstexprinherited

Definition at line 57 of file DiscSurface.h.

The documentation for this class was generated from the following files:

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Typedef Documentation

◆ ChargedTrackParametersUniquePtr

◆ NeutralTrackParametersUniquePtr

Constructor & Destructor Documentation

◆ SubtractedDiscSurface() [1/4]

◆ SubtractedDiscSurface() [2/4]

◆ SubtractedDiscSurface() [3/4]

◆ SubtractedDiscSurface() [4/4]

◆ ~SubtractedDiscSurface()

Member Function Documentation

◆ associatedDetectorElement()

◆ associatedDetectorElementIdentifier()

◆ associatedLayer()

◆ associateLayer()

◆ baseSurface()

◆ bounds()

◆ cachedTransform()

◆ center()

◆ clone()

◆ createUniqueNeutralParameters() [1/2]

◆ createUniqueNeutralParameters() [2/2]

◆ createUniqueParameters() [1/2]

◆ createUniqueParameters() [2/2]

◆ createUniqueTrackParameters() [1/2]

◆ createUniqueTrackParameters() [2/2]

◆ dump() [1/2]

◆ dump() [2/2]

◆ globalReferencePoint()

◆ globalToLocal() [1/3]

◆ globalToLocal() [2/3]

◆ globalToLocal() [3/3]

◆ insideBounds()

◆ insideBoundsCheck()

◆ inverseTransformHelper()

◆ inverseTransformMultHelper()

◆ isActive()

◆ isFree()

◆ isOnSurface()

◆ localParametersToPosition()

◆ localToGlobal() [1/5]

◆ localToGlobal() [2/5]

◆ localToGlobal() [3/5]

◆ localToGlobal() [4/5]

◆ localToGlobal() [5/5]

◆ materialLayer() [1/2]

◆ materialLayer() [2/2]

◆ measurementFrame()

◆ name()

◆ normal() [1/2]

◆ normal() [2/2]

◆ numberOfInstantiations()

◆ onSurface()

◆ operator!=()

◆ operator=()

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ owner()

◆ pathCorrection()

◆ positionOnSurface()

◆ setMaterialLayer()

◆ setOwner()

◆ setTransform()

◆ shared()

◆ straightLineDistanceEstimate() [1/2]

◆ straightLineDistanceEstimate() [2/2]

◆ straightLineIntersection() [1/2]

◆ straightLineIntersection() [2/2]

◆ subtractedVolume()

◆ transform()

◆ type()

◆ uniqueClone()

Member Data Documentation