Trk::PlaneSurface Class Reference

Class for a planaer rectangular or trapezoidal surface in the ATLAS detector. More...

#include <PlaneSurface.h>

Inheritance diagram for Trk::PlaneSurface:

Collaboration diagram for Trk::PlaneSurface:

Public Types
using	ChargedTrackParametersUniquePtr
	Unique ptr types.
using	NeutralTrackParametersUniquePtr

Public Member Functions
	PlaneSurface ()
	Default Constructor - needed for persistency.
	PlaneSurface (const PlaneSurface &psf)=default
	Copy Constructor.
PlaneSurface &	operator= (const PlaneSurface &psf)=default
	Assignment operator.
	PlaneSurface (PlaneSurface &&psf) noexcept=default
	Move Constructor.
PlaneSurface &	operator= (PlaneSurface &&psf) noexcept=default
	Move assignment operator.
virtual	~PlaneSurface ()=default
	Destructor.
	PlaneSurface (const PlaneSurface &psf, const Amg::Transform3D &transf)
	Copy Constructor with shift.
	PlaneSurface (const Amg::Vector3D &position, const CurvilinearUVT &curvUVT)
	Dedicated Constructor with CurvilinearUVT class.
	PlaneSurface (const TrkDetElementBase &detelement, const Amg::Transform3D &transf)
	Constructor from TrkDetElementBase.
	PlaneSurface (const TrkDetElementBase &detelement)
	Constructor from TrkDetElementBase.
	PlaneSurface (const TrkDetElementBase &detelement, const Identifier &id, const Amg::Transform3D &transf)
	Constructor from TrkDetElementBase and Identifier in case one element holds more surfaces.
	PlaneSurface (const TrkDetElementBase &detelement, const Identifier &id)
	Constructor from TrkDetElementBase and Identifier in case one element holds more surfaces.
	PlaneSurface (const Amg::Transform3D &htrans)
	Constructor for planar Surface without Bounds , reference.
	PlaneSurface (const Amg::Transform3D &htrans, double halephi, double haleta)
	Constructor for Rectangular Planes.
	PlaneSurface (const Amg::Transform3D &htrans, double minhalephi, double maxhalephi, double haleta)
	Constructor for Trapezoidal Planes.
	PlaneSurface (const Amg::Transform3D &htrans, std::shared_ptr< const Trk::SurfaceBounds > sbounds)
	Constructor for Planes with shared object.
virtual bool	operator== (const Surface &sf) const override
	Equality operator.
bool	operator== (const PlaneSurface &cf) const
virtual PlaneSurface *	clone () const override
	Virtual constructor.
virtual constexpr SurfaceType	type () const override final
	Return the surface type.
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.
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.
virtual NeutralTrackParametersUniquePtr	createUniqueNeutralParameters (double l1, double l2, double phi, double theta, double oop, std::optional< AmgSymMatrix(5)> cov=std::nullopt) const override final
	Use the Surface as a ParametersBase constructor, from local parameters - neutral.
virtual NeutralTrackParametersUniquePtr	createUniqueNeutralParameters (const Amg::Vector3D &position, const Amg::Vector3D &momentum, double charge=0., std::optional< AmgSymMatrix(5)> cov=std::nullopt) const override final
	Use the Surface as a ParametersBase constructor, from global parameters.
template<int DIM, class T>
std::unique_ptr< ParametersT< DIM, T, PlaneSurface > >	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.
template<int DIM, class T>
std::unique_ptr< ParametersT< DIM, T, PlaneSurface > >	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.
virtual const SurfaceBounds &	bounds () const override final
	This method returns the bounds by reference, static NoBounds in case of no boundaries.
virtual bool	insideBounds (const Amg::Vector2D &locpos, double tol1=0., double tol2=0.) const override
	This method calls the inside() method of the Bounds.
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 final
	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.
virtual void	localToGlobal (const Amg::Vector2D &locp, const Amg::Vector3D &mom, Amg::Vector3D &glob) const override final
	Specified for PlaneSurface: LocalToGlobal method without dynamic memory allocation.
