OFFIS DCMTK  Version 3.6.0
Public Member Functions | Private Member Functions | Private Attributes
DcmQuantHistogramItemList Class Reference

this is a helper class used by class DcmQuantColorHashTable. More...

Collaboration diagram for DcmQuantHistogramItemList:
[legend]

List of all members.

Public Member Functions

 DcmQuantHistogramItemList ()
 constructor
 ~DcmQuantHistogramItemList ()
 destructor. Destroys all objects pointed to by list.
void moveto (DcmQuantHistogramItemPointer *array, unsigned long &counter, unsigned long numcolors)
 this method moves the contents of this list into the given array.
int lookup (const DcmQuantPixel &colorP)
 searches the list for an entry that equals the given pixel value.
unsigned long add (const DcmQuantPixel &colorP)
 adds the given pixel to the list.
void push_front (const DcmQuantPixel &colorP, int value)
 inserts a new DcmQuantHistogramItem at the beginning of the list.
size_t size () const
 returns current number of objects in the list

Private Member Functions

 OFListIterator (DcmQuantHistogramItem *) first
 temporary iterator used in various methods; declared here for efficiency reasons only.
 OFListIterator (DcmQuantHistogramItem *) last
 constant iterator which always contains list_.end(); declared here for efficiency reasons only.

Private Attributes

OFList< DcmQuantHistogramItem * > list_
 list of (pointers to) DcmQuantHistogramItem objects

Detailed Description

this is a helper class used by class DcmQuantColorHashTable.

It maintains a list of DcmQuantHistogramItem objects.

Definition at line 42 of file diqthitl.h.


Member Function Documentation

unsigned long DcmQuantHistogramItemList::add ( const DcmQuantPixel colorP)
inline

adds the given pixel to the list.

If the pixel is already contained in the list, it's integer value (counter) is increased and 0 is returned. Otherwise, a new entry with a counter of 1 is created and 1 is returned.

Parameters:
colorPpixel to add to the list
Returns:
0 if pixel was already in list, 1 otherwise.

Definition at line 85 of file diqthitl.h.

References OFList< T >::begin(), list_, and OFList< T >::push_front().

int DcmQuantHistogramItemList::lookup ( const DcmQuantPixel colorP)
inline

searches the list for an entry that equals the given pixel value.

If found, the integer value assigned to that pixel is returned, otherwise returns -1.

Parameters:
colorPpixel to lookup in list
Returns:
integer value for given color if found, -1 otherwise.

Definition at line 67 of file diqthitl.h.

References OFList< T >::begin(), and list_.

Referenced by DcmQuantColorHashTable::lookup().

void DcmQuantHistogramItemList::moveto ( DcmQuantHistogramItemPointer array,
unsigned long &  counter,
unsigned long  numcolors 
)

this method moves the contents of this list into the given array.

The list becomes empty if the array is large enough to contain all list members.

Parameters:
arrayarray of pointers to DcmQuantHistogramItem
counterWhen called, contains the index of the array element into which the first member of the list will be moved. Must be < numcolors. Upon return, contains the array index of the last element moved + 1.
numcolorsnumber of elements in array
void DcmQuantHistogramItemList::push_front ( const DcmQuantPixel colorP,
int  value 
)
inline

inserts a new DcmQuantHistogramItem at the beginning of the list.

Parameters:
colorPpixel value assigned to the new object in the list
valueinteger value assigned to the new object in the list

Definition at line 107 of file diqthitl.h.

References list_, and OFList< T >::push_front().

Referenced by DcmQuantColorHashTable::add().


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


Generated on Thu May 31 2012 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.8.1