Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Acts::detail::Grid< T, Axes > Class Template Referencefinal

class for describing a regular multi-dimensional grid More...

#include <acts/blob/sPHENIX/Core/include/Acts/Utilities/detail/Grid.hpp>

Public Types

using value_type = T
 type of values stored
 
using reference = value_type &
 reference type to values stored
 
using const_reference = const value_type &
 constant reference type to values stored
 
using point_t = std::array< ActsScalar, DIM >
 type for points in d-dimensional grid space
 
using index_t = std::array< size_t, DIM >
 index type using local bin indices along each axis
 

Public Member Functions

 Grid (std::tuple< Axes...> &axes)=delete
 default constructor
 
 Grid (std::tuple< Axes...> &&axes)
 
template<class Point >
reference atPosition (const Point &point)
 access value stored in bin for a given point
 
template<class Point >
const_reference atPosition (const Point &point) const
 access value stored in bin for a given point
 
reference at (size_t bin)
 access value stored in bin with given global bin number
 
const_reference at (size_t bin) const
 access value stored in bin with given global bin number
 
reference atLocalBins (const index_t &localBins)
 access value stored in bin with given local bin numbers
 
const_reference atLocalBins (const index_t &localBins) const
 access value stored in bin with given local bin numbers
 
template<class Point >
detail::GlobalNeighborHoodIndices
< DIM
closestPointsIndices (const Point &position) const
 get global bin indices for closest points on grid
 
std::array< ActsScalar, DIMbinCenter (const index_t &localBins) const
 get center position of bin with given local bin numbers
 
template<class Point >
size_t globalBinFromPosition (const Point &point) const
 determine global index for bin containing the given point
 
size_t globalBinFromLocalBins (const index_t &localBins) const
 determine global bin index from local bin indices along each axis
 
template<class Point >
size_t globalBinFromFromLowerLeftEdge (const Point &point) const
 determine global bin index of the bin with the lower left edge closest to the given point for each axis
 
template<class Point >
index_t localBinsFromPosition (const Point &point) const
 determine local bin index for each axis from the given point
 
index_t localBinsFromGlobalBin (size_t bin) const
 determine local bin index for each axis from global bin index
 
template<class Point >
index_t localBinsFromLowerLeftEdge (const Point &point) const
 determine local bin index of the bin with the lower left edge closest to the given point for each axis
 
point_t lowerLeftBinEdge (const index_t &localBins) const
 retrieve lower-left bin edge from set of local bin indices
 
point_t upperRightBinEdge (const index_t &localBins) const
 retrieve upper-right bin edge from set of local bin indices
 
point_t binWidth () const
 get bin width along each specific axis
 
index_t numLocalBins () const
 get number of bins along each specific axis
 
point_t minPosition () const
 get the minimum value of all axes of one grid
 
point_t maxPosition () const
 get the maximum value of all axes of one grid
 
void setExteriorBins (const value_type &value)
 set all overflow and underflow bins to a certain value
 
template<class Point , typename U = T, typename = std::enable_if_t< can_interpolate<Point, std::array<ActsScalar, DIM>, std::array<ActsScalar, DIM>, U>::value>>
T interpolate (const Point &point) const
 interpolate grid values to given position
 
template<class Point >
bool isInside (const Point &position) const
 check whether given point is inside grid limits
 
detail::GlobalNeighborHoodIndices
< DIM
neighborHoodIndices (const index_t &localBins, size_t size=1u) const
 get global bin indices for neighborhood
 
detail::GlobalNeighborHoodIndices
< DIM
neighborHoodIndices (const index_t &localBins, std::array< std::pair< int, int >, DIM > &sizePerAxis) const
 get global bin indices for neighborhood
 
size_t size (bool fullCounter=true) const
 total number of bins
 
std::array< const IAxis *, DIMaxes () const
 

Static Public Member Functions

static constexpr size_t dimensions ()
 dimensionality of grid
 

