DLTIFFImage Class Reference

TIFF image I/O class. More...

#include <DLTIFFImage.h>

Inheritance diagram for DLTIFFImage:

DLBaseImage List of all members.

Public Member Functions

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

Static Public Member Functions

static DLTIFFImagecreateImageReader ()
static void dlSaveImage (TIFF *image, const DLImage &dlimage, int TIFF_COMPRESSION_TYPE, bool MIN_IS_WHITE=true)
static void dlSaveImage (const char *filename, const DLImage &dlimage, int TIFF_COMPRESSION_TYPE, bool MIN_IS_WHITE=true)
static void * dlSaveImageToMem (int &nSize, const DLImage &dlimage, int TIFF_COMPRESSION_TYPE, bool MIN_IS_WHITE=true)

Detailed Description

TIFF image I/O class.

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

Special save functions which are unique to the TIFF format are shown here in the group of static member functions.

Definition at line 28 of file DLTIFFImage.h.


Constructor & Destructor Documentation

virtual DLTIFFImage::~DLTIFFImage (  )  [virtual]

Default DLTIFFImage Destructor


Member Function Documentation

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

Returns:
A handle to the DLTIFFImage object

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

Load TIFF Image

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

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

Load TIFF Image

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

Implements DLBaseImage.

void DLTIFFImage::dlLoadImage ( const void *  pMemLoc,
int  nSize,
DLImage dlimage 
)

Load TIFF Image from memory

Parameters:
[in] pMemLoc pointer to beginning of memory buffer of TIFF file
[in] nSize size of TIFF file in memory, in bytes
[out] dlimage DLImage object passed by reference; will be overwritten to contain image from TIFF file.

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

Load TIFF Image from memory

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

Implements DLBaseImage.

static void DLTIFFImage::dlSaveImage ( TIFF image,
const DLImage dlimage,
int  TIFF_COMPRESSION_TYPE,
bool  MIN_IS_WHITE = true 
) [static]

Save TIFF image given a TIFF pointer

Parameters:
image TIFF*
dlimage image to be saved
TIFF_COMPRESSION_TYPE compression type to save with
MIN_IS_WHITE For grayscale and binary images:
  • true (the default) saves with the minimum bit or byte value indicating a white pixel;
  • false save with the minimum value indicating a black pixel.

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

Save TIFF Image

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

Implements DLBaseImage.

static void DLTIFFImage::dlSaveImage ( const char *  filename,
const DLImage dlimage,
int  TIFF_COMPRESSION_TYPE,
bool  MIN_IS_WHITE = true 
) [static]

Save an image with a particular compression scheme. Here are the compression algorithms supported as of LIB TIFF Version 3.6.0:

Example:
 DLImage i;
 // ... 
 DLTIFFImage::dlSaveImage("output.tif", i, COMPRESSION_LZW);
Parameters:
filename name of file to be saved
dlimage image object to be saved
TIFF_COMPRESSION_TYPE TIFF compression type
MIN_IS_WHITE For grayscale and binary images:
  • true (the default) saves with the minimum bit or byte value indicating a white pixel;
  • false save with the minimum value indicating a black pixel.

static void* DLTIFFImage::dlSaveImageToMem ( int &  nSize,
const DLImage dlimage,
int  TIFF_COMPRESSION_TYPE,
bool  MIN_IS_WHITE = true 
) [static]

Save an image to a memory buffer with a particular compression scheme. Here are the compression algorithms supported as of LIB TIFF Version 3.6.0

Parameters:
[out] nSize size of TIFF file as saved in memory, in bytes
[in] dlimage image object to be saved
[in] TIFF_COMPRESSION_TYPE tiff compression type
[in] MIN_IS_WHITE For grayscale and binary images:
  • true (the default) saves with the minimum bit or byte value indicating a white pixel;
  • false save with the minimum value indicating a black pixel.
Returns:
pointer to memory buffer in which the image was saved

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

Save TIFF Image to memory

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

Implements DLBaseImage.

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

Loads a particular page from a multiple page image.

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

Implements DLBaseImage.

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

Loads a particular page from a multiple 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.

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

get the total number of pages in a image

Parameters:
pMemLoc pointer to beginning of TIFF memory buffer
nSize size of TIFF file in memory, in bytes
Returns:
the total number of pages

Implements DLBaseImage.

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

dlGetTotalPages returns the total number of pages in the document

Parameters:
filename name of file to be checked
Returns:
the total number of pages

Implements DLBaseImage.

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

Determines if an image file is in the TIFF format and is supported for loading by DLTIFFImage.

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

Implements DLBaseImage.

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

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

Parameters:
pMemLoc pointer to beginning of memory image buffer to be checked
size buffer size in bytes
Returns:
boolean: true if supported

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