#include <acts/blob/sPHENIX/Core/include/Acts/Surfaces/RadialBounds.hpp>

Inheritance diagram for Acts::RadialBounds:

Collaboration diagram for Acts::RadialBounds:

Public Types
enum	BoundValues { eMinR = 0, eMaxR = 1, eHalfPhiSector = 2, eAveragePhi = 3, eSize = 4 }

Public Member Functions
	RadialBounds ()=delete

	RadialBounds (double minR, double maxR, double halfPhi=M_PI, double avgPhi=0.) noexcept(false)

	RadialBounds (const std::array< double, eSize > &values) noexcept(false)

	~RadialBounds () override=default

SurfaceBounds::BoundsType	type () const final

std::vector< double >	values () const final

bool	inside (const Vector2 &lposition, const BoundaryCheck &bcheck) const final

std::ostream &	toStream (std::ostream &sl) const final

double	rMin () const final
	Return method for inner Radius.

double	rMax () const final
	Return method for outer Radius.

double	get (BoundValues bValue) const

bool	coversFullAzimuth () const final
	Returns true for full phi coverage.

bool	insideRadialBounds (double R, double tolerance=0.) const final

double	binningValueR () const final
	Return a reference radius for binning.

double	binningValuePhi () const final
	Return a reference radius for binning.

Private Member Functions
void	checkConsistency () noexcept(false)

Vector2	shifted (const Vector2 &lposition) const

std::vector< Vector2 >	vertices (unsigned int lseg) const final

Private Attributes
std::array< double, eSize >	m_values

Detailed Description

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

Definition at line 32 of file RadialBounds.hpp.

View newest version in sPHENIX GitHub at line 32 of file RadialBounds.hpp

Member Enumeration Documentation

enum Acts::RadialBounds::BoundValues

Enumerator:

eMinR
eMaxR
eHalfPhiSector
eAveragePhi
eSize

Definition at line 34 of file RadialBounds.hpp.

View newest version in sPHENIX GitHub at line 34 of file RadialBounds.hpp

Constructor & Destructor Documentation

Acts::RadialBounds::RadialBounds ( )

delete

Acts::RadialBounds::RadialBounds	(	double	minR,
		double	maxR,
		double	halfPhi = `M_PI`,
		double	avgPhi = `0.`
	)

inlinenoexcept

Constructor for full disc of symmetric disc around phi=0

Parameters

minR	The inner radius (0 for full disc)
maxR	The outer radius
halfPhi	The half opening angle (Pi for full angular coverage)
avgPhi	The average phi for the disc/ring sector

Definition at line 50 of file RadialBounds.hpp.

View newest version in sPHENIX GitHub at line 50 of file RadialBounds.hpp

References maxR, and minR.

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

inlinenoexcept

Constructor from array values

Parameters

values The bound values

Definition at line 59 of file RadialBounds.hpp.

View newest version in sPHENIX GitHub at line 59 of file RadialBounds.hpp

References checkConsistency().

Here is the call graph for this function:

Acts::RadialBounds::~RadialBounds ( )

overridedefault

Member Function Documentation

double Acts::RadialBounds::binningValuePhi ( ) const

inlinefinalvirtual

Return a reference radius for binning.

Implements Acts::DiscBounds.

Definition at line 156 of file RadialBounds.hpp.

View newest version in sPHENIX GitHub at line 156 of file RadialBounds.hpp

References eAveragePhi.

double Acts::RadialBounds::binningValueR ( ) const

inlinefinalvirtual

Return a reference radius for binning.

Implements Acts::DiscBounds.

Definition at line 152 of file RadialBounds.hpp.

View newest version in sPHENIX GitHub at line 152 of file RadialBounds.hpp

References eMaxR, and eMinR.

void Acts::RadialBounds::checkConsistency ( )

inlineprivatenoexcept

Check the input values for consistency, will throw a logic_exception if consistency is not given

Definition at line 166 of file RadialBounds.hpp.

View newest version in sPHENIX GitHub at line 166 of file RadialBounds.hpp

References eAveragePhi, eHalfPhiSector, eMaxR, eMinR, and Acts::detail::radian_sym().

Referenced by RadialBounds().

Here is the call graph for this function:

Here is the caller graph for this function:

bool Acts::RadialBounds::coversFullAzimuth ( ) const

inlinefinalvirtual

Returns true for full phi coverage.

Implements Acts::DiscBounds.

Definition at line 144 of file RadialBounds.hpp.

View newest version in sPHENIX GitHub at line 144 of file RadialBounds.hpp

References eHalfPhiSector.

double Acts::RadialBounds::get ( BoundValues bValue ) const

inline

Access to the bound values

Parameters

bValue the class nested enum for the array access

Definition at line 95 of file RadialBounds.hpp.

View newest version in sPHENIX GitHub at line 95 of file RadialBounds.hpp

References m_values.

Referenced by Acts::adjustBinUtility(), Acts::MappingMaterialDecorator::binnedSurfaceMaterial(), Acts::Test::BOOST_AUTO_TEST_CASE(), and ActsFatras::PlanarSurfaceMask::radialMask().

Here is the caller graph for this function:

