#include <RegularGrid3D.h>

Public Member Functions
	RegularGrid3D (const DataT zmin, const DataT rmin, const DataT phimin, const DataT spacingZ, const DataT spacingR, const DataT spacingPhi, const ParamSpaceCharge &params)

int	getDeltaXDataIndex (const int deltaX) const

int	getDeltaYDataIndex (const int deltaY) const

int	getDeltaZDataIndex (const int deltaZ) const

int	getDeltaDataIndex (const int delta, const int dim) const

bool	isIndexInGrid (const int index, const unsigned int dim) const

size_t	getN (unsigned int dim) const

size_t	getNZ () const

size_t	getNR () const

size_t	getNPhi () const

const Vector< DataT, 3 > &	getGridMin () const

DataT	getGridMinZ () const

DataT	getGridMinR () const

DataT	getGridMinPhi () const

DataT	getGridMaxZ () const

DataT	getGridMaxR () const

DataT	getGridMaxPhi () const

const Vector< DataT, 3 > &	getInvSpacing () const

DataT	getInvSpacingZ () const

DataT	getInvSpacingR () const

DataT	getInvSpacingPhi () const

DataT	getSpacingZ () const

DataT	getSpacingR () const

DataT	getSpacingPhi () const

DataT	clampToGrid (const DataT pos, const unsigned int dim) const

DataT	clampToGridRel (const DataT pos, const unsigned int dim) const

DataT	clampToGridCircular (DataT pos, const unsigned int dim) const

DataT	clampToGridCircularRel (DataT pos, const unsigned int dim) const

DataT	getZVertex (const size_t vertexX) const

DataT	getRVertex (const size_t vertexY) const

DataT	getPhiVertex (const size_t vertexZ) const

const Vector< DataT, 3 > &	getMaxIndices () const

DataT	getMaxIndexZ () const
	get max indices for all dimensions

DataT	getMaxIndexR () const
	get max index in x direction

DataT	getMaxIndexPhi () const
	get max index in y direction

const auto &	getParamSC () const
	get max index in z direction

unsigned short	getRVertices () const

unsigned short	getZVertices () const

unsigned short	getPhiVertices () const

RegularGridHelper< double >	getHelper () const

Static Public Member Functions
static constexpr unsigned int	getDim ()

static constexpr unsigned int	getFZ ()

static constexpr unsigned int	getFR ()

static constexpr unsigned int	getFPhi ()

Detailed Description

template<typename DataT = double>
class o2::tpc::RegularGrid3D< DataT >

This class implements basic properties of a regular 3D-Grid like the spacing for each dimension and min and max coordinates.

Template Parameters

DataT the type of data which is used during the calculations

Definition at line 47 of file RegularGrid3D.h.

Constructor & Destructor Documentation

◆ RegularGrid3D()

template<typename DataT = double>

o2::tpc::RegularGrid3D< DataT >::RegularGrid3D	(	const DataT	zmin,
		const DataT	rmin,
		const DataT	phimin,
		const DataT	spacingZ,
		const DataT	spacingR,
		const DataT	spacingPhi,
		const ParamSpaceCharge &	params
	)

inline

Definition at line 50 of file RegularGrid3D.h.

Member Function Documentation

◆ clampToGrid()

template<typename DataT >

DataT o2::tpc::RegularGrid3D< DataT >::clampToGrid	(	const DataT	pos,
		const unsigned int	dim
	)		const

Parameters

pos	query position which will be clamped

Returns: returns clamped coordinate coordinate

Inline implementations of some methods

Definition at line 188 of file RegularGrid3D.h.

◆ clampToGridCircular()

template<typename DataT >

DataT o2::tpc::RegularGrid3D< DataT >::clampToGridCircular	(	DataT	pos,
		const unsigned int	dim
	)		const

Parameters

pos	query position which will be clamped

Returns: returns clamped coordinate coordinate

Definition at line 218 of file RegularGrid3D.h.

◆ clampToGridCircularRel()

template<typename DataT >

DataT o2::tpc::RegularGrid3D< DataT >::clampToGridCircularRel	(	DataT	pos,
		const unsigned int	dim
	)		const

