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

VisualizeHeatmap_Old

Header:	AVL.h
Namespace:	avl
Module:	FoundationLite

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

Syntax

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

Parameters

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

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 inImage pixel format in VisualizeHeatmap_Old.