virtual bool	globalToLocal (const Amg::Vector3D &glob, const Amg::Vector3D &mom, Amg::Vector2D &loc) const override final
	Specified for PlaneSurface: GlobalToLocal method without dynamic memory allocation - boolean checks if on surface.
void	localToGlobalDirection (const Trk::LocalDirection &locdir, Amg::Vector3D &globdir) const
	This method transforms a local direction wrt the plane to a global direction.
void	globalToLocalDirection (const Amg::Vector3D &glodir, Trk::LocalDirection &locdir) const
	This method transforms the global direction to a local direction wrt the plane.
virtual Intersection	straightLineIntersection (const Amg::Vector3D &pos, const Amg::Vector3D &dir, bool forceDir, Trk::BoundaryCheck bchk) const override final
	fast straight line intersection schema - standard: provides closest intersection and (signed) path length forceDir is to provide the closest forward solution
virtual DistanceSolution	straightLineDistanceEstimate (const Amg::Vector3D &pos, const Amg::Vector3D &dir) const override final
	fast straight line distance evaluation to Surface
virtual DistanceSolution	straightLineDistanceEstimate (const Amg::Vector3D &pos, const Amg::Vector3D &dir, bool Bound) const override final
	fast straight line distance evaluation to Surface - with bound option
virtual std::string	name () const override
	Return properly formatted class name for screen output.
bool	operator!= (const Surface &sf) const
	Non-equality operator.
std::unique_ptr< Surface >	uniqueClone () const
	NVI method returning unique_ptr clone.
const Amg::Transform3D *	cachedTransform () const
	Return the cached transformation directly.
const Amg::Transform3D &	transform () const
	Returns HepGeom::Transform3D by reference.
const Amg::Vector3D &	center () const
	Returns the center position of the Surface.
virtual const Amg::Vector3D &	normal () const
	Returns the normal vector of the Surface (i.e.
virtual Amg::Vector3D	normal (const Amg::Vector2D &lp) const
	Returns a normal vector at a specific local position.
virtual const Amg::Vector3D &	globalReferencePoint () const
	Returns a global reference point on the surface, for PlaneSurface, StraightLineSurface, PerigeeSurface this is equal to center(), for CylinderSurface and DiscSurface this is a new member.
const TrkDetElementBase *	associatedDetectorElement () const
	return associated Detector Element
Identifier	associatedDetectorElementIdentifier () const
	return Identifier of the associated Detector Element
const Trk::Layer *	associatedLayer () const
	return the associated Layer
const Trk::MaterialLayer *	materialLayer () const
	return the material Layer
Trk::MaterialLayer *	materialLayer ()
virtual const Trk::Surface *	baseSurface () const
	return the base surface (simplified for persistification)
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).
template<class T>
bool	onSurface (const T &parameters, const BoundaryCheck &bchk=BoundaryCheck(true)) const
	The templated Parameters OnSurface method - checks on surface pointer first.
Amg::Vector3D	localToGlobal (const Amg::Vector2D &locpos) const
	This method returns the GlobalPosition from a LocalPosition uses the per surface localToGlobal.
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.
Amg::Vector3D	localToGlobal (const LocalParameters &locpars) const
	This method returns the GlobalPosition from LocalParameters The LocalParameters can be outside Surface bounds.
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.
std::optional< Amg::Vector2D >	globalToLocal (const Amg::Vector3D &glopos, double tol=0.) const
	This method returns the LocalPosition from a provided GlobalPosition.
std::optional< Amg::Vector2D >	globalToLocal (const Amg::Vector3D &glopos, const Amg::Vector3D &glomom) const
	This method returns the LocalPosition from a provided GlobalPosition.
virtual Amg::Vector2D	localParametersToPosition (const LocalParameters &locpars) const
	Optionally specified by each surface type : LocalParameters to Vector2D.
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
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.
template<typename 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
bool	isFree () const
	Returns 'true' if this surface is 'free', i.e.
bool	isActive () const
	Return 'true' if this surface is owned by the detector element.
