ml::TSubImageCursor< DATATYPE > Class Template Reference
[Image Processing]

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

#include <mlTSubImage.h>

Inheritance diagram for ml::TSubImageCursor< DATATYPE >:

List of all members.

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 1743 of file mlTSubImage.h.

---

Constructor & Destructor Documentation

template<typename DATATYPE >

ml::TSubImageCursor< DATATYPE >::TSubImageCursor

(

TSubImage< DATATYPE > &

subImage

)

[inline]

Definition at line 1749 of file mlTSubImage.h.

---

Member Function Documentation

template<typename DATATYPE >

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

Deprecated:

Use getPointerWithOffset() instead.

Definition at line 1795 of file mlTSubImage.h.

template<typename DATATYPE >

DATATYPE* ml::TSubImageCursor< DATATYPE >::getCursorPos

(

const ImageVector &

dp

)

const [inline]

Deprecated:

Use getPointerWithOffset() instead.

Definition at line 1792 of file mlTSubImage.h.

template<typename DATATYPE >

DATATYPE* ml::TSubImageCursor< DATATYPE >::getCursorPos

(

)

const [inline]

Deprecated:

Use getPointer() instead.

Definition at line 1789 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 1757 of file mlTSubImage.h.

Referenced by ml::TSubImage< DATATYPE >::fillBordersWithInputValues().

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 1761 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 1759 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 1804 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 1801 of file mlTSubImage.h.

template<typename DATATYPE >

void ml::TSubImageCursor< DATATYPE >::setCursorVal

(

DATATYPE

val

)

const [inline]

Deprecated:

Use setValue() instead.

Definition at line 1798 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 1773 of file mlTSubImage.h.

Referenced by ml::TSubImage< DATATYPE >::fillBordersWithBorderValues().

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 1777 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 1775 of file mlTSubImage.h.

---

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

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