Base class for all TSubImage Cursors. More...

#include <mlTSubImage.h>

Inheritance diagram for ml::TSubImageCursorBase< DATATYPE >:

Public Member Functions
Positioning and movement of voxel cursor.
void	setSubImagePosition (const ImageVector &position)
	Sets cursor to the given `position` relative to the origin of the subimage region.
void	setSubImagePosition (MLint x, MLint y, MLint z)
	Sets cursor to the given 3d position (`x`, `y`, `z`) relative to the origin of the subimage region.
void	setImagePosition (const ImageVector &position)
	Sets cursor to the given 6d `position` relative to the origin of the complete image region.
void	setImagePosition (MLint x, MLint y, MLint z)
	Sets cursor to the given 3d position (`x`, `y`, `z`) relative to the origin of the complete image region.
void	setPosition (const DATATYPE *pointer)
	Sets cursor to the given `pointer` where the `pointer` is the memory address of the voxel.
void	moveByOffset (const ImageVector &offset)
	Moves cursor to cursor position + `offset`.
void	moveByOffset (MLint x, MLint y, MLint z)
	Moves cursor to cursor position + (`x`, `y`, `z`).
void	moveX ()
	Moves cursor forward in x direction.
void	moveY ()
	Moves cursor forward in y direction.
void	moveZ ()
	Moves cursor forward in z direction.
void	moveC ()
	Moves cursor forward in c direction.
void	moveT ()
	Moves cursor forward in t direction.
void	moveU ()
	Moves cursor forward in u direction.
void	reverseMoveX ()
	Moves cursor backward in x direction.
void	reverseMoveY ()
	Moves cursor backward in y direction.
void	reverseMoveZ ()
	Moves cursor backward in z direction.
void	reverseMoveC ()
	Moves cursor backward in c direction.
void	reverseMoveT ()
	Moves cursor backward in t direction.
void	reverseMoveU ()
	Moves cursor backward in u direction.
Get voxel values at cursor position.
DATATYPE	getValue () const
	Returns voxel value at cursor position.
DATATYPE	getValueWithOffset (const ImageVector &offset) const
	Returns voxel value at (cursor position + `offset`).
DATATYPE	getValueWithOffset (MLint dx, MLint dy, MLint dz) const
	Return voxel value at (cursor position + (`dx`, `dy`, `dz`))
Deprecated
void	setCursorSubImgPos (const ImageVector &p)
void	setCursorSubImgPos (MLint x, MLint y, MLint z)
void	setCursorImgPos (const ImageVector &p)
void	setCursorImgPos (MLint x, MLint y, MLint z)
void	setCursorPos (const DATATYPE *position)
void	moveCursor (const ImageVector &dp)
void	moveCursor (MLint x, MLint y, MLint z)
void	moveCursorX ()
void	moveCursorY ()
void	moveCursorZ ()
void	moveCursorC ()
void	moveCursorT ()
void	moveCursorU ()
void	moveCursorBX ()
void	moveCursorBY ()
void	moveCursorBZ ()
void	moveCursorBC ()
void	moveCursorBT ()
void	moveCursorBU ()
DATATYPE	getCursorVal () const
DATATYPE	getCursorVal (const ImageVector &dp) const
DATATYPE	getCursorVal (MLint dx, MLint dy, MLint dz) const
Protected Member Functions
	TSubImageCursorBase (const TSubImage< DATATYPE > &subImage)
Protected Attributes
DATATYPE *	_data
	SubImage data.
ImageVector	_subImageOffset
	SubImage offset in original image.
ImageVector	_stride
	Stride for the sub image.
DATATYPE *	_cursor
	Cursor address for image data access.

Detailed Description

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

Base class for all TSubImage Cursors.

Definition at line 1020 of file mlTSubImage.h.

Constructor & Destructor Documentation

template<typename DATATYPE >

ml::TSubImageCursorBase< DATATYPE >::TSubImageCursorBase ( const TSubImage< DATATYPE > & subImage ) [inline, protected]

Definition at line 1024 of file mlTSubImage.h.

References ml::SubImage::getBox(), ml::TSubImage< DATATYPE >::getData(), ml::SubImage::getStride(), and ml::TSubImageBox< intT >::v1.

Member Function Documentation

template<typename DATATYPE >

DATATYPE ml::TSubImageCursorBase< DATATYPE >::getCursorVal ( ) const [inline]

Deprecated:: Use getValue() instead.

Definition at line 1178 of file mlTSubImage.h.

