Appendix D. Summary of All Classes

This appendix lists all the classes that make up the IL. Each of these classes has its own reference page. Convenience functions that do not belong to any particular class are also listed here. These functions have reference pages as well.

Table D-1. Summary of All Classes

Class or Function

Description

iflBitArray

Provides a limited, subscriptable bit array

iflClassList

Creates a class inheritance chain.

iflColor

Defines a few convenience functions for obtaining info on color models.

iflColormap

Provides the base class for lookup tables.

iflConfig

Defines configuration of pixel data

iflConvIter

Provides an iterator for converters. It is used to step to the beginning of each row shared in common between two converters. The iterator also steps through the channels.

iflConverter

Handles type conversion and reorganization between arbitrary rectangular data buffers.

iflCoord

Contains structures to hold coordinates with arithmetic operations.

iflDataSize()

Manipulates the size of IL data types

iflDatabase

Describes the capabilities of a particular image file format.

iflDefs

Contains standard definitions required by the Image Format Library.

iflDictionary

Implements a dictionary of named elements

iflError

Contains error codes, error handling, and assertion macros used by the IFL library.

iflFile

Contains an abstraction of a handle to an image file.

iflFileConfig

Describes the configuration of an iflFile. It is used with the iflFile::create() calls to query file configurations.

iflFormat

Describes the capabilities of a particular image file format.

iflHashTable

Contains the base class from which hash table implementations can be derived.

iflList

Contains the base class for a simple doubly-linked list.

iflLut

Defines a lookup table.

iflMinMax

Contains the functions for performing minimum and maximum comparisons

iflOrientation

Transposes the orientation of an image's axis.

iflPixel

Defines a pixel.

iflSGIColormap()

Contains the functions that create or access color maps.

iflSize

Defines the size of an image.

iflTile

Defines a three-dimensional rectangle of image data.

iflTileIter

Cycles through the pages spanning a tile.

iflTypeNames

Provides a some convenience functions to get the ASCII string for some of the enumerated types used by IFL.

iflTypes

Defines the image data types, pixel component ordering, supported Color Models, supported orientations, supported compression schemes, and flip modes.

ilABGRImg

Converts to the ABGR color model.

ilAbsImg

Computes the pixelwise absolute value of an image.

ilAddImg

Computes the pixelwise addition of two images.

ilAndImg

Computes the pixelwise logical AND of two images.

ilArena

Defines an area of CPU memory shared by multiple threads.

ilArenaItem

Creates a shared memory version of your favorite objects.

ilArenaSem

Provides an interface to the user mode semaphore services.

ilArenaSmallBitArray

Provides a shared memory version of the ilSmallBitArray class.

ilArenaSpin

Provides an interface to the user mode spin lock services.

ilArithLutImg

Performs a generalized arithmetic operation using a look-up table.

ilArrayAlloc

Allocates memory for arrays.

ilAtomicOps

Provides inline functions to define some useful atomic operations. This header file is mainly intended to ease portability of code using these operations.

ilBGRImg

Converts to the BGR color model.

ilBitMapRoi

Defines a bitmap-based region of interest (ROI).

ilBlendImg

Blends images.

ilBlurImg

Blurs an image.

ilBoundingBox

Accumulate 2D bounding box of a set of points.

ilBuffer

Provides a four-dimensional resizable buffer.

ilCMYKImg

Converts to the CMYK color model.

ilCache

Implements the new and delete operators to allow objects of derived classes to be cached. This can be used to minimize calls to malloc() and free() for objects that are frequently constructed and destroyed.

ilCacheImg

Implements image data caching.

ilCallback

Implements callback method which is a abstraction of a pointer-to-function parameter.

ilChromaKeyImg

Compares each input pixel against a statistical measure of the “background”. If the pixel is close enough to the mean value of the background it is marked as being in the background.

ilColorConv

Converts between color models.

ilColorImg

Converts to the ABGR color model.

ilCombineImg

Combines two images controlled by an ROI.

ilCompassImg

Performs a directional gradient transform of an image.

ilConfigure

Contains routines to configure the IL environment.

ilConstImg

Defines a constant-valued image.

ilConvImg

Performs general image convolution.

ilConvPixel

Converts a pixel to different color models.

ilDilateImg

Performs morphological dilation on an image.

ilDisplay

Manages the display of images in an X window.

ilDisplayDefs

Defines various binary flags common to ilDisplay and ilView. Many display operators take a mode parameter that is the bitwise OR of one or more of these flags (e.g. mode = ilCenter | ilDefer).

ilDisplayMgr

Handles cleanup of ilViewCbArg. Created for ilView callbacks.

ilDivImg

Computes pixelwise division of two images

ilDyadicImg

Provides basic support for dual-input operators

ilELTImg

Implements the functions needed for Electronic Light Table applications.

ilELTRoamer

Supports roaming look-ahead and zooming look-ahead for ELT applications.

ilELTrset

Encapsulates all information related to an R-set.

ilEnviron

Provides support for environment variables.

ilErodeImg

Performs a morphological erosion on an image.

ilExpImg

Performs pixelwise exponentiation of an image.

ilFConjImg

