Acts::EllipseBounds Class Reference

#include <Acts/Surfaces/EllipseBounds.hpp>

Inheritance diagram for Acts::EllipseBounds:

Collaboration diagram for Acts::EllipseBounds:

Public Types
enum	BoundValues {   eInnerRx = 0 , eInnerRy = 1 , eOuterRx = 2 , eOuterRy = 3 ,   eHalfPhiSector = 4 , eAveragePhi = 5 , eSize = 6 }
	Enumeration for the bound values. More...
Public Types inherited from Acts::SurfaceBounds
enum	BoundsType : int {   eCone = 0 , eCylinder = 1 , eDiamond = 2 , eDisc = 3 ,   eEllipse = 4 , eLine = 5 , eRectangle = 6 , eTrapezoid = 7 ,   eTriangle = 8 , eDiscTrapezoid = 9 , eConvexPolygon = 10 , eAnnulus = 11 ,   eBoundless = 12 , eOther = 13 }
	This is nested to the SurfaceBounds, as also VolumeBounds will have Bounds Type. More...

Public Member Functions
	EllipseBounds (const std::array< double, eSize > &values) noexcept(false)
	Constructor - from fixed size array.
	EllipseBounds (double innerRx, double innerRy, double outerRx, double outerRy, double halfPhi=std::numbers::pi, double averagePhi=0.) noexcept(false)
	Constructor for full of an ellipsoid ring.
const RectangleBounds &	boundingBox () const final
	Bounding box parameters.
Vector2	center () const final
	Calculate the center of the surface bounds in local coordinates.
Vector2	closestPoint (const Vector2 &lposition, const SquareMatrix2 &metric) const final
	Calculates the closest point on the bounds to a given local position.
double	get (BoundValues bValue) const
	Access to the bound values.
bool	inside (const Vector2 &lposition) const final
	Inside check for the bounds object.
virtual bool	inside (const Vector2 &lposition, const BoundaryTolerance &boundaryTolerance) const
	Inside check for the bounds object given a boundary tolerance.
std::ostream &	toStream (std::ostream &sl) const final
	Output Method for std::ostream.
BoundsType	type () const final
	Return the bounds type - for persistency optimization.
std::vector< double >	values () const final
	Return the bound values as dynamically sized vector.
std::vector< Vector2 >	vertices (unsigned int quarterSegments) const final
	Return the vertices.
Public Member Functions inherited from Acts::PlanarBounds
SquareMatrix2	boundToCartesianJacobian (const Vector2 &lposition) const final
	Computes the bound to cartesian jacobian at a given local position.
SquareMatrix2	boundToCartesianMetric (const Vector2 &lposition) const final
	Computes the bound to cartesian metric at a given local position.
bool	isCartesian () const final
	Check if the bound coordinates are cartesian.
Public Member Functions inherited from Acts::SurfaceBounds
virtual	~SurfaceBounds ()=default
virtual double	distance (const Vector2 &lposition) const
	Calculates the distance to the bounds from a given local position.

Detailed Description

Class to describe the bounds for a planar ellispoid surface.

By providing an argument for hphisec, the bounds can be restricted to a phi-range around the center position.

Member Enumeration Documentation

BoundValues

enum Acts::EllipseBounds::BoundValues

Enumeration for the bound values.

Enumerator
eInnerRx
eInnerRy
eOuterRx
eOuterRy
eHalfPhiSector
eAveragePhi
eSize

Constructor & Destructor Documentation

EllipseBounds() [1/2]

Acts::EllipseBounds::EllipseBounds ( double innerRx, double innerRy, double outerRx, double outerRy, double halfPhi = std::numbers::pi, double averagePhi = 0. )

explicit

Constructor for full of an ellipsoid ring.

Parameters

innerRx	The inner ellipse radius in x
innerRy	The inner ellipse radius in y
outerRx	The outer ellipse radius in x
outerRy	The outer ellipse radius in y
halfPhi	spanning phi sector (is set to pi as default)
averagePhi	average phi (is set to 0. as default)

