Acts::IGrid Class Reference

Base class for all grid types. More...

#include <Acts/Utilities/Grid.hpp>

Inheritance diagram for Acts::IGrid:

Public Member Functions
virtual	~IGrid ()=default
virtual boost::container::small_vector< const IAxis *, 3 >	axes () const =0
	Get a dynamically sized vector of axis objects for inspection.
virtual std::size_t	dimensions () const =0
	Get the number of dimensions of the grid.
virtual std::type_info const &	valueType () const =0
	Get the type of the values stored in the grid.

Protected Member Functions
virtual std::any	atLocalBinsAny (AnyIndexType indices) const =0
	Get the value of a bin for a given set of indices.
virtual std::any	atLocalBinsAny (AnyIndexType indices)=0
	Get the value of a bin for a given set of indices.
virtual void	toStream (std::ostream &os) const =0
using	AnyIndexType = boost::container::small_vector<std::size_t, 3>
	Type-erased interface to access the contents of the grid.
using	AnyPointType = boost::container::small_vector<double, 3>
	Type alias for dynamic point type (coordinates as vector of doubles).
virtual AnyPointType	lowerLeftBinEdgeAny (AnyIndexType indices) const =0
	Get the lower left edge of a bin for a given set of indices.
virtual AnyPointType	upperRightBinEdgeAny (AnyIndexType indices) const =0
	Get the upper right edge of a bin for a given set of indices.
virtual AnyPointType	binCenterAny (AnyIndexType indices) const =0
	Get the center of a bin for a given set of indices.
virtual AnyIndexType	numLocalBinsAny () const =0
	Get the number of local bins for a given set of indices.

Detailed Description

Base class for all grid types.

Member Typedef Documentation

AnyIndexType

using Acts::IGrid::AnyIndexType = boost::container::small_vector<std::size_t, 3>

Type-erased interface to access the contents of the grid.

Note

This interface has non-negligible runtime overhead due to packing and unpacking from/to std::any and the dynamically sized index and point types. USE WITH CARE!

AnyPointType

using Acts::IGrid::AnyPointType = boost::container::small_vector<double, 3>

Type alias for dynamic point type (coordinates as vector of doubles).

Constructor & Destructor Documentation

~IGrid()

virtual Acts::IGrid::~IGrid ( )

virtualdefault

Member Function Documentation

atLocalBinsAny() [1/2]

virtual std::any Acts::IGrid::atLocalBinsAny ( AnyIndexType indices ) const

protectedpure virtual

Get the value of a bin for a given set of indices.

Parameters

indices

The indices to get the value of the bin for

Returns

The value of the bin: the std::any contains a const pointer to the value

Implemented in Acts::Grid< T, Axes >, Acts::Grid< Acts::AccumulatedVolumeMaterial, EAxis, EAxis >, Acts::Grid< Acts::AccumulatedVolumeMaterial, EAxis, EAxis, EAxis >, Acts::Grid< Acts::Material::ParametersVector, EAxis, EAxis >, Acts::Grid< Acts::Material::ParametersVector, EAxis, EAxis, EAxis >, Acts::Grid< BinType, PhiAxisType, ZAxisType, RAxisType >, Acts::Grid< const TrackingVolume *, Axes... >, Acts::Grid< HoughCell< identifier_t >, Axis, Axis >, Acts::Grid< HoughCount_t, HoughAxis, HoughAxis >, Acts::Grid< SurfaceVector, Axis1, Axis2 >, Acts::Grid< T, Axis< AxisType::Equidistant, aType > >, Acts::Grid< T, Axis< AxisType::Equidistant, aType >, Axis< AxisType::Equidistant, bType > >, Acts::Grid< T, Axis< AxisType::Equidistant, aType >, Axis< AxisType::Variable, bType > >, Acts::Grid< T, Axis< AxisType::Variable, aType > >, Acts::Grid< T, Axis< AxisType::Variable, aType >, Axis< AxisType::Equidistant, bType > >, and Acts::Grid< T, Axis< AxisType::Variable, aType >, Axis< AxisType::Variable, bType > >.

atLocalBinsAny() [2/2]

virtual std::any Acts::IGrid::atLocalBinsAny ( AnyIndexType indices )

protectedpure virtual

Get the value of a bin for a given set of indices.

Parameters

indices

The indices to get the value of the bin for

Returns

The value of the bin: the std::any contains a pointer to the value