Computes the conjugate of a Fourier image and normalizes the complex value by a real factor.

ilFCrCorrImg

Computes the cross-correlation of two Fourier images.

ilFDivImg

Divides two Fourier images.

ilFDyadicImg

Provides basic support for dual-input Fourier operators.

ilFExpFiltImg

Applies an exponential Fourier filter to a Fourier image.

ilFFiltImg

Provides basic support for Fourier filter operators.

ilFFTOp

Performs a forward, inverse, or average fast Fourier transform of an image.

ilFFiltImg

Provides the base class for frequency filters.

ilFGaussFiltImg

Applies a Gaussian Fourier filter to a Fourier image.

ilFileFormat

Registers supported image file formats.

ilFileImg

Provides basic support for image files.

ilFMagImg

Computes the magnitude values of a Fourier image.

ilFMergeImg

Merges magnitude and phase images into a Fourier image.

ilFMonadicImg

Provides basic support for single-input Fourier operators.

ilFMultImg

Multiplies two Fourier images.

ilFPhaseImg

Computes the phase values of a Fourier image.

ilFPolarImg

Provides the base class for single input fourier operators.

ilFPolyadicImg

Provides the base class for multiple input fourier operators.

ilFRaisePwrImg

Raises the magnitude values of a Fourier image by a power.

ilFSpectImg

Computes the spectrum of a Fourier image.

ilFalseColorImg

Performs false coloring of multispectral images.

ilFrameBufferImg

Provides the basis for IL access to frame buffer memory. IL maintains internal Display* and GL contexts to isolate its rendering from the user's code.

ilFsDitherer

Allocates and returns an optimized color map.

ilGBlurImg

Performs a two-dimensional Gaussian blur of an image.

ilGrayImg

Converts to the gray-scale color model.

ilHistEqImg

Performs histogram equalization of an image.

ilHistLutImg

Provides the base class for operators that compute a lookup table based on a histogram.

ilHistNormImg

Performs histogram normalization of an image.

ilHistScaleImg

Performs histogram scaling of an image.

ilHSVImg

Converts to the HSV color model.

ilHSVconverter

Converts HSV to RGB file format.

ilHwConnection

Provides private connections to the display server and serves as a graphics hardware capability query mechanism.

ilHwContext

Provides the foundation for all of IL's rendering to graphics hardware.

ilHwDefs

Defines some types and enums for hardware acceleration.

ilHwManager

Provides the base class for various types of hardware accelerated rendering. This header file includes a couple of miscellaneous managers for fillTile and qBarrier operators.

ilHwManagerGL

Implements those rendering operations that can be accomplished with the OpenGL drawPixels function.

ilHwMgrELT

Provides the ilMpManager for Electronic Light Table applications.

ilHwPass

Encodes the hardware acceleration for an ilImage (or an ilImgStat).

ilHwPassELT

Implements hardware acceleration for the ELT application.

ilHwPassGL

Implements hardware acceleration in OpenGL.

ilHwTexture

Represents a single GL texture.

ilImage

Provides basic support for images.

ilImgRoi

Defines the image-mapped Roi class.

ilImgStat

Computes the histogram, minimum, maximum, mean, and standard deviation of an image.

ilIndexableList

Provides an indexable linked list.

ilIndexableStack

Manages an indexable list as a stack.

ilInvertImg

Performs one's complement of an image.

ilKernel

Defines kernels.

ilLaplaceImg

Performs edge detection using Laplacian kernels.

ilLink

Provides chaining and setting attributes.

ilLinkIter

Provides an iterator for ilLink.

ilLockPageCache

Manages a toroidal cache of lock requests on an image.

ilLogImg

Computes the pixelwise logarithm of an image.

ilLutImg

Translates an image using a lookup table.

ilMachDep

Provides definitions and typedefs used to detect machine dependencies and compensate for them to ease the difficulty of porting the IL to other platforms.

ilMath

Facilitates the mod operation for integer types.

ilMatrix

Defines matrices.

ilMaxFltImg

Performs max filtering of an image

ilMaxImg

Computes the pixelwise maximum of two images

ilMedFltImg

Performs median filtering of an image

ilMemCacheImg

Implements data caching in main memory.

ilMemoryImg

Defines an image array resident in memory.

ilMergeImg

Merges several images into one.

ilMinFltImg

Performs minimum filtering of an image.

ilMinImg

Computes the pixelwise minimum of two images.

ilMonadicImg

Provides basic support for single-input operators.

ilMpLock

Provides an encapsulated version of ilSpinLock with a different API that is more suitable for deriving from, for example, to make a lockable list.

ilMpManager

Provides a generalized method to execute work in parallel using a configurable number of threads created with sproc.

ilMpPool

Manages a shared pool of resources, for example, buffers. Groups of requests can acquire a particular resource or get queued until the resource becomes available.

ilMpQueue

Provides an abstract API for queueing ilMpRequest's to be executed by ilMpThread::run().

ilMpThread

Implements the abstraction of an execution thread created with sproc.

ilMultiplyImg

Computes the pixelwise multiplication of two images.

ilNegImg

Performs two's complement of an image.

ilNopImg

