Trk::SubtractedPlaneLayer Class Reference

Class to describe a planar detector layer for tracking, with subtraction. More...

#include <SubtractedPlaneLayer.h>

Inheritance diagram for Trk::SubtractedPlaneLayer:

Collaboration diagram for Trk::SubtractedPlaneLayer:

Public Types
using	ChargedTrackParametersUniquePtr
	Unique ptr types.
using	NeutralTrackParametersUniquePtr

Public Member Functions
	SubtractedPlaneLayer ()
	Default Constructor.
	SubtractedPlaneLayer (const SubtractedPlaneSurface *subtrPlaneSurf, const LayerMaterialProperties &laymatprop, double thickness=0., std::unique_ptr< OverlapDescriptor > od=nullptr, int laytyp=int(Trk::active))
	Constructor with SubtractedPlaneSurface and MaterialProperties.
	SubtractedPlaneLayer (const SubtractedPlaneLayer &pla)
	Copy constructor of SubtractedPlaneLayer.
	SubtractedPlaneLayer (const SubtractedPlaneLayer &pla, const Amg::Transform3D &tr)
	Copy constructor with shift.
SubtractedPlaneLayer &	operator= (const SubtractedPlaneLayer &)
	Assignment operator for PlaneLayers.
	~SubtractedPlaneLayer () override
	Destructor.
virtual const SubtractedPlaneSurface &	surfaceRepresentation () const override final
	Transforms the layer into a Surface representation for extrapolation.
virtual SubtractedPlaneSurface &	surfaceRepresentation () override final
double	preUpdateMaterialFactor (const Trk::TrackParameters &par, Trk::PropDirection dir) const override final
	getting the MaterialProperties back - for pre-update
double	postUpdateMaterialFactor (const Trk::TrackParameters &par, Trk::PropDirection dir) const override final
	getting the MaterialProperties back - for post-update
virtual void	moveLayer (Amg::Transform3D &shift) override final
	move the Layer
virtual void	resizeLayer (const VolumeBounds &, double) override final
	Resize the layer to the tracking volume - not implemented.
virtual void	resizeAndRepositionLayer (const VolumeBounds &, const Amg::Vector3D &, double) override final
	Resize the layer to the tracking volume - not implemented.
virtual bool	operator== (const Surface &sf) const override final
	Equality operator.
bool	operator== (const PlaneSurface &cf) const
bool	shared () const
	This method indicates the subtraction mode.
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.
const AreaExcluder *	subtractedVolume () const
	This method allows access to the subtracted part.
virtual std::string	name () const override final
	Return properly formatted class name for screen output.
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	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.
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.
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.
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.
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
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 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
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.
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.
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.
const SurfaceArray *	surfaceArray () const
	Return the entire SurfaceArray, returns nullptr if no SurfaceArray.
SurfaceArray *	surfaceArray ()
	Return the entire SurfaceArray, returns nullptr if no SurfaceArray.
const Surface *	subSurface (const Amg::Vector3D &gp) const
	If no subSurface array is defined or no subSurface can be found to the given Amg::Vector3D, it would return 0.
const Surface *	subSurface (const Amg::Vector2D &lp) const
	If no subSurface array is defined or no subSurface can be found to the given Amg::Vector2D, it would return 0.
const Surface *	subSurfaceReference (unsigned int idx=0) const
	Return a reference sub surface of the layer, usually the first one in the array.
double	thickness () const
	Return the Thickness of the Layer.
template<class T>
bool	onLayer (const T &parameters, const BoundaryCheck &bcheck=BoundaryCheck(true)) const
	templated on Layer method
virtual bool	isOnLayer (const Amg::Vector3D &gp, const BoundaryCheck &bcheck=BoundaryCheck(true)) const
	isOnLayer() method, using isOnSurface() with Layer specific tolerance
const LayerMaterialProperties *	layerMaterialProperties () const
	getting the LayerMaterialProperties including full/pre/post update
const MaterialProperties *	fullUpdateMaterialProperties (const TrackParameters &par) const
	getting the MaterialProperties back - for full update
const OverlapDescriptor *	overlapDescriptor () const
	gettint hte overlap descriptor
const Layer *	previousLayer (bool skipNavLayer=false) const
	getting what's stored to be the previous Layer, boolean to skip navigation layers
void	setPreviousLayer (const Layer *)
	set the previous Layer