Static Public Attributes

static constexpr size_t DIM = sizeof...(Axes)
 number of dimensions of the grid
 

Private Member Functions

detail::GlobalNeighborHoodIndices
< DIM
rawClosestPointsIndices (const index_t &localBins) const
 

Private Attributes

std::tuple< Axes...> m_axes
 set of axis defining the multi-dimensional grid
 
std::vector< Tm_values
 linear value store for each bin
 

Detailed Description

template<typename T, class... Axes>
class Acts::detail::Grid< T, Axes >

class for describing a regular multi-dimensional grid

Template Parameters
Ttype of values stored inside the bins of the grid
Axesparameter pack of axis types defining the grid

Class describing a multi-dimensional, regular grid which can store objects in its multi-dimensional bins. Bins are hyper-boxes and can be accessed either by global bin index, local bin indices or position.

Note
T must be default-constructible.

Definition at line 39 of file Grid.hpp.

View newest version in sPHENIX GitHub at line 39 of file Grid.hpp

Member Typedef Documentation

template<typename T, class... Axes>
using Acts::detail::Grid< T, Axes >::const_reference = const value_type&

constant reference type to values stored

Definition at line 49 of file Grid.hpp.

View newest version in sPHENIX GitHub at line 49 of file Grid.hpp

template<typename T, class... Axes>
using Acts::detail::Grid< T, Axes >::index_t = std::array<size_t, DIM>

index type using local bin indices along each axis

Definition at line 53 of file Grid.hpp.

View newest version in sPHENIX GitHub at line 53 of file Grid.hpp

template<typename T, class... Axes>
using Acts::detail::Grid< T, Axes >::point_t = std::array<ActsScalar, DIM>

type for points in d-dimensional grid space

Definition at line 51 of file Grid.hpp.

View newest version in sPHENIX GitHub at line 51 of file Grid.hpp

template<typename T, class... Axes>
using Acts::detail::Grid< T, Axes >::reference = value_type&

reference type to values stored

Definition at line 47 of file Grid.hpp.

View newest version in sPHENIX GitHub at line 47 of file Grid.hpp

template<typename T, class... Axes>
using Acts::detail::Grid< T, Axes >::value_type = T

type of values stored

Definition at line 45 of file Grid.hpp.

View newest version in sPHENIX GitHub at line 45 of file Grid.hpp

Constructor & Destructor Documentation

template<typename T, class... Axes>
Acts::detail::Grid< T, Axes >::Grid ( std::tuple< Axes...> &  axes)
delete

default constructor

Parameters
[in]axesactual axis objects spanning the grid
template<typename T, class... Axes>
Acts::detail::Grid< T, Axes >::Grid ( std::tuple< Axes...> &&  axes)
inline

Definition at line 59 of file Grid.hpp.

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

Member Function Documentation

template<typename T, class... Axes>
const_reference Acts::detail::Grid< T, Axes >::at ( size_t  bin) const
inline

access value stored in bin with given global bin number

Parameters
[in]binglobal bin number
Returns
const-reference to value stored in bin containing the given point

Definition at line 113 of file Grid.hpp.

View newest version in sPHENIX GitHub at line 113 of file Grid.hpp

template<typename T, class... Axes>
reference Acts::detail::Grid< T, Axes >::atLocalBins ( const index_t localBins)
inline

access value stored in bin with given local bin numbers

Parameters
[in]localBinslocal bin indices along each axis
Returns
reference to value stored in bin containing the given point
Precondition
All local bin indices must be a valid index for the corresponding axis (including the under-/overflow bin for this axis).

Definition at line 123 of file Grid.hpp.

View newest version in sPHENIX GitHub at line 123 of file Grid.hpp

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

+ Here is the caller graph for this function:

template<typename T, class... Axes>
const_reference Acts::detail::Grid< T, Axes >::atLocalBins ( const index_t localBins) const
inline

access value stored in bin with given local bin numbers

