You are here: Start » FIL.NET » Function Reference » Image » Image Point Transforms » FIL.ColorizeImage
Shows a monochromatic image in false colors.
Namespace: | FilNet |
---|---|
Assembly: | FIL.NET.dll |
Syntax
public static void ColorizeImage ( FilNet.ColorizeImageState ioState, FilNet.Image inImage, NullableRef<FilNet.Region> inRoi, FilNet.ColorPalette inPalette, bool inNegate, int? inMinValue, int? inMaxValue, FilNet.Image outImage )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
ioState | FilNet.ColorizeImageState | ||||
![]() | inImage | FilNet.Image | Input image. | ||
![]() | inRoi | FilNet.NullableRef<FilNet.Region> | Range of pixels to be processed. Default value: ftl::NIL. | ||
![]() | inPalette | FilNet.ColorPalette | Iron | Palette of colors which is used to replace pixels. Default value: Iron. | |
![]() | inNegate | bool | Reversing palette colors. | ||
![]() | inMinValue | int? | 0 | Minimal value of pixel that will be replaced by color from palette, otherwise first color from palette will be set. Default value: 0. | |
![]() | inMaxValue | int? | 255 | Maximal value of pixel that will be replaced by color from palette, otherwise last color from palette will be set. Default value: 255. | |
![]() | outImage | FilNet.Image | Output image. |
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.
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.
Hardware acceleration settings may be manipulated with Settings class.
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. |
Function Overrides
- ColorizeImage(ColorizeImageState, Image, ColorPalette, Boolean, Nullable<Int32>, Nullable<Int32>, Image)
- ColorizeImage(ColorizeImageState, Image, NullableRef<Region>, ColorPalette, Boolean, Nullable<Int32>, Nullable<Int32>, Image, Image)