OFFIS DCMTK  Version 3.6.0
Public Member Functions | Protected Attributes | List of all members
DiPixel Class Referenceabstract

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

Inheritance diagram for DiPixel:
[legend]

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 44 of file dipixel.h.

Constructor & Destructor Documentation

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

constructor

Parameters
countnumber of pixels stored in the buffer
inputCountnumber of pixels read from 'PixelData' attribute

Definition at line 54 of file dipixel.h.

Member Function Documentation

unsigned long DiPixel::getCount ( ) const
inline
virtual const void* DiPixel::getData ( ) const
pure virtual
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 >, DiColorPixelTemplate< T2 >, DiColorPixelTemplate< T3 >, DiMonoPixelTemplate< T >, 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 >, DiColorPixelTemplate< T2 >, DiColorPixelTemplate< T3 >, DiMonoPixelTemplate< T >, 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 113 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 DiMonoPixel, and DiColorPixel.

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 >, DiColorPixelTemplate< T2 >, DiColorPixelTemplate< T3 >, DiMonoPixelTemplate< T >, and DiMonoPixelTemplate< T3 >.


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