Parameters
[in]localBinslocal bin indices along each axis
Returns
const-reference to value stored in bin containing the given point
Precondition
All local bin indices must be a valid index for the corresponding axis (including the under-/overflow bin for this axis).

Definition at line 135 of file Grid.hpp.

View newest version in sPHENIX GitHub at line 135 of file Grid.hpp

template<typename T, class... Axes>
template<class Point >
reference Acts::detail::Grid< T, Axes >::atPosition ( const Point &  point)
inline

access value stored in bin for a given point

Template Parameters
Pointany type with point semantics supporting component access through operator[]
Parameters
[in]pointpoint used to look up the corresponding bin in the grid
Returns
reference to value stored in bin containing the given point
Precondition
The given Point type must represent a point in d (or higher) dimensions where d is dimensionality of the grid.
Note
The look-up considers under-/overflow bins along each axis. Therefore, the look-up will never fail.

Definition at line 78 of file Grid.hpp.

View newest version in sPHENIX GitHub at line 78 of file Grid.hpp

Referenced by Acts::Test::BOOST_AUTO_TEST_CASE(), and Acts::SurfaceArray::SurfaceGridLookup< Axes >::lookup().

+ Here is the caller graph for this function:

template<typename T, class... Axes>
template<class Point >
const_reference Acts::detail::Grid< T, Axes >::atPosition ( const Point &  point) const
inline

access value stored in bin for a given point

Template Parameters
Pointany type with point semantics supporting component access through operator[]
Parameters
[in]pointpoint used to look up the corresponding bin in the grid
Returns
const-reference to value stored in bin containing the given point
Precondition
The given Point type must represent a point in d (or higher) dimensions where d is dimensionality of the grid.
Note
The look-up considers under-/overflow bins along each axis. Therefore, the look-up will never fail.

Definition at line 97 of file Grid.hpp.

View newest version in sPHENIX GitHub at line 97 of file Grid.hpp

template<typename T, class... Axes>
std::array<const IAxis*, DIM> Acts::detail::Grid< T, Axes >::axes ( ) const
inline

Definition at line 458 of file Grid.hpp.

View newest version in sPHENIX GitHub at line 458 of file Grid.hpp

Referenced by Acts::SurfaceArray::SurfaceGridLookup< Axes >::getAxes(), and Acts::PortalJsonConverter::toJsonDetray().

+ Here is the caller graph for this function:

template<typename T, class... Axes>
std::array<ActsScalar, DIM> Acts::detail::Grid< T, Axes >::binCenter ( const index_t localBins) const
inline

get center position of bin with given local bin numbers

Parameters
[in]localBinslocal bin indices along each axis
Returns
center position of bin
Precondition
All local bin indices must be a valid index for the corresponding axis (excluding the under-/overflow bins for each axis).

Definition at line 168 of file Grid.hpp.

View newest version in sPHENIX GitHub at line 168 of file Grid.hpp

Referenced by Acts::SurfaceArray::SurfaceGridLookup< Axes >::getBinCenterImpl().

+ Here is the caller graph for this function:

template<typename T, class... Axes>
point_t Acts::detail::Grid< T, Axes >::binWidth ( ) const
inline

get bin width along each specific axis

Returns
array giving the bin width alonf all axes

Definition at line 293 of file Grid.hpp.

View newest version in sPHENIX GitHub at line 293 of file Grid.hpp

template<typename T, class... Axes>
template<class Point >
detail::GlobalNeighborHoodIndices<DIM> Acts::detail::Grid< T, Axes >::closestPointsIndices ( const Point &  position) const
inline

get global bin indices for closest points on grid

Template Parameters
Pointany type with point semantics supporting component access through operator[]
Parameters
[in]positionpoint of interest
Returns
Iterable thatemits the indices of bins whose lower-left corners are the closest points on the grid to the input.
Precondition
The given Point type must represent a point in d (or higher) dimensions where d is dimensionality of the grid. It must lie within the grid range (i.e. not within a under-/overflow bin).

