Acts::IGrid Class Reference

Base class for all grid types. More...

#include <Acts/Utilities/IGrid.hpp>

Inheritance diagram for Acts::IGrid:

Public Member Functions
virtual const IAxis &	axis (std::size_t index) const
	Get the axis object for a given index.
virtual std::size_t	dimensions () const =0
	Get the number of dimensions of the grid.
virtual const IMultiAxis &	multiAxisAny () const =0
	Get the multi-axis object for the grid.

Protected Member Functions
virtual void	toStream (std::ostream &os) const =0
using	AnyIndexType = IMultiAxis::AnyLocalBins
	Type alias for dynamic index type (indices as vector of std::size_t).
using	AnyPointType = IMultiAxis::AnyPoint
	Type alias for dynamic point type (coordinates as vector of doubles).
using	AnyAxesVector = IMultiAxis::AnyAxesVector
	Dynamically sized vector of (non-owning) pointers to the contained axes.
virtual std::type_info const &	valueType () const =0
	Type-erased interface to access the contents of the grid.
virtual AnyAxesVector	axes () const
	Get a dynamically sized vector of axis objects for inspection.
virtual AnyPointType	lowerLeftBinEdgeAny (const AnyIndexType &indices) const
	Get the lower left edge of a bin for a given set of indices.
virtual AnyPointType	upperRightBinEdgeAny (const AnyIndexType &indices) const
	Get the upper right edge of a bin for a given set of indices.
virtual AnyPointType	binCenterAny (const AnyIndexType &indices) const
	Get the center of a bin for a given set of indices.
virtual AnyIndexType	numLocalBinsAny () const
	Get the number of local bins for a given set of indices.
virtual std::any	atLocalBinsAny (const AnyIndexType &indices) const =0
	Get the value of a bin for a given set of indices.
virtual std::any	atLocalBinsAny (const AnyIndexType &indices)=0
	Get the value of a bin for a given set of indices.

Detailed Description

Base class for all grid types.

Member Function Documentation

atLocalBinsAny() [1/2]

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

pure 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< const TrackingVolume *, Axes... >, Acts::Grid< HoughCell< identifier_t >, Axis, Axis >, 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 ( const AnyIndexType & indices )

pure 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< const TrackingVolume *, Axes... >, Acts::Grid< HoughCell< identifier_t >, Axis, Axis >, 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 AnyAxesVector Acts::IGrid::axes ( ) const

virtual

Get a dynamically sized vector of axis objects for inspection.

Returns

a vector of axis pointers

Reimplemented 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< const TrackingVolume *, Axes... >, Acts::Grid< HoughCell< identifier_t >, Axis, Axis >, 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 > >.

axis()

virtual const IAxis & Acts::IGrid::axis ( std::size_t index ) const

virtual

Get the axis object for a given index.

Parameters

index

The index of the axis to get

Returns

The axis object for the given index

Reimplemented 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< const TrackingVolume *, Axes... >, Acts::Grid< HoughCell< identifier_t >, Axis, Axis >, 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 ( const AnyIndexType & indices ) const

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

Deprecated

Use grid.multiAxisAny().getBinCenterAny(indices) instead

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< const TrackingVolume *, Axes... >, Acts::Grid< HoughCell< identifier_t >, Axis, Axis >, 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 ( const AnyIndexType & indices ) const

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

Deprecated

Use grid.multiAxisAny().getLowerLeftBinEdgeAny(indices) instead

multiAxisAny()

virtual const IMultiAxis & Acts::IGrid::multiAxisAny ( ) const

pure virtual

Get the multi-axis object for the grid.

Returns

The multi-axis object for 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< const TrackingVolume *, Axes... >, Acts::Grid< HoughCell< identifier_t >, Axis, Axis >, 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

virtual

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

Returns

The number of local bins

Deprecated

Use grid.multiAxisAny().getNBinsAny() instead

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< const TrackingVolume *, Axes... >, Acts::Grid< HoughCell< identifier_t >, Axis, Axis >, 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 ( const AnyIndexType & indices ) const

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

Deprecated

Use grid.multiAxisAny().getUpperRightBinEdgeAny(indices) instead

valueType()

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

pure virtual

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! 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< const TrackingVolume *, Axes... >, Acts::Grid< HoughCell< identifier_t >, Axis, Axis >, 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 > >.