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

#include <mlTSubImage.h>

Inheritance diagram for ml::TSubImageWithCursor< DATATYPE >:

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.
Returns current cursor pointer (i.e., returns the memory address of the voxel the cursor points to).
DATATYPE *	getCursorPointer () const

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.

Public Member Functions inherited from ml::TSubImage< DATATYPE >
	TSubImage (const SubImageBox &box, MLDataType dataType, void *data)
	Constructor for an image region with location/extent `box`, with data type `dataType` (must fit to DATATYPE!) and the memory address `data` which hold the image region.

	TSubImage ()
	Default constructor to build a typed subimage (with an empty box) from scratch.

	TSubImage (const SubImage &subImage)
	Constructor to build a typed subimage from an untyped `subImage`.

	TSubImage (const TSubImage< DATATYPE > &typedSubImage)
	Copy constructor to get an identical copy.

	~TSubImage () override=default
	Virtual destructor to shut up compiler warnings.

TSubImage &	operator= (const TSubImage< DATATYPE > &typedSubImage)
	Assignment operator to get an identical copy.

const DATATYPE *	getData () const
	Returns memory address of image region (Overloads method from SubImage)

DATATYPE *	getData ()

const DATATYPE *	getSubImagePointer (const ImageVector &position) const
	Returns a pointer to voxel data of image voxel at the 6d `position` relative to the begin of the subimage region.

DATATYPE *	getSubImagePointer (const ImageVector &position)

const DATATYPE *	getSubImagePointer (MLint x, MLint y, MLint z) const
	Returns a pointer to voxel data of image voxel at 3d position p=(`x`, `y`, `z`) relative to the begin of the subimage region.

DATATYPE *	getSubImagePointer (MLint x, MLint y, MLint z)

const DATATYPE *	getImagePointer (const ImageVector &position) const
	Returns a pointer to voxel data of image voxel at 6d position `position` relative to the begin of the complete image region.

DATATYPE *	getImagePointer (const ImageVector &position)

const DATATYPE *	getImagePointer (MLint x, MLint y, MLint z) const
	Returns a pointer to voxel data of image voxel at 3d position p=(`x`, `y`, `z`) relative to the begin of the complete image region.

DATATYPE *	getImagePointer (MLint x, MLint y, MLint z)

ImageVector	convertPointerToSubImagePosition (DATATYPE *pointer) const
	Returns 6d voxel coordinates corresponding to the memory address `pointer`.

void	convertPointerToSubImagePosition (DATATYPE pointer, MLint x, MLint y, MLint z) const
	Returns 3d voxel coordinates corresponding to the memory address `pointer`.

ImageVector	convertPointerToImagePosition (DATATYPE *pointer) const
	Returns 6d voxel coordinates corresponding to the memory address `pointer`.

void	convertPointerToImagePosition (DATATYPE pointer, MLint x, MLint y, MLint z) const
	Returns 3d voxel coordinates corresponding to the memory address `pointer`.

const DATATYPE &	operator[] (const ImageVector &position) const
	Constant reference access to voxel value at the given `position`.

DATATYPE &	operator[] (const ImageVector &position)
	Reference access to voxel value at the given `position`.

void	setSubImageValue (const ImageVector &position, DATATYPE value)
	Sets the voxel value at the given `position` to the given `value` where `position` is relative to the origin of the subimage region.

DATATYPE	getSubImageValue (const ImageVector &position) const
	Returns voxel value at the given `position` where `position` is relative to the origin of the subimage region.

void	setSubImageValue (MLint x, MLint y, DATATYPE value)
	Sets the voxel value at the given position(`x`, `y`) to the given `value` where the position is relative to the origin of the subimage region.

DATATYPE	getSubImageValue (MLint x, MLint y) const
	Returns the voxel value at position (`x`, `y`) where the position is relative to the origin of the subimage region.

void	setSubImageValue (MLint x, MLint y, MLint z, DATATYPE value)
	Sets the voxel value at the given position (`x`, `y`, `z`) to the given `value` where the positionis relative to the origin of the subimage region.

DATATYPE	getSubImageValue (MLint x, MLint y, MLint z) const
	Returns the voxel value at the given position (`x`, `y`, `z`) where the position is relative to the origin of the subimage region.