const Layer *	nextLayer (const Amg::Vector3D &gp, const Amg::Vector3D &udir) const
	getting the next/previous Layer if registered - unit for direction vector required
const Layer *	nextLayer (bool skipNavLayer=false) const
	getting what's stored to be the next Layer, boolean to skip navigation layers
void	setNextLayer (const Layer *)
	set the next Layer
const BinUtility *	binUtility () const
	access the BinUtility
void	setBinUtility (const BinUtility *)
	set the BinUtility
virtual const Surface &	surfaceOnApproach (const Amg::Vector3D &pos, const Amg::Vector3D &dir, PropDirection pdir, const BoundaryCheck &bcheck, bool resolveSubSurfaces=0, const ICompatibilityEstimator *ice=nullptr) const
	Surface seen on approach - if not defined differently, it is the surfaceRepresentation()
size_t	compatibleSurfaces (std::vector< SurfaceIntersection > &cSurfaces, const TrackParameters &pars, PropDirection pdir, const BoundaryCheck &bcheck, bool materialSurfacesOnly=true, const Surface *startSurface=nullptr, const Surface *endSurface=nullptr, const ICompatibilityEstimator *ice=nullptr) const
	get compatible surfaces starting from charged parameters
size_t	compatibleSurfaces (std::vector< SurfaceIntersection > &cSurfaces, const NeutralParameters &pars, PropDirection pdir, const BoundaryCheck &bcheck, bool materialSurfacesOnly=true, const Surface *startSurface=nullptr, const Surface *endSurface=nullptr, const ICompatibilityEstimator *ice=nullptr) const
	get compatible surfaces starting from neutral parameters
virtual bool	hasSubStructure (bool resolveSensitive=false) const
	Has sub-structure method:
const TrackingVolume *	enclosingTrackingVolume () const
	get the confining TrackingVolume
const DetachedTrackingVolume *	enclosingDetachedTrackingVolume () const
	get the confining DetachedTrackingVolume
const LayerIndex &	layerIndex () const
	get the layerIndex
int	layerType () const
	get the Layer coding
void	setLayerType (int identifier)
	set the Layer coding
void	assignMaterialProperties (const LayerMaterialProperties &, double scale=1.0)
	assignMaterialPropeties
void	registerRepresentingVolume (const Volume *theVol)
	register Volume associated to the layer
const Volume *	representingVolume () const
	get the Volume associated to the layer
void	setRef (double)
	set the reference measure
double	getRef () const
	get the reference measure
void	encloseTrackingVolume (const TrackingVolume &tvol)
	private method to set the enclosed detached TV
void	encloseDetachedTrackingVolume (const DetachedTrackingVolume &tvol)
template<class T>
size_t	getCompatibleSurfaces (std::vector< SurfaceIntersection > &cSurfaces, const T &pars, PropDirection pdir, const BoundaryCheck &bcheck, bool materialSurfacesOnly=true, const Surface *startSurface=nullptr, const Surface *endSurface=nullptr, const ICompatibilityEstimator *ice=nullptr) const
	get compatible surfaces starting from charged parameters
void	compactify (size_t &cSurfaces, size_t &tSurfaces)
	register layer index for material map registration
void	registerLayerIndex (const LayerIndex &lIdx)

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 AreaExcluder >	m_subtrVol
bool	m_shared {true}
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
std::unique_ptr< SurfaceArray >	m_surfaceArray {}
	MaterialPoperties of this layer Surface.
std::unique_ptr< LayerMaterialProperties >	m_layerMaterialProperties {}
	thickness of the Layer
double	m_layerThickness {}
	descriptor for overlap/next surface (owning ptr)
std::unique_ptr< OverlapDescriptor >	m_overlapDescriptor {}
const Layer *	m_previousLayer = nullptr
	< the previous Layer according to BinGenUtils
const Layer *	m_nextLayer = nullptr
	BinUtility for next/previous decision.
const BinUtility *	m_binUtility = nullptr
	Enclosing TrackingVolume.
const TrackingVolume *	m_enclosingTrackingVolume = nullptr
	Enclosing DetachedTrackingVolume.
const DetachedTrackingVolume *	m_enclosingDetachedTrackingVolume = nullptr
LayerIndex	m_index {-1}
	LayerIndex.
int	m_layerType {Trk::active}
	active passive layer
double	m_ref {}
	reference measure for local coordinate convertors

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

Detailed Description

Class to describe a planar detector layer for tracking, with subtraction.

