VIPER REFERENCE MANUAL


NAME
iflDataTypeName, iflOrientationName, iflOrderName, iflColorModelName, iflCompressionName - conversion of IFL enumerated types to strings

HEADER FILE
#include <ifl/iflTypeNames.h>

SYNOPSIS
extern "C" char* iflDataTypeName ( iflDataType type);
extern "C" char* iflOrientationName ( iflOrientation orientation);
extern "C" char* iflOrderName ( iflOrder order);
extern "C" char* iflColorModelName ( iflColorModel cm);
extern "C" char* iflCompressionName ( iflCompression compress);

DESCRIPTION
These functions operate on various IFL enumerated type values and are provided for convenience. Each function is stand-alone and is not a member function of any object. The enumerated types used in the IFL are defined in <ifl/iflTypes.h>. Any values beyond those defined in the header file will be translated as "unknown".

FUNCTION DESCRIPTIONS

   iflColorModelName()
extern "C" char* iflColorModelName ( iflColorModel cm);

This function translates an iflColorModel value to it's string equivalent. The IFL color models will be translated as follows:

Value Translation
iflNegative "greyscale, minimum value white"
iflLuminance "greyscale"
iflLuminanceAlpha "greyscale with alpha"
iflRGB "RGB"
iflRGBA "RGBA"
iflRGBPalette "color index"
iflHSV "HSV"
iflCMY "CMY"
iflCMYK "CMYK"
iflBGR "BGR"
iflABGR "ABGR"
iflMultiSpectral "multi-spectral"
iflYCC "YCC"

   iflCompressionName()
extern "C" char* iflCompressionName ( iflCompression compress);

TThis function translates an iflCompression value to it's string equivalent. The IFL compressions will be translated as follows:

Value Translation
iflNoCompression "none"
iflCCITTFAX3 "CCITT Group 3"
iflCCITTFAX4 "CCITT Group 4"
iflLZW "Lempel-Ziv & Welch"
iflPACKBITS "Mac-RLE"
iflSGIRLE "SGI-RLE"
iflJPEG "JPEG"
iflZIP "ZIP deflate/inflate"

   iflDataTypeName()
extern "C" char* iflDataTypeName ( iflDataType type);

This function translates an iflDataType value to it's string equivalent. The IFL data types will be translated as follows:

Value Translation
iflBit "bit"
iflUChar "unsigned char"
iflChar "char"
iflUShort "unsigned short"
iflShort "short"
iflUInt "unsigned integer"
iflInt "integer"
iflFloat "float"
iflDouble "double"

   iflOrderName()
extern "C" char* iflOrderName ( iflOrder order);

This function translates an iflOrder value to it's string equivalent. The IFL orders will be translated as follows:

Value Translation
iflInterleaved "interleaved"
iflSequential "sequential"
iflSeparate "separate"

   iflOrientationName()
extern "C" char* iflOrientationName ( iflOrientation orientation);

This function translates an iflOrientation value to it's string equivalent. The IFL orientations will be translated as follows:

Value Translation
iflUpperLeftOrigin "upper-left"
iflUpperRightOrigin "upper-right"
iflLowerRightOrigin "lower-right"
iflLowerLeftOrigin "lower-left"
iflLeftUpperOrigin "left-upper"
iflRightUpperOrigin "right-upper"
iflRightLowerOrigin "right-lower"
iflLeftLowerOrigin "left-lower"