ml::TSubImageWithCursor< DATATYPE > Class Template Reference

A class that offers a TSubImage with a TSubImageCursor. More...

#include <mlTSubImage.h>

Inheritance diagram for ml::TSubImageWithCursor< DATATYPE >:

ml::TSubImage< DATATYPE > ml::SubImage

List of all members.

Public Member Functions

 TSubImageWithCursor ()
 Default constructor.
 TSubImageWithCursor (const TSubImage< DATATYPE > &subImage)
 Constructor with TSubImage.
 TSubImageWithCursor (const SubImage &subImage)
 Constructor with SubImage.
 TSubImageWithCursor (const TSubImageWithCursor &subImage)
 Constructor with TSubImageWithCursor.
TSubImageWithCursor & operator= (const TSubImageWithCursor< DATATYPE > &tSubImg)
 Assignment operator to get an identical copy.
Positioning and movement of voxel cursor.
void setCursorSubImagePosition (const ImageVector &position)
 Sets cursor to the given position relative to the origin of the subimage region.
void setCursorSubImagePosition (MLint x, MLint y, MLint z)
 Sets cursor to the given 3d position (x, y, z) relative to the origin of the subimage region.
void setCursorImagePosition (const ImageVector &position)
 Sets cursor to the given 6d position relative to the origin of the complete image region.
