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 the cursor to the given `position` relative to the origin of the subimage region. More...

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. More...

void	setImagePosition (const ImageVector &position)
	Sets the cursor to the given 6D `position` relative to the origin of the complete image region. More...

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. More...

void	setPosition (const DATATYPE *pointer)
	Sets the cursor to the given `pointer` where the `pointer` is the memory address of the voxel. More...

void	moveByOffset (const ImageVector &offset)
	Moves the cursor to cursor position + `offset`. More...

void	moveByOffset (MLint x, MLint y, MLint z)
	Moves the cursor to cursor position + (`x`, `y`, `z`). More...

void	moveX ()
	Moves the cursor forward in x direction. More...

void	moveY ()
	Moves the cursor forward in y direction. More...

void	moveZ ()
	Moves the cursor forward in z direction. More...

void	moveC ()
	Moves the cursor forward in c direction. More...

void	moveT ()
	Moves the cursor forward in t direction. More...

void	moveU ()
	Moves the cursor forward in u direction. More...

void	reverseMoveX ()
	Moves the cursor backward in x direction. More...

void	reverseMoveY ()
	Moves the cursor backward in y direction. More...

void	reverseMoveZ ()
	Moves the cursor backward in z direction. More...

void	reverseMoveC ()
	Moves the cursor backward in c direction. More...

void	reverseMoveT ()
	Moves the cursor backward in t direction. More...

void	reverseMoveU ()
	Moves the cursor backward in u direction. More...

Get voxel values at the cursor position.
DATATYPE	getValue () const
	Returns the voxel value at cursor position. More...

DATATYPE	getValueWithOffset (const ImageVector &offset) const
	Returns the voxel value at (cursor position + `offset`). More...

DATATYPE	getValueWithOffset (MLint dx, MLint dy, MLint dz) const
	Return the voxel value at (cursor position + (`dx`, `dy`, `dz`)) More...

Protected Member Functions
	TSubImageCursorBase (const TSubImage< DATATYPE > &subImage)

Protected Attributes
DATATYPE *	_data
	SubImage data. More...

ImageVector	_subImageOffset
	SubImage offset in original image. More...

ImageVector	_stride
	Stride for the subimage. More...

DATATYPE *	_cursor
	Cursor address for image data access. More...

Detailed Description

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

Base class for all TSubImage Cursors.

Definition at line 823 of file mlTSubImage.h.

Constructor & Destructor Documentation

◆ TSubImageCursorBase()

template<typename DATATYPE >

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

inlineprotected

Definition at line 827 of file mlTSubImage.h.

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

Member Function Documentation

◆ getValue()

template<typename DATATYPE >

DATATYPE ml::TSubImageCursorBase< DATATYPE >::getValue ( ) const

inline

Returns the voxel value at cursor position.

Definition at line 894 of file mlTSubImage.h.

◆ getValueWithOffset() [1/2]

template<typename DATATYPE >

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

inline

Returns the voxel value at (cursor position + offset).

Definition at line 897 of file mlTSubImage.h.

◆ getValueWithOffset() [2/2]

template<typename DATATYPE >

DATATYPE ml::TSubImageCursorBase< DATATYPE >::getValueWithOffset	(	MLint	dx,
		MLint	dy,
		MLint	dz
	)		const

inline

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

Definition at line 900 of file mlTSubImage.h.

◆ moveByOffset() [1/2]

template<typename DATATYPE >

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

inline

Moves the cursor to cursor position + offset.

Definition at line 855 of file mlTSubImage.h.

◆ moveByOffset() [2/2]

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::moveByOffset	(	MLint	x,
		MLint	y,
		MLint	z
	)

inline

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

Definition at line 857 of file mlTSubImage.h.

◆ moveC()

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::moveC ( )

inline

Moves the cursor forward in c direction.

Definition at line 865 of file mlTSubImage.h.

◆ moveT()

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::moveT ( )

inline

Moves the cursor forward in t direction.

Definition at line 867 of file mlTSubImage.h.

◆ moveU()

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::moveU ( )

inline

Moves the cursor forward in u direction.

Definition at line 869 of file mlTSubImage.h.