Parameters

pos	relative query position in grid which will be clamped

Returns: returns clamped coordinate coordinate

Definition at line 230 of file RegularGrid3D.h.

◆ clampToGridRel()

template<typename DataT >

DataT o2::tpc::RegularGrid3D< DataT >::clampToGridRel	(	const DataT	pos,
		const unsigned int	dim
	)		const

Parameters

pos	relative query position in grid which will be clamped

Returns: returns clamped coordinate coordinate

Definition at line 207 of file RegularGrid3D.h.

◆ getDeltaDataIndex()

template<typename DataT >

int o2::tpc::RegularGrid3D< DataT >::getDeltaDataIndex	(	const int	delta,
		const int	dim
	)		const

Parameters

delta	delta index
dim	dimension of interest

Returns: returns the delta index (where the data is stored) for given delta and dim

Definition at line 259 of file RegularGrid3D.h.

◆ getDeltaXDataIndex()

template<typename DataT = double>

int o2::tpc::RegularGrid3D< DataT >::getDeltaXDataIndex ( const int deltaX ) const

inline

Parameters

deltaX delta x index

Returns: returns the delta index (where the data is stored) for given deltaX

Definition at line 60 of file RegularGrid3D.h.

◆ getDeltaYDataIndex()

template<typename DataT = double>

int o2::tpc::RegularGrid3D< DataT >::getDeltaYDataIndex ( const int deltaY ) const

inline

Parameters

deltaY delta y index

Returns: returns the delta index (where the data is stored) for given deltaY

Definition at line 64 of file RegularGrid3D.h.

◆ getDeltaZDataIndex()

template<typename DataT = double>

int o2::tpc::RegularGrid3D< DataT >::getDeltaZDataIndex ( const int deltaZ ) const

inline

Parameters

deltaZ delta z index

Returns: returns the delta index (where the data is stored) for given deltaZ

Definition at line 68 of file RegularGrid3D.h.

◆ getDim()

template<typename DataT = double>

static constexpr unsigned int o2::tpc::RegularGrid3D< DataT >::getDim ( )

inlinestaticconstexpr

Definition at line 88 of file RegularGrid3D.h.

◆ getFPhi()

template<typename DataT = double>

static constexpr unsigned int o2::tpc::RegularGrid3D< DataT >::getFPhi ( )

inlinestaticconstexpr

Returns: returns the index for dimension y (1)

Definition at line 91 of file RegularGrid3D.h.

◆ getFR()

template<typename DataT = double>

static constexpr unsigned int o2::tpc::RegularGrid3D< DataT >::getFR ( )

inlinestaticconstexpr

Returns: returns the index for dimension x (0)

Definition at line 90 of file RegularGrid3D.h.

◆ getFZ()

template<typename DataT = double>

static constexpr unsigned int o2::tpc::RegularGrid3D< DataT >::getFZ ( )

inlinestaticconstexpr

Returns: returns number of dimensions of the grid (3)

Definition at line 89 of file RegularGrid3D.h.

◆ getGridMaxPhi()

template<typename DataT = double>

DataT o2::tpc::RegularGrid3D< DataT >::getGridMaxPhi ( ) const

inline

Definition at line 100 of file RegularGrid3D.h.

◆ getGridMaxR()

template<typename DataT = double>

DataT o2::tpc::RegularGrid3D< DataT >::getGridMaxR ( ) const

inline

Definition at line 99 of file RegularGrid3D.h.

◆ getGridMaxZ()

template<typename DataT = double>

DataT o2::tpc::RegularGrid3D< DataT >::getGridMaxZ ( ) const

inline

Returns: returns the minimum coordinate of the grid in z dimension

Definition at line 98 of file RegularGrid3D.h.

◆ getGridMin()

template<typename DataT = double>

const Vector< DataT, 3 > & o2::tpc::RegularGrid3D< DataT >::getGridMin ( ) const

inline

Returns: returns the index for dimension z (2)

Definition at line 93 of file RegularGrid3D.h.

◆ getGridMinPhi()

template<typename DataT = double>

DataT o2::tpc::RegularGrid3D< DataT >::getGridMinPhi ( ) const

