ImageUtilityHeatmap Class Reference

Static functions to create heatmap images from image objects of pixel format Mono8 and Mono16. More...

#include <ImageUtilityHeatmap.h>

Static Public Member Functions
static ImagePtr	CreateHeatmap (const ImagePtr &srcImage)
	Computes a heatmap image.
static ImagePtr	CreateHeatmap (const ImagePtr &srcImage, const float min, const float max, const HeatmapColor lowColor, const HeatmapColor highColor, const bool doCheckInvalidVal, const unsigned int invalidVal)
	Computes a heatmap image considering custom min and max image data value.
static void	CreateHeatmap (const ImagePtr &srcImage, ImagePtr &destImage)
	Computes a heatmap image.
static void	SetHeatmapColorGradient (const HeatmapColor newLowColor, const HeatmapColor newHighColor)
	Sets the heatmap gradient color vector to the new desired range between HEATMAP_BLACK and HEATMAP_WHITE.
static void	GetHeatmapColorGradient (HeatmapColor &currentLowColor, HeatmapColor &currentHighColor)
	Returns the current heatmap gradient color range.
static void	SetHeatmapRange (const unsigned int newLowValue, const unsigned int newHighValue)
	Sets the high and low values used to determine which grayscale values are converted to a color 'heatmap' representation.
static void	GetHeatmapRange (unsigned int &currentLowValue, unsigned int &currentHighValue)
	Returns the current high and low values used in heatmap representations.

Detailed Description

Static functions to create heatmap images from image objects of pixel format Mono8 and Mono16.

Member Function Documentation

CreateHeatmap() [1/3]

static ImagePtr CreateHeatmap ( const ImagePtr &  srcImage )

static

Computes a heatmap image.

A heatmap image reinterprets monochrome data by mapping the luminosity of each pixel to a color value defined in the heatmap color gradient. The created image can be modified by changing the color gradient and heatmap range from the accompanying functions. The source image is required to be Mono8 or Mono16 pixel format.

Parameters

srcImage

The source image from which to create the heatmap

See also

SetHeatmapRange()

SetHeatmapColorGradient()

Returns

The heatmap image

CreateHeatmap() [2/3]

static ImagePtr CreateHeatmap ( const ImagePtr &  srcImage, const float  min, const float  max, const HeatmapColor  lowColor, const HeatmapColor  highColor, const bool  doCheckInvalidVal, const unsigned int  invalidVal  )

static

Computes a heatmap image considering custom min and max image data value.

A heatmap image reinterprets monochrome data by mapping the luminosity of each pixel to a color value defined in the heatmap color gradient. The created image can be modified by changing the color gradient and heatmap range from the accompanying functions. The source image is required to be Mono8 or Mono16 pixel format.

Parameters

srcImage	The source image from which to create the heatmap
min	The min image value to map to the heatmap low color
max	The max image value to map to the heatmap high color
newLowColor	New color at which to begin the gradient.
newHighColor	New color at which to end the gradient.
doCheckInvalidVal	Indication if to check for invalid values
invalidVal	The invalid value. heatmap will be color coded with specific color to indicate invalid pixels

See also

SetHeatmapRange()

SetHeatmapColorGradient()

Returns

The heatmap image

CreateHeatmap() [3/3]

static void CreateHeatmap ( const ImagePtr &  srcImage, ImagePtr &  destImage  )

static

Computes a heatmap image.

A heatmap image reinterprets monochrome data by mapping the luminosity of each pixel to a color value defined in the heatmap color gradient. The created image can be modified by changing the color gradient and heatmap range from the accompanying functions. The source image is required to be Mono8 or Mono16 pixel format. The destination is required to be initialized, RGB8 or RGB16 pixel format, and have the same width, height, x offset, and y offset as the source image.

Parameters

srcImage	The source image from which to create the heatmap
destImage	The destination image in which to store the created heatmap

See also

SetHeatmapRange()

SetHeatmapColorGradient()

GetHeatmapColorGradient()

static void GetHeatmapColorGradient ( HeatmapColor &  currentLowColor, HeatmapColor &  currentHighColor  )

static

Returns the current heatmap gradient color range.

Parameters

currentLowColor	Current color at which the gradient begins.
currentHighColor	Current color at which the gradient ends.

See also

SetHeatmapColorGradient()

GetHeatmapRange()

static void GetHeatmapRange ( unsigned int &  currentLowValue, unsigned int &  currentHighValue  )

static

Returns the current high and low values used in heatmap representations.

Parameters

currentLowValue	Current value at which color representation begins.
currentHighValue	Current value at which color representation ends.

See also

SetHeatmapRange()

SetHeatmapColorGradient()

static void SetHeatmapColorGradient ( const HeatmapColor  newLowColor, const HeatmapColor  newHighColor  )

static

Sets the heatmap gradient color vector to the new desired range between HEATMAP_BLACK and HEATMAP_WHITE.

Parameters

newLowColor	New color at which to begin the gradient.
newHighColor	New color at which to end the gradient.

SetHeatmapRange()

static void SetHeatmapRange ( const unsigned int  newLowValue, const unsigned int  newHighValue  )

static

Sets the high and low values used to determine which grayscale values are converted to a color 'heatmap' representation.

Acceptable values range from 0 to 100.

Parameters

newLowValue	New value at which to begin color representation.
newHighValue	New value at which to end color representation.

---

The documentation for this class was generated from the following file:

• include/ImageUtilityHeatmap.h