ml::ConstTSubImageCursor< DATATYPE > Class Template Reference

Predeclaration for const cursor. More...

#include <mlTSubImage.h>

Inheritance diagram for ml::ConstTSubImageCursor< DATATYPE >:

Public Member Functions
	ConstTSubImageCursor (const TSubImage< DATATYPE > &subImage)
Getting the cursor position as a const pointer to the data.
Returns the current cursor position (i.e., returns the memory address of the voxel the cursor points to).
const DATATYPE *	getPointer () const
const DATATYPE *	getPointerWithOffset (const ImageVector &offset) const
	Returns the cursor position of the voxel computed from the current cursor shifted by offset.
const DATATYPE *	getPointerWithOffset (MLint dx, MLint dy, MLint dz) const
	Returns the cursor position of the voxel computed from the current cursor shifted by (dx, dy, dz).
Public Member Functions inherited from ml::TSubImageCursorBase< DATATYPE >
void	setSubImagePosition (const ImageVector &position)
	Sets the cursor to the given position relative to the origin of the subimage region.
void	setSubImagePosition (MLint x, MLint y, MLint z)
	Sets the cursor to the given 3D position (x, y, z) relative to the origin of the subimage region.
void	setImagePosition (const ImageVector &position)
	Sets the cursor to the given 6D position relative to the origin of the complete image region.
void	setImagePosition (MLint x, MLint y, MLint z)
	Sets the cursor to the given 3D position (x, y, z) relative to the origin of the complete image region.
void	setPosition (const DATATYPE *pointer)
	Sets the cursor to the given pointer where the pointer is the memory address of the voxel.
void	moveByOffset (const ImageVector &offset)
	Moves the cursor to cursor position + offset.
void	moveByOffset (MLint x, MLint y, MLint z)
	Moves the cursor to cursor position + (x, y, z).
void	moveX ()
	Moves the cursor forward in x direction.
void	moveY ()
	Moves the cursor forward in y direction.
void	moveZ ()
	Moves the cursor forward in z direction.
void	moveC ()
	Moves the cursor forward in c direction.
void	moveT ()
	Moves the cursor forward in t direction.
void	moveU ()
	Moves the cursor forward in u direction.
void	reverseMoveX ()
	Moves the cursor backward in x direction.
void	reverseMoveY ()
	Moves the cursor backward in y direction.
void	reverseMoveZ ()
	Moves the cursor backward in z direction.
void	reverseMoveC ()
	Moves the cursor backward in c direction.
void	reverseMoveT ()
	Moves the cursor backward in t direction.
void	reverseMoveU ()
	Moves the cursor backward in u direction.
DATATYPE	getValue () const
	Returns the voxel value at cursor position.
DATATYPE	getValueWithOffset (const ImageVector &offset) const
	Returns the voxel value at (cursor position + offset).
DATATYPE	getValueWithOffset (MLint dx, MLint dy, MLint dz) const
	Return the voxel value at (cursor position + (dx, dy, dz))

Additional Inherited Members
Protected Member Functions inherited from ml::TSubImageCursorBase< DATATYPE >
	TSubImageCursorBase (const TSubImage< DATATYPE > &subImage)
Protected Attributes inherited from ml::TSubImageCursorBase< DATATYPE >
DATATYPE *	_data
	SubImage data.
ImageVector	_subImageOffset
	SubImage offset in original image.
ImageVector	_stride
	Stride for the subimage.
DATATYPE *	_cursor
	Cursor address for image data access.

Detailed Description

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

Predeclaration for const cursor.

Cursor to access const data of a TSubImage.

Definition at line 920 of file mlTSubImage.h.

Constructor & Destructor Documentation

ConstTSubImageCursor()

template<typename DATATYPE >

ml::ConstTSubImageCursor< DATATYPE >::ConstTSubImageCursor ( const TSubImage< DATATYPE > & subImage )

inline

Definition at line 925 of file mlTSubImage.h.

Member Function Documentation

getPointer()

template<typename DATATYPE >

const DATATYPE * ml::ConstTSubImageCursor< DATATYPE >::getPointer ( ) const

inline

Definition at line 933 of file mlTSubImage.h.

getPointerWithOffset() [1/2]

template<typename DATATYPE >

const DATATYPE * ml::ConstTSubImageCursor< DATATYPE >::getPointerWithOffset ( const ImageVector & offset ) const

inline

Returns the cursor position of the voxel computed from the current cursor shifted by offset.

Definition at line 935 of file mlTSubImage.h.

getPointerWithOffset() [2/2]

template<typename DATATYPE >

const DATATYPE * ml::ConstTSubImageCursor< DATATYPE >::getPointerWithOffset ( MLint dx, MLint dy, MLint dz ) const

inline

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

Definition at line 937 of file mlTSubImage.h.

References mlrange_cast().

---

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

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