Author

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

Definition at line 31 of file SubtractedPlaneLayer.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

SubtractedPlaneLayer() [1/4]

Trk::SubtractedPlaneLayer::SubtractedPlaneLayer ( )

inline

Default Constructor.

Definition at line 37 of file SubtractedPlaneLayer.h.

{}

SubtractedPlaneLayer() [2/4]

Trk::SubtractedPlaneLayer::SubtractedPlaneLayer	(	const SubtractedPlaneSurface *	subtrPlaneSurf,
		const LayerMaterialProperties &	laymatprop,
		double	thickness = 0.,
		std::unique_ptr< OverlapDescriptor >	od = nullptr,
		int	laytyp = int(Trk::active) )

Constructor with SubtractedPlaneSurface and MaterialProperties.

Definition at line 18 of file SubtractedPlaneLayer.cxx.

    : SubtractedPlaneSurface(*subtrPlaneSurf),
      Layer(laymatprop, thickness, std::move(olap), laytyp) {}

SubtractedPlaneLayer() [3/4]

Trk::SubtractedPlaneLayer::SubtractedPlaneLayer ( const SubtractedPlaneLayer & pla )

default

Copy constructor of SubtractedPlaneLayer.

SubtractedPlaneLayer() [4/4]

Trk::SubtractedPlaneLayer::SubtractedPlaneLayer	(	const SubtractedPlaneLayer &	pla,
		const Amg::Transform3D &	tr )

Copy constructor with shift.

Definition at line 28 of file SubtractedPlaneLayer.cxx.

    : SubtractedPlaneSurface(play, transf), Layer(play) {}

~SubtractedPlaneLayer()

Trk::SubtractedPlaneLayer::~SubtractedPlaneLayer ( )

inlineoverride

Destructor.

Definition at line 57 of file SubtractedPlaneLayer.h.

{}

Member Function Documentation

assignMaterialProperties()

void Trk::Layer::assignMaterialProperties ( const LayerMaterialProperties & prop, double scale = 1.0 )

inherited

assignMaterialPropeties

Definition at line 177 of file Layer.cxx.

                                                        {
  m_layerMaterialProperties.reset(prop.clone());
  if (scale != 1.0) {
    (*(m_layerMaterialProperties)) *= scale;
  }
}

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 BinUtility * Trk::Layer::binUtility ( ) const

inherited

access the BinUtility

bounds()

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

finaloverridevirtualinherited

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

overridevirtualinherited

Virtual constructor.

Implements Trk::Surface.

compactify()

void Trk::Layer::compactify ( size_t & cSurfaces, size_t & tSurfaces )

inherited

register layer index for material map registration

Definition at line 186 of file Layer.cxx.

{
  // set the layer surface representation
  ++tSurfaces;
  if (surfaceRepresentation().owner() == Trk::noOwn) {
    surfaceRepresentation().setOwner(Trk::TGOwn);
    ++cSurfaces;
  }
  // set the subsurface representation, usually already owned by DetElement
  if (m_surfaceArray) {
    std::span<Trk::Surface * const> surfaces = m_surfaceArray->arrayObjects();
    for (Trk::Surface * const sIter : surfaces) {
      if (sIter && (*sIter).owner() == Trk::noOwn) {
        (*sIter).setOwner(Trk::TGOwn);
        ++cSurfaces;
      }
      ++tSurfaces;
    }
  }
}

compatibleSurfaces() [1/2]

size_t Trk::Layer::compatibleSurfaces ( std::vector< SurfaceIntersection > & cSurfaces, const NeutralParameters & pars, PropDirection pdir, const BoundaryCheck & bcheck, bool materialSurfacesOnly = true, const Surface * startSurface = nullptr, const Surface * endSurface = nullptr, const ICompatibilityEstimator * ice = nullptr ) const

inherited

get compatible surfaces starting from neutral parameters

compatibleSurfaces() [2/2]

size_t Trk::Layer::compatibleSurfaces ( std::vector< SurfaceIntersection > & cSurfaces, const TrackParameters & pars, PropDirection pdir, const BoundaryCheck & bcheck, bool materialSurfacesOnly = true, const Surface * startSurface = nullptr, const Surface * endSurface = nullptr, const ICompatibilityEstimator * ice = nullptr ) const

inherited

get compatible surfaces starting from charged parameters

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

finaloverridevirtualinherited

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

