mds::img::CVolumeBase< V > Class Template Reference

Base class for all volumes. More...

#include <mdsVolumeBase.h>

Inheritance diagram for mds::img::CVolumeBase< V >:

List of all members.

Public Types
typedef V	tVolume
	Volume type.
typedef CVolumeTraits< V >::tVoxel	tVoxel
	Voxel type.
Public Member Functions
tVoxel &	at (tSize x, tSize y, tSize z)
	Returns the subscripted voxel [x][y][z].
const tVoxel &	at (tSize x, tSize y, tSize z) const
tVoxel &	at (tSize i)
	Returns the subscripted voxel.
const tVoxel &	at (tSize i) const
tSize	depth () const
template<class Function >
Function	forEach (Function Func)
	Calls a function object for every voxel.
template<class Function >
Function	forEach (Function Func) const
	Calls a function object for every voxel.
tSize	getIdx (tSize x, tSize y, tSize z) const
	Calculates index of a voxel.
tVolume &	getImpl ()
	Returns reference to the volume data implementation.
const tVolume &	getImpl () const
tSize	getMargin () const
	Returns the volume Margin size in voxels.
CSize3i &	getSize ()
	Returns size of the volume.
const CSize3i &	getSize () const
tSize	getXOffset () const
	Returns offset between two neigbouring voxels in x-axis.
tSize	getXSize () const
	Returns the volume size (dimensions).
tSize	getYOffset () const
	Returns offset between two neigbouring voxels in y-axis.
tSize	getYSize () const
tSize	getZOffset () const
	Returns offset between two neigbouring voxels in z-axis.
tSize	getZSize () const
tSize	height () const
tVoxel &	operator() (tSize x, tSize y, tSize z)
	Returns the subscripted voxel [x][y][z].
const tVoxel &	operator() (tSize x, tSize y, tSize z) const
tVoxel &	operator() (tSize i)
	Returns the subscripted voxel.
const tVoxel &	operator() (tSize i) const
template<class Function >
Function	pforEach (Function Func)
	Calls a function object for every voxel.
template<class Function >
Function	pforEach (Function Func) const
	Calls a function object for every voxel.
tVolume &	set (tSize x, tSize y, tSize z, const tVoxel &Value)
	Sets the voxel at the position [x][y][z].
tVolume &	set (tSize i, const tVoxel &Value)
	Sets the subscripted voxel.
tSize	width () const
	Returns the volume size (dimensions).
Protected Member Functions
	CVolumeBase ()
	Default constructor.
	CVolumeBase (const CVolumeBase &)
	Protected copy constructor.
CVolumeBase &	operator= (const CVolumeBase &)
	Assignment operator.

---

Detailed Description

template<class V>
class mds::img::CVolumeBase< V >

Base class for all volumes.

• Base class takes a template parameter V. This parameter is the type of the class which derives from it (so called curiously recurring template pattern).

---

Member Typedef Documentation

template<class V>

typedef V mds::img::CVolumeBase< V >::tVolume

Volume type.

Reimplemented in mds::img::CRectBox< V >.

template<class V>

typedef CVolumeTraits<V>::tVoxel mds::img::CVolumeBase< V >::tVoxel

Voxel type.

Reimplemented in mds::img::CVolume< T, Allocator >, and mds::img::CRectBox< V >.

---

Constructor & Destructor Documentation

template<class V>

mds::img::CVolumeBase< V >::CVolumeBase

(

)

[protected]

Default constructor.

template<class V>

mds::img::CVolumeBase< V >::CVolumeBase

(

const CVolumeBase< V > &

)

[protected]

Protected copy constructor.

---

Member Function Documentation

template<class V>

tVoxel& mds::img::CVolumeBase< V >::at	(	tSize	x,
		tSize	y,
		tSize	z
	)

Returns the subscripted voxel [x][y][z].

Reimplemented in mds::img::CVolume< T, Allocator >, and mds::img::CRectBox< V >.

template<class V>

const tVoxel& mds::img::CVolumeBase< V >::at	(	tSize	x,
		tSize	y,
		tSize	z
	)		const

Reimplemented in mds::img::CVolume< T, Allocator >, and mds::img::CRectBox< V >.

template<class V>

tVoxel& mds::img::CVolumeBase< V >::at

(

tSize

i

)

Returns the subscripted voxel.

Reimplemented in mds::img::CVolume< T, Allocator >, and mds::img::CRectBox< V >.

template<class V>

const tVoxel& mds::img::CVolumeBase< V >::at

(

tSize

i

)

const

Reimplemented in mds::img::CVolume< T, Allocator >, and mds::img::CRectBox< V >.

template<class V>

tSize mds::img::CVolumeBase< V >::depth

(

)

const

Reimplemented in mds::img::CVolume< T, Allocator >, and mds::img::CRectBox< V >.

template<class V>

template<class Function >

Function mds::img::CVolumeBase< V >::forEach

(

Function

Func

)

Calls a function object for every voxel.

Reimplemented in mds::img::CVolume< T, Allocator >, mds::img::CVolume< T, Allocator >, mds::img::CRectBox< V >, and mds::img::CRectBox< V >.

template<class V>

template<class Function >

Function mds::img::CVolumeBase< V >::forEach

(

Function

Func

)

const

Calls a function object for every voxel.