◆ moveX()

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::moveX ( )

inline

Moves the cursor forward in x direction.

Definition at line 859 of file mlTSubImage.h.

◆ moveY()

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::moveY ( )

inline

Moves the cursor forward in y direction.

Definition at line 861 of file mlTSubImage.h.

◆ moveZ()

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::moveZ ( )

inline

Moves the cursor forward in z direction.

Definition at line 863 of file mlTSubImage.h.

◆ reverseMoveC()

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::reverseMoveC ( )

inline

Moves the cursor backward in c direction.

Definition at line 877 of file mlTSubImage.h.

◆ reverseMoveT()

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::reverseMoveT ( )

inline

Moves the cursor backward in t direction.

Definition at line 879 of file mlTSubImage.h.

◆ reverseMoveU()

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::reverseMoveU ( )

inline

Moves the cursor backward in u direction.

Definition at line 881 of file mlTSubImage.h.

◆ reverseMoveX()

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::reverseMoveX ( )

inline

Moves the cursor backward in x direction.

Definition at line 871 of file mlTSubImage.h.

◆ reverseMoveY()

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::reverseMoveY ( )

inline

Moves the cursor backward in y direction.

Definition at line 873 of file mlTSubImage.h.

◆ reverseMoveZ()

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::reverseMoveZ ( )

inline

Moves the cursor backward in z direction.

Definition at line 875 of file mlTSubImage.h.

◆ setImagePosition() [1/2]

template<typename DATATYPE >

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

inline

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

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

Definition at line 848 of file mlTSubImage.h.

References _ML_TSUBIMG_SUBDOT6.

◆ setImagePosition() [2/2]

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::setImagePosition	(	MLint	x,
		MLint	y,
		MLint	z
	)

inline

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

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

Definition at line 851 of file mlTSubImage.h.

References _ML_TSUBIMG_SUBDOT3.

◆ setPosition()

template<typename DATATYPE >

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

inline

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

Definition at line 853 of file mlTSubImage.h.

◆ setSubImagePosition() [1/2]

template<typename DATATYPE >

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

inline

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

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

Definition at line 842 of file mlTSubImage.h.

◆ setSubImagePosition() [2/2]

template<typename DATATYPE >

void ml::TSubImageCursorBase< DATATYPE >::setSubImagePosition	(	MLint	x,
		MLint	y,
		MLint	z
	)

inline

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

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

Definition at line 845 of file mlTSubImage.h.

Member Data Documentation

◆ _cursor

template<typename DATATYPE >

DATATYPE* ml::TSubImageCursorBase< DATATYPE >::_cursor

protected

Cursor address for image data access.

Definition at line 912 of file mlTSubImage.h.

◆ _data

template<typename DATATYPE >

DATATYPE* ml::TSubImageCursorBase< DATATYPE >::_data

protected

SubImage data.

Definition at line 906 of file mlTSubImage.h.

◆ _stride

template<typename DATATYPE >

ImageVector ml::TSubImageCursorBase< DATATYPE >::_stride

protected

Stride for the subimage.

Definition at line 910 of file mlTSubImage.h.

◆ _subImageOffset

template<typename DATATYPE >

ImageVector ml::TSubImageCursorBase< DATATYPE >::_subImageOffset

protected

SubImage offset in original image.

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

◆ TSubImageCursorBase()

Member Function Documentation

◆ getValue()

◆ getValueWithOffset() [1/2]

◆ getValueWithOffset() [2/2]

◆ moveByOffset() [1/2]

◆ moveByOffset() [2/2]

◆ moveC()

◆ moveT()

◆ moveU()

◆ moveX()

◆ moveY()

◆ moveZ()

◆ reverseMoveC()

◆ reverseMoveT()

◆ reverseMoveU()

◆ reverseMoveX()

◆ reverseMoveY()

◆ reverseMoveZ()

◆ setImagePosition() [1/2]

◆ setImagePosition() [2/2]

◆ setPosition()

◆ setSubImagePosition() [1/2]

◆ setSubImagePosition() [2/2]

Member Data Documentation

◆ _cursor

◆ _data

◆ _stride

◆ _subImageOffset

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