Trk::SlidingCylinderSurface Class Reference

Class for a Calo CylinderSurface with variable depth in the ATLAS detector. More...

#include <SlidingCylinderSurface.h>

Inheritance diagram for Trk::SlidingCylinderSurface:

Collaboration diagram for Trk::SlidingCylinderSurface:

Public Types
using	ChargedTrackParametersUniquePtr
	Unique ptr types.
using	NeutralTrackParametersUniquePtr

Public Member Functions
	SlidingCylinderSurface (const CylinderSurface &surf, const Trk::BinUtility &bu, const std::vector< float > &offset)
	Constructor.
virtual bool	operator== (const Surface &sf) const override final
	Equality operator.
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
	Specialized for DiscSurface: LocalToGlobal method without dynamic memory allocation.
virtual bool	globalToLocal (const Amg::Vector3D &glob, const Amg::Vector3D &mom, Amg::Vector2D &loc) const override final
	Specialized for DiscSurface: GlobalToLocal method without dynamic memory allocation - boolean checks if on surface.
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
const Trk::BinUtility &	binUtility () const
	This method allows access to the bin utility.
const std::vector< float > &	offset () const
	This method allows access to the radial offset values.
virtual std::string	name () const override
	Return properly formatted class name for screen output.
bool	operator== (const CylinderSurface &cf) const
virtual CylinderSurface *	clone () const override
	Implicit Constructor.
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 qop, 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, std::optional< AmgSymMatrix(5)> cov=std::nullopt) const override final
	Use the Surface as a ParametersBase constructor, from global parameters - neutral.
template<int DIM, class T>
std::unique_ptr< ParametersT< DIM, T, CylinderSurface > >	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, CylinderSurface > >	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 Amg::RotationMatrix3D	measurementFrame (const Amg::Vector3D &glopos, const Amg::Vector3D &glomom) const override final
	Return the measurement frame - this is needed for alignment, in particular for StraightLine and Perigee Surface.
virtual constexpr SurfaceType	type () const override final
	Return the surface type.
virtual const Amg::Vector3D &	globalReferencePoint () const override final
	Returns a global reference point: For the Cylinder this is \( (R*cos(\phi), R*sin(\phi),0)*transform() \) Where \( \phi \) denotes the averagePhi() of the cylinderBounds.
virtual Amg::Vector3D	normal (const Amg::Vector2D &locpo) const override final
	Return method for surface normal information at a given local point, overwrites the normal() from base class.
virtual const Amg::Vector3D &	normal () const
	Returns the normal vector of the Surface (i.e.
virtual const Amg::Vector3D &	rotSymmetryAxis () const
	Return method for the rotational symmetry axis - the z-Axis of the HepTransform.
virtual const CylinderBounds &	bounds () const override final
	This method returns the CylinderBounds by reference (NoBounds is not possible for cylinder)
bool	hasBounds () const
virtual bool	insideBounds (const Amg::Vector2D &locpos, double tol1=0., double tol2=0.) const override
	This method calls the inside method of CylinderBounds.
virtual bool	insideBoundsCheck (const Amg::Vector2D &locpos, const BoundaryCheck &bchk) const override final
virtual Amg::Vector2D	localParametersToPosition (const LocalParameters &locpars) const override final
	Specialized for CylinderSurface : LocalParameters to Vector2D.
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 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 - provides closest intersection and (signed) path length
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
virtual double	pathCorrection (const Amg::Vector3D &pos, const Amg::Vector3D &mom) const override
	the pathCorrection for derived classes with thickness
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.
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.
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::Cylinder
	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::vector< float >	m_depth {}
Trk::BinUtility	m_etaBin {}
std::shared_ptr< const CylinderBounds >	m_bounds
	The global reference point (== a point on the surface)
CxxUtils::CachedUniquePtr< Amg::Vector3D >	m_referencePoint
	The rotational symmetry axis.
CxxUtils::CachedUniquePtr< Amg::Vector3D >	m_rotSymmetryAxis
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 constexpr double	s_onSurfaceTolerance = 10e-5
	Tolerance for being on Surface.

Detailed Description

Class for a Calo CylinderSurface with variable depth in the ATLAS detector.

The variable depth is stored as a binned vector of radial corrections. Local eta bin is defined by base curvature and z position in base transform ( corrected for misalignement ). It inherits from CylinderSurface.

Author

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

Definition at line 33 of file SlidingCylinderSurface.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

SlidingCylinderSurface()

Trk::SlidingCylinderSurface::SlidingCylinderSurface	(	const CylinderSurface &	surf,
		const Trk::BinUtility &	bu,
		const std::vector< float > &	offset )

Constructor.

Definition at line 22 of file SlidingCylinderSurface.cxx.

  : Trk::CylinderSurface(dsf)
  , m_depth(offset)
  , m_etaBin(bu)
{}

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)

