ImageUtility Class Reference

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

#include <ImageUtility.h>

Static Public Member Functions
static ImagePtr	CreateScaled (const ImagePtr &srcImage, ImageScalingAlgorithm scalingAlg, double scalingFactor)
	Computes a scaled image using the specified parameters.
static void	CreateScaled (const ImagePtr &srcImage, ImagePtr &destImage, ImageScalingAlgorithm scalingAlg, double scalingFactor)
	Computes a scaled image using the specified parameters.
static ImagePtr	CreateNormalized (const ImagePtr &srcImage, const PixelFormatEnums destPixelFormat, SourceDataRange srcDataRange=SPINNAKER_SOURCE_DATA_RANGE_IMAGE_DATA_RANGE)
	Computes a normalized image.
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.
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.
static void	CreateNormalized (const ImagePtr &srcImage, ImagePtr &destImage, SourceDataRange srcDataRange=SPINNAKER_SOURCE_DATA_RANGE_IMAGE_DATA_RANGE)
	Computes a normalized image.
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.

Detailed Description

Static helper functions for the image object class.

Member Function Documentation

CreateNormalized() [1/5]

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

srcImage	The source image from which to create normalized image
min	The lower bound of the normalization range
max	The upper bound of the normalization range
destPixelFormat	The desired pixel format for the normalized image
srcDataRange	The desired option for the source data range to normalize from

Returns

The normalized image

CreateNormalized() [2/5]

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

srcImage	The source image from which to create normalized image
min	The lower bound of the normalization range
max	The upper bound of the normalization range
srcDataRange	The desired option for the source data range to normalize from

Returns

The normalized image

CreateNormalized() [3/5]

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

srcImage	The source image from which to create normalized image
destPixelFormat	The desired pixel format for the normalized image
srcDataRange	The desired option for the source data range to normalize from

Returns

The normalized image

CreateNormalized() [4/5]

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

srcImage	The source image from which to create normalized image
destImage	The destination image in which to store the normalized image
min	The lower bound of the normalization range
max	The upper bound of the normalization range
srcDataRange	The desired option for the source data range to normalize from

CreateNormalized() [5/5]

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

srcImage	The source image from which to create normalized image
destImage	The destination image in which to store the normalized image
srcDataRange	The desired option for the source data range to normalize from

CreateScaled() [1/2]

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

srcImage	The source image from which to create scaled image
destImage	An image object in which to store the scaled data
scalingAlg	The desired image scaling algorithm to use
scalingFactor	The desired image scaling factor to use

CreateScaled() [2/2]

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

srcImage	The source image from which to create scaled image
scalingAlg	The desired image scaling algorithm to use
scalingFactor	The desired image scaling factor to use

Returns

The scaled image

---

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

• include/ImageUtility.h