DLPPMImage Class Reference

BMP image I/O class. More...

#include <DLPPMImage.h>

Inheritance diagram for DLPPMImage:

DLBaseImage List of all members.

Public Member Functions

void dlLoadImage (const char *filename, DLImage &image)
DLImage dlLoadImage (const void *pMemLoc, int nSize)
DLImage dlLoadImage (const char *filename)
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 DLPPMImagecreateImageReader ()
 
Returns:
A handle to the DLPPMImage object.


Protected Member Functions

virtual ~DLPPMImage ()

Detailed Description

BMP image I/O class.

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

Definition at line 14 of file DLPPMImage.h.


Constructor & Destructor Documentation

virtual DLPPMImage::~DLPPMImage (  )  [inline, protected, virtual]

Default DLPPMImage Destructor

Definition at line 40 of file DLPPMImage.h.


Member Function Documentation

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

Returns:
A handle to the DLPPMImage object.

void DLPPMImage::dlLoadImage ( const char *  filename,
DLImage image 
)

Load PPM Image

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

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

Load PPM Image from memory

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

Implements DLBaseImage.

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

Load PPM Image

Parameters:
filename name of file to be opened
Returns:
DLImage of file

Implements DLBaseImage.

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

Loads a particular page from a multiple page image file.

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

Implements DLBaseImage.

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

Loads a particular page from a mulitple page image stored in a memory buffer.

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 of particular page

Implements DLBaseImage.

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

Save PPM Image

Parameters:
filename name of file to be saved
dlimage image to be saved

Implements DLBaseImage.

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

Save PPM Image to memory

Parameters:
[out] nSize size of tiff file in memory
[in] dlimage DLImage* PPM Image
Returns:
pointer to the memory buffer in which the image was saved
Exceptions:
DL_NOT_SUPPORTED_EXCEPTION 

Implements DLBaseImage.

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

Determines if an image file is in the PPM format and is supported for loading by DLPPMImage.

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

Implements DLBaseImage.

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

Determines if an image memory buffer is in the PPM format and is supported for loading by DLPPMImage.

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

Implements DLBaseImage.

int DLPPMImage::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 DLPPMImage::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