MakeHeatmap

Header:	AVL.h
Namespace:	avl

Creates a new Heatmap object.

Syntax

void avl::MakeHeatmap
(
	const avl::Image& inImage,
	const int inHeatmapLowerThreshold,
	const int inHeatmapMiddleThreshold,
	const int inHeatmapUpperThreshold,
	avl::Heatmap& outHeatmap
)

Parameters

Name	Type	Range	Default	Description
inImage	const Image&			Input image
inHeatmapLowerThreshold	const int	0 -	0
inHeatmapMiddleThreshold	const int	0 -	127
inHeatmapUpperThreshold	const int	0 -	255
outHeatmap	Heatmap&

Requirements

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

Read more about pixel formats in Image documentation.

Errors

List of possible exceptions:

Error type	Description
DomainError	inHeatmapLowerThreshold is greater than inHeatmapUpperThreshold in MakeHeatmap
DomainError	inHeatmapMiddleThreshold is bigger than inHeatmapUpperThreshold in MakeHeatmap
DomainError	inHeatmapMiddleThreshold is lower than inHeatmapLowerThreshold in MakeHeatmap
DomainError	Not supported inImage pixel format in MakeHeatmap.