DcmQuantHistogramItem Class Reference

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

Inheritance diagram for DcmQuantHistogramItem:

DcmQuantPixel List of all members.

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

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 49 of file diqthitm.h.

Constructor & Destructor Documentation

DcmQuantHistogramItem::DcmQuantHistogramItem (  const DcmQuantPixel &  colorP,
int  val
)  [inline]
 

constructor

Parameters:
colorP pixel value
val initial value

Definition at line 56 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:
colorP pixel to compare with
Returns:
true if pixel values are equal, false otherwise

Definition at line 75 of file diqthitm.h.

void DcmQuantHistogramItem::setValue (  int  v  )  [inline]
 

assigns a new integer value to this object

Parameters:
v new value

Definition at line 89 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 111 of file diqthitm.h.

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

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

Generated on 20 Dec 2005 for OFFIS DCMTK Version 3.5.4 by Doxygen 1.4.5