MeVisLab Toolbox Reference
Public Member Functions | Public Attributes | List of all members
ml::DICOMTagTools::DicomPaletteInfo Struct Reference

DICOM palette container which is to be used for ML index image to RGB image voxel translation. More...

#include <mlDICOMTagPaletteTools.h>

Public Member Functions

 DicomPaletteInfo ()
 Default constructor.
 
 ~DicomPaletteInfo ()
 Default destructor.
 
 DicomPaletteInfo (const DicomPaletteInfo &inputInfo)
 Copy constructor.
 
DicomPaletteInfo & operator= (const DicomPaletteInfo &inputInfo)
 Assignment operator.
 
bool operator== (const DicomPaletteInfo &inputInfo) const
 Comparison operator, equals on content equality (arrays can have different pointers but need to have same content in valid areas).
 
bool operator!= (const DicomPaletteInfo &inputInfo) const
 Comparison operator, returns false on content inequality (different array pointers are not handled as difference if they have same content in valid areas).
 
bool isValid () const
 Returns true if the palette looks valid, otherwise false.
 
void reset ()
 Makes contents invalid, reset to default construction state.
 

Public Attributes

MLDataType dataType = ML_INVALID_DATA_TYPE
 MLDataType of color table entries, MLuint8Type or MLuint16Type or ML_INVALID_DATA_TYPE if not defined.
 
MLint32 minVal = 0
 Minimum voxel value to map to a color, all smaller voxel values shall be clamped to it, or in case of a supplemental LUT, shall be mapped as normal grayscale image.
 
MLint32 maxVal = 0
 Maximum voxel value to map to a color, all larger voxel values shall be clamped to it.

 
MLuint32 numEntries = 0
 Number of valid table entries in rgbLUT, at most 65536.
 
bool usesAlpha = false
 True if alpha channel is valid, otherwise false.
 
bool isSupplementalPaletteLUT = false
 If true then the rgbaFloatLUT is used and has a meaning according to a Supplemental LUT according to DICOM standard, otherwise rgbaLUT is used.
 
MLuint16 * rgbaLUT = nullptr
 Table of RGB[A] values as MLuint16 values if isSupplementalPaletteLUT is false, otherwise undefined.
 
MLfloat * rgbaFloatLUT = nullptr
 Table of RGB[A] values as MLfloat values if isSupplementalPaletteLUT is true, otherwise undefined.
 
MLuint16 minLUTEntry = ML_UINT16_MAX
 Minimum value found in all entries of LUT in any of the R, G, or B channels (but not Alpha even if it is valid); only valid if <= maxLUTEntry.
 
MLuint16 maxLUTEntry = ML_UINT16_MIN
 Maximum value found in all entries of LUT in any of the R, G, or B channels (but not Alpha even if it is valid); only valid if >= minLUTEntry.
 

Detailed Description

DICOM palette container which is to be used for ML index image to RGB image voxel translation.

Definition at line 35 of file mlDICOMTagPaletteTools.h.

Constructor & Destructor Documentation

◆ DicomPaletteInfo() [1/2]

ml::DICOMTagTools::DicomPaletteInfo::DicomPaletteInfo ( )
inline

Default constructor.

Definition at line 37 of file mlDICOMTagPaletteTools.h.

◆ ~DicomPaletteInfo()

ml::DICOMTagTools::DicomPaletteInfo::~DicomPaletteInfo ( )
inline

Default destructor.

Definition at line 43 of file mlDICOMTagPaletteTools.h.

◆ DicomPaletteInfo() [2/2]

ml::DICOMTagTools::DicomPaletteInfo::DicomPaletteInfo ( const DicomPaletteInfo &  inputInfo)
inline

Copy constructor.

Definition at line 49 of file mlDICOMTagPaletteTools.h.

Member Function Documentation

◆ isValid()

bool ml::DICOMTagTools::DicomPaletteInfo::isValid ( ) const
inline

Returns true if the palette looks valid, otherwise false.

Definition at line 101 of file mlDICOMTagPaletteTools.h.

References MLfloatType, MLuint16Type, and MLuint8Type.

◆ operator!=()

bool ml::DICOMTagTools::DicomPaletteInfo::operator!= ( const DicomPaletteInfo &  inputInfo) const
inline

Comparison operator, returns false on content inequality (different array pointers are not handled as difference if they have same content in valid areas).

Definition at line 95 of file mlDICOMTagPaletteTools.h.

References ml::operator==().

◆ operator=()

DicomPaletteInfo & ml::DICOMTagTools::DicomPaletteInfo::operator= ( const DicomPaletteInfo &  inputInfo)
inline

Assignment operator.

