DCMTK  Version 3.6.1 20120515
OFFIS DICOM Toolkit
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes
DiMonoPixelTemplate< T > Class Template Reference

Template class to handle monochrome pixel data. More...

+ Inheritance diagram for DiMonoPixelTemplate< T >:

List of all members.

Public Member Functions

 DiMonoPixelTemplate (const unsigned long count)
 constructor
 DiMonoPixelTemplate (const DiInputPixel *pixel, DiMonoModality *modality)
 constructor
 DiMonoPixelTemplate (DiMonoOutputPixel *pixel, DiMonoModality *modality)
 constructor
virtual ~DiMonoPixelTemplate ()
 destructor
EP_Representation getRepresentation () const
 get integer representation
const void * getData () const
 get pointer to internal pixel data
void * getDataPtr ()
 get pointer to internal pixel data
void * getDataArrayPtr ()
 get reference to pointer to internal pixel data.
int getMinMaxValues (double &min, double &max) const
 get minimum and maximum pixel values
int getMinMaxWindow (const int idx, double &center, double &width)
 get automatically computed min-max window
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)
 get automatically computed Region of Interest (ROI) window
int getHistogramWindow (const double thresh, double &center, double &width)
 get automatically computed histogram window

Protected Member Functions

 DiMonoPixelTemplate (const DiPixel *pixel, DiMonoModality *modality)
 constructor
 DiMonoPixelTemplate (const DiMonoPixel *pixel, const unsigned long count)
 constructor
void determineMinMax (T minvalue=0, T maxvalue=0, const int mode=0x1)
 determine minimum and maximum pixel values

Protected Attributes

T * Data
 pointer to pixel data

Private Member Functions

 DiMonoPixelTemplate (const DiMonoPixelTemplate< T > &)
DiMonoPixelTemplate< T > & operator= (const DiMonoPixelTemplate< T > &)

Private Attributes

MinValue [2]
 minimum pixel values (0 = global, 1 = ignoring global)
MaxValue [2]
 maximum pixel values

Detailed Description

template<class T>
class DiMonoPixelTemplate< T >

Template class to handle monochrome pixel data.


Constructor & Destructor Documentation

template<class T>
DiMonoPixelTemplate< T >::DiMonoPixelTemplate ( const unsigned long  count) [inline]

constructor

Parameters:
countnumber of pixels
template<class T>
DiMonoPixelTemplate< T >::DiMonoPixelTemplate ( const DiInputPixel pixel,
DiMonoModality modality 
) [inline]

constructor

Parameters:
pixelpointer to input pixel data
modalitypointer to object managing modality transform
template<class T>
DiMonoPixelTemplate< T >::DiMonoPixelTemplate ( DiMonoOutputPixel pixel,
DiMonoModality modality 
) [inline]

constructor

Parameters:
pixelpointer to output pixel data used for intermediate representation
modalitypointer to object managing modality transform
template<class T>
DiMonoPixelTemplate< T >::DiMonoPixelTemplate ( const DiPixel pixel,
DiMonoModality modality 
) [inline, protected]

constructor

Parameters:
pixelpointer to intermediate pixel data (not necessarily monochrome)
modalitypointer to object managing modality transform
template<class T>
DiMonoPixelTemplate< T >::DiMonoPixelTemplate ( const DiMonoPixel pixel,
const unsigned long  count 
) [inline, protected]

constructor

Parameters:
pixelpointer to intermediate monochrome pixel data
countnumber of pixels

Member Function Documentation

template<class T>
void DiMonoPixelTemplate< T >::determineMinMax ( minvalue = 0,
maxvalue = 0,
const int  mode = 0x1 
) [inline, protected]

determine minimum and maximum pixel values

Parameters:
minvaluestarting global minimum value (0 = invalid)
maxvaluestarting global maximum value (0 = invalid)
modecalculate global min/max if 0x1 bit is set (default), calculate next min/max if 0x2 bit is set
template<class T>
const void* DiMonoPixelTemplate< T >::getData ( ) const [inline, virtual]

get pointer to internal pixel data

Returns:
pointer to pixel data

Implements DiPixel.

template<class T>
void* DiMonoPixelTemplate< T >::getDataArrayPtr ( ) [inline, virtual]

get reference to pointer to internal pixel data.

The returned array points to the (single) image plane. The behaviour of this method is, therefore, identical for both monochrome and color images.

Returns:
reference to pointer to pixel data

Implements DiPixel.

template<class T>
void* DiMonoPixelTemplate< T >::getDataPtr ( ) [inline, virtual]

get pointer to internal pixel data

Returns:
pointer to pixel data

Implements DiPixel.

template<class T>
int DiMonoPixelTemplate< T >::getHistogramWindow ( const double  thresh,
double &  center,
double &  width 
) [inline, virtual]

get automatically computed histogram window

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

Implements DiMonoPixel.

template<class T>
int DiMonoPixelTemplate< T >::getMinMaxValues ( double &  min,
double &  max 
) const [inline, virtual]

get minimum and maximum pixel values

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

Implements DiMonoPixel.

template<class T>
int DiMonoPixelTemplate< T >::getMinMaxWindow ( const int  idx,
double &  center,
double &  width 
) [inline, virtual]

get automatically computed min-max window

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

Implements DiMonoPixel.

template<class T>
EP_Representation DiMonoPixelTemplate< T >::getRepresentation ( ) const [inline, virtual]

get integer representation

Returns:
integer representation of the internally stored pixel data

Reimplemented from DiPixelRepresentationTemplate< T >.

template<class T>
virtual int DiMonoPixelTemplate< T >::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 
) [inline, virtual]

get automatically computed Region of Interest (ROI) window

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

Implements DiMonoPixel.


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