Class Spinnaker::ImageUtilityHeatmap¶

ClassList > Spinnaker > ImageUtilityHeatmap

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

#include <ImageUtilityHeatmap.h>

Public Static Functions¶

Type	Name
ImagePtr	CreateHeatmap (const ImagePtr & srcImage)
void	CreateHeatmap (const ImagePtr & srcImage, ImagePtr & destImage)
ImagePtr	CreateHeatmap (const ImagePtr & srcImage, const float minPixelValue, const float maxPixelValue, const HeatmapColor lowColor, const HeatmapColor highColor, const bool doCheckInvalidVal, const unsigned int invalidVal)
void	CreateHeatmap (const ImagePtr & srcImage, ImagePtr & destImage, const float minPixelValue, const float maxPixelValue, const HeatmapColor lowColor, const HeatmapColor highColor, const bool doCheckInvalidVal, const unsigned int invalidVal)
void	GetHeatmapColorGradient (HeatmapColor & currentLowColor, HeatmapColor & currentHighColor)
void	GetHeatmapRange (unsigned int & currentLowValue, unsigned int & currentHighValue)
void	SetHeatmapColorGradient (const HeatmapColor newLowColor, const HeatmapColor newHighColor)
void	SetHeatmapRange (const unsigned int newLowValue, const unsigned int newHighValue)

Public Static Functions Documentation¶

function CreateHeatmap [1/4]¶

static ImagePtr Spinnaker::ImageUtilityHeatmap::CreateHeatmap (
    const ImagePtr & srcImage
)

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 single channel 8bit, 16bit or 32bit floating point pixel format.

Parameters:

srcImage The source image from which to create the heatmap

See also: SetHeatmapRange()

See also: SetHeatmapColorGradient()

Returns:

The heatmap image

function CreateHeatmap [2/4]¶

static void Spinnaker::ImageUtilityHeatmap::CreateHeatmap (
    const ImagePtr & srcImage,
    ImagePtr & destImage
)

Computes a heatmap image. Resulting heatmap data is stored in the provided destImage object. 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 single channel 8bit, 16bit or 32bit floating point pixel format.

The destination is required to be initialized with RGB8, RGB16 or RGB32f 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()

See also: SetHeatmapColorGradient()

function CreateHeatmap [3/4]¶

static ImagePtr Spinnaker::ImageUtilityHeatmap::CreateHeatmap (
    const ImagePtr & srcImage,
    const float minPixelValue,
    const float maxPixelValue,
    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. 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 single channel 8bit, 16bit or 32bit floating point pixel format.

Parameters:

srcImage The source image from which to create the heatmap
minPixelValue The minimum image value to map to the heatmap low color
maxPixelValue The maximum 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()

See also: SetHeatmapColorGradient()

Returns:

The heatmap image

function CreateHeatmap [4/4]¶

static void Spinnaker::ImageUtilityHeatmap::CreateHeatmap (
    const ImagePtr & srcImage,
    ImagePtr & destImage,
    const float minPixelValue,
    const float maxPixelValue,
    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. Resulting heatmap data is stored in the provided destImage object. 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 single channel 8bit, 16bit or 32bit floating point pixel format.

The destination is required to be initialized with RGB8, RGB16 or RGB32f 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
minPixelValue The minimum image value to map to the heatmap low color
maxPixelValue The maximum 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()

See also: SetHeatmapColorGradient()

function GetHeatmapColorGradient¶

static void Spinnaker::ImageUtilityHeatmap::GetHeatmapColorGradient (
    HeatmapColor & currentLowColor,
    HeatmapColor & currentHighColor
)

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()

function GetHeatmapRange¶

static void Spinnaker::ImageUtilityHeatmap::GetHeatmapRange (
    unsigned int & currentLowValue,
    unsigned int & currentHighValue
)

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()

function SetHeatmapColorGradient¶

static void Spinnaker::ImageUtilityHeatmap::SetHeatmapColorGradient (
    const HeatmapColor newLowColor,
    const HeatmapColor newHighColor
)

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.

function SetHeatmapRange¶

static void Spinnaker::ImageUtilityHeatmap::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. 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 C:/workspace/include/ImageUtilityHeatmap.h