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

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

Inheritance diagram for DiMonoModality:
[legend]
Collaboration diagram for DiMonoModality:
[legend]

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
 
- Public Member Functions inherited from DiObjectCounter
void addReference ()
 add a reference.
 
void removeReference ()
 remove a reference.
 

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
 
- Protected Member Functions inherited from DiObjectCounter
 DiObjectCounter ()
 constructor.
 
virtual ~DiObjectCounter ()
 destructor
 

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)

Definition at line 54 of file dimomod.h.

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

Definition at line 163 of file dimomod.h.

References AbsMaximum.

Referenced by DiMonoPixel::getAbsMaximum().

double DiMonoModality::getAbsMinimum ( ) const
inline

get absolute (possible) minimum pixel value after modality transform

Returns
absolute minimum pixel value

Definition at line 154 of file dimomod.h.

References AbsMinimum.

Referenced by DiMonoPixel::getAbsMinimum().

unsigned int DiMonoModality::getBits ( ) const
inline

get number of bits describing the width of output data

Returns
number of bits (might be 0)

Definition at line 135 of file dimomod.h.

References Bits.

Referenced by DiMonoPixel::getBits().

const char* DiMonoModality::getExplanation ( ) const
inline

get modality LUT explanation

Returns
modality LUT explanation or NULL if absent

Definition at line 199 of file dimomod.h.

References DiBaseLUT::getExplanation(), and TableData.

Referenced by DiMonoPixel::getModalityLutExplanation().

double DiMonoModality::getMaxValue ( ) const
inline

get maximum pixel value after modality transform

Returns
maximum pixel value

Definition at line 126 of file dimomod.h.

References MaxValue.

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

double DiMonoModality::getMinValue ( ) const
inline

get minimum pixel value after modality transform

Returns
minimum pixel value

Definition at line 117 of file dimomod.h.

References MinValue.

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

EP_Representation DiMonoModality::getRepresentation ( ) const
inline

get integer representation

Returns
integer representation

Definition at line 108 of file dimomod.h.

References Representation.

double DiMonoModality::getRescaleIntercept ( ) const
inline

get rescale intercept value

Returns
rescale intercept value

Definition at line 172 of file dimomod.h.

References RescaleIntercept.

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

double DiMonoModality::getRescaleSlope ( ) const
inline

get rescale slope value

Returns
rescale slope value

Definition at line 181 of file dimomod.h.

References RescaleSlope.

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

const DiLookupTable* DiMonoModality::getTableData ( ) const
inline

get pointer to lookup table data

Returns
pointer to lookup table data or NULL if absent

Definition at line 190 of file dimomod.h.

References TableData.

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

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)

Definition at line 145 of file dimomod.h.

References UsedBits.

int DiMonoModality::hasLookupTable ( ) const
inline

check whether lookup table is present

Returns
true if lookup table is present, false otherwise

Definition at line 208 of file dimomod.h.

References LookupTable.

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

int DiMonoModality::hasRescaling ( ) const
inline

check whether rescaling is present

Returns
true if rescaling is present, false otherwise

Definition at line 217 of file dimomod.h.

References Rescaling.

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

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 Thu Dec 20 2012 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.8.2