MeVisLab Toolbox Reference
List of all members
ml::ImageProperties Class Reference
Image Processing

This class represents basic image properties: More...

#include <mlImageProperties.h>

Inheritance diagram for ml::ImageProperties:
ml::MedicalImageProperties ml::PagedImage ml::PagedImageProperties

Public Member Functions

Constructing, copying, and initializing of ImageProperties
MLEXPORT ImageProperties ()
 Constructor.
 
virtual MLEXPORT ~ImageProperties ()
 Virtual destructor to suppress compiler warnings.
 
MLEXPORT ImageProperties (ImageVector extent, MLDataType dataType, MLdouble minValue, MLdouble maxValue)
 Constructor to set extent to extent, data type to dataType, minimum value to minValue, and maximum value to maxValue.
 
MLEXPORT ImageProperties (const ImageProperties &imageProperties)
 Copy constructor from an existing imageProperties object to get an identical copy.
 
MLEXPORT ImageProperties & operator= (const ImageProperties &imageProperties)
 Assignment operator from an existing imageProperties object to get an identical copy.
 
MLEXPORT void setImageProperties (const ImageProperties &imageProperties)
 Copies property parameters from another image property instance imageProperties.
 
Comparison.
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.
 
Set/Get image size/extents etc.
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
 Returns the number of voxels in (sub)image.
 
MLint getSizeInBytes () const
 Returns the number of potential bytes in (sub)image.
 
Set/Get data type.
virtual MLEXPORT void setDataType (MLDataType dataType)
 Sets type of data to dataType.
 
MLDataType getDataType () const
 Returns the data type of the image.
 
Set minimum and maximum data value.
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.
 

Detailed Description

This class represents basic image properties:

The following image properties are available in this class:

  • Image extent,
  • Data type,
  • Minimum and maximum voxel value in the image Note that the class itself is not exported to make inline possible. Code that is not inlined is exported explicitly.

Definition at line 42 of file mlImageProperties.h.

Constructor & Destructor Documentation

◆ ImageProperties() [1/3]

MLEXPORT ml::ImageProperties::ImageProperties ( )

Constructor.

Sets data type to MLuint8, extents to (0,...,0), minimum voxel value to 0, maximum voxel value to 0.

◆ ~ImageProperties()

virtual MLEXPORT ml::ImageProperties::~ImageProperties ( )
virtual

Virtual destructor to suppress compiler warnings.

◆ ImageProperties() [2/3]

MLEXPORT ml::ImageProperties::ImageProperties ( ImageVector  extent,
MLDataType  dataType,
MLdouble  minValue,
MLdouble  maxValue 
)

Constructor to set extent to extent, data type to dataType, minimum value to minValue, and maximum value to maxValue.

◆ ImageProperties() [3/3]

MLEXPORT ml::ImageProperties::ImageProperties ( const ImageProperties &  imageProperties)

Copy constructor from an existing imageProperties object to get an identical copy.

Member Function Documentation

◆ getBoxFromImageExtent()

SubImageBox ml::ImageProperties::getBoxFromImageExtent ( ) const
inline

Returns the size of image as box with origin 0.

Definition at line 98 of file mlImageProperties.h.

Referenced by ml::PCLMLTools::createPointCloudFromPagedImage(), and ml::determineImageFilterInRegionTN().

◆ getDataType()

MLDataType ml::ImageProperties::getDataType ( ) const
inline

Returns the data type of the image.

Definition at line 122 of file mlImageProperties.h.

Referenced by ml::PCLMLTools::createPointCloudFromPagedImage(), ml::ITKFiniteDifferenceFunctionWrapper::isFiniteDifferenceFunctionValid(), and ml::MultiFileVolumeListImageOutput::OutputImageProperties::readAndSetFromPagedImage().

◆ getImageExtent()

ImageVector ml::ImageProperties::getImageExtent ( ) const
inline

Returns the extent of the (sub)image.

Definition at line 95 of file mlImageProperties.h.

Referenced by ml::ClusterHandler< CLUSTERVOXELTYPE, DerivedAlgorithm >::calculateOutputImageProperties(), ml::determineImageFilterOutImageRegionTN(), ml::getInputAsItkImportImageAndSubImg(), ml::ITKFiniteDifferenceFunctionWrapper::isFiniteDifferenceFunctionValid(), and ml::MultiFileVolumeListImageOutput::OutputImageProperties::readAndSetFromPagedImage().

◆ getMaxVoxelValue()

MLdouble ml::ImageProperties::getMaxVoxelValue ( ) const
inline

Returns the assumed maximum value in data.

Definition at line 136 of file mlImageProperties.h.

Referenced by ml::MultiFileVolumeListImageOutput::OutputImageProperties::readAndSetFromPagedImage().

◆ getMinVoxelValue()

MLdouble ml::ImageProperties::getMinVoxelValue ( ) const
inline

Returns the assumed minimum value in data.

Definition at line 132 of file mlImageProperties.h.

Referenced by ml::MultiFileVolumeListImageOutput::OutputImageProperties::readAndSetFromPagedImage().

◆ getNumVoxels()

MLint ml::ImageProperties::getNumVoxels ( ) const
inline

Returns the number of voxels in (sub)image.

Note that it could become larger than 2^32 even on 32-bit systems. It will never be less than 0; the signed return type is used for safer signed arithmetics.

Definition at line 107 of file mlImageProperties.h.

◆ getSizeInBytes()

MLint ml::ImageProperties::getSizeInBytes ( ) const
inline

Returns the number of potential bytes in (sub)image.

Note that it could become larger than 2^32 even on 32-bit systems. It will never be less than 0; the signed return type is used for safer signed arithmetics.

Definition at line 111 of file mlImageProperties.h.

References MLSizeOf().

◆ hasValidExtent()

bool ml::ImageProperties::hasValidExtent ( ) const
inline

Returns whether the image has a valid extent (which means that all components are greater than 0).

Definition at line 101 of file mlImageProperties.h.

◆ operator!=()

MLEXPORT bool ml::ImageProperties::operator!= ( const ImageProperties &  imageProperties) const

Returns true if *this and imageProperties differ; otherwise, it returns false.

◆ operator=()

MLEXPORT ImageProperties & ml::ImageProperties::operator= ( const ImageProperties &  imageProperties)

Assignment operator from an existing imageProperties object to get an identical copy.

◆ operator==()

MLEXPORT bool ml::ImageProperties::operator== ( const ImageProperties &  imageProperties) const

Returns true if *this and imageProperties are identical; otherwise, it returns false.

◆ setDataType()

virtual MLEXPORT void ml::ImageProperties::setDataType ( MLDataType  dataType)
virtual

Sets type of data to dataType.

Reimplemented in ml::PagedImage.

◆ setImageExtent()

MLEXPORT void ml::ImageProperties::setImageExtent ( const ImageVector &  extent)
inline

Sets the extent of the (sub)image.

Definition at line 92 of file mlImageProperties.h.

Referenced by ml::PagedImage::setImageExtent().

◆ setImageProperties()

MLEXPORT void ml::ImageProperties::setImageProperties ( const ImageProperties &  imageProperties)

Copies property parameters from another image property instance imageProperties.

◆ setMaxVoxelValue()

void ml::ImageProperties::setMaxVoxelValue ( MLdouble  maxval)
inline

Sets assumed maximum value to maxval.

Definition at line 134 of file mlImageProperties.h.

◆ setMinVoxelValue()

void ml::ImageProperties::setMinVoxelValue ( MLdouble  minval)
inline

Sets assumed minimum value to minval.

Definition at line 130 of file mlImageProperties.h.

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