void	setImageValue (const ImageVector &position, DATATYPE value)
	Sets the 6d voxel at the given `position` to the given `value`.

DATATYPE	getImageValue (const ImageVector &position) const
	Returns the 6d voxel value from the given `position`.

void	setImageValue (MLint x, MLint y, DATATYPE value)
	Sets the 2d voxel at the given position (`x`, `y`) to the the given `value`.

DATATYPE	getImageValue (MLint x, MLint y) const
	Returns the 2d voxel value from the given position (`x`, `y`).

void	setImageValue (MLint x, MLint y, MLint z, DATATYPE value)
	Sets the 3d voxel at the given position (`x`, `y`, `z`) to the given `value`.

DATATYPE	getImageValue (MLint x, MLint y, MLint z) const
	Returns the 3d voxel value from given position (`x`, `y`, `z`).

MLint	calculateMinMax (DATATYPE &minValue, DATATYPE &maxValue, const SubImageBox *const validBox=nullptr) const
	Scans subimage and determines minimum and maximum values of the region which is part of subimage box and of `validBox`.

template<typename FROM_DATATYPE >
void	copySubImageReorderColorPlanesToInterleaved (const TSubImage< FROM_DATATYPE > &typedFromImage, const ScaleShiftData &scaleShiftData)
	Implements special case for void copySubImageTyped(const TSubImage<FROM_DATATYPE> &typedFromImg, const ScaleShiftData& scaleShiftData) where color planes shall be interleaved instead of in planes.

template<typename FROM_DATATYPE >
void	copySubImageTyped (const TSubImage< FROM_DATATYPE > &typedFromImg, const ScaleShiftData &scaleShiftData)
	Copies image data from the subimage fromImg into the overlapping region of this subimage.

void	fill (DATATYPE value)
	Sets all voxel values in subimage to `value`.

void	fillBordersWithValue (const SubImageBox &box, DATATYPE fillValue)
	Fills all regions with `fillValue` which are not covered by `box`.

void	fillInvalidRegionWithValue (DATATYPE value)
	Fills the invalid region (everything outside of getValidRegion()) with the given `value`.

void	fillInvalidRegionWithBorderValues ()
	Fills the invalid region (everything outside of getValidRegion()) with the values on the borders of the valid region.

Public Member Functions inherited from ml::SubImage
const SubImageBox &	getBox () const
	Returns the box describing the origin/extent of the subimage.

void	setSourceImageExtent (const ImageVector &extent)
	Sets the image extent of the source image that was used to create this SubImage to `extent`.

ImageVector	getSourceImageExtent () const
	Returns the image extent of the source image that was used to create this SubImage.

SubImageBox	getValidRegion () const
	Returns the valid region of the SubImage, which is defined by the intersection of the SubImage::getBox() and the SubImageBox(ImageVector(0), SubImage::getSourceImageExtent()-1).

MLint	getNumVoxels () const
	Returns number of voxels in (sub)image.

MLint	getSizeInBytes () const
	Returns number of potential bytes in (sub)image.

ImageVector	getStride () const
	Returns a stride vector to address the memory efficiently.

MLint	getOffset (const ImageVector &voxelPosition) const
	Returns the array index offset from the origin (0,0,0,0,0,0) to the `voxelPosition`.

void	setDataType (MLDataType dataType)
	Overwrite inherited setDataType method to set type of data to `dataType`.

MLDataType	getDataType () const
	Return type of image data.

const MLTypeInfos *	getDataTypeInfos () const
	Get MLTypeInfos for image data type.

MLEXPORT ImageProperties	toImageProperties () const
	Converts the Subimage's datatype and extend to an ImageProperties object.

MLEXPORT void	setFromImageProperties (const ImageProperties &imageProperties)
	Sets the image box and datatype from the `imageProperties` extent and datatype.

void	toStream (std::ostream &ostr) const

	SubImage ()
	Constructor: Creates a subimage with no data.

	SubImage (const SubImage &si)
	Copy constructor to get identical copy.

	SubImage (const SubImageBox &box, MLDataType datatype, void *data=nullptr)
	Constructor for a rectangular 6d image region with position and extent given by box, with data type datatype and memory given by the pointer data.

	SubImage (const SubImage &si, const ImageVector &offset)
	Copy constructor to get identical copy.