bool Acts::RadialBounds::inside	(	const Vector2 &	lposition,
		const BoundaryCheck &	bcheck
	)		const

finalvirtual

For disc surfaces the local position in (r,phi) is checked

Parameters

lposition	local position to be checked
bcheck	boundary check directive

Returns: is a boolean indicating the operation success

Implements Acts::SurfaceBounds.

Definition at line 31 of file RadialBounds.cpp.

View newest version in sPHENIX GitHub at line 31 of file RadialBounds.cpp

References Acts::BoundaryCheck::isInside().

Referenced by Acts::Test::BOOST_AUTO_TEST_CASE().

Here is the call graph for this function:

Here is the caller graph for this function:

bool Acts::RadialBounds::insideRadialBounds	(	double	R,
		double	tolerance = `0.`
	)		const

inlinefinalvirtual

Checks if this is inside the radial coverage given the a tolerance

Implements Acts::DiscBounds.

Definition at line 148 of file RadialBounds.hpp.

View newest version in sPHENIX GitHub at line 148 of file RadialBounds.hpp

References eMaxR, and eMinR.

double Acts::RadialBounds::rMax ( ) const

inlinefinalvirtual

Return method for outer Radius.

Implements Acts::DiscBounds.

Definition at line 140 of file RadialBounds.hpp.

View newest version in sPHENIX GitHub at line 140 of file RadialBounds.hpp

References eMaxR.

Referenced by Acts::CylinderVolumeBuilder::analyzeContent(), Acts::MappingMaterialDecorator::binnedSurfaceMaterial(), Acts::CylinderVolumeHelper::estimateAndCheckDimension(), and ActsExamples::RootMaterialTrackWriter::writeT().

Here is the caller graph for this function:

double Acts::RadialBounds::rMin ( ) const

inlinefinalvirtual

Return method for inner Radius.

Implements Acts::DiscBounds.

Definition at line 136 of file RadialBounds.hpp.

View newest version in sPHENIX GitHub at line 136 of file RadialBounds.hpp

References eMinR.

Referenced by Acts::CylinderVolumeBuilder::analyzeContent(), Acts::MappingMaterialDecorator::binnedSurfaceMaterial(), Acts::CylinderVolumeHelper::estimateAndCheckDimension(), and ActsExamples::RootMaterialTrackWriter::writeT().

Here is the caller graph for this function:

Acts::Vector2 Acts::RadialBounds::shifted ( const Vector2 & lposition ) const

private

Private helper method to shift a local position within the bounds

Parameters

lposition The local position in polar coordinates

Definition at line 22 of file RadialBounds.cpp.

View newest version in sPHENIX GitHub at line 22 of file RadialBounds.cpp

References Acts::eBoundLoc0, Acts::eBoundLoc1, Acts::detail::radian_sym(), and Acts::Test::tmp().

Here is the call graph for this function:

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

finalvirtual

Outstream operator

Parameters

sl	is the ostream to be dumped into

Implements Acts::SurfaceBounds.

Definition at line 44 of file RadialBounds.cpp.

View newest version in sPHENIX GitHub at line 44 of file RadialBounds.cpp

Referenced by Acts::Test::BOOST_AUTO_TEST_CASE().

Here is the caller graph for this function:

Acts::SurfaceBounds::BoundsType Acts::RadialBounds::type ( ) const

finalvirtual

Return the bounds type - for persistency optimization

Returns: is a BoundsType enum

Implements Acts::SurfaceBounds.

Definition at line 18 of file RadialBounds.cpp.

View newest version in sPHENIX GitHub at line 18 of file RadialBounds.cpp

References Acts::SurfaceBounds::eDisc.

Referenced by Acts::Test::BOOST_AUTO_TEST_CASE().

Here is the caller graph for this function:

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

inlinefinalvirtual

Return the bound values as dynamically sized vector

Returns: this returns a copy of the internal values

Implements Acts::SurfaceBounds.

Definition at line 160 of file RadialBounds.hpp.

View newest version in sPHENIX GitHub at line 160 of file RadialBounds.hpp

References m_values.

Referenced by Acts::Test::BOOST_AUTO_TEST_CASE().

Here is the caller graph for this function:

std::vector< Acts::Vector2 > Acts::RadialBounds::vertices ( unsigned int lseg ) const

finalprivatevirtual

This method returns the xy coordinates of vertices along the radial bounds

Parameters

lseg	the number of segments used to approximate and eventually curved line

Note: that the extremas are given, which may slightly alter the number of segments returned

Returns: vector for vertices in 2D

Implements Acts::DiscBounds.

Definition at line 38 of file RadialBounds.cpp.

View newest version in sPHENIX GitHub at line 38 of file RadialBounds.cpp

References Acts::detail::VerticesHelper::circularVertices().

Here is the call graph for this function:

Member Data Documentation

std::array<double, eSize> Acts::RadialBounds::m_values

private

Definition at line 111 of file RadialBounds.hpp.

View newest version in sPHENIX GitHub at line 111 of file RadialBounds.hpp

Referenced by get(), and values().

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

acts/blob/sPHENIX/Core/include/Acts/Surfaces/RadialBounds.hpp
acts/blob/sPHENIX/Core/src/Surfaces/RadialBounds.cpp

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation