DiMonoPixel Class Reference

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

Inheritance diagram for DiMonoPixel:

DiPixel DiMonoPixelTemplate< T > DiMonoPixelTemplate< T3 > DiColorMonoTemplate< T > DiMonoCopyTemplate< T > DiMonoFlipTemplate< T > DiMonoRotateTemplate< T > DiMonoScaleTemplate< T > DiMonoInputPixelTemplate< T1, T2, T3 > 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
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.

Definition at line 54 of file dimopx.h.


Constructor & Destructor Documentation

DiMonoPixel::DiMonoPixel ( const unsigned long  count  ) 

constructor

Parameters:
count number of pixels

DiMonoPixel::DiMonoPixel ( const DiInputPixel pixel,
DiMonoModality modality 
)

constructor

Parameters:
pixel pointer to input pixel data
modality pointer to object managing modality transform

DiMonoPixel::DiMonoPixel ( DiMonoOutputPixel pixel,
DiMonoModality modality 
)

constructor

Parameters:
pixel pointer to output pixel data used for intermediate representation
modality pointer to object managing modality transform

DiMonoPixel::DiMonoPixel ( const DiPixel pixel,
DiMonoModality modality 
) [protected]

constructor

Parameters:
pixel pointer to intermediate pixel data (not necessarily monochrome)
modality pointer to object managing modality transform

DiMonoPixel::DiMonoPixel ( const DiMonoPixel pixel,
const unsigned long  count 
) [protected]

constructor

Parameters:
pixel pointer to intermediate monochrome pixel data
count number of pixels


Member Function Documentation

int DiMonoPixel::getPlanes (  )  const [inline, virtual]

get number of planes

Returns:
number of planes (here 1, monochrome)

Implements DiPixel.

Definition at line 90 of file dimopx.h.

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

get minimum and maximum pixel values (abstract)

Parameters:
min reference to storage area for minimum pixel value
max reference 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:
idx ignore global min/max pixel values if > 0
center reference to storage area for window center value
width reference to storage area for window width value
Returns:
status, true if successful, false otherwise

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

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_pos x-coordinate of the top left-hand corner of the ROI (starting from 0)
top_pos y-coordinate of the top left-hand corner of the ROI (starting from 0)
width width in pixels of the rectangular ROI (minimum: 1)
height height in pixels of the rectangular ROI (minimum: 1)
columns number of columns (width) of the associated image
rows number of rows (height) of the associated image
frame index of the frame to be used for the calculation
voiCenter reference to storage area for window center value
voiWidth reference to storage area for window width value
Returns:
status, true if successful, false otherwise

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

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

get automatically computed histogram window (abstract)

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

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

unsigned int DiMonoPixel::getBits (  )  const [inline]

get number of bits per pixel

Returns:
number of bits

Definition at line 157 of file dimopx.h.

References DiMonoModality::getBits(), and Modality.

Referenced by DiMonoScaleTemplate< T >::DiMonoScaleTemplate(), and DiMonoOutputPixelTemplate< T1, T2, T3 >::nowindow().

double DiMonoPixel::getAbsMinimum (  )  const [inline]

get absolute minimum pixel value.

The result depends on former transforms.

Returns:
absolute minimum value

Definition at line 167 of file dimopx.h.

References DiMonoModality::getAbsMinimum(), and Modality.

Referenced by getAbsMaxRange(), isPotentiallySigned(), DiMonoOutputPixelTemplate< T1, T2, T3 >::nowindow(), DiMonoOutputPixelTemplate< T1, T2, T3 >::sigmoid(), DiMonoOutputPixelTemplate< T1, T2, T3 >::voilut(), and DiMonoOutputPixelTemplate< T1, T2, T3 >::window().

double DiMonoPixel::getAbsMaximum (  )  const [inline]

get absolute maximum pixel value.

The result depends on former transforms.

Returns:
absolute maximum value

Definition at line 177 of file dimopx.h.

References DiMonoModality::getAbsMaximum(), and Modality.

Referenced by getAbsMaxRange(), and DiMonoOutputPixelTemplate< T1, T2, T3 >::nowindow().

double DiMonoPixel::getAbsMaxRange (  )  const [inline]

get absolute pixel range

Returns:
absolute pixel range

Definition at line 186 of file dimopx.h.

References getAbsMaximum(), and getAbsMinimum().

Referenced by DiMonoOutputPixelTemplate< T1, T2, T3 >::nowindow(), DiMonoOutputPixelTemplate< T1, T2, T3 >::sigmoid(), DiMonoOutputPixelTemplate< T1, T2, T3 >::voilut(), and DiMonoOutputPixelTemplate< T1, T2, T3 >::window().

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

get modality LUT explanation string

Returns:
modality LUT explanation

Definition at line 195 of file dimopx.h.

References DiMonoModality::getExplanation(), and Modality.

Referenced by DiMonoImage::getModalityLutExplanation().

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

Definition at line 206 of file dimopx.h.

References getAbsMinimum().


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


Generated on 6 Jan 2011 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.5.1