virtual	~SubImage ()=default
	Virtual destructor to suppress compiler warnings.

SubImage &	operator= (const SubImage &si)
	Assignment operator to get identical copy.

void	setBox (const SubImageBox &subImageBox)
	Sets a rectangular 6d region of the subimage to `subImageBox`.

void	setBox (const ImageVector &imageExtent)
	Sets a rectangular 6d region of the subimage to `imageExtent`.

void	translate (const ImageVector &offset)
	Translates the box of the subimage by adding the vector `offset`.

const ImageVector &	getOrigin () const
	Returns the origin of the subimage (which is identical to getBox().v1).

void	setOrigin (const ImageVector &newOrigin)
	Sets the origin of the subimage (which moves the box of the subimage to `newOrigin`).

ImageVector	getExtent () const
	Returns the extent of the subimage (which is identical to getBox().getExtent()).

void	setExtent (MLint x, MLint y, MLint z=1, MLint c=1, MLint t=1, MLint u=1)
	Sets the extent of the subimage (which also changes the strides) to `newExtent`.

void	setExtent (const ImageVector &newExtent)
	Sets the extent of the subimage (which also changes the strides) to `newExtent`.

SubImageBox	getBoxFromExtent () const
	Returns size of image as box with origin 0.

SubImageBox	getBoxFromImageExtent () const

ImageVector	getImageExtent () const

void	setImageExtent (const ImageVector &newExtent)

void *	getSubImagePointer (const ImageVector &voxelPosition) const
	Returns pointer to voxel data of image voxel at 6d `voxelPosition` relative to the begin of the subimage region.

void *	getSubImagePointer (MLint x, MLint y, MLint z) const
	Returns pointer to voxel data of image voxel at 3d position p=(`x`,`y`,`z`) relative to the begin of the subimage region.

void *	getImagePointer (const ImageVector &voxelPosition) const
	Returns pointer to voxel data of image voxel at 6d position `voxelPosition` relative to the begin of the complete image region.

void *	getImagePointer (MLint x, MLint y, MLint z) const
	Returns pointer to voxel data of image voxel at 3d position p=(`x`, `y`, `z`) relative to the begin of the complete image region.

MLEXPORT void	copySubImage (const SubImage &fromImage, const ScaleShiftData &scaleShiftData)
	Copies image data from the subimage `fromImage` into the overlapping region of this subimage.

MLEXPORT void	copySubImage (const SubImage &fromImage)
	Implements special case for void copySubImage(const TSubImage<FROM_DATATYPE> &typedFromImg, const ScaleShiftData& scaleShiftData) where scaleShiftData is default.

bool	isValidSubImagePosition (const ImageVector &voxelPosition) const
	Returns `true` if 6d `voxelPosition` is a valid position within subimage region, i.e., if `voxelPosition` is within (0,0,0,0,0,0) and subimage extents.

bool	isValidSubImagePosition (MLint x, MLint y, MLint z) const
	Returns `true` if 3d position p=(`x`, `y`, `z`) is a valid position within subimage region, i.e., if the position is within (0,0,0) and subimage extents.

bool	isValidImagePosition (const ImageVector &voxelPosition) const
	Returns `true` if 6d `voxelPosition` is a valid position within subimage region, i.e., if `voxelPosition` is within subImgBox.v1 and subImgBox.v2.

bool	isValidImagePosition (MLint x, MLint y, MLint z) const
	Returns `true` if 3d position p=(`x`, `y`, `z`) is a valid position within subimage region, i.e., if the position is within subImgBox.v1 and subImgBox.v2.

MLEXPORT void	allocate (MLMemoryErrorHandling handleFailure)
	Allocate data with MLAlloc().

MLEXPORT void	allocateAsMemoryBlockHandle (MLMemoryErrorHandling handleFailure=ML_RETURN_NULL)
	Allocate data using the ML memory manager. For failure handing, see SubImage::allocate().

MLEXPORT void	free ()
	Frees data pointed to by getData() with MLFree().

MLEXPORT bool	isOneValued () const
	Returns `true` if all page voxels have the same value or if the page contains only 1 voxel.

MLEXPORT MLint	calculateMinMax (MLdouble &minValue, MLdouble &maxValue, const SubImageBox *const validBox=nullptr) const
	Scans subimage and determines minimum and maximum values on region which is part of subimage box and of validBox.

