OFFIS DCMTK  Version 3.6.0
Public Member Functions | Protected Attributes | List of all members
DiInputPixel Class Referenceabstract

Abstract base class to convert DICOM pixel stream to intermediate representation. More...

Inheritance diagram for DiInputPixel:
[legend]

Public Member Functions

 DiInputPixel (const unsigned int bits, const unsigned long first, const unsigned long number, const unsigned long fsize)
 constructor
 
virtual ~DiInputPixel ()
 destructor
 
virtual int determineMinMax ()=0
 determine minimum and maximum pixel value (abstract)
 
virtual EP_Representation getRepresentation () const =0
 get pixel representation (abstract).
 
virtual const void * getData () const =0
 get pointer to input pixel data (abstract)
 
virtual void * getDataPtr ()=0
 get pointer to input pixel data (abstract)
 
virtual void removeDataReference ()=0
 remove reference to (internally handled) pixel data (abstract)
 
virtual double getMinValue (const int idx) const =0
 get minimum pixel value (abstract)
 
virtual double getMaxValue (const int idx) const =0
 get maximum pixel value (abstract)
 
unsigned int getBits () const
 get number of bits per pixel
 
double getAbsMinimum () const
 get absolute minimum pixel value
 
double getAbsMaximum () const
 get absolute maximum pixel value
 
double getAbsMaxRange () const
 get absolute pixel value range
 
unsigned long getCount () const
 get number of pixels stored
 
unsigned long getPixelStart () const
 get first pixel to be processed
 
unsigned long getPixelCount () const
 get number of pixels to be processed
 
unsigned long getComputedCount () const
 get number of pixels computed from the image resolution
 

Protected Attributes

unsigned long Count
 number of pixels stored
 
unsigned int Bits
 bits per pixel/sample
 
unsigned long FirstFrame
 first frame to be processed
 
unsigned long NumberOfFrames
 number of frames to be processed
 
unsigned long FrameSize
 number of pixels per frame
 
unsigned long PixelStart
 first pixel to be processed
 
unsigned long PixelCount
 number of pixels to be processed
 
unsigned long ComputedCount
 number of pixels computed from the image resolution
 
double AbsMinimum
 absolute minimum (possible) pixel value
 
double AbsMaximum
 absolute maximum (possible) pixel value
 

Detailed Description

Abstract base class to convert DICOM pixel stream to intermediate representation.

Definition at line 44 of file diinpx.h.

Constructor & Destructor Documentation

DiInputPixel::DiInputPixel ( const unsigned int  bits,
const unsigned long  first,
const unsigned long  number,
const unsigned long  fsize 
)

constructor

Parameters
bitsnumber of bits stored for each pixel (depth)
firstfirst frame to be processed
numbernumber of frames to be processed
fsizenumber of pixels per frame (frame size)

Member Function Documentation

virtual int DiInputPixel::determineMinMax ( )
pure virtual

determine minimum and maximum pixel value (abstract)

Returns
status, true if successful, false otherwise

Implemented in DiInputPixelTemplate< T1, T2 >.

double DiInputPixel::getAbsMaximum ( ) const
inline

get absolute maximum pixel value

Returns
absolute maximum pixel value

Definition at line 135 of file diinpx.h.

References AbsMaximum.

double DiInputPixel::getAbsMaxRange ( ) const
inline

get absolute pixel value range

Returns
absolute pixel value range

Definition at line 144 of file diinpx.h.

References AbsMaximum, and AbsMinimum.

Referenced by DiInputPixelTemplate< T1, T2 >::determineMinMax(), DiMonoInputPixelTemplate< T1, T2, T3 >::modlut(), and DiMonoInputPixelTemplate< T1, T2, T3 >::rescale().

double DiInputPixel::getAbsMinimum ( ) const
inline

get absolute minimum pixel value

Returns
absolute minimum pixel value

Definition at line 126 of file diinpx.h.

References AbsMinimum.

Referenced by DiInputPixelTemplate< T1, T2 >::determineMinMax(), DiMonoInputPixelTemplate< T1, T2, T3 >::modlut(), and DiMonoInputPixelTemplate< T1, T2, T3 >::rescale().

unsigned int DiInputPixel::getBits ( ) const
inline

get number of bits per pixel

Returns
number of bits per pixel

Definition at line 117 of file diinpx.h.

References Bits.

unsigned long DiInputPixel::getComputedCount ( ) const
inline

get number of pixels computed from the image resolution

Returns
number of pixels computed

Definition at line 180 of file diinpx.h.

References ComputedCount.

unsigned long DiInputPixel::getCount ( ) const
inline

get number of pixels stored

Returns
number of pixels stored

Definition at line 153 of file diinpx.h.

References Count.

virtual const void* DiInputPixel::getData ( ) const
pure virtual
virtual void* DiInputPixel::getDataPtr ( )
pure virtual

get pointer to input pixel data (abstract)

Returns
pointer to input pixel data

Implemented in DiInputPixelTemplate< T1, T2 >.

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

virtual double DiInputPixel::getMaxValue ( const int  idx) const
pure virtual

get maximum pixel value (abstract)

Parameters
idxspecifies whether to return the global maximum (0) or the maximum of the selected pixel range (1, see PixelStart/Range)
Returns
maximum pixel value

Implemented in DiInputPixelTemplate< T1, T2 >.

virtual double DiInputPixel::getMinValue ( const int  idx) const
pure virtual

get minimum pixel value (abstract)

Parameters
idxspecifies whether to return the global minimum (0) or the minimum of the selected pixel range (1, see PixelStart/Range)
Returns
minimum pixel value

Implemented in DiInputPixelTemplate< T1, T2 >.

unsigned long DiInputPixel::getPixelCount ( ) const
inline

get number of pixels to be processed

Returns
number of pixels to be processed

Definition at line 171 of file diinpx.h.

References PixelCount.

unsigned long DiInputPixel::getPixelStart ( ) const
inline
virtual EP_Representation DiInputPixel::getRepresentation ( ) const
pure virtual

get pixel representation (abstract).

Determine which integer type (size and signed/unsigned) is necessary to store the pixel data.

Returns
pixel representation

Implemented in DiInputPixelTemplate< T1, T2 >.


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