Back to FabImage Library website

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

MakeHeatmap


Header: FIL.h
Namespace: fil
Module: FoundationLite

Creates a new Heatmap object.

Syntax

C++
C#
 
void fil::MakeHeatmap
(
	const fil::Image& inImage,
	const int inHeatmapLowerThreshold,
	const int inHeatmapMiddleThreshold,
	const int inHeatmapUpperThreshold,
	fil::Heatmap& outHeatmap
)

Parameters

Name Type Range Default Description
Input value inImage const Image& Input image
Input value inHeatmapLowerThreshold const int 0 - 0
Input value inHeatmapMiddleThreshold const int 0 - 127
Input value inHeatmapUpperThreshold const int 0 - 255
Output value 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. Supported formats: 1xUInt8.