template<typename DATATYPE >

DATATYPE ml::TSubImageCursorBase< DATATYPE >::getCursorVal ( const ImageVector & dp ) const [inline]

Deprecated:: Use getValueWithOffset() instead.

Definition at line 1181 of file mlTSubImage.h.

template<typename DATATYPE >

DATATYPE ml::TSubImageCursorBase< DATATYPE >::getCursorVal	(	MLint	dx,
		MLint	dy,
		MLint	dz
	)		const `[inline]`

Deprecated:: Use getValueWithOffset() instead.

Definition at line 1184 of file mlTSubImage.h.

template<typename DATATYPE >

DATATYPE ml::TSubImageCursorBase< DATATYPE >::getValue ( ) const [inline]

Returns voxel value at cursor position.

Definition at line 1091 of file mlTSubImage.h.

template<typename DATATYPE >

DATATYPE ml::TSubImageCursorBase< DATATYPE >::getValueWithOffset ( const ImageVector & offset ) const [inline]

Returns voxel value at (cursor position + offset).

Definition at line 1094 of file mlTSubImage.h.

template<typename DATATYPE >

DATATYPE ml::TSubImageCursorBase< DATATYPE >::getValueWithOffset	(	MLint	dx,
		MLint	dy,
		MLint	dz
	)		const `[inline]`

Return voxel value at (cursor position + (dx, dy, dz))

Definition at line 1097 of file mlTSubImage.h.

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::moveByOffset ( const ImageVector & offset ) [inline]

Moves cursor to cursor position + offset.

Definition at line 1052 of file mlTSubImage.h.

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::moveByOffset	(	MLint	x,
		MLint	y,
		MLint	z
	)		`[inline]`

Moves cursor to cursor position + (x, y, z).

Definition at line 1054 of file mlTSubImage.h.

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::moveC ( ) [inline]

Moves cursor forward in c direction.

Definition at line 1062 of file mlTSubImage.h.

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::moveCursor ( const ImageVector & dp ) [inline]

Deprecated:: Use moveByOffset() instead.

Definition at line 1136 of file mlTSubImage.h.

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::moveCursor	(	MLint	x,
		MLint	y,
		MLint	z
	)		`[inline]`

Deprecated:: Use moveByOffset() instead.

Definition at line 1139 of file mlTSubImage.h.

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::moveCursorBC ( ) [inline]

Deprecated:: Use reverseMoveC() instead.

Definition at line 1169 of file mlTSubImage.h.

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::moveCursorBT ( ) [inline]

Deprecated:: Use reverseMoveT() instead.

Definition at line 1172 of file mlTSubImage.h.

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::moveCursorBU ( ) [inline]

Deprecated:: Use reverseMoveU() instead.

Definition at line 1175 of file mlTSubImage.h.

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::moveCursorBX ( ) [inline]

Deprecated:: Use reverseMoveX() instead.

Definition at line 1160 of file mlTSubImage.h.

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::moveCursorBY ( ) [inline]

Deprecated:: Use reverseMoveY() instead.

Definition at line 1163 of file mlTSubImage.h.

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::moveCursorBZ ( ) [inline]

Deprecated:: Use reverseMoveZ() instead.

Definition at line 1166 of file mlTSubImage.h.

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::moveCursorC ( ) [inline]

Deprecated:: Use moveC() instead.

Definition at line 1151 of file mlTSubImage.h.

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::moveCursorT ( ) [inline]

Deprecated:: Use moveT() instead.

Definition at line 1154 of file mlTSubImage.h.

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::moveCursorU ( ) [inline]

Deprecated:: Use moveU() instead.

Definition at line 1157 of file mlTSubImage.h.

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::moveCursorX ( ) [inline]

Deprecated:: Use moveX() instead.

Definition at line 1142 of file mlTSubImage.h.

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::moveCursorY ( ) [inline]

Deprecated:: Use moveY() instead.

Definition at line 1145 of file mlTSubImage.h.

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::moveCursorZ ( ) [inline]

Deprecated:: Use moveZ() instead.

Definition at line 1148 of file mlTSubImage.h.

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::moveT ( ) [inline]

Moves cursor forward in t direction.

Definition at line 1064 of file mlTSubImage.h.

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::moveU ( ) [inline]

Moves cursor forward in u direction.

Definition at line 1066 of file mlTSubImage.h.

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::moveX ( ) [inline]

Moves cursor forward in x direction.

