Class SpinnakerNET::ManagedImageUtilityHeatmap¶

ClassList > SpinnakerNET > ManagedImageUtilityHeatmap

Helper functions for managed image objects of pixel format Mono8 and Mono16.

#include <ManagedImageUtilityHeatMap.h>

Public Static Functions¶

Type	Name
IManagedImage	CreateHeatmap (IManagedImage^ srcImage)
void	CreateHeatmap (IManagedImage^ srcImage, IManagedImage^ destImage)
IManagedImage	CreateHeatmap (IManagedImage ^ srcImage, float min, float max, HeatmapColor lowColor, HeatmapColor highColor, bool doCheckInvalidVal, unsigned int invalidVal)
void	CreateHeatmap (IManagedImage^ srcImage, IManagedImage^ destImage, float min, float max, HeatmapColor lowColor, HeatmapColor highColor, bool doCheckInvalidVal, unsigned int invalidVal)
void	GetHeatmapColorGradient (SpinnakerNET::HeatmapColor^ currentLowColor, SpinnakerNET::HeatmapColor^ currentHighColor)
void	GetHeatmapRange (unsigned int^ currentLowValue, unsigned int^ currentHighValue)
void	SetHeatmapColorGradient (const SpinnakerNET::HeatmapColor newLowColor, const SpinnakerNET::HeatmapColor newHighColor)
void	SetHeatmapRange (const unsigned int newLowValue, const unsigned int newHighValue)

Public Static Functions Documentation¶

function CreateHeatmap [1/4]¶

static IManagedImage SpinnakerNET::ManagedImageUtilityHeatmap::CreateHeatmap (
    IManagedImage ^ 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 SpinnakerNET::ManagedImageUtilityHeatmap::CreateHeatmap (
    IManagedImage ^ srcImage,
    IManagedImage ^ 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.

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 IManagedImage SpinnakerNET::ManagedImageUtilityHeatmap::CreateHeatmap (
    IManagedImage ^ srcImage,
    float min,
    float max,
    HeatmapColor lowColor,
    HeatmapColor highColor,
    bool doCheckInvalidVal,
    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. Must be non-null and valid.
min The minimum value in the source image to be mapped to the color gradient. Values below this threshold will be clamped to the lower color.
max The maximum value in the source image to be mapped to the color gradient. Values above this threshold will be clamped to the upper color.
lowColor The custom color representing the lower end of the gradient.
highColor The custom color representing the upper end of the gradient.
doCheckInvalidVal A flag indicating whether to check for invalid values in the source image. If true, pixels with a value equal to invalidVal will be set to black (R=G=B=0).
invalidVal The value in the source image considered invalid if doCheckInvalidVal is true. Pixels with this value will be excluded from the gradient mapping.

See also: SetHeatmapRange()

See also: SetHeatmapColorGradient()

Returns:

The heatmap image

function CreateHeatmap [4/4]¶

static void SpinnakerNET::ManagedImageUtilityHeatmap::CreateHeatmap (
    IManagedImage ^ srcImage,
    IManagedImage ^ destImage,
    float min,
    float max,
    HeatmapColor lowColor,
    HeatmapColor highColor,
    bool doCheckInvalidVal,
    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.

Parameters:

srcImage The source image from which to create the heatmap. Must be non-null and valid.
destImage The destination image in which to store the created heatmap
min The minimum value in the source image to be mapped to the color gradient. Values below this threshold will be clamped to the lower color.
max The maximum value in the source image to be mapped to the color gradient. Values above this threshold will be clamped to the upper color.
lowColor The custom color representing the lower end of the gradient.
highColor The custom color representing the upper end of the gradient.
doCheckInvalidVal A flag indicating whether to check for invalid values in the source image. If true, pixels with a value equal to invalidVal will be set to black (R=G=B=0).
invalidVal The value in the source image considered invalid if doCheckInvalidVal is true. Pixels with this value will be excluded from the gradient mapping.

See also: SetHeatmapRange()

See also: SetHeatmapColorGradient()

Returns:

The heatmap image

function GetHeatmapColorGradient¶

static void SpinnakerNET::ManagedImageUtilityHeatmap::GetHeatmapColorGradient (
    SpinnakerNET::HeatmapColor ^ currentLowColor,
    SpinnakerNET::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.

function GetHeatmapRange¶

static void SpinnakerNET::ManagedImageUtilityHeatmap::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 SpinnakerNET::ManagedImageUtilityHeatmap::SetHeatmapColorGradient (
    const  SpinnakerNET::HeatmapColor newLowColor,
    const  SpinnakerNET::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 SpinnakerNET::ManagedImageUtilityHeatmap::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/src/SpinnakerNET/ManagedImageUtilityHeatMap.h