inline

Returns: returns the minimum coordinate of the grid in y dimension

Definition at line 96 of file RegularGrid3D.h.

◆ getGridMinR()

template<typename DataT = double>

DataT o2::tpc::RegularGrid3D< DataT >::getGridMinR ( ) const

inline

Returns: returns the minimum coordinate of the grid in x dimension

Definition at line 95 of file RegularGrid3D.h.

◆ getGridMinZ()

template<typename DataT = double>

DataT o2::tpc::RegularGrid3D< DataT >::getGridMinZ ( ) const

inline

Returns: returns the minimum coordinates of the grid in all dimensions

Definition at line 94 of file RegularGrid3D.h.

◆ getHelper()

template<typename DataT = double>

RegularGridHelper< double > o2::tpc::RegularGrid3D< DataT >::getHelper ( ) const

inline

Returns: returns helper struct containing the properties to create the object

Definition at line 158 of file RegularGrid3D.h.

◆ getInvSpacing()

template<typename DataT = double>

const Vector< DataT, 3 > & o2::tpc::RegularGrid3D< DataT >::getInvSpacing ( ) const

inline

Returns: returns the inversed spacing of the grid for all dimensions

Definition at line 103 of file RegularGrid3D.h.

◆ getInvSpacingPhi()

template<typename DataT = double>

DataT o2::tpc::RegularGrid3D< DataT >::getInvSpacingPhi ( ) const

inline

Definition at line 106 of file RegularGrid3D.h.

◆ getInvSpacingR()

template<typename DataT = double>

DataT o2::tpc::RegularGrid3D< DataT >::getInvSpacingR ( ) const

inline

Definition at line 105 of file RegularGrid3D.h.

◆ getInvSpacingZ()

template<typename DataT = double>

DataT o2::tpc::RegularGrid3D< DataT >::getInvSpacingZ ( ) const

inline

Definition at line 104 of file RegularGrid3D.h.

◆ getMaxIndexPhi()

template<typename DataT = double>

DataT o2::tpc::RegularGrid3D< DataT >::getMaxIndexPhi ( ) const

inline

get max index in y direction

Definition at line 148 of file RegularGrid3D.h.

◆ getMaxIndexR()

template<typename DataT = double>

DataT o2::tpc::RegularGrid3D< DataT >::getMaxIndexR ( ) const

inline

get max index in x direction

Definition at line 147 of file RegularGrid3D.h.

◆ getMaxIndexZ()

template<typename DataT = double>

DataT o2::tpc::RegularGrid3D< DataT >::getMaxIndexZ ( ) const

inline

get max indices for all dimensions

Definition at line 146 of file RegularGrid3D.h.

◆ getMaxIndices()

template<typename DataT = double>

const Vector< DataT, 3 > & o2::tpc::RegularGrid3D< DataT >::getMaxIndices ( ) const

inline

Definition at line 144 of file RegularGrid3D.h.

◆ getN()

template<typename DataT = double>

size_t o2::tpc::RegularGrid3D< DataT >::getN ( unsigned int dim ) const

inline

Parameters

dim	dimension of interest

Returns: returns the number of vertices for given dimension for the grid

Definition at line 83 of file RegularGrid3D.h.

◆ getNPhi()

template<typename DataT = double>

size_t o2::tpc::RegularGrid3D< DataT >::getNPhi ( ) const

inline

Definition at line 86 of file RegularGrid3D.h.

◆ getNR()

template<typename DataT = double>

size_t o2::tpc::RegularGrid3D< DataT >::getNR ( ) const

inline

Definition at line 85 of file RegularGrid3D.h.

◆ getNZ()

template<typename DataT = double>

size_t o2::tpc::RegularGrid3D< DataT >::getNZ ( ) const

inline

Definition at line 84 of file RegularGrid3D.h.

◆ getParamSC()

template<typename DataT = double>

const auto & o2::tpc::RegularGrid3D< DataT >::getParamSC ( ) const

inline

get max index in z direction

returns grid parameters

Definition at line 151 of file RegularGrid3D.h.

◆ getPhiVertex()

template<typename DataT = double>