MLEXPORT void	compare (const SubImage &subImage2, bool regionsMatch, bool dataTypesMatch, bool thisBoxIsPartOfRegion2, bool region2IsPartOfThisBox, bool overlapHasSameValues, ImageVector firstMismatchPos) const
	Compare two subimages with respect to their regions and their contents.

MLEXPORT void	fill (MLdouble value)
	Fills the subimage with a `value` cast to the data type of the subimage.

MLEXPORT void	fillWithTypeData (const MLTypeData *value)
	Fills the subimage with a `value` given as MLTypeData.

MLEXPORT void	fillBordersWithScalarValue (const SubImageBox &box, MLdouble fillValue)
	Fill all regions with the fill value fillValue which are not covered by box.

MLEXPORT void	fillBordersWithTypeData (const SubImageBox &box, const MLTypeData *fillValue)
	Fills all regions with the fill value `fillValue` which are not covered by `box`.

MLEXPORT void	fillBordersWithInputValues (const SubImageBox &box, const SubImage &inputSubImage)
	Fills all regions with values from `inputSubImage` which are not covered by `box`, however, only valid regions of `inputSubImage` are read.

MLEXPORT void	fillBordersWithBorderValues (const SubImageBox &box)
	Each voxel of which is not inside `box` is filled with the nearest voxel which is inside `box`.

void	fillInvalidRegionWithScalarValue (MLdouble value)
	Fills the invalid region (everything outside of getValidRegion()) with the given `value`.

void	fillInvalidRegionWithTypeData (const MLTypeData *value)
	Fills the invalid region (everything outside of getValidRegion()) with the given `value`.

void	fillInvalidRegionWithBorderValues ()
	Fills the invalid region (everything outside of getValidRegion()) with the values on the borders of the valid region.

MLEXPORT bool	isValid () const
	Returns 1(=true) if image region and data is valid.

void *	getData () const
	Returns the memory address of the memory managed by the subimage.

MLEXPORT void	setData (void *data)
	Sets `data` as a new memory block for the subimage.

MLEXPORT void	setDataFromMemoryBlockHandle (const MLMemoryBlockHandle &data)
	Sets the managed `data` from a given MLMemoryBlockHandle, the sub image will store this handle and thus reference count the memory managed by the handle as long as the SubImage stays alive.

const MLMemoryBlockHandle &	getMemoryBlockHandle () const
	Returns the memory block handle that manages the data of this SubImage if it has been set via setDataFromMemoryBlockHandle().

Additional Inherited Members
Public Types inherited from ml::TSubImage< DATATYPE >
typedef DATATYPE	ComponentType
	A typedef to "export" the type of voxels components.

typedef TSubImageCursor< DATATYPE >	Cursor
	A read/write cursor.

typedef ConstTSubImageCursor< DATATYPE >	ConstCursor
	A read-only cursor.

Static Public Member Functions inherited from ml::SubImage
static MLEXPORT MLint	coordToIndex (MLint x, MLint y, MLint z, MLint c, MLint t, MLint u, const ImageVector &size)
	Converts the coordinate (`x`, `y`, `z`, `c`, `t`,`u`) to an index into an image with 6D extents given by `size`.

static MLEXPORT MLint	coordToIndex (const ImageVector &voxelPosition, const ImageVector &size)
	Converts the coordinate `voxelPosition` into the image with extents `size` to an index.

static MLEXPORT ImageVector	indexToCoord (MLint index, const ImageVector &extent)
	Converts an `index` into an array with extents `extent` to a coordinate.

Protected Member Functions inherited from ml::SubImage
void	_calcFillAreaParams (const SubImageBox &box, const SubImageBox &maxValidInputRegion, ImageVector &boxV1, ImageVector &boxV2, ImageVector &outputTSubImageV1, ImageVector &outputTSubImageV2, MLint &fullLineLenX, MLint &fullLineLenXB, MLint &leftLineStartX, MLint &leftLineLenX, MLint &leftLineLenXB, MLint &rightLineStartX, MLint &rightLineLenX, MLint &rightLineLenXB)
	Helper method to calculate important parameters for page based border filling.

void	_copySubImageGeneric (const SubImage &fromImage, const ScaleShiftData &scaleShiftData)
	Generic, non-optimized version of copySubImage.