EllipseBounds() [2/2]

Acts::EllipseBounds::EllipseBounds ( const std::array< double, eSize > & values )

explicitnoexcept

Constructor - from fixed size array.

Parameters

values

The parameter values

Member Function Documentation

boundingBox()

const RectangleBounds & Acts::EllipseBounds::boundingBox ( ) const

finalvirtual

Bounding box parameters.

Returns

rectangle bounds for a bounding box

Implements Acts::PlanarBounds.

center()

Vector2 Acts::EllipseBounds::center ( ) const

finalvirtual

Calculate the center of the surface bounds in local coordinates.

This method returns a representative center point of the bounds region. The exact definition varies by bounds type and coordinate system:

Cartesian bounds (Rectangle, Diamond, Trapezoid):

• Returns the geometric center or center of symmetry
• For symmetric shapes: center of bounding box or origin (0,0)

Polar/Cylindrical bounds (Radial, Cylinder, Cone):

• Returns (r, phi) where r is average radius, phi is average angle
• Coordinates are in the bounds' natural coordinate system

Complex bounds (Annulus, ConvexPolygon):

• Annulus: Pre-calculated from corner vertices (accounts for coordinate transforms)
• Polygon: Average of all vertices (vertex centroid, not area centroid)

Infinite bounds: Returns conceptual center at (0,0)

Note

The returned point is guaranteed to be a reasonable representative center, but may not be the true geometric centroid for all shapes.

Returns

Vector2 representing the center position in local coordinates

Implements Acts::SurfaceBounds.

closestPoint()

Vector2 Acts::EllipseBounds::closestPoint ( const Vector2 & lposition, const SquareMatrix2 & metric ) const

finalvirtual

Calculates the closest point on the bounds to a given local position.

Parameters

lposition	is the local position
metric	to be used for the distance calculation

Returns

the closest point on the bounds

Implements Acts::SurfaceBounds.

get()

double Acts::EllipseBounds::get

(

BoundValues

bValue

)

const

Access to the bound values.

Parameters

bValue

the class nested enum for the array access

Returns

Value of the specified bound parameter

inside() [1/2]

bool Acts::EllipseBounds::inside ( const Vector2 & lposition ) const

finalvirtual

Inside check for the bounds object.

Parameters

lposition

is the local position

Returns

true if the local position is inside the bounds

Implements Acts::SurfaceBounds.

inside() [2/2]

virtual bool Acts::SurfaceBounds::inside ( const Vector2 & lposition, const BoundaryTolerance & boundaryTolerance ) const

virtual

Inside check for the bounds object given a boundary tolerance.

Parameters

lposition	is the local position
boundaryTolerance	is the boundary tolerance object

Returns

true if the local position is inside the bounds and tolerance

Reimplemented from Acts::SurfaceBounds.

toStream()

std::ostream & Acts::EllipseBounds::toStream ( std::ostream & sl ) const

finalvirtual

Output Method for std::ostream.

Parameters

sl	The output stream to write to

Returns

Reference to the output stream after writing

Implements Acts::SurfaceBounds.

type()

BoundsType Acts::EllipseBounds::type ( ) const

finalvirtual

Return the bounds type - for persistency optimization.

Returns

the bounds type

Implements Acts::SurfaceBounds.

values()

std::vector< double > Acts::EllipseBounds::values ( ) const

finalvirtual

Return the bound values as dynamically sized vector.

Returns

this returns a copy of the internal values

Implements Acts::SurfaceBounds.

vertices()

std::vector< Vector2 > Acts::EllipseBounds::vertices ( unsigned int quarterSegments ) const

finalvirtual

Return the vertices.

Parameters

quarterSegments

is the number of segments to approximate a quarter of a circle. In order to symmetrize fully closed and sectoral cylinders, also in the first case the two end points are given (albeit they overlap) in -pi / pi

Returns

vector for vertices in 2D

Implements Acts::PlanarBounds.