vlVolIter< DataType, Layout > Class Template Reference

This is the base class for non-const volume iterators. More...

#include <vlvoliterbase.h>

Inheritance diagram for vlVolIter< DataType, Layout >:

List of all members.

Public Member Functions
	vlVolIter (vlVolume *vol)
	Default constructor.
	vlVolIter (vlVolData *data)
virtual	~vlVolIter ()
	Default destructor.
bool	set (const DataType &value)
	Set the value of voxel at current position.
bool	setRelative (const vlOffset &offset, const DataType &value)
	set value at a voxel offset from the current one
bool	setRelativeNBC (const vlOffset &offset, const DataType &value)
	Same as getRelative but with NBC = No Boundary Check, thus faster.
bool	setRelativeX (const int32 offset, const DataType &value)
	Get the voxel along X axis.
bool	setRelativeY (const int32 offset, const DataType &value)
	Get the voxel along Y axis.
bool	setRelativeZ (const int32 offset, const DataType &value)
	Get the voxel along Z axis.
bool	setNeighbor (const DataType &value)
	Set the current neighbor of the current voxel.

---

Detailed Description

template<typename DataType, vlLayoutType Layout = vlLayout::DefaultLayout>
class vlVolIter< DataType, Layout >

Each layout type should re-implement all the API functions in the most optimal way. Derive non-const iterator for your data layout from this class. You will also need to implement const iterators. Those will be derived from vlVolIterBaseConst.

See also:

vlVolIterBaseConst

Author:

Sarang Lakare <sarang@users.sf.net>

Definition at line 557 of file vlvoliterbase.h.

---

Constructor & Destructor Documentation

template<typename DataType, vlLayoutType Layout = vlLayout::DefaultLayout> vlVolIter< DataType, Layout >::vlVolIter (  vlVolume *  vol  )  [inline]

Definition at line 562 of file vlvoliterbase.h.

template<typename DataType, vlLayoutType Layout = vlLayout::DefaultLayout> vlVolIter< DataType, Layout >::vlVolIter (  vlVolData *  data  )  [inline]

Definition at line 567 of file vlvoliterbase.h.

template<typename DataType, vlLayoutType Layout = vlLayout::DefaultLayout> virtual vlVolIter< DataType, Layout >::~vlVolIter (   )  [inline, virtual]

Definition at line 573 of file vlvoliterbase.h.

---

Member Function Documentation

template<typename DataType, vlLayoutType Layout = vlLayout::DefaultLayout> bool vlVolIter< DataType, Layout >::set (  const DataType &  value  )  [virtual]

Implements vlVolIterBase< DataType >. Referenced by vlVolProcessorAlphaAdd::alphaAddReal(), GaussianApprox::computeApproxGaussBlur(), vlVolume::copyDataT(), vlVolProcessorConcatenate::copyDataT(), CreateVolume(), vlVolume::cropREDtoRGBA(), vlVolume::cropRGBtoRed(), vlVolume::cropRGBtoRGBA(), vlVolume::cropSliceT(), vlVolFioSLC::readData(), vlVolFioPPM::readData(), vlVolFioRAW::readData(), vlVolFioDEN::readData(), vlVolFioPGMVol::readDataT(), vlVolFiof3d::readDataT(), vlRegionGrowOffsetFinder::regionGrowOffsets(), vlVolProcessorRegionGrow::regionGrowReal(), vlVolProcessorSobel::runT(), vlVolProcessorCentralDiff::runT(), and vlVolProcessorThresh::thresholding().

template<typename DataType, vlLayoutType Layout = vlLayout::DefaultLayout> bool vlVolIter< DataType, Layout >::setNeighbor (  const DataType &  value  )  [virtual]

Implements vlVolIterBase< DataType >.

template<typename DataType, vlLayoutType Layout = vlLayout::DefaultLayout> bool vlVolIter< DataType, Layout >::setRelative (  const vlOffset &  offset, const DataType &  value )  [virtual]

Implements vlVolIterBase< DataType >. Referenced by vlVolProcessorDilate::dilateReal(), vlVolProcessorErode::erodeReal(), vlRegionGrowOffsetFinder::regionGrowOffsets(), and vlVolProcessorRegionGrow::regionGrowReal().

template<typename DataType, vlLayoutType Layout = vlLayout::DefaultLayout> bool vlVolIter< DataType, Layout >::setRelativeNBC (  const vlOffset &  offset, const DataType &  value )  [virtual]

Implements vlVolIterBase< DataType >.

template<typename DataType, vlLayoutType Layout = vlLayout::DefaultLayout> bool vlVolIter< DataType, Layout >::setRelativeX (  const int32  offset, const DataType &  value )  [virtual]

Implements vlVolIterBase< DataType >.

template<typename DataType, vlLayoutType Layout = vlLayout::DefaultLayout> bool vlVolIter< DataType, Layout >::setRelativeY (  const int32  offset, const DataType &  value )  [virtual]

Implements vlVolIterBase< DataType >.

template<typename DataType, vlLayoutType Layout = vlLayout::DefaultLayout> bool vlVolIter< DataType, Layout >::setRelativeZ (  const int32  offset, const DataType &  value )  [virtual]

Implements vlVolIterBase< DataType >.

---

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

• vlvoliterbase.h

---