Reimplemented in mds::img::CVolume< T, Allocator >, mds::img::CVolume< T, Allocator >, mds::img::CRectBox< V >, and mds::img::CRectBox< V >.

template<class V>

tSize mds::img::CVolumeBase< V >::getIdx	(	tSize	x,
		tSize	y,
		tSize	z
	)		const

Calculates index of a voxel.

Reimplemented in mds::img::CVolume< T, Allocator >, and mds::img::CRectBox< V >.

template<class V>

tVolume& mds::img::CVolumeBase< V >::getImpl

(

)

Returns reference to the volume data implementation.

template<class V>

const tVolume& mds::img::CVolumeBase< V >::getImpl

(

)

const

template<class V>

tSize mds::img::CVolumeBase< V >::getMargin

(

)

const

Returns the volume Margin size in voxels.

Reimplemented in mds::img::CVolume< T, Allocator >, and mds::img::CRectBox< V >.

template<class V>

CSize3i& mds::img::CVolumeBase< V >::getSize

(

)

Returns size of the volume.

Reimplemented in mds::img::CVolume< T, Allocator >, and mds::img::CRectBox< V >.

template<class V>

const CSize3i& mds::img::CVolumeBase< V >::getSize

(

)

const

Reimplemented in mds::img::CVolume< T, Allocator >, and mds::img::CRectBox< V >.

template<class V>

tSize mds::img::CVolumeBase< V >::getXOffset

(

)

const

Returns offset between two neigbouring voxels in x-axis.

Reimplemented in mds::img::CVolume< T, Allocator >, and mds::img::CRectBox< V >.

template<class V>

tSize mds::img::CVolumeBase< V >::getXSize

(

)

const

Returns the volume size (dimensions).

Reimplemented in mds::img::CVolume< T, Allocator >, and mds::img::CRectBox< V >.

template<class V>

tSize mds::img::CVolumeBase< V >::getYOffset

(

)

const

Returns offset between two neigbouring voxels in y-axis.

Reimplemented in mds::img::CVolume< T, Allocator >, and mds::img::CRectBox< V >.

template<class V>

tSize mds::img::CVolumeBase< V >::getYSize

(

)

const

Reimplemented in mds::img::CVolume< T, Allocator >, and mds::img::CRectBox< V >.

template<class V>

tSize mds::img::CVolumeBase< V >::getZOffset

(

)

const

Returns offset between two neigbouring voxels in z-axis.

Reimplemented in mds::img::CVolume< T, Allocator >, and mds::img::CRectBox< V >.

template<class V>

tSize mds::img::CVolumeBase< V >::getZSize

(

)

const

Reimplemented in mds::img::CVolume< T, Allocator >, and mds::img::CRectBox< V >.

template<class V>

tSize mds::img::CVolumeBase< V >::height

(

)

const

Reimplemented in mds::img::CVolume< T, Allocator >, and mds::img::CRectBox< V >.

template<class V>

tVoxel& mds::img::CVolumeBase< V >::operator()	(	tSize	x,
		tSize	y,
		tSize	z
	)

Returns the subscripted voxel [x][y][z].

Reimplemented in mds::img::CVolume< T, Allocator >, and mds::img::CRectBox< V >.

template<class V>

const tVoxel& mds::img::CVolumeBase< V >::operator()	(	tSize	x,
		tSize	y,
		tSize	z
	)		const

Reimplemented in mds::img::CVolume< T, Allocator >, and mds::img::CRectBox< V >.

template<class V>

tVoxel& mds::img::CVolumeBase< V >::operator()

(

tSize

i

)

Returns the subscripted voxel.

Reimplemented in mds::img::CVolume< T, Allocator >, and mds::img::CRectBox< V >.

template<class V>

const tVoxel& mds::img::CVolumeBase< V >::operator()

(

tSize

i

)

const

Reimplemented in mds::img::CVolume< T, Allocator >, and mds::img::CRectBox< V >.

template<class V>

CVolumeBase& mds::img::CVolumeBase< V >::operator=

(

const CVolumeBase< V > &

)

[protected]

Assignment operator.

template<class V>

template<class Function >

Function mds::img::CVolumeBase< V >::pforEach

(

Function

Func

)

Calls a function object for every voxel.

• Parallel version.

Reimplemented in mds::img::CVolume< T, Allocator >, mds::img::CVolume< T, Allocator >, mds::img::CRectBox< V >, and mds::img::CRectBox< V >.

template<class V>

template<class Function >

Function mds::img::CVolumeBase< V >::pforEach

(

Function

Func

)

const

Calls a function object for every voxel.

• Parallel version.

Reimplemented in mds::img::CVolume< T, Allocator >, mds::img::CVolume< T, Allocator >, mds::img::CRectBox< V >, and mds::img::CRectBox< V >.

template<class V>

tVolume& mds::img::CVolumeBase< V >::set	(	tSize	x,
		tSize	y,
		tSize	z,
		const tVoxel &	Value
	)

Sets the voxel at the position [x][y][z].

template<class V>

tVolume& mds::img::CVolumeBase< V >::set	(	tSize	i,
		const tVoxel &	Value
	)

Sets the subscripted voxel.

template<class V>

tSize mds::img::CVolumeBase< V >::width

(

)

const

Returns the volume size (dimensions).

Reimplemented in mds::img::CVolume< T, Allocator >, and mds::img::CRectBox< V >.

---

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

• mdsVolumeBase.h