void setCursorImagePosition (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.
void setCursorPosition (const DATATYPE *pointer)
 Sets cursor to the given pointer where pointer is the memory address of the voxel.
void moveCursorByOffset (const ImageVector &offset)
 Moves cursor to cursor position + offset.
void moveCursorByOffset (MLint x, MLint y, MLint z)
 Moves cursor to cursor position + (x, y, z).
void moveCursorX ()
 Moves cursor forward in x direction.
void moveCursorY ()
 Moves cursor forward in y direction.
void moveCursorZ ()
 Moves cursor forward in z direction.
void moveCursorC ()
 Moves cursor forward in c direction.
void moveCursorT ()
 Moves cursor forward in t direction.
void moveCursorU ()
 Moves cursor forward in u direction.
void reverseMoveCursorX ()
 Moves cursor backward in x direction.
void reverseMoveCursorY ()
 Moves cursor backward in y direction.
void reverseMoveCursorZ ()
 Moves cursor backward in z direction.
void reverseMoveCursorC ()
 Moves cursor backward in c direction.
void reverseMoveCursorT ()
 Moves cursor backward in t direction.
void reverseMoveCursorU ()
 Moves cursor backward in u direction.
Get voxel values at cursor position.
DATATYPE getCursorValue () const
 Returns the voxel value at the cursor position.
DATATYPE getCursorValueWithOffset (const ImageVector &offset) const
 Returns the voxel value at (cursor position + offset).
DATATYPE getCursorValueWithOffset (MLint dx, MLint dy, MLint dz) const
 Returns voxel value at (cursor position + (dx, dy, dz)).
Getting the cursor position as pointer to data.
DATATYPE * getCursorPointer () const
 Returns current cursor pointer (i.e., returns the memory address of the voxel the cursor points to).
DATATYPE * getCursorPointerWithOffset (const ImageVector &offset) const
 Returns cursor pointer of voxel given from current cursor shifted by offset.
DATATYPE * getCursorPointerWithOffset (MLint dx, MLint dy, MLint dz) const
 Returns cursor pointer of voxel given from current cursor shifted by (dx, dy, dz).
Set voxel values at cursor position.
void setCursorValue (DATATYPE value)
 Sets the voxel value at cursor position to value.
void setCursorValueWithOffset (const ImageVector &offset, DATATYPE value)
 Sets the voxel value at (cursor position + offset) to value.
void setCursorValueWithOffset (MLint dx, MLint dy, MLint dz, DATATYPE value)
 Sets voxel value at (cursor position + (dx, dy,dz)) to value.
Deprecated
void setCursorSubImgPos (const ImageVector &p)
void setCursorSubImgPos (MLint x, MLint y, MLint z)
void setCursorImgPos (const ImageVector &p)
void setCursorImgPos (MLint x, MLint y, MLint z)
void setCursorPos (const DATATYPE *position)
void moveCursor (const ImageVector &dp)
void moveCursor (MLint x, MLint y, MLint z)
void moveCursorBX ()
void moveCursorBY ()
void moveCursorBZ ()
void moveCursorBC ()
void moveCursorBT ()
void moveCursorBU ()
DATATYPE getCursorVal () const
DATATYPE getCursorVal (const ImageVector &dp) const
DATATYPE getCursorVal (MLint dx, MLint dy, MLint dz) const
DATATYPE * getCursorPos () const
DATATYPE * getCursorPos (const ImageVector &dp) const
DATATYPE * getCursorPos (MLint dx, MLint dy, MLint dz) const
void setCursorVal (DATATYPE val)
void setCursorVal (const ImageVector &dp, DATATYPE val)
void setCursorVal (MLint dx, MLint dy, MLint dz, DATATYPE val)

Detailed Description

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

A class that offers a TSubImage with a TSubImageCursor.

This class should only be used in legacy code to keep old code working.

Definition at line 2081 of file mlTSubImage.h.

Constructor & Destructor Documentation

template<typename DATATYPE>
ml::TSubImageWithCursor< DATATYPE >::TSubImageWithCursor (  )  [inline]

Default constructor.

Definition at line 2087 of file mlTSubImage.h.

template<typename DATATYPE>
ml::TSubImageWithCursor< DATATYPE >::TSubImageWithCursor ( const TSubImage< DATATYPE > &  subImage  )  [inline]

Constructor with TSubImage.

Definition at line 2091 of file mlTSubImage.h.

template<typename DATATYPE>
ml::TSubImageWithCursor< DATATYPE >::TSubImageWithCursor ( const SubImage &  subImage  )  [inline]

Constructor with SubImage.

Definition at line 2096 of file mlTSubImage.h.

template<typename DATATYPE>
ml::TSubImageWithCursor< DATATYPE >::TSubImageWithCursor ( const TSubImageWithCursor< DATATYPE > &  subImage  )  [inline]

Constructor with TSubImageWithCursor.

Definition at line 2101 of file mlTSubImage.h.

Member Function Documentation

template<typename DATATYPE>
DATATYPE* ml::TSubImageWithCursor< DATATYPE >::getCursorPointer (  )  const [inline]

Returns current cursor pointer (i.e., returns the memory address of the voxel the cursor points to).

Definition at line 2190 of file mlTSubImage.h.

template<typename DATATYPE>
DATATYPE* ml::TSubImageWithCursor< DATATYPE >::getCursorPointerWithOffset ( MLint  dx,
MLint  dy,
MLint  dz 
) const [inline]

Returns cursor pointer of voxel given from current cursor shifted by (dx, dy, dz).

Definition at line 2194 of file mlTSubImage.h.

template<typename DATATYPE>
DATATYPE* ml::TSubImageWithCursor< DATATYPE >::getCursorPointerWithOffset ( const ImageVector &  offset  )  const [inline]

Returns cursor pointer of voxel given from current cursor shifted by offset.

Definition at line 2192 of file mlTSubImage.h.

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

Deprecated:
Use getCursorPointerWithOffset() instead.

Definition at line 2282 of file mlTSubImage.h.

template<typename DATATYPE>
DATATYPE* ml::TSubImageWithCursor< DATATYPE >::getCursorPos ( const ImageVector &  dp  )  const [inline]

Deprecated:
Use getCursorPointerWithOffset() instead.

Definition at line 2279 of file mlTSubImage.h.

template<typename DATATYPE>
DATATYPE* ml::TSubImageWithCursor< DATATYPE >::getCursorPos (  )  const [inline]

Deprecated:
Use getCursorPointer() instead.

Definition at line 2276 of file mlTSubImage.h.

Referenced by ml::KernelLineApplicator< DATATYPE, KDATATYPE >::applyToLine(), and ml::KernelLineApplicator< DATATYPE, KDATATYPE >::applyUserFilterToLine().

template<typename DATATYPE>
DATATYPE ml::TSubImageWithCursor< DATATYPE >::getCursorVal ( MLint  dx,
MLint  dy,
MLint  dz 
) const [inline]

Deprecated:
Use getCursorValueWithOffset() instead.

Definition at line 2273 of file mlTSubImage.h.

template<typename DATATYPE>
DATATYPE ml::TSubImageWithCursor< DATATYPE >::getCursorVal ( const ImageVector &  dp  )  const [inline]

Deprecated:
Use getCursorValueWithOffset() instead.

Definition at line 2270 of file mlTSubImage.h.

template<typename DATATYPE>
DATATYPE ml::TSubImageWithCursor< DATATYPE >::getCursorVal (  )  const [inline]

Deprecated:
Use getCursorValue() instead.

Definition at line 2267 of file mlTSubImage.h.

template<typename DATATYPE>
DATATYPE ml::TSubImageWithCursor< DATATYPE >::getCursorValue (  )  const [inline]

Returns the voxel value at the cursor position.

Definition at line 2177 of file mlTSubImage.h.

template<typename DATATYPE>
DATATYPE ml::TSubImageWithCursor< DATATYPE >::getCursorValueWithOffset ( MLint  dx,
MLint  dy,
MLint  dz 
) const [inline]

Returns voxel value at (cursor position + (dx, dy, dz)).

Definition at line 2181 of file mlTSubImage.h.

template<typename DATATYPE>
DATATYPE ml::TSubImageWithCursor< DATATYPE >::getCursorValueWithOffset ( const ImageVector &  offset  )  const [inline]

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

Definition at line 2179 of file mlTSubImage.h.

template<typename DATATYPE>
void ml::TSubImageWithCursor< DATATYPE >::moveCursor ( MLint  x,
MLint  y,
MLint  z 
) [inline]

Deprecated:
Use moveCursorByOffset() instead.

Definition at line 2246 of file mlTSubImage.h.

template<typename DATATYPE>
void ml::TSubImageWithCursor< DATATYPE >::moveCursor ( const ImageVector &  dp  )  [inline]

Deprecated:
Use moveCursorByOffset() instead.

Definition at line 2243 of file mlTSubImage.h.

template<typename DATATYPE>
void ml::TSubImageWithCursor< DATATYPE >::moveCursorBC (  )  [inline]

Deprecated:
Use reverseMoveCursorC() instead.

Definition at line 2258 of file mlTSubImage.h.

template<typename DATATYPE>
void ml::TSubImageWithCursor< DATATYPE >::moveCursorBT (  )  [inline]

Deprecated:
Use reverseMoveCursorT() instead.

Definition at line 2261 of file mlTSubImage.h.

template<typename DATATYPE>
void ml::TSubImageWithCursor< DATATYPE >::moveCursorBU (  )  [inline]

Deprecated:
Use reverseMoveCursorU() instead.

Definition at line 2264 of file mlTSubImage.h.

template<typename DATATYPE>
void ml::TSubImageWithCursor< DATATYPE >::moveCursorBX (  )  [inline]

Deprecated:
Use reverseMoveCursorX() instead.

Definition at line 2249 of file mlTSubImage.h.

template<typename DATATYPE>
void ml::TSubImageWithCursor< DATATYPE >::moveCursorBY (  )  [inline]

Deprecated:
Use reverseMoveCursorY() instead.

Definition at line 2252 of file mlTSubImage.h.

template<typename DATATYPE>
void ml::TSubImageWithCursor< DATATYPE >::moveCursorByOffset ( MLint  x,
MLint  y,
MLint  z 
) [inline]

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

Definition at line 2140 of file mlTSubImage.h.

template<typename DATATYPE>
void ml::TSubImageWithCursor< DATATYPE >::moveCursorByOffset ( const ImageVector &  offset  )  [inline]

Moves cursor to cursor position + offset.

Definition at line 2138 of file mlTSubImage.h.

template<typename DATATYPE>
void ml::TSubImageWithCursor< DATATYPE >::moveCursorBZ (  )  [inline]

Deprecated:
Use reverseMoveCursorZ() instead.

Definition at line 2255 of file mlTSubImage.h.

template<typename DATATYPE>
void ml::TSubImageWithCursor< DATATYPE >::moveCursorC (  )  [inline]

Moves cursor forward in c direction.

Definition at line 2148 of file mlTSubImage.h.

template<typename DATATYPE>
void ml::TSubImageWithCursor< DATATYPE >::moveCursorT (  )  [inline]

Moves cursor forward in t direction.

Definition at line 2150 of file mlTSubImage.h.

template<typename DATATYPE>
void ml::TSubImageWithCursor< DATATYPE >::moveCursorU (  )  [inline]

Moves cursor forward in u direction.

Definition at line 2152 of file mlTSubImage.h.

template<typename DATATYPE>
void ml::TSubImageWithCursor< DATATYPE >::moveCursorX (  )  [inline]

Moves cursor forward in x direction.

Definition at line 2142 of file mlTSubImage.h.

template<typename DATATYPE>
void ml::TSubImageWithCursor< DATATYPE >::moveCursorY (  )  [inline]

Moves cursor forward in y direction.

Definition at line 2144 of file mlTSubImage.h.

template<typename DATATYPE>
void ml::TSubImageWithCursor< DATATYPE >::moveCursorZ (  )  [inline]

Moves cursor forward in z direction.

Definition at line 2146 of file mlTSubImage.h.

template<typename DATATYPE>
TSubImageWithCursor& ml::TSubImageWithCursor< DATATYPE >::operator= ( const TSubImageWithCursor< DATATYPE > &  tSubImg  )  [inline]

Assignment operator to get an identical copy.

Note that only the pointer to the data is copied, and NOT the data itself.

Definition at line 2107 of file mlTSubImage.h.

References ml::TSubImageWithCursor< DATATYPE >::_cursor, ML_CATCH_RETHROW, ML_TRACE_IN_TIME_CRITICAL, and ML_TRY.

template<typename DATATYPE>
void ml::TSubImageWithCursor< DATATYPE >::reverseMoveCursorC (  )  [inline]

Moves cursor backward in c direction.

Definition at line 2160 of file mlTSubImage.h.

template<typename DATATYPE>
void ml::TSubImageWithCursor< DATATYPE >::reverseMoveCursorT (  )  [inline]

Moves cursor backward in t direction.

Definition at line 2162 of file mlTSubImage.h.

template<typename DATATYPE>
void ml::TSubImageWithCursor< DATATYPE >::reverseMoveCursorU (  )  [inline]

Moves cursor backward in u direction.

Definition at line 2164 of file mlTSubImage.h.

template<typename DATATYPE>
void ml::TSubImageWithCursor< DATATYPE >::reverseMoveCursorX (  )  [inline]

Moves cursor backward in x direction.

Definition at line 2154 of file mlTSubImage.h.

template<typename DATATYPE>
void ml::TSubImageWithCursor< DATATYPE >::reverseMoveCursorY (  )  [inline]

Moves cursor backward in y direction.

Definition at line 2156 of file mlTSubImage.h.

template<typename DATATYPE>
void ml::TSubImageWithCursor< DATATYPE >::reverseMoveCursorZ (  )  [inline]

Moves cursor backward in z direction.

Definition at line 2158 of file mlTSubImage.h.

template<typename DATATYPE>
void ml::TSubImageWithCursor< DATATYPE >::setCursorImagePosition ( 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 2134 of file mlTSubImage.h.

References _ML_TSUBIMG_SUBDOT3.

template<typename DATATYPE>
void ml::TSubImageWithCursor< DATATYPE >::setCursorImagePosition ( 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 2131 of file mlTSubImage.h.

References _ML_TSUBIMG_SUBDOT6.

template<typename DATATYPE>
void ml::TSubImageWithCursor< DATATYPE >::setCursorImgPos ( MLint  x,
MLint  y,
MLint  z 
) [inline]

Deprecated:
Use setCursorImagePosition() instead.

Definition at line 2237 of file mlTSubImage.h.

template<typename DATATYPE>
void ml::TSubImageWithCursor< DATATYPE >::setCursorImgPos ( const ImageVector &  p  )  [inline]

Deprecated:
Use setCursorImagePosition() instead.

Definition at line 2234 of file mlTSubImage.h.

Referenced by ml::MLKernelToolsApplyFiltering().

template<typename DATATYPE>
void ml::TSubImageWithCursor< DATATYPE >::setCursorPos ( const DATATYPE *  position  )  [inline]

Deprecated:
Use setCursorPosition() instead.

Definition at line 2240 of file mlTSubImage.h.

template<typename DATATYPE>
void ml::TSubImageWithCursor< DATATYPE >::setCursorPosition ( const DATATYPE *  pointer  )  [inline]

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

Definition at line 2136 of file mlTSubImage.h.

template<typename DATATYPE>
void ml::TSubImageWithCursor< DATATYPE >::setCursorSubImagePosition ( 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 2128 of file mlTSubImage.h.

template<typename DATATYPE>
void ml::TSubImageWithCursor< DATATYPE >::setCursorSubImagePosition ( 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 2125 of file mlTSubImage.h.

template<typename DATATYPE>
void ml::TSubImageWithCursor< DATATYPE >::setCursorSubImgPos ( MLint  x,
MLint  y,
MLint  z 
) [inline]

Deprecated:
Use setCursorSubImagePosition() instead.

Definition at line 2231 of file mlTSubImage.h.

template<typename DATATYPE>
void ml::TSubImageWithCursor< DATATYPE >::setCursorSubImgPos ( const ImageVector &  p  )  [inline]

Deprecated:
Use setCursorSubImagePosition() instead.

Definition at line 2228 of file mlTSubImage.h.

template<typename DATATYPE>
void ml::TSubImageWithCursor< DATATYPE >::setCursorVal ( MLint  dx,
MLint  dy,
MLint  dz,
DATATYPE  val 
) [inline]

Deprecated:
Use setCursorValueWithOffset() instead.

Definition at line 2291 of file mlTSubImage.h.

template<typename DATATYPE>
void ml::TSubImageWithCursor< DATATYPE >::setCursorVal ( const ImageVector &  dp,
DATATYPE  val 
) [inline]

Deprecated:
Use setCursorValueWithOffset() instead.

Definition at line 2288 of file mlTSubImage.h.

template<typename DATATYPE>
void ml::TSubImageWithCursor< DATATYPE >::setCursorVal ( DATATYPE  val  )  [inline]

Deprecated:
Use setCursorValue() instead.

Definition at line 2285 of file mlTSubImage.h.

template<typename DATATYPE>
void ml::TSubImageWithCursor< DATATYPE >::setCursorValue ( DATATYPE  value  )  [inline]

Sets the voxel value at cursor position to value.

Definition at line 2206 of file mlTSubImage.h.

template<typename DATATYPE>
void ml::TSubImageWithCursor< DATATYPE >::setCursorValueWithOffset ( MLint  dx,
MLint  dy,
MLint  dz,
DATATYPE  value 
) [inline]

Sets voxel value at (cursor position + (dx, dy,dz)) to value.

Definition at line 2210 of file mlTSubImage.h.

template<typename DATATYPE>
void ml::TSubImageWithCursor< DATATYPE >::setCursorValueWithOffset ( const ImageVector &  offset,
DATATYPE  value 
) [inline]

Sets the voxel value at (cursor position + offset) to value.

Definition at line 2208 of file mlTSubImage.h.

The documentation for this class was generated from the following file:
Generated on Sat Sep 3 18:39:36 2011 for MeVisLab Toolbox Reference by  doxygen 1.5.8