Definition at line 151 of file Grid.hpp.

View newest version in sPHENIX GitHub at line 151 of file Grid.hpp

template<typename T, class... Axes>
static constexpr size_t Acts::detail::Grid< T, Axes >::dimensions ( )
inlinestatic

dimensionality of grid

Returns
number of axes spanning the grid

Definition at line 159 of file Grid.hpp.

View newest version in sPHENIX GitHub at line 159 of file Grid.hpp

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

+ Here is the caller graph for this function:

template<typename T, class... Axes>
template<class Point >
size_t Acts::detail::Grid< T, Axes >::globalBinFromFromLowerLeftEdge ( const Point &  point) const
inline

determine global bin index of the bin with the lower left edge closest to the given point for each axis

Template Parameters
Pointany type with point semantics supporting component access through operator[]
Parameters
[in]pointpoint to look up in the grid
Returns
global index for bin containing the given point
Precondition
The given Point type must represent a point in d (or higher) dimensions where d is dimensionality of the grid.
Note
This could be a under-/overflow bin along one or more axes.

Definition at line 212 of file Grid.hpp.

View newest version in sPHENIX GitHub at line 212 of file Grid.hpp

template<typename T, class... Axes>
size_t Acts::detail::Grid< T, Axes >::globalBinFromLocalBins ( const index_t localBins) const
inline

determine global bin index from local bin indices along each axis

Parameters
[in]localBinslocal bin indices along each axis
Returns
global index for bin defined by the local bin indices
Precondition
All local bin indices must be a valid index for the corresponding axis (including the under-/overflow bin for this axis).

Definition at line 195 of file Grid.hpp.

View newest version in sPHENIX GitHub at line 195 of file Grid.hpp

Referenced by Acts::detail::Grid< external_spacepoint_t >::atLocalBins(), Acts::Test::BOOST_AUTO_TEST_CASE(), Acts::detail::Grid< external_spacepoint_t >::globalBinFromFromLowerLeftEdge(), and Acts::detail::Grid< external_spacepoint_t >::globalBinFromPosition().

+ Here is the caller graph for this function:

template<typename T, class... Axes>
template<class Point >
size_t Acts::detail::Grid< T, Axes >::globalBinFromPosition ( const Point &  point) const
inline

determine global index for bin containing the given point

Template Parameters
Pointany type with point semantics supporting component access through operator[]
Parameters
[in]pointpoint to look up in the grid
Returns
global index for bin containing the given point
Precondition
The given Point type must represent a point in d (or higher) dimensions where d is dimensionality of the grid.
Note
This could be a under-/overflow bin along one or more axes.

Definition at line 184 of file Grid.hpp.

View newest version in sPHENIX GitHub at line 184 of file Grid.hpp

Referenced by Acts::detail::Grid< external_spacepoint_t >::atPosition(), Acts::Test::BOOST_AUTO_TEST_CASE(), and Acts::SurfaceArray::SurfaceGridLookup< Axes >::neighbors().

+ Here is the caller graph for this function:

template<typename T, class... Axes>
template<class Point , typename U = T, typename = std::enable_if_t< can_interpolate<Point, std::array<ActsScalar, DIM>, std::array<ActsScalar, DIM>, U>::value>>
T Acts::detail::Grid< T, Axes >::interpolate ( const Point &  point) const
inline

interpolate grid values to given position

Template Parameters
Pointtype specifying geometric positions
Udummy template parameter identical to T
Parameters
[in]pointlocation to which to interpolate grid values. The position must be within the grid dimensions and not lie in an under-/overflow bin along any axis.
Returns
interpolated value at given position
Precondition
The given Point type must represent a point in d (or higher) dimensions where d is dimensionality of the grid.
Note
This function is available only if the following conditions are fulfilled:
  • Given U and V of value type T as well as two ActsScalar a and b, then the following must be a valid expression a * U + b
  • V yielding an object which is (implicitly) convertible to T.
  • Point must represent a d-dimensional position and support coordinate access using operator[] which should return a ActsScalar (or a value which is implicitly convertible). Coordinate indices must start at 0.
