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

Abstract base class to handle monochrome pixel data. More...

+ Inheritance diagram for DiMonoPixel:

List of all members.

Public Member Functions

 DiMonoPixel (const unsigned long count)
 constructor
 DiMonoPixel (const DiInputPixel *pixel, DiMonoModality *modality)
 constructor
 DiMonoPixel (DiMonoOutputPixel *pixel, DiMonoModality *modality)
 constructor
virtual ~DiMonoPixel ()
 destructor
int getPlanes () const
 get number of planes
virtual int getMinMaxValues (double &min, double &max) const =0
 get minimum and maximum pixel values (abstract)
virtual int getMinMaxWindow (const int idx, double &center, double &width)=0
 get automatically computed min-max window (abstract)
virtual int getRoiWindow (const unsigned long left_pos, const unsigned long top_pos, const unsigned long width, const unsigned long height, const unsigned long columns, const unsigned long rows, const unsigned long frame, double &voiCenter, double &voiWidth)=0
 get automatically computed Region of Interest (ROI) window (abstract)
virtual int getHistogramWindow (const double thresh, double &center, double &width)=0
 get automatically computed histogram window (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 range
const char * getModalityLutExplanation () const
 get modality LUT explanation string
DiMonoModalityaddReferenceToModality ()
 add a reference to the internally managed modality transform object
int isPotentiallySigned () const
 check whether pixel data is 'potentially' signed.

Protected Member Functions

 DiMonoPixel (const DiPixel *pixel, DiMonoModality *modality)
 constructor
 DiMonoPixel (const DiMonoPixel *pixel, const unsigned long count)
 constructor

Protected Attributes

DiMonoModalityModality
 pointer to modality transform object

Private Member Functions

 DiMonoPixel (const DiMonoPixel &)
DiMonoPixeloperator= (const DiMonoPixel &)

Detailed Description

Abstract base class to handle monochrome pixel data.


Constructor & Destructor Documentation

DiMonoPixel::DiMonoPixel ( const unsigned long  count)

constructor

Parameters:
countnumber of pixels
DiMonoPixel::DiMonoPixel ( const DiInputPixel pixel,
DiMonoModality modality 
)

constructor

Parameters:
pixelpointer to input pixel data
modalitypointer to object managing modality transform

constructor

Parameters:
pixelpointer to output pixel data used for intermediate representation
modalitypointer to object managing modality transform
DiMonoPixel::DiMonoPixel ( const DiPixel pixel,
DiMonoModality modality 
) [protected]

constructor

Parameters:
pixelpointer to intermediate pixel data (not necessarily monochrome)
modalitypointer to object managing modality transform
DiMonoPixel::DiMonoPixel ( const DiMonoPixel pixel,
const unsigned long  count 
) [protected]

constructor

Parameters:
pixelpointer to intermediate monochrome pixel data
countnumber of pixels

Member Function Documentation

add a reference to the internally managed modality transform object

Returns:
pointer to modality transform object (might be NULL)
double DiMonoPixel::getAbsMaximum ( ) const [inline]

get absolute maximum pixel value.

The result depends on former transforms.

Returns:
absolute maximum value
double DiMonoPixel::getAbsMaxRange ( ) const [inline]

get absolute pixel range

Returns:
absolute pixel range
double DiMonoPixel::getAbsMinimum ( ) const [inline]

get absolute minimum pixel value.

The result depends on former transforms.

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

get number of bits per pixel

Returns:
number of bits
virtual int DiMonoPixel::getHistogramWindow ( const double  thresh,
double &  center,
double &  width 
) [pure virtual]

get automatically computed histogram window (abstract)

Parameters:
threshignore certain percentage of pixels at lower and upper boundaries
centerreference to storage area for window center value
widthreference to storage area for window width value
Returns:
status, true if successful, false otherwise

Implemented in DiMonoPixelTemplate< T >, and DiMonoPixelTemplate< T3 >.

virtual int DiMonoPixel::getMinMaxValues ( double &  min,
double &  max 
) const [pure virtual]

get minimum and maximum pixel values (abstract)

Parameters:
minreference to storage area for minimum pixel value
maxreference to storage area for maximum pixel value
Returns:
status, true if successful, false otherwise

Implemented in DiMonoPixelTemplate< T >, and DiMonoPixelTemplate< T3 >.

virtual int DiMonoPixel::getMinMaxWindow ( const int  idx,
double &  center,
double &  width 
) [pure virtual]

get automatically computed min-max window (abstract)

Parameters:
idxignore global min/max pixel values if > 0
centerreference to storage area for window center value
widthreference to storage area for window width value
Returns:
status, true if successful, false otherwise

Implemented in DiMonoPixelTemplate< T >, and DiMonoPixelTemplate< T3 >.

const char* DiMonoPixel::getModalityLutExplanation ( ) const [inline]

get modality LUT explanation string

Returns:
modality LUT explanation
int DiMonoPixel::getPlanes ( ) const [inline, virtual]

get number of planes

Returns:
number of planes (here 1, monochrome)

Implements DiPixel.

virtual int DiMonoPixel::getRoiWindow ( const unsigned long  left_pos,
const unsigned long  top_pos,
const unsigned long  width,
const unsigned long  height,
const unsigned long  columns,
const unsigned long  rows,
const unsigned long  frame,
double &  voiCenter,
double &  voiWidth 
) [pure virtual]

get automatically computed Region of Interest (ROI) window (abstract)

Parameters:
left_posx-coordinate of the top left-hand corner of the ROI (starting from 0)
top_posy-coordinate of the top left-hand corner of the ROI (starting from 0)
widthwidth in pixels of the rectangular ROI (minimum: 1)
heightheight in pixels of the rectangular ROI (minimum: 1)
columnsnumber of columns (width) of the associated image
rowsnumber of rows (height) of the associated image
frameindex of the frame to be used for the calculation
voiCenterreference to storage area for window center value
voiWidthreference to storage area for window width value
Returns:
status, true if successful, false otherwise

Implemented in DiMonoPixelTemplate< T >, and DiMonoPixelTemplate< T3 >.

int DiMonoPixel::isPotentiallySigned ( ) const [inline]

check whether pixel data is 'potentially' signed.

This check is necessary to interpret possibly folowing LUT descriptors correctly (see supplement 33)

Returns:
true if pixel data is potentially signed, false otherwise

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