Back to FabImage Library website

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

VisualizeHeatmap


Header: FIL.h
Namespace: fil
Module: FoundationLite

Colorizes heat-map and blends it with background image.

Syntax

C++
C#
 
void fil::VisualizeHeatmap
(
	ftl::Optional<const fil::Image&> inImage,
	const fil::Heatmap& inHeatmap,
	const fil::ColorPalette::Type& inPalette,
	ftl::Optional<float> inPercentFuzziness,
	bool inForceMono,
	bool inThreshold,
	fil::Image& outImage,
	fil::Image& diagPalette
)

Parameters

Name Type Range Default Description
Input value
 inImage Optional<const Image&> NIL Input image
Input value
 inHeatmap const Heatmap& Confidence of defect at each pixel
Input value
 inPalette const ColorPalette::Type& GreenYellowRed
Input value
 inPercentFuzziness Optional<float> 0.0 - 0.0f
Input value
 inForceMono bool Converts input image to monochromatic
Input value
 inThreshold bool Remove all values lower than value of minimal threshold.
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 Not supported inHeatmap pixel format in VisualizeHeatmap. Supported formats: 1xUInt8.
DomainError Not supported inImage pixel format in VisualizeHeatmap. Supported formats: 1xUInt8, 1xUInt16, 2xUInt8, 2xUInt16, 3xUInt8, 3xUInt16, 4xUInt8, 4xUInt16.