Bin values are interpreted as being the field values at the lower-left corner of the corresponding hyper-box.

Definition at line 352 of file Grid.hpp.

View newest version in sPHENIX GitHub at line 352 of file Grid.hpp

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

+ Here is the caller graph for this function:

template<typename T, class... Axes>
template<class Point >
bool Acts::detail::Grid< T, Axes >::isInside ( const Point &  position) const
inline

check whether given point is inside grid limits

Returns
true if $\text{xmin_i} \le x_i < \text{xmax}_i \forall i=0, \dots, d-1$, otherwise false
Precondition
The given Point type must represent a point in d (or higher) dimensions where d is dimensionality of the grid.
Postcondition
If true is returned, the global bin containing the given point is a valid bin, i.e. it is neither a underflow nor an overflow bin along any axis.

Definition at line 389 of file Grid.hpp.

View newest version in sPHENIX GitHub at line 389 of file Grid.hpp

template<typename T, class... Axes>
index_t Acts::detail::Grid< T, Axes >::localBinsFromGlobalBin ( size_t  bin) const
inline

determine local bin index for each axis from global bin index

Parameters
[in]binglobal bin index
Returns
array with local bin indices along each axis (in same order as given axes object)
Note
Local bin indices can contain under-/overflow bins along the corresponding axis.

Definition at line 241 of file Grid.hpp.

View newest version in sPHENIX GitHub at line 241 of file Grid.hpp

Referenced by Acts::Test::BOOST_AUTO_TEST_CASE(), Acts::SurfaceArray::SurfaceGridLookup< Axes >::getBinCenterImpl(), Acts::SurfaceArray::SurfaceGridLookup< Axes >::isValidBin(), and Acts::SurfaceArray::SurfaceGridLookup< Axes >::populateNeighborCache().

+ Here is the caller graph for this function:

template<typename T, class... Axes>
template<class Point >
index_t Acts::detail::Grid< T, Axes >::localBinsFromLowerLeftEdge ( const Point &  point) const
inline

determine local bin index of the bin with the lower left edge closest to the given point for each axis

Template Parameters
Pointany type with point semantics supporting component access through operator[]
Parameters
[in]pointpoint to look up in the grid
Returns
array with local bin indices along each axis (in same order as given axes object)
Precondition
The given Point type must represent a point in d (or higher) dimensions where d is dimensionality of the grid.
Note
This could be a under-/overflow bin along one or more axes.

Definition at line 259 of file Grid.hpp.

View newest version in sPHENIX GitHub at line 259 of file Grid.hpp

Referenced by Acts::Test::BOOST_AUTO_TEST_CASE(), and Acts::detail::Grid< external_spacepoint_t >::globalBinFromFromLowerLeftEdge().

+ Here is the caller graph for this function:

template<typename T, class... Axes>
template<class Point >
index_t Acts::detail::Grid< T, Axes >::localBinsFromPosition ( const Point &  point) const
inline

determine local bin index for each axis from the given point

Template Parameters
Pointany type with point semantics supporting component access through operator[]
Parameters
[in]pointpoint to look up in the grid
Returns
array with local bin indices along each axis (in same order as given axes object)
Precondition
The given Point type must represent a point in d (or higher) dimensions where d is dimensionality of the grid.
Note
This could be a under-/overflow bin along one or more axes.

Definition at line 229 of file Grid.hpp.

View newest version in sPHENIX GitHub at line 229 of file Grid.hpp

Referenced by Acts::detail::Grid< external_spacepoint_t >::closestPointsIndices(), Acts::detail::Grid< external_spacepoint_t >::globalBinFromPosition(), and Acts::detail::Grid< external_spacepoint_t >::interpolate().

