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 () | |
| Constructor. | |
| ~MedicalImageProperties () override | |
| Destructor. Cleans up dynamically allocated memory. | |
| MedicalImageProperties (const MedicalImageProperties &medicalImageProperties) | |
Copy constructor from an existing medicalImageProperties object to get a copy. | |
| MedicalImageProperties & | operator= (const MedicalImageProperties &medicalImageProperties) |
Assignment operator from an existing edicalImageProperties object to get a copy. | |
| void | setImageProperties (const MedicalImageProperties &medicalImageProperties) |
Sets a copy of the passed image properties 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 |
| Returns the volume of a single voxel in cubic millimeters (mm^3). | |
| double | getVoxelVolumeInMilliliters () const |
| Returns the volume of a single voxel in milliliters (ml). | |
| bool | isVoxelToWorldMatrixValid () const |
| Shows the validity state of the VoxelToWorldMatrix (default=true=valid). | |
| void | setVoxelToWorldMatrixValid (bool valid) |
Validates/Invalidates the voxelToWorld matrix by passing true/false as 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) |
Scales the voxelToWorld matrix by the vector scaleFactors and updates the image's voxel size. | |
| void | translateVoxelToWorldMatrix (const Vector3 &offsetVector) |
Translates the voxelToWorld matrix by the offsetVector. | |
| std::vector< std::string > & | getCDimensionInfos () |
| Permits access to the additional information for subimages on the c-, t-, and u-dimensions. | |
| 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 () |
| 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. | |
| 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 |
| Returns the number of voxels in (sub)image. | |
| MLint | getSizeInBytes () const |
| Returns the number of potential bytes in (sub)image. | |
| 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]
|
inline |
Definition at line 28 of file mlModuleBackgroundTask.h.
◆ PagedImageProperties() [2/2]
|
inline |
Definition at line 29 of file mlModuleBackgroundTask.h.
References ml::ImagePropertyExtensionContainer::clear(), and ml::MedicalImageProperties::getImagePropertyContainer().
Member Function Documentation
◆ getPageExtent()
|
inline |
Returns the page extent.
Definition at line 38 of file mlModuleBackgroundTask.h.
Member Data Documentation
◆ _pageExtent
|
protected |
Definition at line 41 of file mlModuleBackgroundTask.h.
The documentation for this class was generated from the following file:
- MeVis/Foundation/Sources/MLBackgroundTasks/mlModuleBackgroundTask.h