finaloverridevirtualinherited

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

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, PlaneSurface > > Trk::PlaneSurface::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::PlaneSurface::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 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

finaloverridevirtualinherited

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

encloseDetachedTrackingVolume()

void Trk::Layer::encloseDetachedTrackingVolume ( const DetachedTrackingVolume & tvol )

inherited

encloseTrackingVolume()

void Trk::Layer::encloseTrackingVolume ( const TrackingVolume & tvol )

inherited

private method to set the enclosed detached TV

enclosingDetachedTrackingVolume()

const DetachedTrackingVolume * Trk::Layer::enclosingDetachedTrackingVolume ( ) const

inherited

get the confining DetachedTrackingVolume

enclosingTrackingVolume()

const TrackingVolume * Trk::Layer::enclosingTrackingVolume ( ) const

inherited

get the confining TrackingVolume

fullUpdateMaterialProperties()

const Trk::MaterialProperties * Trk::Layer::fullUpdateMaterialProperties ( const TrackParameters & par ) const

inherited

getting the MaterialProperties back - for full update

Definition at line 169 of file Layer.cxx.

                                          {
  if (m_layerMaterialProperties){
    return m_layerMaterialProperties->fullMaterial(parm.position());
  }
  return nullptr;
}

getCompatibleSurfaces()

template<class T>

size_t Trk::Layer::getCompatibleSurfaces ( std::vector< SurfaceIntersection > & cSurfaces, const T & pars, PropDirection pdir, const BoundaryCheck & bcheck, bool materialSurfacesOnly = true, const Surface * startSurface = nullptr, const Surface * endSurface = nullptr, const ICompatibilityEstimator * ice = nullptr ) const

inherited

get compatible surfaces starting from charged parameters

propagate TrackingGeometry owner downstream

getRef()

double Trk::Layer::getRef ( ) const

inherited

get the reference measure

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

finaloverridevirtualinherited

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

inherited

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

hasSubStructure()

bool Trk::Layer::hasSubStructure ( bool resolveSensitive = false ) const

virtualinherited

Has sub-structure method:

• sub-structure depending on : (a) only when required to resolve sub surfaces for sensitive hits (b) also material is ordered with sub structure

Definition at line 238 of file Layer.cxx.

                                                          {
  return resolveSensitive && m_surfaceArray;
}

insideBounds()

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

finaloverridevirtualinherited

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

Reimplemented from Trk::PlaneSurface.

insideBoundsCheck()

virtual bool Trk::PlaneSurface::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

isOnLayer()

bool Trk::Layer::isOnLayer ( const Amg::Vector3D & gp, const BoundaryCheck & bcheck = BoundaryCheck(true) ) const

virtualinherited

isOnLayer() method, using isOnSurface() with Layer specific tolerance

Reimplemented in Trk::MaterialLayer, Trk::MaterialLayerNoOwnSurf, Trk::MaterialLayerOwnSurf, and Trk::NavigationLayer.

Definition at line 135 of file Layer.cxx.

                                                            {
  return (surfaceRepresentation())
      .isOnSurface(gp, bchk, 0.5 * m_layerThickness);
}

isOnSurface()

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

finaloverridevirtualinherited

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

layerIndex()

const LayerIndex & Trk::Layer::layerIndex ( ) const

inherited

get the layerIndex

layerMaterialProperties()

const LayerMaterialProperties * Trk::Layer::layerMaterialProperties ( ) const

inherited

getting the LayerMaterialProperties including full/pre/post update

layerType()

int Trk::Layer::layerType ( ) const

inherited

get the Layer coding

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

finaloverridevirtualinherited

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

inherited

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

moveLayer()

void Trk::SubtractedPlaneLayer::moveLayer ( Amg::Transform3D & shift )

finaloverridevirtual

move the Layer

Implements Trk::Layer.

Definition at line 72 of file SubtractedPlaneLayer.cxx.

                                                             {
  m_transforms =
      std::make_unique<Transforms>(shift * (m_transforms->transform));
}

name()

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

inlinefinaloverridevirtualinherited

Return properly formatted class name for screen output.

Reimplemented from Trk::PlaneSurface.

Definition at line 70 of file SubtractedPlaneSurface.h.

  {
    return "Trk::SubtractedPlaneSurface";
  }

nextLayer() [1/2]

const Trk::Layer * Trk::Layer::nextLayer ( bool skipNavLayer = false ) const

inherited

