DiPixel Class Reference

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

Inheritance diagram for DiPixel:

DiColorPixel DiMonoPixel DiColorPixelTemplate< T > DiColorPixelTemplate< T2 > DiColorPixelTemplate< T3 > DiMonoPixelTemplate< T > DiMonoPixelTemplate< T3 > DiColorCopyTemplate< T > DiColorFlipTemplate< T > DiColorRotateTemplate< T > DiColorScaleTemplate< T > DiCMYKPixelTemplate< T1, T2 > DiHSVPixelTemplate< T1, T2 > DiRGBPixelTemplate< T1, T2 > DiYBR422PixelTemplate< T1, T2 > DiYBRPart422PixelTemplate< T1, T2 > DiYBRPixelTemplate< T1, T2 > DiARGBPixelTemplate< T1, T2, T3 > DiPalettePixelTemplate< T1, T2, T3 > DiColorMonoTemplate< T > DiMonoCopyTemplate< T > DiMonoFlipTemplate< T > DiMonoRotateTemplate< T > DiMonoScaleTemplate< T > DiMonoInputPixelTemplate< T1, T2, T3 > List of all members.

Public Member Functions

 DiPixel (const unsigned long count, const unsigned long inputCount=0)
 constructor
virtual ~DiPixel ()
 destructor
virtual EP_Representation getRepresentation () const =0
 get integer representation (abstract)
virtual int getPlanes () const =0
 get number of planes (abstract).
virtual const void * getData () const =0
 get pointer to pixel data (abstract).
virtual void * getDataPtr ()=0
 get pointer to pixel data (abstract).
virtual void * getDataArrayPtr ()=0
 get pointer to array of pixel data (abstract).
unsigned long getCount () const
 get number of pixels
unsigned long getInputCount () const
 get number of pixels stored in the 'PixelData' element

Protected Attributes

unsigned long Count
 number of pixels
unsigned long InputCount
 number of pixels in the input buffer

Detailed Description

Abstract base class to handle pixel data.

Definition at line 49 of file dipixel.h.

Constructor & Destructor Documentation

DiPixel::DiPixel (  const unsigned long  count,
const unsigned long  inputCount = 0
)  [inline]
 

constructor

Parameters:
count number of pixels stored in the buffer
inputCount number of pixels read from 'PixelData' attribute

Definition at line 59 of file dipixel.h.

Member Function Documentation

unsigned long DiPixel::getCount (   )  const [inline]
 

get number of pixels

Returns:
number of pixels

Definition at line 109 of file dipixel.h.

References Count.

Referenced by DiMonoCopyTemplate< T >::copy(), DiColorCopyTemplate< T >::DiColorCopyTemplate(), DiColorFlipTemplate< T >::DiColorFlipTemplate(), DiColorMonoTemplate< T >::DiColorMonoTemplate(), DiColorRotateTemplate< T >::DiColorRotateTemplate(), DiColorScaleTemplate< T >::DiColorScaleTemplate(), DiFlipTemplate< T >::DiFlipTemplate(), DiMonoCopyTemplate< T >::DiMonoCopyTemplate(), DiMonoFlipTemplate< T >::DiMonoFlipTemplate(), DiMonoRotateTemplate< T >::DiMonoRotateTemplate(), DiMonoScaleTemplate< T >::DiMonoScaleTemplate(), DiRotateTemplate< T >::DiRotateTemplate(), and DiMonoRotateTemplate< T >::rotate().

virtual const void* DiPixel::getData (   )  const [pure virtual]
 

get pointer to pixel data (abstract).

NB: See implemented method in derived class for details.

Returns:
pointer to pixel data

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

Referenced by DiColorCopyTemplate< T >::DiColorCopyTemplate(), DiColorFlipTemplate< T >::DiColorFlipTemplate(), DiColorMonoTemplate< T >::DiColorMonoTemplate(), DiColorOutputPixelTemplate< T1, T2 >::DiColorOutputPixelTemplate(), DiColorRotateTemplate< T >::DiColorRotateTemplate(), DiColorScaleTemplate< T >::DiColorScaleTemplate(), DiMonoCopyTemplate< T >::DiMonoCopyTemplate(), DiMonoFlipTemplate< T >::DiMonoFlipTemplate(), DiMonoRotateTemplate< T >::DiMonoRotateTemplate(), DiMonoScaleTemplate< T >::DiMonoScaleTemplate(), DiMonoOutputPixelTemplate< T1, T2, T3 >::nowindow(), DiMonoOutputPixelTemplate< T1, T2, T3 >::voilut(), and DiMonoOutputPixelTemplate< T1, T2, T3 >::window().

virtual void* DiPixel::getDataArrayPtr (   )  [pure virtual]
 

get pointer to array of pixel data (abstract).

The number of planes in the returned array can be determined using 'getPlanes()'.

Returns:
pointer to array of pixel data

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

Referenced by DiFlipTemplate< T >::DiFlipTemplate(), and DiRotateTemplate< T >::DiRotateTemplate().

virtual void* DiPixel::getDataPtr (   )  [pure virtual]
 

get pointer to pixel data (abstract).

NB: See implemented method in derived class for details.

Returns:
pointer to pixel data

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

unsigned long DiPixel::getInputCount (   )  const [inline]
 

get number of pixels stored in the 'PixelData' element

Returns:
number pixels read from the input buffer

Definition at line 118 of file dipixel.h.

References InputCount.

virtual int DiPixel::getPlanes (   )  const [pure virtual]
 

get number of planes (abstract).

Returns:
number of planes (e.g. 1 for monochrome and 3 for color images)

Implemented in DiColorPixel, and DiMonoPixel.

Referenced by DiFlipTemplate< T >::DiFlipTemplate(), and DiRotateTemplate< T >::DiRotateTemplate().

virtual EP_Representation DiPixel::getRepresentation (   )  const [pure virtual]
 

get integer representation (abstract)

Returns:
integer representation of the internally stored pixel data

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

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