Implemented in Acts::Grid< T, Axes >, Acts::Grid< Acts::AccumulatedVolumeMaterial, EAxis, EAxis >, Acts::Grid< Acts::AccumulatedVolumeMaterial, EAxis, EAxis, EAxis >, Acts::Grid< Acts::Material::ParametersVector, EAxis, EAxis >, Acts::Grid< Acts::Material::ParametersVector, EAxis, EAxis, EAxis >, Acts::Grid< BinType, PhiAxisType, ZAxisType, RAxisType >, Acts::Grid< const TrackingVolume *, Axes... >, Acts::Grid< HoughCell< identifier_t >, Axis, Axis >, Acts::Grid< HoughCount_t, HoughAxis, HoughAxis >, Acts::Grid< SurfaceVector, Axis1, Axis2 >, Acts::Grid< T, Axis< AxisType::Equidistant, aType > >, Acts::Grid< T, Axis< AxisType::Equidistant, aType >, Axis< AxisType::Equidistant, bType > >, Acts::Grid< T, Axis< AxisType::Equidistant, aType >, Axis< AxisType::Variable, bType > >, Acts::Grid< T, Axis< AxisType::Variable, aType > >, Acts::Grid< T, Axis< AxisType::Variable, aType >, Axis< AxisType::Equidistant, bType > >, and Acts::Grid< T, Axis< AxisType::Variable, aType >, Axis< AxisType::Variable, bType > >.

axes()

virtual boost::container::small_vector< const IAxis *, 3 > Acts::IGrid::axes ( ) const

pure virtual

Get a dynamically sized vector of axis objects for inspection.

Returns

a vector of axis pointers

Implemented in Acts::Grid< T, Axes >, Acts::Grid< Acts::AccumulatedVolumeMaterial, EAxis, EAxis >, Acts::Grid< Acts::AccumulatedVolumeMaterial, EAxis, EAxis, EAxis >, Acts::Grid< Acts::Material::ParametersVector, EAxis, EAxis >, Acts::Grid< Acts::Material::ParametersVector, EAxis, EAxis, EAxis >, Acts::Grid< BinType, PhiAxisType, ZAxisType, RAxisType >, Acts::Grid< const TrackingVolume *, Axes... >, Acts::Grid< HoughCell< identifier_t >, Axis, Axis >, Acts::Grid< HoughCount_t, HoughAxis, HoughAxis >, Acts::Grid< SurfaceVector, Axis1, Axis2 >, Acts::Grid< T, Axis< AxisType::Equidistant, aType > >, Acts::Grid< T, Axis< AxisType::Equidistant, aType >, Axis< AxisType::Equidistant, bType > >, Acts::Grid< T, Axis< AxisType::Equidistant, aType >, Axis< AxisType::Variable, bType > >, Acts::Grid< T, Axis< AxisType::Variable, aType > >, Acts::Grid< T, Axis< AxisType::Variable, aType >, Axis< AxisType::Equidistant, bType > >, and Acts::Grid< T, Axis< AxisType::Variable, aType >, Axis< AxisType::Variable, bType > >.

binCenterAny()

virtual AnyPointType Acts::IGrid::binCenterAny ( AnyIndexType indices ) const

pure virtual

Get the center of a bin for a given set of indices.

Parameters

indices

The indices to get the center of the bin for

Returns

The center of the bin

Implemented in Acts::Grid< T, Axes >, Acts::Grid< Acts::AccumulatedVolumeMaterial, EAxis, EAxis >, Acts::Grid< Acts::AccumulatedVolumeMaterial, EAxis, EAxis, EAxis >, Acts::Grid< Acts::Material::ParametersVector, EAxis, EAxis >, Acts::Grid< Acts::Material::ParametersVector, EAxis, EAxis, EAxis >, Acts::Grid< BinType, PhiAxisType, ZAxisType, RAxisType >, Acts::Grid< const TrackingVolume *, Axes... >, Acts::Grid< HoughCell< identifier_t >, Axis, Axis >, Acts::Grid< HoughCount_t, HoughAxis, HoughAxis >, Acts::Grid< SurfaceVector, Axis1, Axis2 >, Acts::Grid< T, Axis< AxisType::Equidistant, aType > >, Acts::Grid< T, Axis< AxisType::Equidistant, aType >, Axis< AxisType::Equidistant, bType > >, Acts::Grid< T, Axis< AxisType::Equidistant, aType >, Axis< AxisType::Variable, bType > >, Acts::Grid< T, Axis< AxisType::Variable, aType > >, Acts::Grid< T, Axis< AxisType::Variable, aType >, Axis< AxisType::Equidistant, bType > >, and Acts::Grid< T, Axis< AxisType::Variable, aType >, Axis< AxisType::Variable, bType > >.

dimensions()

virtual std::size_t Acts::IGrid::dimensions ( ) const

pure virtual

Get the number of dimensions of the grid.

Returns

The number of dimensions of the grid

