DCMTK  Version 3.6.1 20120515
OFFIS DICOM Toolkit
Public Member Functions
DJEncoder Class Reference

abstract base class for compression classes. More...

+ Inheritance diagram for DJEncoder:

List of all members.

Public Member Functions

 DJEncoder ()
 default constructor
virtual ~DJEncoder ()
 destructor
virtual OFCondition encode (Uint16 columns, Uint16 rows, EP_Interpretation interpr, Uint16 samplesPerPixel, Uint16 *image_buffer, Uint8 *&to, Uint32 &length)=0
 single frame compression routine for 16-bit raw pixel data.
virtual OFCondition encode (Uint16 columns, Uint16 rows, EP_Interpretation interpr, Uint16 samplesPerPixel, Uint8 *image_buffer, Uint8 *&to, Uint32 &length)=0
 single frame compression routine for 8-bit raw pixel data.
virtual Uint16 bytesPerSample () const =0
 returns the number of bytes per sample that will be expected when encoding.
virtual Uint16 bitsPerSample () const =0
 returns the number of bits per sample that will be expected when encoding.

Detailed Description

abstract base class for compression classes.


Member Function Documentation

virtual OFCondition DJEncoder::encode ( Uint16  columns,
Uint16  rows,
EP_Interpretation  interpr,
Uint16  samplesPerPixel,
Uint16 *  image_buffer,
Uint8 *&  to,
Uint32 &  length 
) [pure virtual]

single frame compression routine for 16-bit raw pixel data.

May only be called if bytesPerSample() == 2.

Parameters:
columnscolumns of frame
rowsrows of frame
interprphotometric interpretation of input frame
samplesPerPixelsamples per pixel of input frame
image_bufferpointer to frame buffer
tocompressed frame returned in this parameter upon success
lengthlength of compressed frame (in bytes) returned in this parameter upon success; length guaranteed to be always even.
Returns:
EC_Normal if successful, an error code otherwise.

Implemented in DJCompressIJG12Bit, DJCompressIJG8Bit, and DJCompressIJG16Bit.

virtual OFCondition DJEncoder::encode ( Uint16  columns,
Uint16  rows,
EP_Interpretation  interpr,
Uint16  samplesPerPixel,
Uint8 *  image_buffer,
Uint8 *&  to,
Uint32 &  length 
) [pure virtual]

single frame compression routine for 8-bit raw pixel data.

May only be called if bytesPerSample() == 1.

Parameters:
columnscolumns of frame
rowsrows of frame
interprphotometric interpretation of input frame
samplesPerPixelsamples per pixel of input frame
image_bufferpointer to frame buffer
tocompressed frame returned in this parameter upon success
lengthlength of compressed frame (in bytes) returned in this parameter upon success; length guaranteed to be always even.
Returns:
EC_Normal if successful, an error code otherwise.

Implemented in DJCompressIJG12Bit, DJCompressIJG8Bit, and DJCompressIJG16Bit.


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


Generated on Tue May 15 2012 for DCMTK Version 3.6.1 20120515 by Doxygen 1.7.5.1-20111027