getting what's stored to be the next Layer, boolean to skip navigation layers

Definition at line 151 of file Layer.cxx.

                                                           {
  if (!skipNavLayer) return m_nextLayer;
  const Trk::Layer* nextMatLayer = m_nextLayer;
  // get the next Material layer
  while (nextMatLayer && !nextMatLayer->layerMaterialProperties() &&
         !nextMatLayer->surfaceArray())
    nextMatLayer = nextMatLayer->nextLayer();
  return nextMatLayer;
}

nextLayer() [2/2]

const Trk::Layer * Trk::Layer::nextLayer ( const Amg::Vector3D & gp, const Amg::Vector3D & udir ) const

inherited

getting the next/previous Layer if registered - unit for direction vector required

Definition at line 161 of file Layer.cxx.

                                                                      {
  // no binutility -> no chance to find out the direction
  if (!m_binUtility) return nullptr;
  return (m_binUtility->orderDirection(gp, mom) == Trk::next) ? m_nextLayer
                                                              : m_previousLayer;
}

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

onLayer()

template<class T>

bool Trk::Layer::onLayer ( const T & parameters, const BoundaryCheck & bcheck = BoundaryCheck(true) ) const

inherited

templated on Layer method

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::SubtractedPlaneLayer & Trk::SubtractedPlaneLayer::operator=

(

const SubtractedPlaneLayer &

play

)

Assignment operator for PlaneLayers.

Definition at line 32 of file SubtractedPlaneLayer.cxx.

                                      {
  if (this != &play) {
    // call the assignments of the base classes
    Trk::SubtractedPlaneSurface::operator=(play);
    Trk::Layer::operator=(play);
  }
  return (*this);
}

operator==() [1/2]

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

inherited

operator==() [2/2]

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

finaloverridevirtualinherited

Equality operator.

Reimplemented from Trk::PlaneSurface.

Definition at line 42 of file SubtractedPlaneSurface.cxx.

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

overlapDescriptor()

const OverlapDescriptor * Trk::Layer::overlapDescriptor ( ) const

inherited

gettint hte overlap descriptor

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

postUpdateMaterialFactor()

double Trk::SubtractedPlaneLayer::postUpdateMaterialFactor ( const Trk::TrackParameters & par, Trk::PropDirection dir ) const

finaloverridevirtual

getting the MaterialProperties back - for post-update

Reimplemented from Trk::Layer.

Definition at line 63 of file SubtractedPlaneLayer.cxx.

                                                                {
  if (!Trk::Layer::m_layerMaterialProperties) return 0.;
  if (Trk::SubtractedPlaneSurface::normal().dot(
          dir * parm.momentum().normalized()) > 0.)
    return Trk::Layer::m_layerMaterialProperties->alongPostFactor();
  return Trk::Layer::m_layerMaterialProperties->oppositePostFactor();
}

preUpdateMaterialFactor()

double Trk::SubtractedPlaneLayer::preUpdateMaterialFactor ( const Trk::TrackParameters & par, Trk::PropDirection dir ) const

finaloverridevirtual

getting the MaterialProperties back - for pre-update

Reimplemented from Trk::Layer.

Definition at line 54 of file SubtractedPlaneLayer.cxx.

                                                                {
  if (!Trk::Layer::m_layerMaterialProperties) return 0.;
  if (Trk::SubtractedPlaneSurface::normal().dot(
          dir * parm.momentum().normalized()) > 0.)
    return Trk::Layer::m_layerMaterialProperties->alongPreFactor();
  return Trk::Layer::m_layerMaterialProperties->oppositePreFactor();
}

previousLayer()

const Trk::Layer * Trk::Layer::previousLayer ( bool skipNavLayer = false ) const

inherited

getting what's stored to be the previous Layer, boolean to skip navigation layers

Definition at line 141 of file Layer.cxx.

                                                               {
  if (!skipNavLayer) return m_previousLayer;
  const Trk::Layer* prevMatLayer = m_previousLayer;
  // get the previoys Material layer
  while (prevMatLayer && !prevMatLayer->layerMaterialProperties() &&
         !prevMatLayer->surfaceArray())
    prevMatLayer = prevMatLayer->previousLayer();
  return prevMatLayer;
}

registerLayerIndex()

void Trk::Layer::registerLayerIndex ( const LayerIndex & lIdx )

inherited

registerRepresentingVolume()

void Trk::Layer::registerRepresentingVolume ( const Volume * theVol )

