Spinnaker C++
2.6.0.0
Public Types | Static Public Member Functions | List of all members
ImageUtilityHeatmap Class Reference

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

Public Types

enum  HeatmapColor {
  HEATMAP_BLACK = 1, HEATMAP_BLUE = 2, HEATMAP_CYAN = 3, HEATMAP_GREEN = 4,
  HEATMAP_YELLOW = 5, HEATMAP_RED = 6, HEATMAP_WHITE = 7
}
 Color specifiers for the heatmap color gradient. More...
 

Static Public Member Functions

static ImagePtr CreateHeatmap (const ImagePtr &srcImage)
 Computes a heatmap image. More...
 
static void CreateHeatmap (const ImagePtr &srcImage, ImagePtr &destImage)
 Computes a heatmap image. More...
 
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. More...
 
static void GetHeatmapColorGradient (HeatmapColor &currentLowColor, HeatmapColor &currentHighColor)
 Returns the current heatmap gradient color range. More...
 
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. More...
 
static void GetHeatmapRange (unsigned int &currentLowValue, unsigned int &currentHighValue)
 Returns the current high and low values used in heatmap representations. More...
 

Detailed Description

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

Member Enumeration Documentation

Color specifiers for the heatmap color gradient.

Enumerator
HEATMAP_BLACK 
HEATMAP_BLUE 
HEATMAP_CYAN 
HEATMAP_GREEN 
HEATMAP_YELLOW 
HEATMAP_RED 
HEATMAP_WHITE 

Member Function Documentation

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
srcImageThe source image from which to create the heatmap
See Also
SetHeatmapRange()
SetHeatmapColorGradient()
Returns
The heatmap image
Examples:
Polarization.cpp.
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
srcImageThe source image from which to create the heatmap
destImageThe destination image in which to store the created heatmap
See Also
SetHeatmapRange()
SetHeatmapColorGradient()
static void GetHeatmapColorGradient ( HeatmapColor currentLowColor,
HeatmapColor currentHighColor 
)
static

Returns the current heatmap gradient color range.

Parameters
currentLowColorCurrent color at which the gradient begins.
currentHighColorCurrent color at which the gradient ends.
See Also
SetHeatmapColorGradient()
static void GetHeatmapRange ( unsigned int &  currentLowValue,
unsigned int &  currentHighValue 
)
static

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

Parameters
currentLowValueCurrent value at which color representation begins.
currentHighValueCurrent value at which color representation ends.
See Also
SetHeatmapRange()
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
newLowColorNew color at which to begin the gradient.
newHighColorNew color at which to end the gradient.
Examples:
Polarization.cpp.
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
newLowValueNew value at which to begin color representation.
newHighValueNew value at which to end color representation.
Examples:
Polarization.cpp.

The documentation for this class was generated from the following file:
Contact Support Spinnaker® SDK Programmer's Guide and API Reference