+ Here is the caller graph for this function:

template<typename T, class... Axes>
point_t Acts::detail::Grid< T, Axes >::lowerLeftBinEdge ( const index_t localBins) const
inline

retrieve lower-left bin edge from set of local bin indices

Parameters
[in]localBinslocal bin indices along each axis
Returns
generalized lower-left bin edge position
Precondition
localBins must only contain valid bin indices (excluding underflow bins).

Definition at line 275 of file Grid.hpp.

View newest version in sPHENIX GitHub at line 275 of file Grid.hpp

Referenced by Acts::detail::Grid< external_spacepoint_t >::interpolate().

+ Here is the caller graph for this function:

template<typename T, class... Axes>
point_t Acts::detail::Grid< T, Axes >::maxPosition ( ) const
inline

get the maximum value of all axes of one grid

Returns
array returning the maxima of all given axes

Definition at line 310 of file Grid.hpp.

View newest version in sPHENIX GitHub at line 310 of file Grid.hpp

Referenced by Acts::Test::BOOST_AUTO_TEST_CASE(), Acts::from_json(), Acts::mapMaterialPoints(), and while().

+ Here is the caller graph for this function:

template<typename T, class... Axes>
point_t Acts::detail::Grid< T, Axes >::minPosition ( ) const
inline

get the minimum value of all axes of one grid

Returns
array returning the minima of all given axes

Definition at line 305 of file Grid.hpp.

View newest version in sPHENIX GitHub at line 305 of file Grid.hpp

Referenced by Acts::Test::BOOST_AUTO_TEST_CASE(), Acts::from_json(), Acts::mapMaterialPoints(), and while().

+ Here is the caller graph for this function:

template<typename T, class... Axes>
detail::GlobalNeighborHoodIndices<DIM> Acts::detail::Grid< T, Axes >::neighborHoodIndices ( const index_t localBins,
size_t  size = 1u 
) const
inline

get global bin indices for neighborhood

Parameters
[in]localBinscenter bin defined by local bin indices along each axis
[in]sizesize of neighborhood determining how many adjacent bins along each axis are considered
Returns
set of global bin indices for all bins in neighborhood
Note
Over-/underflow bins are included in the neighborhood.
The size parameter sets the range by how many units each local bin index is allowed to be varied. All local bin indices are varied independently, that is diagonal neighbors are included. Ignoring the truncation of the neighborhood size reaching beyond over-/underflow bins, the neighborhood is of size $2 \times \text{size}+1$ along each dimension.

Definition at line 408 of file Grid.hpp.

View newest version in sPHENIX GitHub at line 408 of file Grid.hpp

Referenced by Acts::ATLASBottomBinFinder< SpacePoint >::findBins(), Acts::ATLASTopBinFinder< SpacePoint >::findBins(), Acts::BinFinder< external_spacepoint_t >::findBins(), and Acts::SurfaceArray::SurfaceGridLookup< Axes >::populateNeighborCache().

+ Here is the caller graph for this function:

template<typename T, class... Axes>
detail::GlobalNeighborHoodIndices<DIM> Acts::detail::Grid< T, Axes >::neighborHoodIndices ( const index_t localBins,
std::array< std::pair< int, int >, DIM > &  sizePerAxis 
) const
inline

get global bin indices for neighborhood

Parameters
[in]localBinscenter bin defined by local bin indices along each axis. If size is negative, center bin is not returned.
[in]sizePerAxissize of neighborhood for each axis, how many adjacent bins along each axis are considered
Returns
set of global bin indices for all bins in neighborhood
Note
Over-/underflow bins are included in the neighborhood.
The size parameter sets the range by how many units each local bin index is allowed to be varied. All local bin indices are varied independently, that is diagonal neighbors are included. Ignoring the truncation of the neighborhood size reaching beyond over-/underflow bins, the neighborhood is of size $2 \times \text{size}+1$ along each dimension.

Definition at line 429 of file Grid.hpp.