inherited

register Volume associated to the layer

representingVolume()

const Volume * Trk::Layer::representingVolume ( ) const

inherited

get the Volume associated to the layer

resizeAndRepositionLayer()

virtual void Trk::SubtractedPlaneLayer::resizeAndRepositionLayer ( const VolumeBounds & , const Amg::Vector3D & , double  )

inlinefinaloverridevirtual

Resize the layer to the tracking volume - not implemented.

Implements Trk::Layer.

Definition at line 77 of file SubtractedPlaneLayer.h.

                                                               {}

resizeLayer()

virtual void Trk::SubtractedPlaneLayer::resizeLayer ( const VolumeBounds & , double  )

inlinefinaloverridevirtual

Resize the layer to the tracking volume - not implemented.

Implements Trk::Layer.

Definition at line 74 of file SubtractedPlaneLayer.h.

{}

setBinUtility()

void Trk::Layer::setBinUtility ( const BinUtility * )

inherited

set the BinUtility

setLayerType()

void Trk::Layer::setLayerType ( int identifier )

inherited

set the Layer coding

setMaterialLayer()

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

inherited

set material layer

setNextLayer()

void Trk::Layer::setNextLayer ( const Layer * )

inherited

set the next Layer

setOwner()

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

inherited

set Ownership

setPreviousLayer()

void Trk::Layer::setPreviousLayer ( const Layer * )

inherited

set the previous Layer

setRef()

void Trk::Layer::setRef ( double )

inherited

set the reference measure

setTransform()

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

inherited

Set the transform updates center and normal.

shared()

bool Trk::SubtractedPlaneSurface::shared ( ) const

inherited

This method indicates the subtraction mode.

straightLineDistanceEstimate() [1/2]

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

finaloverridevirtualinherited

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

finaloverridevirtualinherited

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

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

subSurface() [1/2]

const Trk::Surface * Trk::Layer::subSurface ( const Amg::Vector2D & lp ) const

inherited

If no subSurface array is defined or no subSurface can be found to the given Amg::Vector2D, it would return 0.

Definition at line 112 of file Layer.cxx.

                                                                  {
  if (m_surfaceArray) return m_surfaceArray->object(lp);
  return nullptr;
}

subSurface() [2/2]

const Trk::Surface * Trk::Layer::subSurface ( const Amg::Vector3D & gp ) const

inherited

If no subSurface array is defined or no subSurface can be found to the given Amg::Vector3D, it would return 0.

Definition at line 107 of file Layer.cxx.

                                                                  {
  if (m_surfaceArray) return m_surfaceArray->object(gp);
  return nullptr;
}

subSurfaceReference()

const Trk::Surface * Trk::Layer::subSurfaceReference ( unsigned int idx = 0 ) const

inherited

Return a reference sub surface of the layer, usually the first one in the array.

• if an index is given (and the index is in range), this surface is returned

Definition at line 117 of file Layer.cxx.

                                                                      {
  // the reference surface
  const Trk::Surface* referenceSurface = nullptr;
  if (m_surfaceArray) {
    // get a reference surface
    std::span<Trk::Surface const * const> surfaces =  std::as_const(*m_surfaceArray).arrayObjects();
    // get a reference surface
    unsigned int rfSurfaces = surfaces.size();
    if (idx && idx < rfSurfaces) return surfaces[idx];
    // get the first one which is non zero
    for (unsigned int rsf = 0; rsf < rfSurfaces; ++rsf) {
      referenceSurface = surfaces[rsf];
      if (referenceSurface) break;
    }
  }
  return referenceSurface;
}

subtractedVolume()

const AreaExcluder * Trk::SubtractedPlaneSurface::subtractedVolume ( ) const

inherited

This method allows access to the subtracted part.

surfaceArray() [1/2]

SurfaceArray * Trk::Layer::surfaceArray ( )

inherited

Return the entire SurfaceArray, returns nullptr if no SurfaceArray.

surfaceArray() [2/2]

const SurfaceArray * Trk::Layer::surfaceArray ( ) const

inherited

Return the entire SurfaceArray, returns nullptr if no SurfaceArray.

surfaceOnApproach()

const Trk::Surface & Trk::Layer::surfaceOnApproach ( const Amg::Vector3D & pos, const Amg::Vector3D & dir, PropDirection pdir, const BoundaryCheck & bcheck, bool resolveSubSurfaces = 0, const ICompatibilityEstimator * ice = nullptr ) const