Definition at line 1056 of file mlTSubImage.h.

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::moveY ( ) [inline]

Moves cursor forward in y direction.

Definition at line 1058 of file mlTSubImage.h.

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::moveZ ( ) [inline]

Moves cursor forward in z direction.

Definition at line 1060 of file mlTSubImage.h.

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::reverseMoveC ( ) [inline]

Moves cursor backward in c direction.

Definition at line 1074 of file mlTSubImage.h.

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::reverseMoveT ( ) [inline]

Moves cursor backward in t direction.

Definition at line 1076 of file mlTSubImage.h.

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::reverseMoveU ( ) [inline]

Moves cursor backward in u direction.

Definition at line 1078 of file mlTSubImage.h.

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::reverseMoveX ( ) [inline]

Moves cursor backward in x direction.

Definition at line 1068 of file mlTSubImage.h.

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::reverseMoveY ( ) [inline]

Moves cursor backward in y direction.

Definition at line 1070 of file mlTSubImage.h.

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::reverseMoveZ ( ) [inline]

Moves cursor backward in z direction.

Definition at line 1072 of file mlTSubImage.h.

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::setCursorImgPos	(	MLint	x,
		MLint	y,
		MLint	z
	)		`[inline]`

Deprecated:: Use setImagePosition() instead.

Definition at line 1130 of file mlTSubImage.h.

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::setCursorImgPos ( const ImageVector & p ) [inline]

Deprecated:: Use setImagePosition() instead.

Definition at line 1127 of file mlTSubImage.h.

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::setCursorPos ( const DATATYPE * position ) [inline]

Deprecated:: Use setPosition() instead.

Definition at line 1133 of file mlTSubImage.h.

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::setCursorSubImgPos ( const ImageVector & p ) [inline]

Deprecated:: Use setSubImagePosition() instead.

Definition at line 1121 of file mlTSubImage.h.

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::setCursorSubImgPos	(	MLint	x,
		MLint	y,
		MLint	z
	)		`[inline]`

Deprecated:: Use setSubImagePosition() instead.

Definition at line 1124 of file mlTSubImage.h.

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::setImagePosition ( const ImageVector & position ) [inline]

Sets cursor to the given 6d position relative to the origin of the complete image region.

I.e., the position p=getBox.v1() is considered the origin of the subimage region.

Definition at line 1045 of file mlTSubImage.h.

References _ML_TSUBIMG_SUBDOT6.

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::setImagePosition	(	MLint	x,
		MLint	y,
		MLint	z
	)		`[inline]`

Sets cursor to the given 3d position (x, y, z) relative to the origin of the complete image region.

I.e., the position p=getBox.v1() is considered the origin of the subimage region.

Definition at line 1048 of file mlTSubImage.h.

References _ML_TSUBIMG_SUBDOT3.

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::setPosition ( const DATATYPE * pointer ) [inline]

Sets cursor to the given pointer where the pointer is the memory address of the voxel.

Definition at line 1050 of file mlTSubImage.h.

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::setSubImagePosition ( const ImageVector & position ) [inline]

Sets cursor to the given position relative to the origin of the subimage region.

I.e., the position (0,0,0,0,0,0) is considered the origin of the subimage.

Definition at line 1039 of file mlTSubImage.h.

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::setSubImagePosition	(	MLint	x,
		MLint	y,
		MLint	z
	)		`[inline]`

Sets cursor to the given 3d position (x, y, z) relative to the origin of the subimage region.

I.e., the position (0,0,0,0,0,0) is considered the origin of the subimage.

Definition at line 1042 of file mlTSubImage.h.

Member Data Documentation

template<typename DATATYPE >

DATATYPE* ml::TSubImageCursorBase< DATATYPE >::_cursor [protected]

Cursor address for image data access.

Definition at line 1109 of file mlTSubImage.h.

template<typename DATATYPE >

DATATYPE* ml::TSubImageCursorBase< DATATYPE >::_data [protected]

SubImage data.

Definition at line 1103 of file mlTSubImage.h.

template<typename DATATYPE >

ImageVector ml::TSubImageCursorBase< DATATYPE >::_stride [protected]

Stride for the sub image.

Definition at line 1107 of file mlTSubImage.h.

template<typename DATATYPE >

ImageVector ml::TSubImageCursorBase< DATATYPE >::_subImageOffset [protected]

SubImage offset in original image.

Definition at line 1105 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

Protected Member Functions

Protected Attributes

Detailed Description

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

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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