void	setTransform (const Amg::Transform3D &trans)
	Set the transform updates center and normal.
void	setOwner (SurfaceOwner x)
	set Ownership
SurfaceOwner	owner () const
	return ownership
void	setMaterialLayer (std::shared_ptr< Trk::MaterialLayer > mlay)
	set material layer
virtual MsgStream &	dump (MsgStream &sl) const
	Output Method for MsgStream, to be overloaded by child classes.
virtual std::ostream &	dump (std::ostream &sl) const
	Output Method for std::ostream, to be overloaded by child classes.
void	associateLayer (const Layer &lay)
	method to associate a Trk::Layer.

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

Static Public Attributes
static constexpr SurfaceType	staticType = SurfaceType::Plane
	The surface type static constexpr.
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.
Amg::Vector3D	inverseTransformMultHelper (const Amg::Vector3D &glopos) const

Protected Attributes
std::shared_ptr< const SurfaceBounds >	m_bounds
	bounds (shared)
std::unique_ptr< Transforms >	m_transforms {}
	Unique Pointer to the Transforms struct.
const TrkDetElementBase *	m_associatedDetElement {}
	Not owning Pointer to the Detector Element.
Identifier	m_associatedDetElementId {}
	Identifier to the Detector Element.
const Layer *	m_associatedLayer {}
	The associated layer Trk::Layer This is the layer in which the Surface is embedded.
std::shared_ptr< MaterialLayer >	m_materialLayer {}
	Possibility to attach a material description to the surface.
SurfaceOwner	m_owner {SurfaceOwner::noOwn}
	enum for surface owner : default free surface

Static Protected Attributes
static const NoBounds	s_boundless
static constexpr double	s_onSurfaceTolerance = 10e-5
	Tolerance for being on Surface.

Friends
template<class SURFACE, class BOUNDS_CNV>
class	::BoundSurfaceCnv_p1
	< data members
template<class SURFACE, class BOUNDS_CNV>
class	::BoundSurfaceCnv_p2

Detailed Description

Class for a planaer rectangular or trapezoidal surface in the ATLAS detector.

It inherits from Surface.

The Trk::PlaneSurface extends the Surface class with the possibility to convert in addition to local to global positions, also local to global direction (vice versa). The definition with of a local direciton with respect to a plane can be found in the dedicated Trk::LocalDirection class of the TrkEventPrimitives package.

Author

Andre.nosp@m.as.S.nosp@m.alzbu.nosp@m.rger.nosp@m.@cern.nosp@m..ch

Christos Anastopoulos (Thread safety and interface cleanup)

Shaun Roe (interface cleanup)

Definition at line 63 of file PlaneSurface.h.

Member Typedef Documentation

ChargedTrackParametersUniquePtr

using Trk::Surface::ChargedTrackParametersUniquePtr

inherited

Initial value:

 
    std::unique_ptr<ParametersBase<5, Trk::Charged>>

Unique ptr types.

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

NeutralTrackParametersUniquePtr

using Trk::Surface::NeutralTrackParametersUniquePtr

inherited

Initial value:

 
    std::unique_ptr<ParametersBase<5, Trk::Neutral>>

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

Constructor & Destructor Documentation

PlaneSurface() [1/13]

Trk::PlaneSurface::PlaneSurface

(

)

Default Constructor - needed for persistency.

Definition at line 36 of file PlaneSurface.cxx.

  : Trk::Surface()
  , m_bounds(nullptr)
{}

PlaneSurface() [2/13]

Trk::PlaneSurface::PlaneSurface ( const PlaneSurface & psf )

default

Copy Constructor.

PlaneSurface() [3/13]

Trk::PlaneSurface::PlaneSurface ( PlaneSurface && psf )

defaultnoexcept

Move Constructor.

~PlaneSurface()

virtual Trk::PlaneSurface::~PlaneSurface ( )

virtualdefault

Destructor.

PlaneSurface() [4/13]

