NAME

     ilColorImg	- perform color	conversion

INHERITS FROM

     ilLink : ilImage :	ilCacheImg : ilMemCacheImg : ilMonadicImg : ilColorImg

HEADER FILE

     #include <il/ilColorImg.h>

CLASS DESCRIPTION

     ilColorImg	performs a color space conversion from any IL-supported	color
     model to the requested color model.  This class is	not normally used
     directly; instead,	the derived classes such as ilABGRImg and
     ilSGIPaletteImg can be used.

     For proper	operation, the input image's color model must be defined.
     Most image	file types automatically set the color model using information
     stored in the file	header.	 Operator images generally inherit their color
     model from	their input images, while other	image types compute a default
     color model based on the number of	channels in the	image.	If the default
     color model needs to changed, this	may be accomplished with the
     setColorModel() function defined by the ilImage base class.

     The color conversion process can also perform a pixel value scaling.  The
     parameters	to this	scaling	process	are defined by the minValue and
     maxValue members derived from the ilImage class.

     The scaling process is defined such that the minimum value	of the input
     maps to the minimum value of the output, and the maximum value of the
     input maps	to the maximum value of	the output (within the constraints of
     the conversion algorithm).	 This behavior may be configured using the
     following functions:

	  setRange(), resetRange()

     By	default	the output scaling range is inherited from the input image's
     minValue and maxValue members like	most operators.

     Conversion	algorithms

     See the manual pages of the derived classes for a description of the
     conversion	algorithms used	to convert to various color spaces.

CLASS MEMBER FUNCTION SUMMARY

     Constructor

	  ilColorImg(ilImage *img=NULL,	iflColorModel cm=iflRGB)

     Controlling the output range



	  void setRange(double outMin, double outMax)
	  void setScaleRange(double outMin, double outMax)
	  void resetRange()
	  void getRange(double&	outMin,	double&	outMax)

FUNCTION DESCRIPTIONS

     ilColorImg()

	  ilColorImg(ilImage *img=NULL,	iflColorModel cm=iflRGB)


	  Constructor for the class. The img parameter defines the input
	  image.  The cm parameter defines the initial color model to convert
	  to; this can be changed with the setColorModel() function.

     getRange()

	  void getRange(double&	outMin,	double&	outMax)


	  Returns the previously set range, or the inherited range if it is
	  not set.

     resetRange()

	  void resetRange()


	  Invalidates the current values of the	output range levels. If	ouput
	  levels are not set using the setRange() function, default values
	  will be inherited from the input.

     setRange()

	  void setRange(double outMin, double outMax)


	  The minimum output level is set to outMin and	the maximum output
	  level	is set to outMax.

     setScaleRange()

	  void setScaleRange(double outMin, double outMax)


	  The minimum and maximum output levels	are set	such that the minimum
	  and maximum scale levels are outMin and outMax, respectively,	while
	  maintaining the same proportionality of the input min/max values to
	  the input scale min/max values.