DataT o2::tpc::RegularGrid3D< DataT >::getPhiVertex ( const size_t vertexZ ) const

inline

Parameters

vertexZ in z dimension

Returns: returns the z positon for given vertex

Definition at line 142 of file RegularGrid3D.h.

◆ getPhiVertices()

template<typename DataT = double>

unsigned short o2::tpc::RegularGrid3D< DataT >::getPhiVertices ( ) const

inline

Definition at line 155 of file RegularGrid3D.h.

◆ getRVertex()

template<typename DataT = double>

DataT o2::tpc::RegularGrid3D< DataT >::getRVertex ( const size_t vertexY ) const

inline

Parameters

vertexY in y dimension

Returns: returns the y positon for given vertex

Definition at line 138 of file RegularGrid3D.h.

◆ getRVertices()

template<typename DataT = double>

unsigned short o2::tpc::RegularGrid3D< DataT >::getRVertices ( ) const

inline

Definition at line 153 of file RegularGrid3D.h.

◆ getSpacingPhi()

template<typename DataT = double>

DataT o2::tpc::RegularGrid3D< DataT >::getSpacingPhi ( ) const

inline

Definition at line 110 of file RegularGrid3D.h.

◆ getSpacingR()

template<typename DataT = double>

DataT o2::tpc::RegularGrid3D< DataT >::getSpacingR ( ) const

inline

Definition at line 109 of file RegularGrid3D.h.

◆ getSpacingZ()

template<typename DataT = double>

DataT o2::tpc::RegularGrid3D< DataT >::getSpacingZ ( ) const

inline

Definition at line 108 of file RegularGrid3D.h.

◆ getZVertex()

template<typename DataT = double>

DataT o2::tpc::RegularGrid3D< DataT >::getZVertex ( const size_t vertexX ) const

inline

Parameters

vertexX in x dimension

Returns: returns the x positon for given vertex

Definition at line 134 of file RegularGrid3D.h.

◆ getZVertices()

template<typename DataT = double>

unsigned short o2::tpc::RegularGrid3D< DataT >::getZVertices ( ) const

inline

Definition at line 154 of file RegularGrid3D.h.

◆ isIndexInGrid()

template<typename DataT = double>

bool o2::tpc::RegularGrid3D< DataT >::isIndexInGrid	(	const int	index,
		const unsigned int	dim
	)		const

inline

Parameters

index query index

Returns: returns if the index lies in the grid

Definition at line 79 of file RegularGrid3D.h.

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

/home/runner/work/AliceO2/AliceO2/Detectors/TPC/spacecharge/include/TPCSpaceCharge/DataContainer3D.h
/home/runner/work/AliceO2/AliceO2/Detectors/TPC/spacecharge/include/TPCSpaceCharge/RegularGrid3D.h

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ RegularGrid3D()

Member Function Documentation

◆ clampToGrid()

Inline implementations of some methods

◆ clampToGridCircular()

◆ clampToGridCircularRel()

◆ clampToGridRel()

◆ getDeltaDataIndex()

◆ getDeltaXDataIndex()

◆ getDeltaYDataIndex()

◆ getDeltaZDataIndex()

◆ getDim()

◆ getFPhi()

◆ getFR()

◆ getFZ()

◆ getGridMaxPhi()

◆ getGridMaxR()

◆ getGridMaxZ()

◆ getGridMin()

◆ getGridMinPhi()

◆ getGridMinR()

◆ getGridMinZ()

◆ getHelper()

◆ getInvSpacing()

◆ getInvSpacingPhi()

◆ getInvSpacingR()

◆ getInvSpacingZ()

◆ getMaxIndexPhi()

◆ getMaxIndexR()

◆ getMaxIndexZ()

◆ getMaxIndices()

◆ getN()

◆ getNPhi()

◆ getNR()

◆ getNZ()

◆ getParamSC()

◆ getPhiVertex()

◆ getPhiVertices()

◆ getRVertex()

◆ getRVertices()

◆ getSpacingPhi()

◆ getSpacingR()

◆ getSpacingZ()

◆ getZVertex()

◆ getZVertices()

◆ isIndexInGrid()