iflPPM(3)

NAME

iflPPM - PPM file format

HEADER FILE

#include <ifl/iflPPM.h>

DESCRIPTION

This IFL format provides support for reading and writing image files with the Portable Bitmap format (PPM). This file format is suitable for archiving multicolor and monochromatic image data. It includes the formats PPM, PGM, PBM, PNM, RPPM, RPGM, RPBM, and RPNM.

The default extensions for image files in the PPM format are '.pbm', '.pgm' and '.ppm', When you create a file with one of these extensions IFL will create an output file using this library. The actual format used will be determined not by the extension, but by the image attributes: 3 channels will create a PPM file, 1 channel will create either a PGM file or, if the data type is bit, a PBM file.

In addition to all the standard iflFile methods, this format supprts format specific operations via the getTag() and setTag() methods. The tag values supported by theses methods are enumerated in the following sections.

TAG VALUES FOR GET ITEM

The followng tag values are supported with getItem():

iflPPMwriteASCII
iflStatus getItem(iflPPMwriteASCII, int* on)

This function returns TRUE in 'on' if ASCII output is enabled; FALSE otherwise.

TAG VALUES FOR SET ITEM

The followng tag values are supported with setItem():

iflPPMwriteASCII
iflStatus setItem(iflPPMwriteASCII, int on)

This function can be used to enable ASCII output while writing a PPM file, by setting 'on' = TRUE.