Back to FabImage Library website

You are here: Start » Function Reference » Image » Image Drawing » VisualizeHeatmap_Old

VisualizeHeatmap_Old


Header: FIL.h
Namespace: fil
Module: FoundationLite

Colorizes a heat-map and blends it with a background image.

Syntax

C++
C#
 
void fil::VisualizeHeatmap_Old
(
	fil::ColorizeImageState& ioState,
	const fil::Image& inImage,
	const fil::Image& inHeatmap,
	const fil::ColorPalette::Type& inPalette,
	int inThreshold,
	ftl::Optional<int> inFuzziness,
	ftl::Optional<int> inMinValue,
	ftl::Optional<int> inMaxValue,
	bool inForceMono,
	fil::Image& outImage,
	fil::Image& diagPalette
)

Parameters

Name Type Range Default Description
Input will be modified ioState ColorizeImageState& Object used to maintain state of the function.
Input value inImage const Image& Input image
Input value inHeatmap const Image& Confidence of defect at each pixel
Input value inPalette const ColorPalette::Type& BlackYellowRed
Input value inThreshold int 0 - 255 64 Minimum defect confidence for choosing more of heat-map color than of input image color
Input value inFuzziness Optional<int> 0 - 0 Confidence distance from inThreshold within which heat-map colors and input image colors are linearly interpolated; Auto = INF
Input value inMinValue Optional<int> 0
Input value inMaxValue Optional<int> 255
Input value inForceMono bool Converts input image to monochromatic
Output value outImage Image& Output image
Diagnostic input diagPalette Image& Used palette preview

Requirements

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

For input inHeatmap only pixel formats are supported: 1⨯uint8.

Read more about pixel formats in Image documentation.

Hardware Acceleration

This operation supports automatic parallelization for multicore and multiprocessor systems.

Errors

List of possible exceptions:

Error type Description
DomainError Image sizes are not equal in VisualizeHeatmap_Old.
DomainError Input heatmap must have 1xUInt8 format in VisualizeHeatmap_Old.
DomainError Input image must have UInt8 or UInt16 pixel format in VisualizeHeatmap_Old.
DomainError Not supported inHeatmap pixel format in VisualizeHeatmap_Old. Supported formats: 1xUInt8.
DomainError Not supported inImage pixel format in VisualizeHeatmap_Old. Supported formats: 1xUInt8, 1xUInt16, 2xUInt8, 2xUInt16, 3xUInt8, 3xUInt16, 4xUInt8, 4xUInt16.