Back to Adaptive Vision Library website
You are here: Start » Function Reference » Image Combinators » VisualizeHeatMap
Colorizes heat-map and blends it with background image
Header: | AVL.h |
---|
Syntax
C++
C#
void avl::VisualizeHeatMap ( 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: 1xuint8, 1xuint16, 2xuint8, 2xuint16, 3xuint8, 3xuint16, 4xuint8, 4xuint16.
For input inHeatMap only pixel formats are supported: 1xuint8.
Read more about pixel formats in Image documentation.
Hardware Acceleration
This operation supports automatic parallelization for multicore and multiprocessor systems.
Errors
Error type | Description |
---|---|
DomainError | Image sizes are not equal in VisualizeHeatMap. |
DomainError | Input heatmap must have 1xUInt8 format in VisualizeHeatMap. |
DomainError | Input image must have UInt8 or UInt16 pixel format in VisualizeHeatMap. |