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

Predeclaration for const cursor. More...

#include <mlTSubImage.h>

Inheritance diagram for ml::ConstTSubImageCursor< DATATYPE >:
ml::TSubImageCursorBase< 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. More...
 
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). More...
 
- 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. 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...
 
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...
 

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


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