virtualinherited

Surface seen on approach - if not defined differently, it is the surfaceRepresentation()

Reimplemented in Trk::CylinderLayer, and Trk::DiscLayer.

Definition at line 209 of file Layer.cxx.

                                             {
  return surfaceRepresentation();
}

surfaceRepresentation() [1/2]

const Trk::SubtractedPlaneSurface & Trk::SubtractedPlaneLayer::surfaceRepresentation ( ) const

finaloverridevirtual

Transforms the layer into a Surface representation for extrapolation.

Implements Trk::Layer.

Definition at line 43 of file SubtractedPlaneLayer.cxx.

{
  return (*this);
}

surfaceRepresentation() [2/2]

Trk::SubtractedPlaneSurface & Trk::SubtractedPlaneLayer::surfaceRepresentation ( )

finaloverridevirtual

Implements Trk::Layer.

Definition at line 49 of file SubtractedPlaneLayer.cxx.

{
  return (*this);
}

thickness()

double Trk::Layer::thickness ( ) const

inherited

Return the Thickness of the Layer.

transform()

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

inherited

Returns HepGeom::Transform3D by reference.

type()

virtual constexpr SurfaceType Trk::PlaneSurface::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_binUtility

const BinUtility* Trk::Layer::m_binUtility = nullptr

protectedinherited

Enclosing TrackingVolume.

Definition at line 300 of file Layer.h.

m_bounds

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

protectedinherited

bounds (shared)

NoBounds as return object when no bounds are declared

Definition at line 284 of file PlaneSurface.h.

m_enclosingDetachedTrackingVolume

const DetachedTrackingVolume* Trk::Layer::m_enclosingDetachedTrackingVolume = nullptr

protectedinherited

Definition at line 304 of file Layer.h.

m_enclosingTrackingVolume

const TrackingVolume* Trk::Layer::m_enclosingTrackingVolume = nullptr

protectedinherited

Enclosing DetachedTrackingVolume.

Definition at line 302 of file Layer.h.

m_index

LayerIndex Trk::Layer::m_index {-1}

protectedinherited

LayerIndex.

Definition at line 306 of file Layer.h.

{-1};  

m_layerMaterialProperties

std::unique_ptr<LayerMaterialProperties> Trk::Layer::m_layerMaterialProperties {}

protectedinherited

thickness of the Layer

Definition at line 288 of file Layer.h.

{};

m_layerThickness

double Trk::Layer::m_layerThickness {}

protectedinherited

descriptor for overlap/next surface (owning ptr)

Definition at line 290 of file Layer.h.

{};

m_layerType

int Trk::Layer::m_layerType {Trk::active}

protectedinherited

active passive layer

Definition at line 307 of file Layer.h.

{Trk::active}; 

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_nextLayer

const Layer* Trk::Layer::m_nextLayer = nullptr

protectedinherited

BinUtility for next/previous decision.

Definition at line 298 of file Layer.h.

m_overlapDescriptor

std::unique_ptr<OverlapDescriptor> Trk::Layer::m_overlapDescriptor {}

protectedinherited

Definition at line 292 of file Layer.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_previousLayer

const Layer* Trk::Layer::m_previousLayer = nullptr

protectedinherited

< the previous Layer according to BinGenUtils

next Layer according to BinGenUtils

Definition at line 296 of file Layer.h.

m_ref

double Trk::Layer::m_ref {}

protectedinherited

reference measure for local coordinate convertors

Definition at line 308 of file Layer.h.

{};  

m_shared

bool Trk::SubtractedPlaneSurface::m_shared {true}

protectedinherited

Definition at line 77 of file SubtractedPlaneSurface.h.

{true};

m_subtrVol

std::shared_ptr<const AreaExcluder> Trk::SubtractedPlaneSurface::m_subtrVol

protectedinherited

Definition at line 76 of file SubtractedPlaneSurface.h.

m_surfaceArray

std::unique_ptr<SurfaceArray> Trk::Layer::m_surfaceArray {}

protectedinherited

MaterialPoperties of this layer Surface.

Definition at line 286 of file Layer.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_boundless

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

staticprotectedinherited

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

staticconstexprinherited

The surface type static constexpr.

Definition at line 67 of file PlaneSurface.h.

---

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

• SubtractedPlaneLayer.h
• SubtractedPlaneLayer.cxx