DCMTK Version 3.6.8
OFFIS DICOM Toolkit
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
DiMonoModality Class Reference

Class to handle modality specific transformations (incl. More...

+ Inheritance diagram for DiMonoModality:

Public Member Functions

 DiMonoModality (const DiDocument *docu, DiInputPixel *pixel)
 constructor More...
 
 DiMonoModality (const DiDocument *docu, DiInputPixel *pixel, const double slope, const double intercept)
 constructor, rescale More...
 
 DiMonoModality (const DiDocument *docu, DiInputPixel *pixel, const DcmUnsignedShort &data, const DcmUnsignedShort &descriptor, const DcmLongString *explanation)
 constructor, LUT More...
 
 DiMonoModality (const int bits)
 constructor, no modality transform More...
 
virtual ~DiMonoModality ()
 destructor
 
EP_Representation getRepresentation () const
 get integer representation More...
 
double getMinValue () const
 get minimum pixel value after modality transform More...
 
double getMaxValue () const
 get maximum pixel value after modality transform More...
 
unsigned int getBits () const
 get number of bits describing the width of output data More...
 
unsigned int getUsedBits () const
 get number of bits actually used to store the output data. More...
 
double getAbsMinimum () const
 get absolute (possible) minimum pixel value after modality transform More...
 
double getAbsMaximum () const
 get absolute (possible) maximum pixel value after modality transform More...
 
double getRescaleIntercept () const
 get rescale intercept value More...
 
double getRescaleSlope () const
 get rescale slope value More...
 
const DiLookupTablegetTableData () const
 get pointer to lookup table data More...
 
const char * getExplanation () const
 get modality LUT explanation More...
 
int hasLookupTable () const
 check whether lookup table is present More...
 
int hasRescaling () const
 check whether rescaling is present More...
 
- Public Member Functions inherited from DiObjectCounter
void addReference ()
 add a reference. More...
 
void removeReference ()
 remove a reference. More...
 

Protected Member Functions

int Init (const DiDocument *docu, DiInputPixel *pixel)
 initialize internal data structures and values More...
 
void checkTable ()
 check lookup table for validity (and possibly correct it)
 
void checkRescaling (const DiInputPixel *pixel)
 check rescaling for validity (and possibly correct it) More...
 
void determineRepresentation (const DiDocument *docu)
 determine integer representation used for the output data More...
 
- Protected Member Functions inherited from DiObjectCounter
 DiObjectCounter ()
 constructor. More...
 
virtual ~DiObjectCounter ()
 destructor
 

Private Attributes

EP_Representation Representation
 integer representation
 
double MinValue
 minimum pixel value
 
double MaxValue
 maximum pixel value
 
unsigned int Bits
 number of bits
 
unsigned int UsedBits
 number of used bits
 
double AbsMinimum
 absolute minimum pixel value
 
double AbsMaximum
 absolute maximum pixel value
 
double RescaleIntercept
 rescale intercept
 
double RescaleSlope
 rescale slope
 
int LookupTable
 status flag: lookup table present
 
int Rescaling
 status flag: rescaling present
 
DiLookupTableTableData
 pointer to modality lookup table
 

Detailed Description

Class to handle modality specific transformations (incl.

modality LUT)

Constructor & Destructor Documentation

◆ DiMonoModality() [1/4]

DiMonoModality::DiMonoModality ( const DiDocument docu,
DiInputPixel pixel 
)

constructor

Parameters
docupointer to dataset (encapsulated)
pixelpointer to input pixel data

◆ DiMonoModality() [2/4]

DiMonoModality::DiMonoModality ( const DiDocument docu,
DiInputPixel pixel,
const double  slope,
const double  intercept 
)

constructor, rescale

Parameters
docupointer to dataset (encapsulated)
pixelpointer to input pixel data
sloperescale slope (<> 0)
interceptrescale intercept

◆ DiMonoModality() [3/4]

DiMonoModality::DiMonoModality ( const DiDocument docu,
DiInputPixel pixel,
const DcmUnsignedShort data,
const DcmUnsignedShort descriptor,
const DcmLongString explanation 
)

constructor, LUT

Parameters
docupointer to dataset (encapsulated)
pixelpointer to input pixel data
dataelement containing the modality LUT data
descriptorelement containing the modality LUT descriptor
explanationelement containing the modality LUT explanation (optional)

◆ DiMonoModality() [4/4]

DiMonoModality::DiMonoModality ( const int  bits)

constructor, no modality transform

Parameters
bitsnumber of bits per pixel

Member Function Documentation

◆ checkRescaling()

void DiMonoModality::checkRescaling ( const DiInputPixel pixel)
protected

check rescaling for validity (and possibly correct it)

Parameters
pixelpointer to input pixel data

◆ determineRepresentation()

void DiMonoModality::determineRepresentation ( const DiDocument docu)
protected

determine integer representation used for the output data

Parameters
docupointer to dataset (encapsulated)

◆ getAbsMaximum()

double DiMonoModality::getAbsMaximum ( ) const
inline

get absolute (possible) maximum pixel value after modality transform

Returns
absolute maximum pixel value

◆ getAbsMinimum()

double DiMonoModality::getAbsMinimum ( ) const
inline

get absolute (possible) minimum pixel value after modality transform

Returns
absolute minimum pixel value

◆ getBits()

unsigned int DiMonoModality::getBits ( ) const
inline

get number of bits describing the width of output data

Returns
number of bits (might be 0)

◆ getExplanation()

const char * DiMonoModality::getExplanation ( ) const
inline

get modality LUT explanation

Returns
modality LUT explanation or NULL if absent

◆ getMaxValue()

double DiMonoModality::getMaxValue ( ) const
inline

get maximum pixel value after modality transform

Returns
maximum pixel value

◆ getMinValue()

double DiMonoModality::getMinValue ( ) const
inline

get minimum pixel value after modality transform

Returns
minimum pixel value

◆ getRepresentation()

EP_Representation DiMonoModality::getRepresentation ( ) const
inline

get integer representation

Returns
integer representation

◆ getRescaleIntercept()

double DiMonoModality::getRescaleIntercept ( ) const
inline

get rescale intercept value

Returns
rescale intercept value

◆ getRescaleSlope()

double DiMonoModality::getRescaleSlope ( ) const
inline

get rescale slope value

Returns
rescale slope value

◆ getTableData()

const DiLookupTable * DiMonoModality::getTableData ( ) const
inline

get pointer to lookup table data

Returns
pointer to lookup table data or NULL if absent

Referenced by DiMonoInputPixelTemplate< T1, T2, T3 >::modlut().

◆ getUsedBits()

unsigned int DiMonoModality::getUsedBits ( ) const
inline

get number of bits actually used to store the output data.

(based on the range given by 'MinValue' and 'MaxValue')

Returns
number of used bits (might be 0)

◆ hasLookupTable()

int DiMonoModality::hasLookupTable ( ) const
inline

check whether lookup table is present

Returns
true if lookup table is present, false otherwise

Referenced by DiMonoInputPixelTemplate< T1, T2, T3 >::DiMonoInputPixelTemplate().

◆ hasRescaling()

int DiMonoModality::hasRescaling ( ) const
inline

check whether rescaling is present

Returns
true if rescaling is present, false otherwise

◆ Init()

int DiMonoModality::Init ( const DiDocument docu,
DiInputPixel pixel 
)
protected

initialize internal data structures and values

Parameters
docupointer to dataset (encapsulated)
pixelpointer to input pixel data
Returns
status, true if successful, false otherwise

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


Generated on Tue Dec 19 2023 for DCMTK Version 3.6.8 by Doxygen 1.9.4