DCMTK  Version 3.6.1 20170228
OFFIS DICOM Toolkit
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Protected Attributes | List of all members
DiColorOutputPixel Class Referenceabstract

Abstract base class to create color output data. More...

+ Inheritance diagram for DiColorOutputPixel:

Public Member Functions

 DiColorOutputPixel (const DiPixel *pixel, const unsigned long size, const unsigned long frame)
 constructor More...
 
virtual ~DiColorOutputPixel ()
 destructor
 
virtual EP_Representation getRepresentation () const =0
 get integer representation (abstract) More...
 
virtual const void * getData () const =0
 get pointer to output pixel data (abstract) More...
 
virtual void * getDataPtr ()=0
 get pointer to outpout pixel data (abstract) More...
 
virtual const void * getPlane (const int plane) const =0
 get pointer to given plane of output pixel data (abstract) More...
 
virtual size_t getItemSize () const =0
 get size of one pixel / item in the pixel array (abstract) More...
 
virtual int writePPM (STD_NAMESPACE ostream &stream) const =0
 write pixel data of selected frame to PPM/ASCII file (abstract) More...
 
virtual int writePPM (FILE *stream) const =0
 write pixel data of selected frame to PPM/ASCII file (abstract) More...
 
unsigned long getCount () const
 get number of pixel per frame More...
 

Protected Attributes

unsigned long Count
 number of pixels per frame (intermediate representation)
 
const unsigned long FrameSize
 number of pixels per frame (memory buffer size)
 

Detailed Description

Abstract base class to create color output data.

Constructor & Destructor Documentation

DiColorOutputPixel::DiColorOutputPixel ( const DiPixel pixel,
const unsigned long  size,
const unsigned long  frame 
)

constructor

Parameters
pixelpointer to intermediate pixel representation
sizenumber of pixel per frame
frameframe to be rendered

Member Function Documentation

unsigned long DiColorOutputPixel::getCount ( ) const
inline

get number of pixel per frame

Returns
number of pixel per frame
virtual const void* DiColorOutputPixel::getData ( ) const
pure virtual

get pointer to output pixel data (abstract)

Returns
pointer to pixel data

Implemented in DiColorOutputPixelTemplate< T1, T2 >.

virtual void* DiColorOutputPixel::getDataPtr ( )
pure virtual

get pointer to outpout pixel data (abstract)

Returns
pointer to pixel data

Implemented in DiColorOutputPixelTemplate< T1, T2 >.

virtual size_t DiColorOutputPixel::getItemSize ( ) const
pure virtual

get size of one pixel / item in the pixel array (abstract)

Returns
item size

Implemented in DiColorOutputPixelTemplate< T1, T2 >.

virtual const void* DiColorOutputPixel::getPlane ( const int  plane) const
pure virtual

get pointer to given plane of output pixel data (abstract)

Parameters
planenumber of the plane to be retrieved (0..2)
Returns
pointer to beginning of plane if successful, NULL otherwise

Implemented in DiColorOutputPixelTemplate< T1, T2 >.

virtual EP_Representation DiColorOutputPixel::getRepresentation ( ) const
pure virtual

get integer representation (abstract)

Returns
integer representation

Implemented in DiColorOutputPixelTemplate< T1, T2 >.

virtual int DiColorOutputPixel::writePPM ( STD_NAMESPACE ostream &  stream) const
pure virtual

write pixel data of selected frame to PPM/ASCII file (abstract)

Parameters
streamopen C++ output stream
Returns
status, true if successful, false otherwise

Implemented in DiColorOutputPixelTemplate< T1, T2 >.

virtual int DiColorOutputPixel::writePPM ( FILE *  stream) const
pure virtual

write pixel data of selected frame to PPM/ASCII file (abstract)

Parameters
streamopen C file stream
Returns
status, true if successful, false otherwise

Implemented in DiColorOutputPixelTemplate< T1, T2 >.


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


Generated on Tue Feb 28 2017 for DCMTK Version 3.6.1 20170228 by Doxygen 1.8.8