MeVisLab Toolbox Reference
ml::TSubImageCursorBase< DATATYPE > Class Template Reference

Base class for all TSubImage Cursors. More...

#include <mlTSubImage.h>

Inheritance diagram for ml::TSubImageCursorBase< DATATYPE >:
ml::ConstTSubImageCursor< DATATYPE > ml::TSubImageCursor< 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. More...
 
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. More...
 
void setImagePosition (const ImageVector &position)
 Sets 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 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 cursor to the given pointer where the pointer is the memory address of the voxel. More...
 
void moveByOffset (const ImageVector &offset)
 Moves cursor to cursor position + offset. More...
 
void moveByOffset (MLint x, MLint y, MLint z)
 Moves cursor to cursor position + (x, y, z). More...
 
void moveX ()
 Moves cursor forward in x direction. More...
 
void moveY ()
 Moves cursor forward in y direction. More...
 
void moveZ ()
 Moves cursor forward in z direction. More...
 
void moveC ()
 Moves cursor forward in c direction. More...
 
void moveT ()
 Moves cursor forward in t direction. More...
 
void moveU ()
 Moves cursor forward in u direction. More...
 
void reverseMoveX ()
 Moves cursor backward in x direction. More...
 
void reverseMoveY ()
 Moves cursor backward in y direction. More...
 
void reverseMoveZ ()
 Moves cursor backward in z direction. More...
 
void reverseMoveC ()
 Moves cursor backward in c direction. More...
 
void reverseMoveT ()
 Moves cursor backward in t direction. More...
 
void reverseMoveU ()
 Moves cursor backward in u direction. More...
 
Get voxel values at cursor position.
DATATYPE getValue () const
 Returns voxel value at cursor position. More...
 
DATATYPE getValueWithOffset (const ImageVector &offset) const
 Returns voxel value at (cursor position + offset). More...
 
DATATYPE getValueWithOffset (MLint dx, MLint dy, MLint dz) const
 Return 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 sub image. 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 946 of file mlTSubImage.h.

Constructor & Destructor Documentation

◆ TSubImageCursorBase()

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

Member Function Documentation

◆ getValue()

template<typename DATATYPE >
DATATYPE ml::TSubImageCursorBase< DATATYPE >::getValue ( ) const
inline

Returns voxel value at cursor position.

Definition at line 1017 of file mlTSubImage.h.

◆ getValueWithOffset() [1/2]

template<typename DATATYPE >
DATATYPE ml::TSubImageCursorBase< DATATYPE >::getValueWithOffset ( const ImageVector offset) const
inline

Returns voxel value at (cursor position + offset).

Definition at line 1020 of file mlTSubImage.h.

◆ getValueWithOffset() [2/2]

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

◆ moveByOffset() [1/2]

template<typename DATATYPE >
void ml::TSubImageCursorBase< DATATYPE >::moveByOffset ( const ImageVector offset)
inline

Moves cursor to cursor position + offset.

Definition at line 978 of file mlTSubImage.h.

◆ moveByOffset() [2/2]

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

◆ moveC()

template<typename DATATYPE >
void ml::TSubImageCursorBase< DATATYPE >::moveC ( )
inline

Moves cursor forward in c direction.

Definition at line 988 of file mlTSubImage.h.

◆ moveT()

template<typename DATATYPE >
void ml::TSubImageCursorBase< DATATYPE >::moveT ( )
inline

Moves cursor forward in t direction.

Definition at line 990 of file mlTSubImage.h.

◆ moveU()

template<typename DATATYPE >
void ml::TSubImageCursorBase< DATATYPE >::moveU ( )
inline

Moves cursor forward in u direction.

Definition at line 992 of file mlTSubImage.h.

◆ moveX()

template<typename DATATYPE >
void ml::TSubImageCursorBase< DATATYPE >::moveX ( )
inline

Moves cursor forward in x direction.

Definition at line 982 of file mlTSubImage.h.

◆ moveY()

template<typename DATATYPE >
void ml::TSubImageCursorBase< DATATYPE >::moveY ( )
inline

Moves cursor forward in y direction.

Definition at line 984 of file mlTSubImage.h.

◆ moveZ()

template<typename DATATYPE >
void ml::TSubImageCursorBase< DATATYPE >::moveZ ( )
inline

Moves cursor forward in z direction.

Definition at line 986 of file mlTSubImage.h.

◆ reverseMoveC()

template<typename DATATYPE >
void ml::TSubImageCursorBase< DATATYPE >::reverseMoveC ( )
inline

Moves cursor backward in c direction.

Definition at line 1000 of file mlTSubImage.h.

◆ reverseMoveT()

template<typename DATATYPE >
void ml::TSubImageCursorBase< DATATYPE >::reverseMoveT ( )
inline

Moves cursor backward in t direction.

Definition at line 1002 of file mlTSubImage.h.

◆ reverseMoveU()

template<typename DATATYPE >
void ml::TSubImageCursorBase< DATATYPE >::reverseMoveU ( )
inline

Moves cursor backward in u direction.

Definition at line 1004 of file mlTSubImage.h.

◆ reverseMoveX()

template<typename DATATYPE >
void ml::TSubImageCursorBase< DATATYPE >::reverseMoveX ( )
inline

Moves cursor backward in x direction.

Definition at line 994 of file mlTSubImage.h.

◆ reverseMoveY()

template<typename DATATYPE >
void ml::TSubImageCursorBase< DATATYPE >::reverseMoveY ( )
inline

Moves cursor backward in y direction.

Definition at line 996 of file mlTSubImage.h.

◆ reverseMoveZ()

template<typename DATATYPE >
void ml::TSubImageCursorBase< DATATYPE >::reverseMoveZ ( )
inline

Moves cursor backward in z direction.

Definition at line 998 of file mlTSubImage.h.

◆ setImagePosition() [1/2]

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

References _ML_TSUBIMG_SUBDOT3.

◆ setPosition()

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

◆ setSubImagePosition() [1/2]

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

◆ setSubImagePosition() [2/2]

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

◆ _data

template<typename DATATYPE >
DATATYPE* ml::TSubImageCursorBase< DATATYPE >::_data
protected

SubImage data.

Definition at line 1029 of file mlTSubImage.h.

◆ _stride

template<typename DATATYPE >
ImageVector ml::TSubImageCursorBase< DATATYPE >::_stride
protected

Stride for the sub image.

Definition at line 1033 of file mlTSubImage.h.

◆ _subImageOffset

template<typename DATATYPE >
ImageVector ml::TSubImageCursorBase< DATATYPE >::_subImageOffset
protected

SubImage offset in original image.

Definition at line 1031 of file mlTSubImage.h.


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