DCMTK  Version 3.6.1 20120515
OFFIS DICOM Toolkit
Public Member Functions | Protected Attributes
I2DImgSource Class Reference
+ Inheritance diagram for I2DImgSource:

List of all members.

Public Member Functions

 I2DImgSource ()
 Constructor.
virtual OFString inputFormat () const =0
 Returns identifier for the image input format the plugin imports.
virtual OFCondition readPixelData (Uint16 &rows, Uint16 &cols, Uint16 &samplesPerPixel, OFString &photoMetrInt, Uint16 &bitsAlloc, Uint16 &bitsStored, Uint16 &highBit, Uint16 &pixelRepr, Uint16 &planConf, Uint16 &pixAspectH, Uint16 &pixAspectV, char *&pixData, Uint32 &length, E_TransferSyntax &ts)=0
 Extracts the raw JPEG pixel data stream from a JPEG file and returns some image information about this pixel data.
virtual OFCondition getLossyComprInfo (OFBool &srcEncodingLossy, OFString &srcLossyComprMethod) const =0
void setImageFile (const OFString &filename)
 Sets the input image file to read.
OFString getImageFile ()
 Returns the input image file that currently associated with plugin.
virtual ~I2DImgSource ()
 Virtual Destructor.

Protected Attributes

OFString m_imageFile
 The input file.

Member Function Documentation

Returns the input image file that currently associated with plugin.

Returns:
The filename of the image input file
virtual OFString I2DImgSource::inputFormat ( ) const [pure virtual]

Returns identifier for the image input format the plugin imports.

Returns:
A short identifier (e. g. "JPEG")

Implemented in I2DJpegSource, and I2DBmpSource.

virtual OFCondition I2DImgSource::readPixelData ( Uint16 &  rows,
Uint16 &  cols,
Uint16 &  samplesPerPixel,
OFString photoMetrInt,
Uint16 &  bitsAlloc,
Uint16 &  bitsStored,
Uint16 &  highBit,
Uint16 &  pixelRepr,
Uint16 &  planConf,
Uint16 &  pixAspectH,
Uint16 &  pixAspectV,
char *&  pixData,
Uint32 &  length,
E_TransferSyntax &  ts 
) [pure virtual]

Extracts the raw JPEG pixel data stream from a JPEG file and returns some image information about this pixel data.

Raw means here that all APP markers (e.g. JFIF information) are removed from the JPEG stream. The pixel data returned is a JPEG stream in JPEG interchange format. This function allocates memory for the pixel data returned to the user. The caller of this function is responsible for deleting the memory buffer

Parameters:
rows- [out] Rows of image
cols- [out] Columns of image
samplesPerPixel- [out] Number of components per pixel
photoMetrInt- [out] The DICOM color model used for the compressed data
bitsAlloc- [out] Bits Allocated for one sample
bitsStored- [out] Bits Stored, number of bits stored within Bits Allocated
highBit- [out] High Bit, hightest bit position set within Bits Allocated
pixelRepr- [out] Pixel Representation (0=unsigned, 1=signed)
planConf- [out] Planar Configuration
pixAspectH- [out] Horizontal value of pixel aspect ratio
pixAspectV- [out] Vertical value of pixel aspect ratio
pixData- [out] Pointer to the pixel data in JPEG Interchange Format (but without APPx markers).
length- [out] Length of pixel data
ts- [out] The transfer syntax imposed by the imported pixel pixel data. This is necessary for the JPEG importer that needs to report which TS must be used for the imported JPEG data (ie. baseline, progressive, ...).
Returns:
EC_Normal, if successful, error otherwise

Implemented in I2DJpegSource, and I2DBmpSource.

void I2DImgSource::setImageFile ( const OFString filename) [inline]

Sets the input image file to read.

Parameters:
filename- [in] The filename of the image input file
Returns:
none

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