const MLTypeInfos *	_getDataTypeInfos (MLDataType dt) const
	Get MLTypeInfos for used data types, indicates error if type is not registered.

Protected Attributes inherited from ml::SubImage
SubImageBox	_box
	The box of the subimage.

ImageVector	_sourceImageExtent
	The extent of the source image, which is used for getValidRegion()

void *	_data
	Memory chunk managed by this subimage.

MLMemoryBlockHandle	_memoryBlock
	Memory block used by this subimage.

ImageVector	_stride
	Stride vector to address the memory efficiently.

MLDataType	_dataType
	Datatype of the image.

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

Constructor & Destructor Documentation

◆ TSubImageWithCursor() [1/4]

template<typename DATATYPE >

ml::TSubImageWithCursor< DATATYPE >::TSubImageWithCursor ( )

inline

Default constructor.

Definition at line 996 of file mlTSubImage.h.

◆ TSubImageWithCursor() [2/4]

template<typename DATATYPE >

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

inline

Constructor with TSubImage.

Definition at line 1000 of file mlTSubImage.h.

◆ TSubImageWithCursor() [3/4]

template<typename DATATYPE >

ml::TSubImageWithCursor< DATATYPE >::TSubImageWithCursor ( const SubImage & subImage )

inline

Constructor with SubImage.

Definition at line 1005 of file mlTSubImage.h.

◆ TSubImageWithCursor() [4/4]

template<typename DATATYPE >

ml::TSubImageWithCursor< DATATYPE >::TSubImageWithCursor ( const TSubImageWithCursor< DATATYPE > & subImage )

inline

Constructor with TSubImageWithCursor.

Definition at line 1010 of file mlTSubImage.h.

Member Function Documentation

◆ getCursorPointer()

template<typename DATATYPE >

DATATYPE * ml::TSubImageWithCursor< DATATYPE >::getCursorPointer ( ) const

inline

Definition at line 1094 of file mlTSubImage.h.

◆ getCursorPointerWithOffset() [1/2]

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

◆ getCursorPointerWithOffset() [2/2]

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

References mlrange_cast().

◆ getCursorValue()

template<typename DATATYPE >

DATATYPE ml::TSubImageWithCursor< DATATYPE >::getCursorValue ( ) const

inline

Returns the voxel value at the cursor position.

Definition at line 1081 of file mlTSubImage.h.

◆ getCursorValueWithOffset() [1/2]

template<typename DATATYPE >

DATATYPE ml::TSubImageWithCursor< DATATYPE >::getCursorValueWithOffset ( const ImageVector & offset ) const

inline

Returns the voxel value at (cursor position + offset)

Definition at line 1083 of file mlTSubImage.h.

◆ getCursorValueWithOffset() [2/2]

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

References mlrange_cast().

◆ moveCursorByOffset() [1/2]

template<typename DATATYPE >

void ml::TSubImageWithCursor< DATATYPE >::moveCursorByOffset ( const ImageVector & offset )

inline

Moves cursor to cursor position + offset.

Definition at line 1042 of file mlTSubImage.h.

◆ moveCursorByOffset() [2/2]

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

◆ moveCursorC()

template<typename DATATYPE >

void ml::TSubImageWithCursor< DATATYPE >::moveCursorC ( )

inline

Moves cursor forward in c direction.

Definition at line 1052 of file mlTSubImage.h.

◆ moveCursorT()

template<typename DATATYPE >

void ml::TSubImageWithCursor< DATATYPE >::moveCursorT ( )

inline

Moves cursor forward in t direction.

Definition at line 1054 of file mlTSubImage.h.

◆ moveCursorU()

template<typename DATATYPE >

void ml::TSubImageWithCursor< DATATYPE >::moveCursorU ( )

inline

Moves cursor forward in u direction.

Definition at line 1056 of file mlTSubImage.h.

◆ moveCursorX()

template<typename DATATYPE >

void ml::TSubImageWithCursor< DATATYPE >::moveCursorX ( )

inline

Moves cursor forward in x direction.

Definition at line 1046 of file mlTSubImage.h.

◆ moveCursorY()

template<typename DATATYPE >

void ml::TSubImageWithCursor< DATATYPE >::moveCursorY ( )

inline