Definition at line 56 of file mlDICOMTagPaletteTools.h.

References dataType, isSupplementalPaletteLUT, maxLUTEntry, maxVal, minLUTEntry, minVal, numEntries, rgbaFloatLUT, rgbaLUT, and usesAlpha.

◆ operator==()

bool ml::DICOMTagTools::DicomPaletteInfo::operator== ( const DicomPaletteInfo &  inputInfo) const
inline

Comparison operator, equals on content equality (arrays can have different pointers but need to have same content in valid areas).

Definition at line 78 of file mlDICOMTagPaletteTools.h.

References dataType, isSupplementalPaletteLUT, maxLUTEntry, maxVal, minLUTEntry, minVal, numEntries, rgbaFloatLUT, rgbaLUT, and usesAlpha.

◆ reset()

void ml::DICOMTagTools::DicomPaletteInfo::reset ( )
inline

Makes contents invalid, reset to default construction state.

Definition at line 111 of file mlDICOMTagPaletteTools.h.

References ML_INVALID_DATA_TYPE, ML_UINT16_MAX, and ML_UINT16_MIN.

Member Data Documentation

◆ dataType

MLDataType ml::DICOMTagTools::DicomPaletteInfo::dataType = ML_INVALID_DATA_TYPE

MLDataType of color table entries, MLuint8Type or MLuint16Type or ML_INVALID_DATA_TYPE if not defined.

Definition at line 127 of file mlDICOMTagPaletteTools.h.

Referenced by operator=(), and operator==().

◆ isSupplementalPaletteLUT

bool ml::DICOMTagTools::DicomPaletteInfo::isSupplementalPaletteLUT = false

If true then the rgbaFloatLUT is used and has a meaning according to a Supplemental LUT according to DICOM standard, otherwise rgbaLUT is used.

Definition at line 144 of file mlDICOMTagPaletteTools.h.

Referenced by operator=(), and operator==().

◆ maxLUTEntry

MLuint16 ml::DICOMTagTools::DicomPaletteInfo::maxLUTEntry = ML_UINT16_MIN

Maximum value found in all entries of LUT in any of the R, G, or B channels (but not Alpha even if it is valid); only valid if >= minLUTEntry.

Definition at line 156 of file mlDICOMTagPaletteTools.h.

Referenced by operator=(), and operator==().

◆ maxVal

MLint32 ml::DICOMTagTools::DicomPaletteInfo::maxVal = 0

Maximum voxel value to map to a color, all larger voxel values shall be clamped to it.

Definition at line 134 of file mlDICOMTagPaletteTools.h.

Referenced by operator=(), and operator==().

◆ minLUTEntry

MLuint16 ml::DICOMTagTools::DicomPaletteInfo::minLUTEntry = ML_UINT16_MAX

Minimum value found in all entries of LUT in any of the R, G, or B channels (but not Alpha even if it is valid); only valid if <= maxLUTEntry.

Definition at line 153 of file mlDICOMTagPaletteTools.h.

Referenced by operator=(), and operator==().

◆ minVal

MLint32 ml::DICOMTagTools::DicomPaletteInfo::minVal = 0

Minimum voxel value to map to a color, all smaller voxel values shall be clamped to it, or in case of a supplemental LUT, shall be mapped as normal grayscale image.

Definition at line 131 of file mlDICOMTagPaletteTools.h.

Referenced by operator=(), and operator==().

◆ numEntries

MLuint32 ml::DICOMTagTools::DicomPaletteInfo::numEntries = 0

Number of valid table entries in rgbLUT, at most 65536.

Definition at line 137 of file mlDICOMTagPaletteTools.h.

Referenced by operator=(), and operator==().

◆ rgbaFloatLUT

MLfloat* ml::DICOMTagTools::DicomPaletteInfo::rgbaFloatLUT = nullptr

Table of RGB[A] values as MLfloat values if isSupplementalPaletteLUT is true, otherwise undefined.

Definition at line 150 of file mlDICOMTagPaletteTools.h.

Referenced by operator=(), and operator==().

◆ rgbaLUT

MLuint16* ml::DICOMTagTools::DicomPaletteInfo::rgbaLUT = nullptr

Table of RGB[A] values as MLuint16 values if isSupplementalPaletteLUT is false, otherwise undefined.

Definition at line 147 of file mlDICOMTagPaletteTools.h.

Referenced by operator=(), and operator==().

◆ usesAlpha

bool ml::DICOMTagTools::DicomPaletteInfo::usesAlpha = false

True if alpha channel is valid, otherwise false.

Definition at line 140 of file mlDICOMTagPaletteTools.h.

Referenced by operator=(), and operator==().

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