MeVisLab Toolbox Reference
ml::MultiFileVolumeListImageOutput::OutputImageProperties Struct Reference

Helper container to manage fields related to an image output. More...

#include <mlMultiFileVolumeListImageOutput.h>

Public Member Functions

void addFields (Module &mod, const std::string suffix="")
void readAndSetFromPagedImage (const PagedImage *pagedImage)
 Reads field contents from pagedImage if that one is not nullptr, otherwise the field values are reset to 0 or empty strings.

Public Attributes

IntField * extFld [6] = {nullptr, nullptr, nullptr, nullptr, nullptr, nullptr}
 Image extent of the currently selected volume, defaults are 0.
IntField * numVolVoxelsFld = nullptr
 Shows the number of voxels of the current volume, default is 0.
StringField * dataTypeFld = nullptr
 String field containing the voxel data type of the currently selected volume, default is "".
DoubleField * minVoxelValueFld = nullptr
 This read-only field shows the minimum voxel value in the currently selected volume, default is 0.
DoubleField * maxVoxelValueFld = nullptr
 This read-only field shows the maximum voxel value in the currently selected volume, default is 0.

Detailed Description

Helper container to manage fields related to an image output.

Definition at line 82 of file mlMultiFileVolumeListImageOutput.h.

Member Function Documentation

◆ addFields()

void ml::MultiFileVolumeListImageOutput::OutputImageProperties::addFields ( Module & mod,
const std::string suffix = "" )
inline

Create fields and add their pointers for field container of mod; suffix is appended to all field names to simplify usage for further image outputs.

Definition at line 100 of file mlMultiFileVolumeListImageOutput.h.

References ml::FieldContainer::addDouble(), ml::FieldContainer::addInt(), ml::FieldContainer::addString(), dataTypeFld, extFld, maxVoxelValueFld, minVoxelValueFld, and numVolVoxelsFld.

◆ readAndSetFromPagedImage()

void ml::MultiFileVolumeListImageOutput::OutputImageProperties::readAndSetFromPagedImage ( const PagedImage * pagedImage)
inline

Reads field contents from pagedImage if that one is not nullptr, otherwise the field values are reset to 0 or empty strings.

Definition at line 114 of file mlMultiFileVolumeListImageOutput.h.

References ml::TVector6DBase< CompIntType >::c, ml::TVector< TVectorBase >::compMul(), dataTypeFld, extFld, ml::ImageProperties::getDataType(), ml::ImageProperties::getImageExtent(), ml::ImageProperties::getMaxVoxelValue(), ml::ImageProperties::getMinVoxelValue(), maxVoxelValueFld, minVoxelValueFld, MLDataTypeNames(), numVolVoxelsFld, ml::TVector6DBase< CompIntType >::t, ml::TVector6DBase< CompIntType >::u, ml::TVector6DBase< CompIntType >::x, ml::TVector6DBase< CompIntType >::y, and ml::TVector6DBase< CompIntType >::z.

Member Data Documentation

◆ dataTypeFld

StringField* ml::MultiFileVolumeListImageOutput::OutputImageProperties::dataTypeFld = nullptr

String field containing the voxel data type of the currently selected volume, default is "".

Definition at line 90 of file mlMultiFileVolumeListImageOutput.h.

Referenced by addFields(), and readAndSetFromPagedImage().

◆ extFld

IntField* ml::MultiFileVolumeListImageOutput::OutputImageProperties::extFld[6] = {nullptr, nullptr, nullptr, nullptr, nullptr, nullptr}

Image extent of the currently selected volume, defaults are 0.

Definition at line 84 of file mlMultiFileVolumeListImageOutput.h.

Referenced by addFields(), and readAndSetFromPagedImage().

◆ maxVoxelValueFld

DoubleField* ml::MultiFileVolumeListImageOutput::OutputImageProperties::maxVoxelValueFld = nullptr

This read-only field shows the maximum voxel value in the currently selected volume, default is 0.

Definition at line 96 of file mlMultiFileVolumeListImageOutput.h.

Referenced by addFields(), and readAndSetFromPagedImage().

◆ minVoxelValueFld

DoubleField* ml::MultiFileVolumeListImageOutput::OutputImageProperties::minVoxelValueFld = nullptr

This read-only field shows the minimum voxel value in the currently selected volume, default is 0.

Definition at line 93 of file mlMultiFileVolumeListImageOutput.h.

Referenced by addFields(), and readAndSetFromPagedImage().

◆ numVolVoxelsFld

IntField* ml::MultiFileVolumeListImageOutput::OutputImageProperties::numVolVoxelsFld = nullptr

Shows the number of voxels of the current volume, default is 0.

Definition at line 87 of file mlMultiFileVolumeListImageOutput.h.

Referenced by addFields(), and readAndSetFromPagedImage().

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