DLPBMImage Class Reference

PBM image I/O class. More...

#include <DLPBMImage.h>

Inheritance diagram for DLPBMImage:

DLBaseImage List of all members.

Public Member Functions

void dlLoadImage (const char *filename, DLImage &dlimage)
DLImage dlLoadImage (const char *filename)
DLImage dlLoadImage (const void *pMemLoc, int nSize)
DLImage dlLoadImageAtPage (const char *filename, int pageNumber)
DLImage dlLoadImageAtPage (const void *pMemLoc, int nSize, int pageNumber)
void dlSaveImage (const char *filename, const DLImage &dlimage)
void * dlSaveImageToMem (int &nSize, const DLImage &dlimage)
bool dlSupportImageFile (const char *filename)
bool dlSupportImageBuffer (const void *pMemLoc, int size)
int dlGetTotalPages (void *pMemLoc, int nSize)
int dlGetTotalPages (const char *filename)

Static Public Member Functions

static DLPBMImagecreateImageReader ()
 
Returns:
A handle to the DLPBMImage object


Protected Member Functions

virtual ~DLPBMImage ()
DLImage dlLoadImage (DLIOStream &dlStream)
void dlSaveImage (DLIOStream &dlStream, const DLImage &dlimage)

Detailed Description

PBM image I/O class.

Implements loading and saving for the PBM image format, and is used by DLImageFactory. See DLImage for the typical interface for loading and saving images.

Definition at line 14 of file DLPBMImage.h.


Constructor & Destructor Documentation

virtual DLPBMImage::~DLPBMImage (  )  [protected, virtual]

Default DLPBMImage Destructor


Member Function Documentation

DLImage DLPBMImage::dlLoadImage ( DLIOStream dlStream  )  [protected]

dlStream is a private IO object that handles the reads and writes. PBM uses this object to read/write the image output source

Parameters:
dlStream Doclib IO stream for read/write
Returns:
dlimage

void DLPBMImage::dlSaveImage ( DLIOStream dlStream,
const DLImage dlimage 
) [protected]

save a dlimage to the dlStream

Parameters:
dlStream Doclib IO stream for read/write
dlimage DLImage object to be saved

static DLPBMImage* DLPBMImage::createImageReader (  )  [static]

Returns:
A handle to the DLPBMImage object

void DLPBMImage::dlLoadImage ( const char *  filename,
DLImage dlimage 
)

Load PBM Image

Parameters:
[in] filename name of file to be loaded
[out] dlimage DLImage object passed by reference; will be overwritten to contain image from PBM file.

DLImage DLPBMImage::dlLoadImage ( const char *  filename  )  [virtual]

Load PBM Image

Parameters:
filename name of PBM image file to be opened
Returns:
DLImage from file

Implements DLBaseImage.

DLImage DLPBMImage::dlLoadImage ( const void *  pMemLoc,
int  nSize 
) [virtual]

Load PBM Image from memory

Parameters:
pMemLoc pointer to beginning of memory buffer
nSize size of memory buffer in bytes
Returns:
DLImage from buffer

Implements DLBaseImage.

DLImage DLPBMImage::dlLoadImageAtPage ( const char *  filename,
int  pageNumber 
) [virtual]

Loads a particular page of a multiple page image into a DLImage

Parameters:
filename name of image file to be opened
pageNumber number of page to be opened
Returns:
DLImage from particular page

Implements DLBaseImage.

DLImage DLPBMImage::dlLoadImageAtPage ( const void *  pMemLoc,
int  nSize,
int  pageNumber 
) [virtual]

Loads a particular page of a multiple page image from an image buffer in memory.

Parameters:
pMemLoc pointer to beginning of memory image buffer to be opened
nSize size of buffer in bytes
pageNumber number of page to be opened
Returns:
DLImage from particular page

Implements DLBaseImage.

void DLPBMImage::dlSaveImage ( const char *  filename,
const DLImage dlimage 
) [virtual]

Save PBM Image

Parameters:
filename name of file to be saved
dlimage PBM Image to be saved

Implements DLBaseImage.

void* DLPBMImage::dlSaveImageToMem ( int &  nSize,
const DLImage dlimage 
) [virtual]

Save PBM Image to a memory buffer. See documentation on DLImage for example code.

Parameters:
[out] nSize size of the buffer to which the image was saved
[in] dlimage PBM Image to be saved
Returns:
pointer to the beginning of the image buffer

Implements DLBaseImage.

bool DLPBMImage::dlSupportImageFile ( const char *  filename  )  [virtual]

Determines if the image file is in the PBM format and is supported for loading by DLPBMImage.

Parameters:
filename name of file to check
Returns:
boolean: true if supported

Implements DLBaseImage.

bool DLPBMImage::dlSupportImageBuffer ( const void *  pMemLoc,
int  size 
) [virtual]

Determines if the memory buffer is in the PBM format and is supported for loading by DLPBMImage.

Parameters:
pMemLoc pointer to beginning of buffer to check
size size of buffer in bytes
Returns:
boolean: true if supported

Implements DLBaseImage.

int DLPBMImage::dlGetTotalPages ( void *  pMemLoc,
int  nSize 
) [virtual]

Get the total number of pages in the image

Parameters:
pMemLoc pointer to beginning of memory buffer
nSize buffer size in bytes
Returns:
number of pages

Implements DLBaseImage.

int DLPBMImage::dlGetTotalPages ( const char *  filename  )  [virtual]

Get the total number of pages in the image

Parameters:
filename file name
Returns:
number of pages

Implements DLBaseImage.


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

DOCLIB is being developed under contract by a collaboration between:
The Laboratory for Language and Media Processing
Unviersity of Maryland, College Park
and
Booz | Allen | Hamilton

All Rights Reserved, 2003-2007