ml::PagedImageProperties Class Reference

PagedImageProperties extends the MedicalImageProperties with the page extent. More...

#include <mlModuleBackgroundTask.h>

Inheritance diagram for ml::PagedImageProperties:

Public Member Functions
	PagedImageProperties ()
	PagedImageProperties (const PagedImage &pagedImage)
const ImageVector &	getPageExtent () const
	Returns the page extent.
Public Member Functions inherited from ml::MedicalImageProperties
	MedicalImageProperties ()
	~MedicalImageProperties () override
	Destructor. Cleans up dynamically allocated memory.
	MedicalImageProperties (const MedicalImageProperties &medicalImageProperties)
MedicalImageProperties &	operator= (const MedicalImageProperties &medicalImageProperties)
void	setImageProperties (const MedicalImageProperties &medicalImageProperties)
bool	operator== (const MedicalImageProperties &medicalImageProperties) const
	Returns true if *this and medicalImageProperties are identical; otherwise, it returns false.
bool	operator!= (const MedicalImageProperties &medicalImageProperties) const
	Returns true if *this and medicalImageProperties differ; otherwise, it returns false.
void	setVoxelSize (MLdouble dx, MLdouble dy, MLdouble dz)
	Sets the voxel size to dx, dy, and dz. This changes the voxelToWorld matrix.
void	setVoxelSize (const Vector3 &voxelSize)
	Sets the voxel size to voxelSize. The transformation matrix is adapted adequately.
Vector3	getVoxelSize () const
	Returns the voxel size.
double	getVoxelVolumeInCubicMillimeters () const
double	getVoxelVolumeInMilliliters () const
bool	isVoxelToWorldMatrixValid () const
void	setVoxelToWorldMatrixValid (bool valid)
const Matrix4 &	getVoxelToWorldMatrix () const
	Returns the voxelToWorld matrix.
void	setVoxelToWorldMatrix (const Matrix4 &matrix)
	Sets the matrix that transforms voxel to world coordinates to matrix.
const Matrix4 &	getWorldToVoxelMatrix () const
	Returns the worlToVoxel matrix.
Vector3	mapVoxelToWorld (const Vector3 &voxelPosition) const
	Maps the voxelPosition vector to world coordinates and returns it.
Vector3	mapWorldToVoxel (const Vector3 &worldPosition) const
	Maps the worldPosition vector to voxel coordinates and returns it.
void	scaleVoxelToWorldMatrix (const Vector3 &scaleFactors)
void	translateVoxelToWorldMatrix (const Vector3 &offsetVector)
	Translates the voxelToWorld matrix by the offsetVector.
std::vector< std::string > &	getCDimensionInfos ()
std::vector< DateTime > &	getTDimensionInfos ()
std::vector< std::string > &	getUDimensionInfos ()
const std::vector< std::string > &	getCDimensionInfos () const
const std::vector< DateTime > &	getTDimensionInfos () const
const std::vector< std::string > &	getUDimensionInfos () const
ImagePropertyExtensionContainer &	getImagePropertyContainer ()
	Permits access to the container for user image properties.
const ImagePropertyExtensionContainer &	getConstImagePropertyContainer () const
Public Member Functions inherited from ml::ImageProperties
MLEXPORT	ImageProperties ()
virtual MLEXPORT	~ImageProperties ()
	Virtual destructor to suppress compiler warnings.
MLEXPORT	ImageProperties (ImageVector extent, MLDataType dataType, MLdouble minValue, MLdouble maxValue)
MLEXPORT	ImageProperties (const ImageProperties &imageProperties)
MLEXPORT ImageProperties &	operator= (const ImageProperties &imageProperties)
MLEXPORT void	setImageProperties (const ImageProperties &imageProperties)
	Copies property parameters from another image property instance imageProperties.
MLEXPORT bool	operator== (const ImageProperties &imageProperties) const
	Returns true if *this and imageProperties are identical; otherwise, it returns false.
MLEXPORT bool	operator!= (const ImageProperties &imageProperties) const
	Returns true if *this and imageProperties differ; otherwise, it returns false.
MLEXPORT void	setImageExtent (const ImageVector &extent)
	Sets the extent of the (sub)image.
ImageVector	getImageExtent () const
	Returns the extent of the (sub)image.
SubImageBox	getBoxFromImageExtent () const
	Returns the size of image as box with origin 0.
bool	hasValidExtent () const
	Returns whether the image has a valid extent (which means that all components are greater than 0).
MLint	getNumVoxels () const
MLint	getSizeInBytes () const
virtual MLEXPORT void	setDataType (MLDataType dataType)
	Sets type of data to dataType.
MLDataType	getDataType () const
	Returns the data type of the image.
void	setMinVoxelValue (MLdouble minval)
	Sets assumed minimum value to minval.
MLdouble	getMinVoxelValue () const
	Returns the assumed minimum value in data.
void	setMaxVoxelValue (MLdouble maxval)
	Sets assumed maximum value to maxval.
MLdouble	getMaxVoxelValue () const
	Returns the assumed maximum value in data.

Protected Attributes
ImageVector	_pageExtent

Detailed Description

PagedImageProperties extends the MedicalImageProperties with the page extent.

Definition at line 26 of file mlModuleBackgroundTask.h.

Constructor & Destructor Documentation

PagedImageProperties() [1/2]

ml::PagedImageProperties::PagedImageProperties ( )

inline

Definition at line 28 of file mlModuleBackgroundTask.h.

PagedImageProperties() [2/2]

ml::PagedImageProperties::PagedImageProperties ( const PagedImage & pagedImage )

inline

Definition at line 29 of file mlModuleBackgroundTask.h.

References _pageExtent, ml::ImagePropertyExtensionContainer::clear(), ml::MedicalImageProperties::getImagePropertyContainer(), getPageExtent(), and ml::MedicalImageProperties::MedicalImageProperties().

Member Function Documentation

getPageExtent()

const ImageVector & ml::PagedImageProperties::getPageExtent ( ) const

inline

Returns the page extent.

Definition at line 38 of file mlModuleBackgroundTask.h.

References _pageExtent.

Referenced by PagedImageProperties().

Member Data Documentation

_pageExtent

ImageVector ml::PagedImageProperties::_pageExtent

protected

Definition at line 41 of file mlModuleBackgroundTask.h.

Referenced by getPageExtent(), and PagedImageProperties().

---

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

• MeVis/Foundation/Sources/MLBackgroundTasks/mlModuleBackgroundTask.h