View newest version in sPHENIX GitHub at line 429 of file Grid.hpp

template<typename T, class... Axes>
index_t Acts::detail::Grid< T, Axes >::numLocalBins ( ) const
inline

get number of bins along each specific axis

Returns
array giving the number of bins along all axes
Note
Not including under- and overflow bins

Definition at line 300 of file Grid.hpp.

View newest version in sPHENIX GitHub at line 300 of file Grid.hpp

Referenced by Acts::Test::BOOST_AUTO_TEST_CASE(), Acts::from_json(), Acts::SurfaceArray::SurfaceGridLookup< Axes >::isValidBin(), Acts::mapMaterialPoints(), Acts::detail::Grid< external_spacepoint_t >::size(), and while().

+ Here is the caller graph for this function:

template<typename T, class... Axes>
detail::GlobalNeighborHoodIndices<DIM> Acts::detail::Grid< T, Axes >::rawClosestPointsIndices ( const index_t localBins) const
inlineprivate

Definition at line 471 of file Grid.hpp.

View newest version in sPHENIX GitHub at line 471 of file Grid.hpp

Referenced by Acts::detail::Grid< external_spacepoint_t >::closestPointsIndices(), and Acts::detail::Grid< external_spacepoint_t >::interpolate().

+ Here is the caller graph for this function:

template<typename T, class... Axes>
void Acts::detail::Grid< T, Axes >::setExteriorBins ( const value_type value)
inline

set all overflow and underflow bins to a certain value

Parameters
[in]valuevalue to be inserted in every overflow and underflow bin of the grid.

Definition at line 317 of file Grid.hpp.

View newest version in sPHENIX GitHub at line 317 of file Grid.hpp

template<typename T, class... Axes>
size_t Acts::detail::Grid< T, Axes >::size ( bool  fullCounter = true) const
inline

total number of bins

Returns
total number of bins in the grid
Note
This number contains under-and overflow bins along all axes.

Definition at line 440 of file Grid.hpp.

View newest version in sPHENIX GitHub at line 440 of file Grid.hpp

Referenced by Acts::Test::BOOST_AUTO_TEST_CASE(), Acts::detail::Grid< external_spacepoint_t >::Grid(), Acts::mapMaterialPoints(), Acts::detail::Grid< external_spacepoint_t >::neighborHoodIndices(), Acts::SurfaceArray::SurfaceGridLookup< Axes >::populateNeighborCache(), Acts::SurfaceArray::SurfaceGridLookup< Axes >::size(), and ActsExamples::RootMaterialWriter::writeMaterial().

+ Here is the caller graph for this function:

template<typename T, class... Axes>
point_t Acts::detail::Grid< T, Axes >::upperRightBinEdge ( const index_t localBins) const
inline

retrieve upper-right bin edge from set of local bin indices

Parameters
[in]localBinslocal bin indices along each axis
Returns
generalized upper-right bin edge position
Precondition
localBins must only contain valid bin indices (excluding overflow bins).

Definition at line 286 of file Grid.hpp.

View newest version in sPHENIX GitHub at line 286 of file Grid.hpp

Referenced by Acts::detail::Grid< external_spacepoint_t >::interpolate().

+ Here is the caller graph for this function:

Member Data Documentation

template<typename T, class... Axes>
constexpr size_t Acts::detail::Grid< T, Axes >::DIM = sizeof...(Axes)
static

number of dimensions of the grid

Definition at line 42 of file Grid.hpp.

View newest version in sPHENIX GitHub at line 42 of file Grid.hpp

Referenced by Acts::detail::Grid< external_spacepoint_t >::dimensions(), Acts::detail::Grid< external_spacepoint_t >::interpolate(), and Acts::detail::Grid< external_spacepoint_t >::localBinsFromLowerLeftEdge().

template<typename T, class... Axes>
std::vector<T> Acts::detail::Grid< T, Axes >::m_values
private

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