binUtility()

const Trk::BinUtility & Trk::SlidingCylinderSurface::binUtility ( ) const

inline

This method allows access to the bin utility.

Definition at line 79 of file SlidingCylinderSurface.h.

{ return m_etaBin; }

bounds()

virtual const CylinderBounds & Trk::CylinderSurface::bounds ( ) const

finaloverridevirtualinherited

This method returns the CylinderBounds by reference (NoBounds is not possible for cylinder)

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

overridevirtualinherited

Implicit Constructor.

Implements Trk::Surface.

createUniqueNeutralParameters() [1/2]

Trk::Surface::NeutralTrackParametersUniquePtr Trk::CylinderSurface::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 156 of file CylinderSurface.cxx.

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

createUniqueNeutralParameters() [2/2]

Trk::Surface::NeutralTrackParametersUniquePtr Trk::CylinderSurface::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 146 of file CylinderSurface.cxx.

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

createUniqueParameters() [1/2]

template<int DIM, class T>

std::unique_ptr< ParametersT< DIM, T, CylinderSurface > > Trk::CylinderSurface::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, CylinderSurface > > Trk::CylinderSurface::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::CylinderSurface::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 136 of file CylinderSurface.cxx.

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

createUniqueTrackParameters() [2/2]

Trk::Surface::ChargedTrackParametersUniquePtr Trk::CylinderSurface::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 126 of file CylinderSurface.cxx.

                                            {
  return std::make_unique<ParametersT<5, Charged, CylinderSurface>>(
      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()

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

finaloverridevirtualinherited

Returns a global reference point: For the Cylinder this is \( (R*cos(\phi), R*sin(\phi),0)*transform() \) Where \( \phi \) denotes the averagePhi() of the cylinderBounds.

Reimplemented from Trk::Surface.

Definition at line 164 of file CylinderSurface.cxx.

{
  if (!m_referencePoint) {
    double rMedium = bounds().r();
    double phi = bounds().averagePhi();
    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::SlidingCylinderSurface::globalToLocal ( const Amg::Vector3D & glob, const Amg::Vector3D & mom, Amg::Vector2D & loc ) const

finaloverridevirtual

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

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

Reimplemented from Trk::CylinderSurface.

Definition at line 67 of file SlidingCylinderSurface.cxx.

{
  // get the transform & transform global position into cylinder frame
  // transform it to the globalframe: CylinderSurfaces are allowed to have 0 pointer transform
  double radius = 0.;
  const double inttol = std::max(bounds().r() * 0.0001, 0.01);
  // realign to find local eta bin
  const Amg::Vector3D& loc3D0 = glopos;
  float offset = m_depth[m_etaBin.bin(loc3D0)];
  // do the transformation or not
  if (Trk::Surface::m_transforms) {
    const Amg::Transform3D& surfaceTrans = transform();
    Amg::Transform3D inverseTrans(surfaceTrans.inverse());
    Amg::Vector3D loc3Dframe(inverseTrans * glopos);
    locpos = Amg::Vector2D((bounds().r() + offset) * loc3Dframe.phi(), loc3Dframe.z());
    radius = loc3Dframe.perp();
  } else {
    locpos = Amg::Vector2D((bounds().r() + offset) * glopos.phi(), glopos.z());
    radius = glopos.perp();
  }
  // return true or false
  return (std::abs(radius - bounds().r() - offset) <= inttol);
}

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

hasBounds()

bool Trk::CylinderSurface::hasBounds ( ) const

inherited

insideBounds()

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

overridevirtualinherited

This method calls the inside method of CylinderBounds.

Implements Trk::Surface.

Reimplemented in Trk::SubtractedCylinderLayer, and Trk::SubtractedCylinderSurface.

insideBoundsCheck()

virtual bool Trk::CylinderSurface::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::SlidingCylinderSurface::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::CylinderSurface.

Definition at line 94 of file SlidingCylinderSurface.cxx.

{
  const Amg::Vector3D& loc3D0 = glopo;
  Amg::Vector3D loc3Dframe = m_transforms ? (transform().inverse()) * glopo : glopo;
  float offset = m_depth[m_etaBin.bin(loc3D0)];
  // recalculate r to match bounds
  Amg::Vector3D loc3Dbase((loc3Dframe.perp() - offset) * std::cos(loc3Dframe.phi()),
                          (loc3Dframe.perp() - offset) * std::sin(loc3Dframe.phi()),
                          loc3Dframe.z());
 
  return (bchk ? bounds().inside3D(loc3Dbase, tol1, tol2) : true);
}

localParametersToPosition()

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

finaloverridevirtualinherited

Specialized for CylinderSurface : LocalParameters to Vector2D.

Reimplemented from Trk::Surface.

localToGlobal() [1/5]

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

finaloverridevirtual

Specialized for DiscSurface: LocalToGlobal method without dynamic memory allocation.

Reimplemented from Trk::CylinderSurface.

Definition at line 47 of file SlidingCylinderSurface.cxx.

{
  // create the position in the local 3d frame
  double r0 = bounds().r();
  double phi0 = locpos[Trk::locRPhi] / r0;
  Amg::Vector3D loc3D0(r0 * std::cos(phi0), r0 * std::sin(phi0), locpos[Trk::locZ]);
  // correct for alignment, retrieve offset correction
  Amg::Transform3D t0 = transform();
  float offset = m_depth[m_etaBin.bin(t0 * loc3D0)];
  double r = r0 + offset;
  double phi = locpos[Trk::locRPhi] / r;
  Amg::Vector3D loc3Dframe(r * std::cos(phi), r * std::sin(phi), locpos[Trk::locZ]);
  // transport it to the globalframe
  glopos = Trk::Surface::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::MaterialLayer * Trk::Surface::materialLayer ( )

inherited

materialLayer() [2/2]

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

inherited

return the material Layer

measurementFrame()

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

finaloverridevirtualinherited

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 from Trk::Surface.

Definition at line 187 of file CylinderSurface.cxx.

{
  Amg::RotationMatrix3D mFrame;
  // construct the measurement frame
  Amg::Vector3D measY(
    transform().rotation().col(2)); // measured Y is the z axis
  Amg::Vector3D measDepth =
    Amg::Vector3D(pos.x(), pos.y(), 0.)
      .unit(); // measured z is the position transverse normalized
  Amg::Vector3D measX(
    measY.cross(measDepth).unit()); // measured X is what comoes out of it
  // the columnes
  mFrame.col(0) = measX;
  mFrame.col(1) = measY;
  mFrame.col(2) = measDepth;
  // return the rotation matrix
  return mFrame;
}

name()

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

inlineoverridevirtual

Return properly formatted class name for screen output.

Reimplemented from Trk::CylinderSurface.

Definition at line 85 of file SlidingCylinderSurface.h.

  {
    return "Trk::SlidingCylinderSurface";
  }

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 from Trk::Surface.

normal() [2/2]

virtual Amg::Vector3D Trk::CylinderSurface::normal ( const Amg::Vector2D & locpo ) const

finaloverridevirtualinherited

Return method for surface normal information at a given local point, overwrites the normal() from base class.

Reimplemented from Trk::Surface.

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

offset()

const std::vector< float > & Trk::SlidingCylinderSurface::offset ( ) const

inline

This method allows access to the radial offset values.

Definition at line 82 of file SlidingCylinderSurface.h.

{ return m_depth; }

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]

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

inherited

operator==() [2/2]

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

finaloverridevirtual

Equality operator.

Reimplemented from Trk::CylinderSurface.

Definition at line 32 of file SlidingCylinderSurface.cxx.

{
  // first check the type not to compare apples with oranges
  const Trk::SlidingCylinderSurface* dsf = dynamic_cast<const Trk::SlidingCylinderSurface*>(&sf);
  if (!dsf)
    return false;
  if (this == dsf)
    return true;
  bool transfEqual(transform().isApprox(dsf->transform(), 10e-8));
  bool centerEqual = (transfEqual) ? (center() == dsf->center()) : false;
  bool boundsEqual = (centerEqual) ? (bounds() == dsf->bounds()) : false;
  return boundsEqual;
}

owner()

SurfaceOwner Trk::Surface::owner ( ) const

inherited

return ownership

pathCorrection()

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

overridevirtualinherited

the pathCorrection for derived classes with thickness

Reimplemented from Trk::Surface.

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

rotSymmetryAxis()

const Amg::Vector3D & Trk::CylinderSurface::rotSymmetryAxis ( ) const

virtualinherited

Return method for the rotational symmetry axis - the z-Axis of the HepTransform.

Definition at line 208 of file CylinderSurface.cxx.

{
  if (!m_rotSymmetryAxis) {
    Amg::Vector3D zAxis(transform().rotation().col(2));
    m_rotSymmetryAxis.set(std::make_unique<Amg::Vector3D>(zAxis));
  }
  return (*m_rotSymmetryAxis);
}

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::SlidingCylinderSurface::straightLineDistanceEstimate ( const Amg::Vector3D & pos, const Amg::Vector3D & dir ) const

finaloverridevirtual

fast straight line distance evaluation to Surface

distance to surface

Reimplemented from Trk::CylinderSurface.

Definition at line 112 of file SlidingCylinderSurface.cxx.

{
  double tol = 0.001;
 
  // retrieve localEta bin using current position
  const Amg::Vector3D& loc3D0 = pos; // used to retrieve localEta bin
  float offset = m_depth[m_etaBin.bin(loc3D0)];
 
  const Amg::Vector3D& X = Trk::Surface::center(); // point
  const Amg::Vector3D& S = Trk::Surface::normal(); // vector
 
  double radius = bounds().r() + offset;
  double sp = pos.dot(S);
  double sc = X.dot(S);
  double dp = dir.dot(S);
  Amg::Vector3D dx = X - pos - (sc - sp) * S; // vector
  Amg::Vector3D ax = dir - dp * S;            // vector
 
  double A = ax.dot(ax); // size of projected direction (squared)
  double B = ax.dot(dx); // dot product (->cos angle)
  double C = dx.dot(dx); // distance to axis (squared)
  double currDist = radius - std::sqrt(C);
  const double bOverA{B/A};
  if (A == 0.) { // direction parallel to cylinder axis
    if (std::abs(currDist) < tol) {
      return {1, 0., true, 0.}; // solution at surface
    }
      return {0, currDist, true, 0.}; // point of closest approach without intersection
 
  }
  // minimal distance to cylinder axis
  double rmin = C - B * bOverA < 0. ? 0. : std::sqrt(C - B * bOverA);
  if (rmin > radius) { // no intersection
    return {0, currDist, true, bOverA}; // point of closest approach without intersection
  }
  if (std::abs(rmin - radius) < tol) { // tangential 'intersection' - return double solution
    return {2, currDist, true, bOverA, bOverA};
  }
  const double sqrtTerm = std::sqrt((radius - rmin) * (radius + rmin)/A) ;
  double first = bOverA - sqrtTerm;
  double second = bOverA + sqrtTerm;
  if (first >= 0.) {
    return {2, currDist, true, first, second};
  } if (second <= 0.) {
    return {2, currDist, true, second, first};
  } // inside cylinder
  return {2, currDist, true, second, first};
}

straightLineDistanceEstimate() [2/2]

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

finaloverridevirtual

fast straight line distance evaluation to Surface - with bound option

Reimplemented from Trk::CylinderSurface.

Definition at line 162 of file SlidingCylinderSurface.cxx.

{
  return straightLineDistanceEstimate(pos, dir);
}

straightLineIntersection() [1/2]

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

finaloverridevirtualinherited

fast straight line intersection schema - provides closest intersection and (signed) path length

mathematical motivation:

The calculation will be done in the 3-dim frame of the cylinder, i.e. the symmetry axis of the cylinder is the z-axis, x- and y-axis are perpenticular to the the z-axis. In this frame the cylinder is centered around the origin. Therefore the two points describing the line have to be first recalculated into the new frame. Suppose, this is done, the intersection is straight forward:
may \(p_{1}=(p_{1x}, p_{1y}, p_{1z}), p_{2}=(p_{2x}, p_{2y}, p_{2z}) \)@_fakenlthe two points describing the 3D-line, then the line in the \(x-y\)plane can be written as \(y=kx+d\), where \(k =\frac{p_{2y}-p_{1y}}{p_{2x}-p_{1x}}\)such as \(d=\frac{p_{2x}p_{1y}-p_{1x}p_{2y}}{p_{2x}-p_{1x}},\)
and intersects with the corresponding circle \(x^{2}+y^{2} = R^{2}. \)
The solutions can then be found by a simple quadratic equation and reinsertion into the line equation.

Implements Trk::Surface.

Definition at line 274 of file CylinderSurface.cxx.

{
  bool needsTransform = m_transforms || m_associatedDetElement;
  // create the hep points
  Amg::Vector3D point1 = pos;
  Amg::Vector3D direction = dir;
  if (needsTransform) {
    Amg::Transform3D invTrans = inverseTransformHelper();
    point1 = invTrans * pos;
    direction = invTrans.linear() * dir;
  }
  // the bounds radius
  double R = bounds().r();
  double t1 = 0.;
  double t2 = 0.;
  if (direction.x()) {
    // get line and circle constants
    double idirx = 1. / direction.x();
    double k = direction.y() * idirx;
    double d = point1.y() - point1.x() * k;
    // and solve the qaudratic equation
    Trk::RealQuadraticEquation pquad(1 + k * k, 2 * k * d, d * d - R * R);
    if (pquad.solutions != Trk::none) {
      // the solutions in the 3D frame of the cylinder
      t1 = (pquad.first - point1.x()) * idirx;
      t2 = (pquad.second - point1.x()) * idirx;
    } else // bail out if no solution exists
      return {pos, 0., false};
  } else if (direction.y()) {
    // x value is the one of point1
    // x^2 + y^2 = R^2
    // y = sqrt(R^2-x^2)
    double x = point1.x();
    double r2mx2 = R * R - x * x;
    // bail out if no solution
    if (r2mx2 < 0.)
      return {pos, 0., false};
    double y = sqrt(r2mx2);
    // assign parameters and solutions
    double idiry = 1. / direction.y();
    t1 = (y - point1.y()) * idiry;
    t2 = (-y - point1.y()) * idiry;
  } else {
    return {pos, 0., false};
  }
  Amg::Vector3D sol1raw(point1 + t1 * direction);
  Amg::Vector3D sol2raw(point1 + t2 * direction);
  // now reorder and return
  Amg::Vector3D solution(0, 0, 0);
  double path = 0.;
 
  // first check the validity of the direction
  bool isValid = true;
 
  // both solutions are of same sign, take the smaller, but flag as false if not
  // forward
  if (t1 * t2 > 0 || !forceDir) {
    // asign validity
    isValid = forceDir ? (t1 > 0.) : true;
    // assign the right solution
    if (t1 * t1 < t2 * t2) {
      solution = sol1raw;
      path = t1;
    } else {
      solution = sol2raw;
      path = t2;
    }
  } else {
    if (t1 > 0.) {
      solution = sol1raw;
      path = t1;
    } else {
      solution = sol2raw;
      path = t2;
    }
  }
  // the solution is still in the local 3D frame, direct check
  isValid =
    bchk ? (isValid && m_bounds->inside3D(solution,
                                          Trk::Surface::s_onSurfaceTolerance,
                                          Trk::Surface::s_onSurfaceTolerance))
         : isValid;
 
  // now return
  return needsTransform ? Intersection(transform() * solution, path, isValid)
                        : Intersection(solution, path, isValid);
}

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::CylinderSurface::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 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 CylinderBounds> Trk::CylinderSurface::m_bounds

protectedinherited

The global reference point (== a point on the surface)

Definition at line 289 of file CylinderSurface.h.

m_depth

std::vector<float> Trk::SlidingCylinderSurface::m_depth {}

protected

Definition at line 91 of file SlidingCylinderSurface.h.

{};

m_etaBin

Trk::BinUtility Trk::SlidingCylinderSurface::m_etaBin {}

protected

Definition at line 92 of file SlidingCylinderSurface.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_referencePoint

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

protectedinherited

The rotational symmetry axis.

Definition at line 291 of file CylinderSurface.h.

m_rotSymmetryAxis

CxxUtils::CachedUniquePtr<Amg::Vector3D> Trk::CylinderSurface::m_rotSymmetryAxis

protectedinherited

Definition at line 293 of file CylinderSurface.h.

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_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::CylinderSurface::staticType = SurfaceType::Cylinder

staticconstexprinherited

The surface type static constexpr.

Definition at line 59 of file CylinderSurface.h.

---

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

• SlidingCylinderSurface.h
• SlidingCylinderSurface.cxx