Implemented in Acts::Grid< T, Axes >, Acts::Grid< Acts::AccumulatedVolumeMaterial, EAxis, EAxis >, Acts::Grid< Acts::AccumulatedVolumeMaterial, EAxis, EAxis, EAxis >, Acts::Grid< Acts::Material::ParametersVector, EAxis, EAxis >, Acts::Grid< Acts::Material::ParametersVector, EAxis, EAxis, EAxis >, Acts::Grid< BinType, PhiAxisType, ZAxisType, RAxisType >, Acts::Grid< const TrackingVolume *, Axes... >, Acts::Grid< HoughCell< identifier_t >, Axis, Axis >, Acts::Grid< HoughCount_t, HoughAxis, HoughAxis >, Acts::Grid< SurfaceVector, Axis1, Axis2 >, Acts::Grid< T, Axis< AxisType::Equidistant, aType > >, Acts::Grid< T, Axis< AxisType::Equidistant, aType >, Axis< AxisType::Equidistant, bType > >, Acts::Grid< T, Axis< AxisType::Equidistant, aType >, Axis< AxisType::Variable, bType > >, Acts::Grid< T, Axis< AxisType::Variable, aType > >, Acts::Grid< T, Axis< AxisType::Variable, aType >, Axis< AxisType::Equidistant, bType > >, and Acts::Grid< T, Axis< AxisType::Variable, aType >, Axis< AxisType::Variable, bType > >.

lowerLeftBinEdgeAny()

virtual AnyPointType Acts::IGrid::lowerLeftBinEdgeAny ( AnyIndexType indices ) const

pure virtual

Get the lower left edge of a bin for a given set of indices.

Parameters

indices

The indices to get the lower left edge of the bin for

Returns

The lower left edge of the bin

Implemented in Acts::Grid< T, Axes >, Acts::Grid< Acts::AccumulatedVolumeMaterial, EAxis, EAxis >, Acts::Grid< Acts::AccumulatedVolumeMaterial, EAxis, EAxis, EAxis >, Acts::Grid< Acts::Material::ParametersVector, EAxis, EAxis >, Acts::Grid< Acts::Material::ParametersVector, EAxis, EAxis, EAxis >, Acts::Grid< BinType, PhiAxisType, ZAxisType, RAxisType >, Acts::Grid< const TrackingVolume *, Axes... >, Acts::Grid< HoughCell< identifier_t >, Axis, Axis >, Acts::Grid< HoughCount_t, HoughAxis, HoughAxis >, Acts::Grid< SurfaceVector, Axis1, Axis2 >, Acts::Grid< T, Axis< AxisType::Equidistant, aType > >, Acts::Grid< T, Axis< AxisType::Equidistant, aType >, Axis< AxisType::Equidistant, bType > >, Acts::Grid< T, Axis< AxisType::Equidistant, aType >, Axis< AxisType::Variable, bType > >, Acts::Grid< T, Axis< AxisType::Variable, aType > >, Acts::Grid< T, Axis< AxisType::Variable, aType >, Axis< AxisType::Equidistant, bType > >, and Acts::Grid< T, Axis< AxisType::Variable, aType >, Axis< AxisType::Variable, bType > >.

numLocalBinsAny()

virtual AnyIndexType Acts::IGrid::numLocalBinsAny ( ) const

pure virtual

Get the number of local bins for a given set of indices.

Returns

The number of local bins

Implemented in Acts::Grid< T, Axes >, Acts::Grid< Acts::AccumulatedVolumeMaterial, EAxis, EAxis >, Acts::Grid< Acts::AccumulatedVolumeMaterial, EAxis, EAxis, EAxis >, Acts::Grid< Acts::Material::ParametersVector, EAxis, EAxis >, Acts::Grid< Acts::Material::ParametersVector, EAxis, EAxis, EAxis >, Acts::Grid< BinType, PhiAxisType, ZAxisType, RAxisType >, Acts::Grid< const TrackingVolume *, Axes... >, Acts::Grid< HoughCell< identifier_t >, Axis, Axis >, Acts::Grid< HoughCount_t, HoughAxis, HoughAxis >, Acts::Grid< SurfaceVector, Axis1, Axis2 >, Acts::Grid< T, Axis< AxisType::Equidistant, aType > >, Acts::Grid< T, Axis< AxisType::Equidistant, aType >, Axis< AxisType::Equidistant, bType > >, Acts::Grid< T, Axis< AxisType::Equidistant, aType >, Axis< AxisType::Variable, bType > >, Acts::Grid< T, Axis< AxisType::Variable, aType > >, Acts::Grid< T, Axis< AxisType::Variable, aType >, Axis< AxisType::Equidistant, bType > >, and Acts::Grid< T, Axis< AxisType::Variable, aType >, Axis< AxisType::Variable, bType > >.

toStream()

virtual void Acts::IGrid::toStream ( std::ostream & os ) const

protectedpure virtual

Parameters

os	Output stream to write grid representation to