Moves cursor forward in y direction.

Definition at line 1048 of file mlTSubImage.h.

◆ moveCursorZ()

template<typename DATATYPE >

void ml::TSubImageWithCursor< DATATYPE >::moveCursorZ ( )

inline

Moves cursor forward in z direction.

Definition at line 1050 of file mlTSubImage.h.

◆ operator=()

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

References mlrange_cast().

◆ reverseMoveCursorC()

template<typename DATATYPE >

void ml::TSubImageWithCursor< DATATYPE >::reverseMoveCursorC ( )

inline

Moves cursor backward in c direction.

Definition at line 1064 of file mlTSubImage.h.

◆ reverseMoveCursorT()

template<typename DATATYPE >

void ml::TSubImageWithCursor< DATATYPE >::reverseMoveCursorT ( )

inline

Moves cursor backward in t direction.

Definition at line 1066 of file mlTSubImage.h.

◆ reverseMoveCursorU()

template<typename DATATYPE >

void ml::TSubImageWithCursor< DATATYPE >::reverseMoveCursorU ( )

inline

Moves cursor backward in u direction.

Definition at line 1068 of file mlTSubImage.h.

◆ reverseMoveCursorX()

template<typename DATATYPE >

void ml::TSubImageWithCursor< DATATYPE >::reverseMoveCursorX ( )

inline

Moves cursor backward in x direction.

Definition at line 1058 of file mlTSubImage.h.

◆ reverseMoveCursorY()

template<typename DATATYPE >

void ml::TSubImageWithCursor< DATATYPE >::reverseMoveCursorY ( )

inline

Moves cursor backward in y direction.

Definition at line 1060 of file mlTSubImage.h.

◆ reverseMoveCursorZ()

template<typename DATATYPE >

void ml::TSubImageWithCursor< DATATYPE >::reverseMoveCursorZ ( )

inline

Moves cursor backward in z direction.

Definition at line 1062 of file mlTSubImage.h.

◆ setCursorImagePosition() [1/2]

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

References _ML_TSUBIMG_SUBDOT6, and mlrange_cast().

Referenced by ml::MLKernelToolsApplyFiltering().

◆ setCursorImagePosition() [2/2]

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

References _ML_TSUBIMG_SUBDOT3, and mlrange_cast().

◆ setCursorPosition()

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

References mlrange_cast().

◆ setCursorSubImagePosition() [1/2]

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

References mlrange_cast().

◆ setCursorSubImagePosition() [2/2]

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

References mlrange_cast().

◆ setCursorValue()

template<typename DATATYPE >

void ml::TSubImageWithCursor< DATATYPE >::setCursorValue ( DATATYPE value )

inline

Sets the voxel value at cursor position to value.

Definition at line 1110 of file mlTSubImage.h.

◆ setCursorValueWithOffset() [1/2]

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

◆ setCursorValueWithOffset() [2/2]

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

References mlrange_cast().

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TSubImageWithCursor() [1/4]

◆ TSubImageWithCursor() [2/4]

◆ TSubImageWithCursor() [3/4]

◆ TSubImageWithCursor() [4/4]

Member Function Documentation

◆ getCursorPointer()

◆ getCursorPointerWithOffset() [1/2]

◆ getCursorPointerWithOffset() [2/2]

◆ getCursorValue()

◆ getCursorValueWithOffset() [1/2]

◆ getCursorValueWithOffset() [2/2]

◆ moveCursorByOffset() [1/2]

◆ moveCursorByOffset() [2/2]

◆ moveCursorC()

◆ moveCursorT()

◆ moveCursorU()

◆ moveCursorX()

◆ moveCursorY()

◆ moveCursorZ()

◆ operator=()

◆ reverseMoveCursorC()

◆ reverseMoveCursorT()

◆ reverseMoveCursorU()

◆ reverseMoveCursorX()

◆ reverseMoveCursorY()

◆ reverseMoveCursorZ()

◆ setCursorImagePosition() [1/2]

◆ setCursorImagePosition() [2/2]

◆ setCursorPosition()

◆ setCursorSubImagePosition() [1/2]

◆ setCursorSubImagePosition() [2/2]

◆ setCursorValue()

◆ setCursorValueWithOffset() [1/2]

◆ setCursorValueWithOffset() [2/2]