INHERITED MEMBER FUNCTIONS

   Inherited from ilMonadicImg
     calcPage(), getOffset(), getPage(), resetOp(), setOffset()
     ilMondadicImgGetOffset(), ilMondadicImgSetOffset()

   Inherited from ilOpImg
     checkMinMax(), clearClamp(), getBias(), getClamp(), getInputMax(),
     getInputMin(), getInputScaleMax(),	getInputScaleMin(), getValidOrders(),
     getValidTypes(), isClamped(), isDiff(), isPrecisionKept(),
     keepPrecision(), resetOp(), setBias(), setClamp(),	setMaxPageSize(),
     setMinPageSize(), setValidOrder(),	setValidType(),	setWorkingType()

   Inherited from ilMemCacheImg
     allocPage(), doUserPageAlloc(), enableMP(), executeRequest(),
     finishRequest(), freePage(), getGlobalThrashMode(), getMpRequest(),
     getPage(),	getPageAllocTime(), getPageTime(), getRetainMode(),
     getRetainPath(), getThrashMode(), getThrashTime(),	getTotalPageTime(),
     isMPenabled(), isUserPageAlloc(), prepareRequest(),
     setGlobalThrashMode(), setPage(), setPageAllocTime(), setRetainMode(),
     setRetainPath(), setThrashMode(),

   Inherited from ilCacheImg
     enablePagingCallback(), flush(), getCacheSize(),
     isPagingCallbackEnabled(),	listResident()

   Inherited from ilImage
     addInput(), allocFillData(), checkColorModel(), checkValidOrder(),
     checkValidType(), clipTile(), configureRetainedCache(), copy(),
     copyTile(), copyTile3D(), copyTileCfg(), fillTile(), fillTile3D(),
     fillTileRGB(), freeFillData(), getColorImg(), getColorModel(),
     getColormap(), getCompression(), getConfig(), getCopyConverter(),
     getCsize(), getDataType(),	getDimensions(), getDirectInput(),
     getDisplayCacheEnable(), getFill(), getFillData(),	getFillValue(),
     getHeight(), getHwEnable(), getHwHint(), getHwIntHint(), getHwOp(),
     getHwPassTable(), getInput(), getInputTileRequirement(),
     getLockTileSet(), getMaxColormapLevels(), getMaxValue(), getMinValue(),
     getNumChans(), getNumInputs(), getOrder(),	getOrientation(),
     getPageBorder(), getPageBorderX(),	getPageBorderY(), getPageBorderZ(),
     getPageCounts(), getPageDelta(), getPageDimensions(), getPageIndices(),
     getPageOrigin(), getPageOriginC(),	getPageOriginX(), getPageOriginY(),
     getPageOriginZ(), getPageSize(), getPageSizeC(), getPageSizePix(),
     getPageSizeVal(), getPageSizeX(), getPageSizeY(), getPageSizeZ(),
     getPixel(), getPixel3D(), getPriority(), getScaleMax(), getScaleMin(),
     getSize(),	getStrides(), getSubTile(), getSubTile3D(), getTile(),
     getTile3D(), getWidth(), getXsize(), getYsize(), getZsize(),
     hasPageBorder(), hasPages(), hwDefine(), hwGetPass(), inherit(),
     initColorModel(), initHwEnable(), initMinMax(), initPageSize(),
     initScaleMinMax(),	isColorImg(), isIntegral(), isMirrorOrientation(),
     isPartialPage(), isSigned(), isValidPage(), isWritable(), lockPage(),
     lockPageSet(), lockTile(),	lockTile3D(), mapFlipTrans(), mapFromInput(),
     mapFromSource(), mapOrientation(),	mapSize(), mapTile(), mapToInput(),
     mapToSource(), mapXY(), mapXYSign(), outOfBound(),	qCopyTileCfg(),
     qFillTile3D(), qFillTileRGB(), qGetSubTile3D(), qGetTile3D(),
     qLockPageSet(), qSetSubTile3D(), qSetTile3D(), removeHwHint(),
     removeInput(), reset(), setColorModel(), setColormap(), setCompression(),
     setCsize(), setDataType(),	setDisplayCacheEnable(), setFill(),
     setFillValue(), setHwEnable(), setHwHint(), setHwIntHint(), setInput(),
     setMaxColormapLevels(), setMaxValue(), setMinValue(), setNumChans(),
     setNumInputs(), setOrder(), setOrientation(), setPageBorder(),
     setPageSize(), setPageSizeC(), setPageSizeZ(), setPixel(),	setPixel3D(),
     setPriority(), setScaleMinMax(), setScaleType(), setSize(), setSubTile(),
     setSubTile3D(), setTile(),	setTile3D(), setTileRequirementFunction(),
     setWritable(), setXsize(),	setYsize(), setZsize(),	unlockPage(),
     unlockPageSet()

   Inherited from ilLink
     addResetCallback(), alterAction(),	anyAltered(), clearAllowed(),
     clearSet(), clearStatus(),	deleteRelated(), disableAltered(),
     dumpChain(), getClassPropSet(), getDescription(), getDirectParent(),
     getDisabledIndex(), getFloatProp(), getGenerationID(), getIntProp(),
     getMaxIndex(), getMinIndex(), getNumChildren(), getNumParents(),
     getParent(), getProp(), getProp(),	getPropSet(), getPtrProp(),
     getRelatedChild(),	getRelatedDelete(), getRelatedType(), getStatus(),
     hasResetCallbacks(), ilGetClassPropSet(), inProgress(), isAllowed(),
     isAltered(), isEnabled(), isRelated(), isSet(), markSet(),	mpUnlock(),
     neverReset(), newRelatedType(), removeParent(), removeProp(),
     removeResetCallback(), reset(), resetAltered(), resetCheck(),
     setAllowed(), setAltered(), setDescription(), setDisabledIndex(),
     setEnabled(), setParent(),	setProp(), setPropAltered(),
     setRelatedDelete(), setRelatedType(), setStatus(),	stopWatching(),
     unalterable(), watch(), watchNotify()

SEE ALSO

     ilABGRImg,	ilCacheImg, ilCMYKImg, ilColorImg, ilGrayImg, ilHSVImg,	ilIm-
     age, ilMonadicImg,	ilRGBImg, ilSGIPaletteImg