Implemented in Acts::Grid< T, Axes >, Acts::Grid< Acts::AccumulatedVolumeMaterial, EAxis, EAxis >, Acts::Grid< Acts::AccumulatedVolumeMaterial, EAxis, EAxis, EAxis >, Acts::Grid< Acts::Material::ParametersVector, EAxis, EAxis >, Acts::Grid< Acts::Material::ParametersVector, EAxis, EAxis, EAxis >, Acts::Grid< BinType, PhiAxisType, ZAxisType, RAxisType >, Acts::Grid< const TrackingVolume *, Axes... >, Acts::Grid< HoughCell< identifier_t >, Axis, Axis >, Acts::Grid< HoughCount_t, HoughAxis, HoughAxis >, Acts::Grid< SurfaceVector, Axis1, Axis2 >, Acts::Grid< T, Axis< AxisType::Equidistant, aType > >, Acts::Grid< T, Axis< AxisType::Equidistant, aType >, Axis< AxisType::Equidistant, bType > >, Acts::Grid< T, Axis< AxisType::Equidistant, aType >, Axis< AxisType::Variable, bType > >, Acts::Grid< T, Axis< AxisType::Variable, aType > >, Acts::Grid< T, Axis< AxisType::Variable, aType >, Axis< AxisType::Equidistant, bType > >, and Acts::Grid< T, Axis< AxisType::Variable, aType >, Axis< AxisType::Variable, bType > >.

upperRightBinEdgeAny()

virtual AnyPointType Acts::IGrid::upperRightBinEdgeAny ( AnyIndexType indices ) const

pure virtual

Get the upper right edge of a bin for a given set of indices.

Parameters

indices

The indices to get the upper right edge of the bin for

Returns

The upper right edge of the bin

Implemented in Acts::Grid< T, Axes >, Acts::Grid< Acts::AccumulatedVolumeMaterial, EAxis, EAxis >, Acts::Grid< Acts::AccumulatedVolumeMaterial, EAxis, EAxis, EAxis >, Acts::Grid< Acts::Material::ParametersVector, EAxis, EAxis >, Acts::Grid< Acts::Material::ParametersVector, EAxis, EAxis, EAxis >, Acts::Grid< BinType, PhiAxisType, ZAxisType, RAxisType >, Acts::Grid< const TrackingVolume *, Axes... >, Acts::Grid< HoughCell< identifier_t >, Axis, Axis >, Acts::Grid< HoughCount_t, HoughAxis, HoughAxis >, Acts::Grid< SurfaceVector, Axis1, Axis2 >, Acts::Grid< T, Axis< AxisType::Equidistant, aType > >, Acts::Grid< T, Axis< AxisType::Equidistant, aType >, Axis< AxisType::Equidistant, bType > >, Acts::Grid< T, Axis< AxisType::Equidistant, aType >, Axis< AxisType::Variable, bType > >, Acts::Grid< T, Axis< AxisType::Variable, aType > >, Acts::Grid< T, Axis< AxisType::Variable, aType >, Axis< AxisType::Equidistant, bType > >, and Acts::Grid< T, Axis< AxisType::Variable, aType >, Axis< AxisType::Variable, bType > >.

valueType()

virtual std::type_info const & Acts::IGrid::valueType ( ) const

pure virtual

Get the type of the values stored in the grid.

Returns

The type of the values stored in the grid

Implemented in Acts::Grid< T, Axes >, Acts::Grid< Acts::AccumulatedVolumeMaterial, EAxis, EAxis >, Acts::Grid< Acts::AccumulatedVolumeMaterial, EAxis, EAxis, EAxis >, Acts::Grid< Acts::Material::ParametersVector, EAxis, EAxis >, Acts::Grid< Acts::Material::ParametersVector, EAxis, EAxis, EAxis >, Acts::Grid< BinType, PhiAxisType, ZAxisType, RAxisType >, Acts::Grid< const TrackingVolume *, Axes... >, Acts::Grid< HoughCell< identifier_t >, Axis, Axis >, Acts::Grid< HoughCount_t, HoughAxis, HoughAxis >, Acts::Grid< SurfaceVector, Axis1, Axis2 >, Acts::Grid< T, Axis< AxisType::Equidistant, aType > >, Acts::Grid< T, Axis< AxisType::Equidistant, aType >, Axis< AxisType::Equidistant, bType > >, Acts::Grid< T, Axis< AxisType::Equidistant, aType >, Axis< AxisType::Variable, bType > >, Acts::Grid< T, Axis< AxisType::Variable, aType > >, Acts::Grid< T, Axis< AxisType::Variable, aType >, Axis< AxisType::Equidistant, bType > >, and Acts::Grid< T, Axis< AxisType::Variable, aType >, Axis< AxisType::Variable, bType > >.