Trk::PlaneSurface::PlaneSurface	(	const PlaneSurface &	psf,
		const Amg::Transform3D &	transf )

Copy Constructor with shift.

Definition at line 43 of file PlaneSurface.cxx.

  : Trk::Surface(psf, transf)
  , m_bounds(psf.m_bounds)
{}

PlaneSurface() [5/13]

ATH_FLATTEN Trk::PlaneSurface::PlaneSurface	(	const Amg::Vector3D &	position,
		const CurvilinearUVT &	curvUVT )

Dedicated Constructor with CurvilinearUVT class.

Definition at line 55 of file PlaneSurface.cxx.

  : Trk::Surface()
  , m_bounds(nullptr) // curvilinear surfaces are boundless
{
  Amg::Translation3D curvilinearTranslation(position.x(), position.y(), position.z());
  // create the rotation
  Amg::RotationMatrix3D curvilinearRotation;
  curvilinearRotation.col(0) = curvUVT.curvU();
  curvilinearRotation.col(1) = curvUVT.curvV();
  curvilinearRotation.col(2) = curvUVT.curvT();
  Amg::Transform3D transform{};
  transform = curvilinearRotation;
  transform.pretranslate(position);
  Trk::Surface::m_transforms = std::make_unique<Transforms>(transform);
}

PlaneSurface() [6/13]

Trk::PlaneSurface::PlaneSurface	(	const TrkDetElementBase &	detelement,
		const Amg::Transform3D &	transf )

Constructor from TrkDetElementBase.

Definition at line 72 of file PlaneSurface.cxx.

  : Trk::Surface(detelement)
  , m_bounds(nullptr)
{
  Trk::Surface::m_transforms = std::make_unique<Transforms>(transf);
}

PlaneSurface() [7/13]

Trk::PlaneSurface::PlaneSurface

(

const TrkDetElementBase &

detelement

)

Constructor from TrkDetElementBase.

Definition at line 80 of file PlaneSurface.cxx.

  : Trk::Surface(detelement)
  , m_bounds(nullptr)
{
  //
}

PlaneSurface() [8/13]

Trk::PlaneSurface::PlaneSurface	(	const TrkDetElementBase &	detelement,
		const Identifier &	id,
		const Amg::Transform3D &	transf )

Constructor from TrkDetElementBase and Identifier in case one element holds more surfaces.

Definition at line 88 of file PlaneSurface.cxx.

  : Trk::Surface(detelement, id)
  , m_bounds(nullptr)
{
  Trk::Surface::m_transforms = std::make_unique<Transforms>(transf);
}

PlaneSurface() [9/13]

Trk::PlaneSurface::PlaneSurface	(	const TrkDetElementBase &	detelement,
		const Identifier &	id )

Constructor from TrkDetElementBase and Identifier in case one element holds more surfaces.

Definition at line 98 of file PlaneSurface.cxx.

  : Trk::Surface(detelement, id)
  , m_bounds(nullptr)
{
  //
}

PlaneSurface() [10/13]

Trk::PlaneSurface::PlaneSurface

(

const Amg::Transform3D &

htrans

)

Constructor for planar Surface without Bounds , reference.

Definition at line 107 of file PlaneSurface.cxx.

  : Trk::Surface(htrans)
  , m_bounds(nullptr)
{}

PlaneSurface() [11/13]

Trk::PlaneSurface::PlaneSurface	(	const Amg::Transform3D &	htrans,
		double	halephi,
		double	haleta )

Constructor for Rectangular Planes.

Definition at line 113 of file PlaneSurface.cxx.

  : Trk::Surface(htrans)
  , m_bounds(std::make_shared<const Trk::RectangleBounds>(halephi, haleta))
{}

PlaneSurface() [12/13]

Trk::PlaneSurface::PlaneSurface	(	const Amg::Transform3D &	htrans,
		double	minhalephi,
		double	maxhalephi,
		double	haleta )

Constructor for Trapezoidal Planes.

Definition at line 119 of file PlaneSurface.cxx.

  : Trk::Surface(htrans)
  , m_bounds(std::make_shared<const Trk::TrapezoidBounds>(minhalephi, maxhalephi, haleta))
{}

PlaneSurface() [13/13]

Trk::PlaneSurface::PlaneSurface	(	const Amg::Transform3D &	htrans,
		std::shared_ptr< const Trk::SurfaceBounds >	sbounds )

Constructor for Planes with shared object.

Definition at line 125 of file PlaneSurface.cxx.

    : Trk::Surface(htrans), m_bounds(std::move(tbounds)) {}

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 a Trk::Layer.

We do not take ownership as this is typically already owned by the Geometry

baseSurface()

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

virtualinherited

return the base surface (simplified for persistification)

bounds()

virtual const SurfaceBounds & Trk::PlaneSurface::bounds ( ) const

finaloverridevirtual

This method returns the bounds by reference, static NoBounds in case of no boundaries.

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 PlaneSurface * Trk::PlaneSurface::clone ( ) const

overridevirtual

Virtual constructor.

Implements Trk::Surface.

createUniqueNeutralParameters() [1/2]

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

finaloverridevirtual

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

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

• neutral

Implements Trk::Surface.

Definition at line 185 of file PlaneSurface.cxx.

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

createUniqueNeutralParameters() [2/2]

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

finaloverridevirtual

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

Implements Trk::Surface.

Definition at line 170 of file PlaneSurface.cxx.

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

createUniqueParameters() [1/2]

template<int DIM, class T>

std::unique_ptr< ParametersT< DIM, T, PlaneSurface > > Trk::PlaneSurface::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.

createUniqueParameters() [2/2]

template<int DIM, class T>

std::unique_ptr< ParametersT< DIM, T, PlaneSurface > > Trk::PlaneSurface::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.

createUniqueTrackParameters() [1/2]

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

finaloverridevirtual

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

Implements Trk::Surface.

Definition at line 157 of file PlaneSurface.cxx.

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

createUniqueTrackParameters() [2/2]

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

finaloverridevirtual

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

Implements Trk::Surface.

Definition at line 143 of file PlaneSurface.cxx.

{
  return std::make_unique<ParametersT<5, Charged, PlaneSurface>>(
    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::DetElementSurface, and Trk::PerigeeSurface.

Definition at line 157 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().linear());
  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();
  if (!checkTransform(*this)) {
     sl << std::endl << "     NOT a strict rotation matrix." << std::endl;
  }
  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::DetElementSurface, and Trk::PerigeeSurface.

Definition at line 185 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().linear());
  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();
  if (!checkTransform(*this)) {
     sl << std::endl << "     NOT a strict rotation matrix." << std::endl;
  }
  sl << std::setprecision(-1);
  return sl;
}

globalReferencePoint()

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

virtualinherited

Returns a global reference point on the surface, for PlaneSurface, StraightLineSurface, PerigeeSurface this is equal to center(), for CylinderSurface and DiscSurface this is a new member.

Reimplemented in GXF::CylinderSurface, GXF::DiscSurface, Trk::ConeSurface, Trk::CylinderSurface, and Trk::DiscSurface.

globalToLocal() [1/3]

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

finaloverridevirtual

Specified for PlaneSurface: GlobalToLocal method without dynamic memory allocation - boolean checks if on surface.

Implements Trk::Surface.

Definition at line 209 of file PlaneSurface.cxx.

                                                                 {
  Amg::Vector3D loc3Dframe = inverseTransformMultHelper(glopos);
  locpos = Amg::Vector2D(loc3Dframe.x(), loc3Dframe.y());
  return (loc3Dframe.z() * loc3Dframe.z() <=
          s_onSurfaceTolerance * 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

globalToLocalDirection()

void Trk::PlaneSurface::globalToLocalDirection	(	const Amg::Vector3D &	glodir,
		Trk::LocalDirection &	locdir ) const

This method transforms the global direction to a local direction wrt the plane.

Definition at line 256 of file PlaneSurface.cxx.

{
  // bring the global direction into the surface frame
  Amg::Vector3D d(inverseTransformHelper().linear() * glodir);
  ldir = Trk::LocalDirection(std::atan2(d.z(), d.x()), std::atan2(d.z(), d.y()));
}

insideBounds()

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

overridevirtual

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

Implements Trk::Surface.

Reimplemented in Trk::SubtractedPlaneSurface.

insideBoundsCheck()

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

finaloverridevirtual

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()

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

finaloverridevirtual

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.

Definition at line 265 of file PlaneSurface.cxx.

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

localParametersToPosition()

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

virtualinherited

Optionally specified by each surface type : LocalParameters to Vector2D.

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

localToGlobal() [1/5]

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

finaloverridevirtual

Specified for PlaneSurface: LocalToGlobal method without dynamic memory allocation.

Implements Trk::Surface.

Definition at line 198 of file PlaneSurface.cxx.

{
  Amg::Vector3D loc3Dframe(locpos[Trk::locX], locpos[Trk::locY], 0.);
  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.

localToGlobalDirection()

void Trk::PlaneSurface::localToGlobalDirection	(	const Trk::LocalDirection &	locdir,
		Amg::Vector3D &	globdir ) const

This method transforms a local direction wrt the plane to a global direction.

Definition at line 238 of file PlaneSurface.cxx.

{
 
  CxxUtils::sincos scXZ(locdir.angleXZ());
  CxxUtils::sincos scYZ(locdir.angleYZ());
 
  double norm = 1. / std::sqrt(scYZ.cs * scYZ.cs * scXZ.sn * scXZ.sn + scYZ.sn * scYZ.sn);
 
  // decide on the sign
  double sign = (scXZ.sn < 0.) ? -1. : 1.;
 
  // now calculate the GlobalDirection in the global frame
  globdir =
    transform().linear() *
    Amg::Vector3D(sign * scXZ.cs * scYZ.sn * norm, sign * scXZ.sn * scYZ.cs * norm, sign * scXZ.sn * scYZ.sn * norm);
}

materialLayer() [1/2]

Trk::MaterialLayer * Trk::Surface::materialLayer ( )

inherited

materialLayer() [2/2]

const Trk::MaterialLayer * 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 GXF::CylinderSurface, Trk::ConeSurface, Trk::CylinderSurface, Trk::PerigeeSurface, and Trk::StraightLineSurface.

Definition at line 135 of file Surface.cxx.

{
  return transform().linear();
}

name()

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

overridevirtual

Return properly formatted class name for screen output.

Implements Trk::Surface.

Reimplemented in Trk::SubtractedPlaneSurface.

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 GXF::CylinderSurface, Trk::ConeSurface, Trk::CylinderSurface, and 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 GXF::CylinderSurface, Trk::ConeSurface, Trk::CylinderSurface, and Trk::PerigeeSurface.

numberOfInstantiations()

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=() [1/2]

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

default

Assignment operator.

operator=() [2/2]

PlaneSurface & Trk::PlaneSurface::operator= ( PlaneSurface && psf )

defaultnoexcept

Move assignment operator.

operator==() [1/2]

bool Trk::PlaneSurface::operator==

(

const PlaneSurface &

cf

)

const

operator==() [2/2]

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

overridevirtual

Equality operator.

Implements Trk::Surface.

Reimplemented in Trk::SubtractedPlaneSurface.

Definition at line 131 of file PlaneSurface.cxx.

{
  // first check the type not to compare apples with oranges
  if (sf.type()!=Trk::SurfaceType::Plane){
      return false;
  }
  return (*this) == static_cast<const Trk::PlaneSurface&>(sf);
}

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 GXF::CylinderSurface, Trk::ConeSurface, Trk::CylinderSurface, Trk::PerigeeSurface, and Trk::StraightLineSurface.

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< Trk::MaterialLayer > 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.

straightLineDistanceEstimate() [1/2]

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

finaloverridevirtual

fast straight line distance evaluation to Surface

distance to surface

Implements Trk::Surface.

Definition at line 278 of file PlaneSurface.cxx.

{
  static const double tol = 0.001;
 
  const Amg::Vector3D& N = normal();
 
  const double d = (pos - center()).dot(N);
 
  const double A = dir.dot(N); // ignore sign
  if (A == 0.) {               // direction parallel to surface
    if (std::abs(d) < tol) {
      return {1, 0., true, 0.};
    }
      return {0, d, true, 0.};
 
  }
 
  return {1, d, true, -d / A};
}

straightLineDistanceEstimate() [2/2]

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

finaloverridevirtual

fast straight line distance evaluation to Surface - with bound option

Implements Trk::Surface.

Definition at line 299 of file PlaneSurface.cxx.

{
  const Amg::Transform3D& T = transform();
  double Az[3] = { T(0, 2), T(1, 2), T(2, 2) };
 
  // Transformation to plane system coordinates
  //
  double dx = pos[0] - T(0, 3);
  double dy = pos[1] - T(1, 3);
  double dz = pos[2] - T(2, 3);
  double z = dx * Az[0] + dy * Az[1] + dz * Az[2];
  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, std::abs(z), true, s};
 
  // Min distance to surface
  //
  double x = dx * T(0, 0) + dy * T(1, 0) + dz * T(2, 0);
  double y = dx * T(0, 1) + dy * T(1, 1) + dz * T(2, 1);
 
  Amg::Vector2D lp(x, y);
 
  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::PlaneSurface::straightLineIntersection ( const Amg::Vector3D & pos, const Amg::Vector3D & dir, bool forceDir, Trk::BoundaryCheck bchk ) const

finaloverridevirtual

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 219 of file PlaneSurface.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<typename 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 352 of file Tracking/TrkDetDescr/TrkSurfaces/TrkSurfaces/Surface.h.

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

transform()

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

inherited

Returns HepGeom::Transform3D by reference.

type()

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

constexprfinaloverridevirtual

Return the surface type.

Implements Trk::Surface.

uniqueClone()

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

inherited

NVI method returning unique_ptr clone.

Friends And Related Symbol Documentation

::BoundSurfaceCnv_p1

template<class SURFACE, class BOUNDS_CNV>

friend class ::BoundSurfaceCnv_p1

friend

< data members

Definition at line 280 of file PlaneSurface.h.

::BoundSurfaceCnv_p2

template<class SURFACE, class BOUNDS_CNV>

friend class ::BoundSurfaceCnv_p2

friend

Definition at line 282 of file PlaneSurface.h.

Member Data Documentation

m_associatedDetElement

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

protectedinherited

Not owning Pointer to the Detector Element.

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

{};

m_associatedDetElementId

Identifier Trk::Surface::m_associatedDetElementId {}

protectedinherited

Identifier to the Detector Element.

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

{};

m_associatedLayer

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

protectedinherited

The associated layer Trk::Layer This is the layer in which the Surface is embedded.

so not owning pointer.

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

{};

m_bounds

std::shared_ptr<const SurfaceBounds> Trk::PlaneSurface::m_bounds

protected

bounds (shared)

NoBounds as return object when no bounds are declared

Definition at line 284 of file PlaneSurface.h.

m_materialLayer

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

protectedinherited

Possibility to attach a material description to the surface.

In this case the surface is what holds the MaterialLayer. This is usually done for boundary surfaces so shared ptr.

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 : default free surface

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

{SurfaceOwner::noOwn};

m_transforms

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

protectedinherited

Unique Pointer to the Transforms struct.

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

{};

s_boundless

const Trk::NoBounds Trk::PlaneSurface::s_boundless

staticprotected

Definition at line 286 of file PlaneSurface.h.

s_numberOfInstantiations

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

inlinestaticinherited

Definition at line 22 of file TrkObjectCounter.h.

s_onSurfaceTolerance

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

SurfaceType Trk::PlaneSurface::staticType = SurfaceType::Plane

staticconstexpr

The surface type static constexpr.

Definition at line 67 of file PlaneSurface.h.

---

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

• PlaneSurface.h
• PlaneSurface.cxx