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

this class extends DcmQuantPixel by an integer value which is used for various purposes. More...

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

Public Member Functions

 DcmQuantHistogramItem (const DcmQuantPixel &colorP, int val)
 constructor
 
 DcmQuantHistogramItem ()
 default constructor
 
OFBool equals (const DcmQuantPixel &colorP) const
 compares the stored pixel value with the given pixel.
 
int getValue () const
 returns the integer value maintained by this object
 
void setValue (int v)
 assigns a new integer value to this object
 
void incValue ()
 increases the integer value maintained by this object by one
 
- Public Member Functions inherited from DcmQuantPixel
 DcmQuantPixel ()
 default constructor, creates black pixel
 
 DcmQuantPixel (const DcmQuantPixel &arg)
 copy assignment constructor
 
OFBool operator== (const DcmQuantPixel &src) const
 comparison operator for equality
 
double luminance () const
 this method computes the luminance of the current pixel according to the NTSC formula.
 
unsigned long hash () const
 this method computes an unsigned long hash value for the current pixel.
 
DcmQuantComponent getRed () const
 returns the red component
 
DcmQuantComponent getGreen () const
 returns the green component
 
DcmQuantComponent getBlue () const
 returns the blue component
 
void assign (DcmQuantComponent r, DcmQuantComponent g, DcmQuantComponent b)
 assigns new R, G and B values to this pixel
 
void scale (DcmQuantComponent r, DcmQuantComponent g, DcmQuantComponent b, const DcmQuantScaleTable &table)
 assigns new R, G and B values to this pixel using the given scale table in which all three values are looked up.
 

Private Attributes

int value
 integer value assigned to this pixel.
 

Detailed Description

this class extends DcmQuantPixel by an integer value which is used for various purposes.

The class is used as a helper class during computation of an image histogram, as a member of a color LUT and as a member of a color hash table.

Definition at line 45 of file diqthitm.h.

Constructor & Destructor Documentation

DcmQuantHistogramItem::DcmQuantHistogramItem ( const DcmQuantPixel colorP,
int  val 
)
inline

constructor

Parameters
colorPpixel value
valinitial value

Definition at line 52 of file diqthitm.h.

Member Function Documentation

OFBool DcmQuantHistogramItem::equals ( const DcmQuantPixel colorP) const
inline

compares the stored pixel value with the given pixel.

Parameters
colorPpixel to compare with
Returns
true if pixel values are equal, false otherwise

Definition at line 71 of file diqthitm.h.

void DcmQuantHistogramItem::setValue ( int  v)
inline

assigns a new integer value to this object

Parameters
vnew value

Definition at line 85 of file diqthitm.h.

References value.

Member Data Documentation

int DcmQuantHistogramItem::value
private

integer value assigned to this pixel.

This value is used for different purposes. During computation of a histogram it is used as a counter that counts the instances of the current color. In a color hash table, it contains the index value from the color LUT assigned to this color. In a color LUT, it is the cluster value, i.e. the radius in which all color are guaranteed to be mapped to this palette color.

Definition at line 107 of file diqthitm.h.

Referenced by getValue(), incValue(), and setValue().


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