Provides caching on non-cached images.

ilOpImg

Provides basic support for operators.

ilOrImg

Computes a pixelwise logical OR of two images.

ilPage

Defines a page of image data in a cache.

ilPager

Implements a page table and manages an image cache.

ilPCDImg

Provides support for the Kodak Photo CD image pack file format class.

ilPerspWarp

Manages a perspective warp.

ilPiecewiseImg

Performs a linear mapping of lookup table images.

ilPixelBufferFrag

Provides support to hardware managers for allocating, locking, and drawing to pbuffer memory.

ilPixelBufferImg

Implements the ilImage model for images whose data resides in off-screen frame buffer memory, that is, GL p-buffers.

ilPixelCacheImg

Implements the ilImage model for images whose
data resides in off-screen frame buffer memory, that
is, GL p-buffers.

ilPolyDef

Defines some structures and methods for polynomials.

ilPolyWarp

Specifies a two-dimensional seventh-order polynomial warp.

ilPolyWarpImg

Performs a two-dimensional seventh-order warp.

ilPolyadicImg

Provides the base class for N-input operators.

ilPool

Implements a pooled memory allocation scheme with facilities for compaction and reclamation of free space.

ilPowerImg

Raises image data to a specified power.

ilPriorityList

Lists items sorted by priority.

ilPropSet

Creates a collection of properties.

ilRankFltImg

Performs two-dimensional rank filtering on an image

ilRectRoi

Defines a rectangular region of interest (ROI).

ilRFFTfImg

Performs a real forward fast Fourier transform.

ilRFFTiImg

Performs a real inverse fast Fourier transform.

ilRGBImg

Converts to the RGB color model.

ilRobertsImg

Performs edge detection using Roberts kernels.

ilRoi

Defines an ROI.

ilRoiImg

Associates an ROI with an image.

ilRoiIter

Cycles through run lengths in an ROI.

ilRotZoomImg

Rotates, zooms, and flips an image.

ilSaturateImg

Performs color saturation of an image.

ilScale

Implements simple linear scaling operations, for example: f(x) = ax + b.

ilScaleImg

Performs a linear scaling of an image.

ilSemaphore

Limits the number of process threads that can access a shared data structure.

ilSepConvImg

Performs an image convolution using a separable kernel.

ilSepKernel

Manages a separable kernel. A separable kernel is one that can be separated into independent X and Y components to optimize computation.

ilSGIPaletteImg

Converts to the RGB Palette color model.

ilSharpenImg

Sharpens an image.

ilSmallBitArray

Defines a bit array.

ilSobelImg

Performs edge detection using Sobel kernels.

ilSpace

Contains a list of IL to IFL compatibility #defines.

ilSpatialImg

Provides basic support for spatial operators.

ilSpinLock

Manages spinlock services.

ilSqRootImg

Computes the pixelwise square root of an image.

ilSquareImg

Computes the pixelwise square of an image.

ilStackAlloc

Provides a wrapper for alloca.

ilStackBuffer

Provides a four-dimensional, resizable buffer with better performance than an ilBuffer.

ilStereoView

Associates a stereo view (two images) with a region in an ilDisplayImg.

ilSubImg

Defines a rectangular portion of an image as an independent image.

ilSubtractImg

Computes the pixelwise subtraction of two images.

ilSwitchImg

Implements a switch construct in an image operator chain.

ilTOTAL

Implements the user interface portion of the interface builder. Normally, it is not used directly. Instead the subclass, FmtAttForm is instantiated.

ilTexImg

Implements a paged image stored in texture memory.

ilThread

Manages a shared group of processes.

ilThreshImg

Applies a threshold to an image.

ilTiePointList

Manages a list of tie points.

ilTieWarpImg

Warps an image by specifying tie points.

ilTIFFImg

Creates an image file in the TIFF format.

ilTileImgIter

Cycles through the pages spanning a tile.

ilTimeoutTimer

Provides a simple and efficient means of implementing a timeout period for a polling loop.

ilTimer

Provides an interface to the high-resolution interval timer. On most SGI machines, this timer has a resolution of 1 usec or better.

ilVector

Provides a resizable Vector class.

ilVectorUtil

Provides vector utility routines.

ilView

Associates an image with a region in an ilDisplayImg.

ilViewCallback

Provides easy access to view state information as well as other information needed for graphics callbacks.

ilViewer

Handles standard operations on ilDisplay objects triggered by X events.

ilViewIter

Iterates through ilDisplay's view stack.

ilWarp

Provides an abstract base class used to define 3D warp functions.

ilWarp3Img

Derives from ilWarpImg and defines addrGen() to evaluate a 3rd order polynomial.

ilWarpImg

Provides basic support for warping an image.

ilWarpRoamer

Provides an object that roams a warped image.

ilXDisplayImg

Defines an image that exists in the frame buffer.

ilXImage

Translates between an XImage and an ilImage.

ilXWindowImg

Manages an IL interface to X Windows. IL maintains internal ilDisplay and GL contexts to isolate rendering from user code.

ilXorImg

Computes the pixelwise exclusive-OR of two images.

ilYCCconverter

Provides a YCC/RGB conversion object.