You are here: Start » Function Reference » Image » Image Point Transforms » ColorizeImage

ColorizeImage

Header:	FIL.h
Namespace:	fil
Module:	FoundationLite

Shows a monochromatic image in false colors.

Syntax

void fil::ColorizeImage
(
	ColorizeImageState& ioState,
	const fil::Image& inImage,
	ftl::Optional<const fil::Region&> inRoi,
	fil::ColorPalette::Type inPalette,
	bool inNegate,
	ftl::Optional<int> inMinValue,
	ftl::Optional<int> inMaxValue,
	fil::Image& outImage,
	fil::Image& diagPalette
)

Parameters

Name	Type	Default	Description
ioState	ColorizeImageState&		Object used to maintain state of the function.
inImage	const Image&		Input image
inRoi	Optional<const Region&>	NIL	Range of pixels to be processed
inPalette	ColorPalette::Type	Iron	Palette of colors which is used to replace pixels
inNegate	bool		Reversing palette colors
inMinValue	Optional<int>	0	Minimal value of pixel that will be replaced by color from palette, otherwise first color from palette will be set
inMaxValue	Optional<int>	255	Maximal value of pixel that will be replaced by color from palette, otherwise last color from palette will be set
outImage	Image&		Output image
diagPalette	Image&		Used palette preview

Requirements

For input inImage only pixel formats are supported: 1⨯uint8, 1⨯uint16.

Read more about pixel formats in Image documentation.

Description

This filter is especially useful for visualization purposes. Hue and RedBlue pallets are useful for scientific visualization and the Iron palette is prepared for showing infrared images in thermo-graphic appliances.

Parameters inMinValue and inMaxValue defines the scale that should be applied to image pixels. Pixels outside this range are reduced to minimal or maximal value in range.

If parameters inMinValue or inMaxValue is set to Auto the filter will find the maximal or minimal pixel value.

This filter works only with single channel images.

Hints

Consider resizing image to smaller format if image does not require to contain details.
This filter can be used to show differences between object and background noises.

Examples

The ColorizeImage performed on the result of TestImage with inPalette set to Iron.

Remarks

Filter pre-computes after changing its parameter which can affect the filter's execution speed. Try to avoid changing filter's parameter during program execution.

Hardware Acceleration

This operation supports automatic parallelization for multicore and multiprocessor systems.

Errors

List of possible exceptions:

Error type	Description
DomainError	inMinValue is greater than inMaxValue in ColorizeImage.
DomainError	Input image must have 1xUInt8 or 1xUInt16 format in ColorizeImage.
DomainError	Region exceeds an input image in ColorizeImage.
DomainError	Not supported inImage pixel format in ColorizeImage. Supported formats: 1xUInt8, 1xUInt16.