Spinnaker C++
4.0.0.116
Static Public Member Functions | List of all members
ImageUtility Class Reference

Static helper functions for the image object class. More...

Static Public Member Functions

static ImagePtr CreateScaled (const ImagePtr &srcImage, ImageScalingAlgorithm scalingAlg, double scalingFactor)
 Computes a scaled image using the specified parameters. More...
 
static void CreateScaled (const ImagePtr &srcImage, ImagePtr &destImage, ImageScalingAlgorithm scalingAlg, double scalingFactor)
 Computes a scaled image using the specified parameters. More...
 
static ImagePtr CreateNormalized (const ImagePtr &srcImage, const PixelFormatEnums destPixelFormat, SourceDataRange srcDataRange=SPINNAKER_SOURCE_DATA_RANGE_IMAGE_DATA_RANGE)
 Computes a normalized image. More...
 
static ImagePtr CreateNormalized (const ImagePtr &srcImage, const double min, const double max, SourceDataRange srcDataRange=SPINNAKER_SOURCE_DATA_RANGE_IMAGE_DATA_RANGE)
 Computes a normalized image. More...
 
static ImagePtr CreateNormalized (const ImagePtr &srcImage, const double min, const double max, const PixelFormatEnums destPixelFormat, SourceDataRange srcDataRange=SPINNAKER_SOURCE_DATA_RANGE_IMAGE_DATA_RANGE)
 Computes a normalized image. More...
 
static void CreateNormalized (const ImagePtr &srcImage, ImagePtr &destImage, SourceDataRange srcDataRange=SPINNAKER_SOURCE_DATA_RANGE_IMAGE_DATA_RANGE)
 Computes a normalized image. More...
 
static void CreateNormalized (const ImagePtr &srcImage, ImagePtr &destImage, const double min, const double max, SourceDataRange srcDataRange=SPINNAKER_SOURCE_DATA_RANGE_IMAGE_DATA_RANGE)
 Computes a normalized image. More...
 

Detailed Description

Static helper functions for the image object class.

Member Function Documentation

static ImagePtr CreateNormalized ( const ImagePtr srcImage,
const PixelFormatEnums  destPixelFormat,
SourceDataRange  srcDataRange = SPINNAKER_SOURCE_DATA_RANGE_IMAGE_DATA_RANGE 
)
static

Computes a normalized image.

The full range of the destination pixel format data type will be used as the min and max range for normalization. The destination pixel format must be of the same data type as the source image pixel format.

Parameters
srcImageThe source image from which to create normalized image
destPixelFormatThe desired pixel format for the normalized image
srcDataRangeThe desired option for the source data range to normalize from
Returns
The normalized image
Examples:
Polarization.cpp.
static ImagePtr CreateNormalized ( const ImagePtr srcImage,
const double  min,
const double  max,
SourceDataRange  srcDataRange = SPINNAKER_SOURCE_DATA_RANGE_IMAGE_DATA_RANGE 
)
static

Computes a normalized image.

The min and max must be within range of the destination pixel format data type. The normalized image pixel format will be the same as the source image.

Parameters
srcImageThe source image from which to create normalized image
minThe lower bound of the normalization range
maxThe upper bound of the normalization range
srcDataRangeThe desired option for the source data range to normalize from
Returns
The normalized image
static ImagePtr CreateNormalized ( const ImagePtr srcImage,
const double  min,
const double  max,
const PixelFormatEnums  destPixelFormat,
SourceDataRange  srcDataRange = SPINNAKER_SOURCE_DATA_RANGE_IMAGE_DATA_RANGE 
)
static

Computes a normalized image.

The min and max must be within range of the destination pixel format data type. The destination pixel format must be of the same data type as the source image pixel format.

Parameters
srcImageThe source image from which to create normalized image
minThe lower bound of the normalization range
maxThe upper bound of the normalization range
destPixelFormatThe desired pixel format for the normalized image
srcDataRangeThe desired option for the source data range to normalize from
Returns
The normalized image
static void CreateNormalized ( const ImagePtr srcImage,
ImagePtr destImage,
SourceDataRange  srcDataRange = SPINNAKER_SOURCE_DATA_RANGE_IMAGE_DATA_RANGE 
)
static

Computes a normalized image.

The full range of the destination pixel format data type will be used as the min and max range for normalization. The destination image must be initialized and have the same width and height as the source image. The destination image pixel format must be of the same data type as the source image pixel format.

Parameters
srcImageThe source image from which to create normalized image
destImageThe destination image in which to store the normalized image
srcDataRangeThe desired option for the source data range to normalize from
static void CreateNormalized ( const ImagePtr srcImage,
ImagePtr destImage,
const double  min,
const double  max,
SourceDataRange  srcDataRange = SPINNAKER_SOURCE_DATA_RANGE_IMAGE_DATA_RANGE 
)
static

Computes a normalized image.

The min and max must be within range of the destination pixel format data type. The destination image must be initialized and have the same width and height as the source image. The destination image pixel format must be of the same data type as the source image pixel format.

Parameters
srcImageThe source image from which to create normalized image
destImageThe destination image in which to store the normalized image
minThe lower bound of the normalization range
maxThe upper bound of the normalization range
srcDataRangeThe desired option for the source data range to normalize from
static ImagePtr CreateScaled ( const ImagePtr srcImage,
ImageScalingAlgorithm  scalingAlg,
double  scalingFactor 
)
static

Computes a scaled image using the specified parameters.

Does not support scaling of raw bayer images.

Parameters
srcImageThe source image from which to create scaled image
scalingAlgThe desired image scaling algorithm to use
scalingFactorThe desired image scaling factor to use
Returns
The scaled image
static void CreateScaled ( const ImagePtr srcImage,
ImagePtr destImage,
ImageScalingAlgorithm  scalingAlg,
double  scalingFactor 
)
static

Computes a scaled image using the specified parameters.

Does not support scaling of raw bayer images. The destination image height and width must be sufficient to store the calculated data. The destination image pixel format must be the same as the source image.

Parameters
srcImageThe source image from which to create scaled image
destImageAn image object in which to store the scaled data
scalingAlgThe desired image scaling algorithm to use
scalingFactorThe desired image scaling factor to use

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