Cursor to access data of a TSubImage for reading and writing. More...

#include <mlTSubImage.h>

Inheritance diagram for ml::TSubImageCursor< DATATYPE >:

Public Member Functions
	TSubImageCursor (TSubImage< DATATYPE > &subImage)
Getting the cursor position as pointer to data.
DATATYPE *	getPointer () const
	Returns current cursor position (i.e., return the memory address of the voxel the cursor points to).
DATATYPE *	getPointerWithOffset (const ImageVector &offset) const
	Returns cursor position of voxel given from current cursor shifted by `offset`.
DATATYPE *	getPointerWithOffset (MLint dx, MLint dy, MLint dz) const
	Returns cursor position of voxel given from current cursor shifted by (`dx`, `dy`, `dz`).
Set voxel values at cursor position.
void	setValue (DATATYPE value) const
	Sets voxel value at cursor position to `value`.
void	setValueWithOffset (const ImageVector &offset, DATATYPE value) const
	Sets voxel value at (cursor position + `offset`) to `value`.
void	setValueWithOffset (MLint dx, MLint dy, MLint dz, DATATYPE value) const
	Sets voxel value at (cursor position + (`dx`, `dy`, `dz`)) to value.
Deprecated
DATATYPE *	getCursorPos () const
DATATYPE *	getCursorPos (const ImageVector &dp) const
DATATYPE *	getCursorPos (MLint dx, MLint dy, MLint dz) const
void	setCursorVal (DATATYPE val) const
void	setCursorVal (const ImageVector &dp, DATATYPE val) const
void	setCursorVal (MLint dx, MLint dy, MLint dz, DATATYPE val) const

Detailed Description

template<typename DATATYPE>
class ml::TSubImageCursor< DATATYPE >

Cursor to access data of a TSubImage for reading and writing.

Definition at line 1261 of file mlTSubImage.h.

Constructor & Destructor Documentation

template<typename DATATYPE >

ml::TSubImageCursor< DATATYPE >::TSubImageCursor ( TSubImage< DATATYPE > & subImage ) [inline]

Definition at line 1267 of file mlTSubImage.h.

Member Function Documentation

template<typename DATATYPE >

DATATYPE* ml::TSubImageCursor< DATATYPE >::getCursorPos ( ) const [inline]

Deprecated:: Use getPointer() instead.

Definition at line 1307 of file mlTSubImage.h.

template<typename DATATYPE >

DATATYPE* ml::TSubImageCursor< DATATYPE >::getCursorPos ( const ImageVector & dp ) const [inline]

Deprecated:: Use getPointerWithOffset() instead.

Definition at line 1310 of file mlTSubImage.h.

template<typename DATATYPE >

DATATYPE* ml::TSubImageCursor< DATATYPE >::getCursorPos	(	MLint	dx,
		MLint	dy,
		MLint	dz
	)		const `[inline]`

Deprecated:: Use getPointerWithOffset() instead.

Definition at line 1313 of file mlTSubImage.h.

template<typename DATATYPE >

DATATYPE* ml::TSubImageCursor< DATATYPE >::getPointer ( ) const [inline]

Returns current cursor position (i.e., return the memory address of the voxel the cursor points to).

Definition at line 1275 of file mlTSubImage.h.

template<typename DATATYPE >

DATATYPE* ml::TSubImageCursor< DATATYPE >::getPointerWithOffset ( const ImageVector & offset ) const [inline]

Returns cursor position of voxel given from current cursor shifted by offset.

Definition at line 1277 of file mlTSubImage.h.

template<typename DATATYPE >

DATATYPE* ml::TSubImageCursor< DATATYPE >::getPointerWithOffset	(	MLint	dx,
		MLint	dy,
		MLint	dz
	)		const `[inline]`

Returns cursor position of voxel given from current cursor shifted by (dx, dy, dz).

Definition at line 1279 of file mlTSubImage.h.

template<typename DATATYPE >

void ml::TSubImageCursor< DATATYPE >::setCursorVal	(	const ImageVector &	dp,
		DATATYPE	val
	)		const `[inline]`

Deprecated:: Use setValueWithOffset() instead.

Definition at line 1319 of file mlTSubImage.h.

template<typename DATATYPE >

void ml::TSubImageCursor< DATATYPE >::setCursorVal ( DATATYPE val ) const [inline]

Deprecated:: Use setValue() instead.

Definition at line 1316 of file mlTSubImage.h.

template<typename DATATYPE >

void ml::TSubImageCursor< DATATYPE >::setCursorVal	(	MLint	dx,
		MLint	dy,
		MLint	dz,
		DATATYPE	val
	)		const `[inline]`

Deprecated:: Use setValueWithOffset() instead.

Definition at line 1322 of file mlTSubImage.h.

template<typename DATATYPE >

void ml::TSubImageCursor< DATATYPE >::setValue ( DATATYPE value ) const [inline]

Sets voxel value at cursor position to value.

Definition at line 1291 of file mlTSubImage.h.

template<typename DATATYPE >

void ml::TSubImageCursor< DATATYPE >::setValueWithOffset	(	const ImageVector &	offset,
		DATATYPE	value
	)		const `[inline]`

Sets voxel value at (cursor position + offset) to value.

Definition at line 1293 of file mlTSubImage.h.

template<typename DATATYPE >

void ml::TSubImageCursor< DATATYPE >::setValueWithOffset	(	MLint	dx,
		MLint	dy,
		MLint	dz,
		DATATYPE	value
	)		const `[inline]`

Sets voxel value at (cursor position + (dx, dy, dz)) to value.

Definition at line 1295 of file mlTSubImage.h.

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

MeVis/Foundation/Sources/ML/include/mlTSubImage.h

Public Member Functions

Detailed Description

template<typename DATATYPE> class ml::TSubImageCursor< DATATYPE >

Constructor & Destructor Documentation

Member Function Documentation

template<typename DATATYPE>
class ml::TSubImageCursor< DATATYPE >