DCMTK  Version 3.6.1 20120515
OFFIS DICOM Toolkit
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
DiMonoModality Class Reference

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

+ Inheritance diagram for DiMonoModality:

List of all members.

Public Member Functions

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

Protected Member Functions

int Init (const DiDocument *docu, DiInputPixel *pixel)
 initialize internal data structures and values
void checkTable ()
 check lookup table for validity (and possibly correct it)
void checkRescaling (const DiInputPixel *pixel)
 check rescaling for validity (and possibly correct it)
void determineRepresentation (const DiDocument *docu)
 determine integer representation used for the output data

Private Member Functions

 DiMonoModality (const DiMonoModality &)
DiMonoModalityoperator= (const DiMonoModality &)

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::DiMonoModality ( const DiDocument docu,
DiInputPixel pixel 
)

constructor

Parameters:
docupointer to dataset (encapsulated)
pixelpointer to input pixel data
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::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::DiMonoModality ( const int  bits)

constructor, no modality transform

Parameters:
bitsnumber of bits per pixel

Member Function Documentation

void DiMonoModality::checkRescaling ( const DiInputPixel pixel) [protected]

check rescaling for validity (and possibly correct it)

Parameters:
pixelpointer to input pixel data
void DiMonoModality::determineRepresentation ( const DiDocument docu) [protected]

determine integer representation used for the output data

Parameters:
docupointer to dataset (encapsulated)
double DiMonoModality::getAbsMaximum ( ) const [inline]

get absolute (possible) maximum pixel value after modality transform

Returns:
absolute maximum pixel value
double DiMonoModality::getAbsMinimum ( ) const [inline]

get absolute (possible) minimum pixel value after modality transform

Returns:
absolute minimum pixel value
unsigned int DiMonoModality::getBits ( ) const [inline]

get number of bits describing the width of output data

Returns:
number of bits (might be 0)
const char* DiMonoModality::getExplanation ( ) const [inline]

get modality LUT explanation

Returns:
modality LUT explanation or NULL if absent
double DiMonoModality::getMaxValue ( ) const [inline]

get maximum pixel value after modality transform

Returns:
maximum pixel value
double DiMonoModality::getMinValue ( ) const [inline]

get minimum pixel value after modality transform

Returns:
minimum pixel value
EP_Representation DiMonoModality::getRepresentation ( ) const [inline]

get integer representation

Returns:
integer representation
double DiMonoModality::getRescaleIntercept ( ) const [inline]

get rescale intercept value

Returns:
rescale intercept value
double DiMonoModality::getRescaleSlope ( ) const [inline]

get rescale slope value

Returns:
rescale slope value
const DiLookupTable* DiMonoModality::getTableData ( ) const [inline]

get pointer to lookup table data

Returns:
pointer to lookup table data or NULL if absent
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)
int DiMonoModality::hasLookupTable ( ) const [inline]

check whether lookup table is present

Returns:
true if lookup table is present, false otherwise
int DiMonoModality::hasRescaling ( ) const [inline]

check whether rescaling is present

Returns:
true if rescaling is present, false otherwise
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

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


Generated on Tue May 15 2012 for DCMTK Version 3.6.1 20120515 by Doxygen 1.7.5.1-20111027