Static functions to create polarization images from image objects of pixel format Polarized8 and BayerRGPolarized8. More...

#include <ImageUtilityPolarization.h>

Static Public Member Functions
static ImagePtr	ExtractPolarQuadrant (const ImagePtr &srcImage, const PolarizationQuadrant desiredQuadrant)
	Extracts all pixels of a specified degree of linear polarization into a new image object.

static void	ExtractPolarQuadrant (const ImagePtr &srcImage, ImagePtr &destQuadImage, const PolarizationQuadrant desiredQuadrant)
	Extracts all pixels of a specified degree of linear polarization into the provided image object.

static ImagePtr	CreateGlareReduced (const ImagePtr &srcImage)
	Create a glare reduced image from the source image by choosing the darkest pixel from each polarization quadrant The source image pixel format must be Polarized8 or BayerRGPolarized8.

static void	CreateGlareReduced (const ImagePtr &srcImage, ImagePtr &destGlareReducedImage)
	Create a glare reduced image from the source image by choosing the darkest pixel from each polarization quadrant The source image pixel format must be Polarized8 or BayerRGPolarized8.

static ImagePtr	CreateStokesS0 (const ImagePtr &srcImage, const ColorProcessingAlgorithm colorProcessingAlg=SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR)
	Computes an image representing the overall intensity of light from a polarized image.

static void	CreateStokesS0 (const ImagePtr &srcImage, ImagePtr &destStokesS0Image, const ColorProcessingAlgorithm colorProcessingAlg=SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR)
	Computes an image representing the overall intensity of light from a polarized image.

static ImagePtr	CreateStokesS1 (const ImagePtr &srcImage, const ColorProcessingAlgorithm colorProcessingAlg=SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR)
	Computes an image representing the difference in intensity accepted through the polarizers at 0 and 90 to the horizontal.

static void	CreateStokesS1 (const ImagePtr &srcImage, ImagePtr &destStokesS1Image, const ColorProcessingAlgorithm colorProcessingAlg=SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR)
	Computes an image representing the difference in intensity accepted through the polarizers at 0 and 90 to the horizontal.

static ImagePtr	CreateStokesS2 (const ImagePtr &srcImage, const ColorProcessingAlgorithm colorProcessingAlg=SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR)
	Computes an image representing the difference in intensity accepted through the polarizers at 45 and -45 to the horizontal.

static void	CreateStokesS2 (const ImagePtr &srcImage, ImagePtr &destStokesS2Image, const ColorProcessingAlgorithm colorProcessingAlg=SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR)
	Computes an image representing the difference in intensity accepted through the polarizers.

static ImagePtr	CreateDolp (const ImagePtr &srcImage, const ColorProcessingAlgorithm colorProcessingAlg=SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR)
	Computes an image representing the fraction of incident light intensity in the linear polarization states.

static void	CreateDolp (const ImagePtr &srcImage, ImagePtr &destDolpImage, const ColorProcessingAlgorithm colorProcessingAlg=SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR)
	Computes an image representing the fraction of incident light intensity in the linear polarization states.

static ImagePtr	CreateAolp (const ImagePtr &srcImage, const ColorProcessingAlgorithm colorProcessingAlg=SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR)
	Computes an image representing the angle at which linearly polarized light oscillates with respect to a reference axis.

static void	CreateAolp (const ImagePtr &srcImage, ImagePtr &destAolpImg, const ColorProcessingAlgorithm colorProcessingAlg=SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR)
	Computes an image representing the angle at which linearly polarized light oscillates with respect to a reference axis.

Detailed Description

Static functions to create polarization images from image objects of pixel format Polarized8 and BayerRGPolarized8.

Member Function Documentation

◆ CreateAolp() [1/2]

static ImagePtr CreateAolp	(	const ImagePtr &	srcImage,
		const ColorProcessingAlgorithm	colorProcessingAlg = `SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR`
	)

static

Computes an image representing the angle at which linearly polarized light oscillates with respect to a reference axis.

The source image pixel format must be Polarized8 or BayerRGPolarized8. The destination image pixel format will be Mono32f or RGB32f respectively. The destination image height and width will be half of the source image.

Parameters

srcImage	The source image from which to extract polarization data
colorProcessingAlg	The color processing algorithm to use for color images

Returns: The angle of linear polarization (aolp) image

◆ CreateAolp() [2/2]

static void CreateAolp	(	const ImagePtr &	srcImage,
		ImagePtr &	destAolpImg,
		const ColorProcessingAlgorithm	colorProcessingAlg = `SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR`
	)

static

Computes an image representing the angle at which linearly polarized light oscillates with respect to a reference axis.

The source image pixel format must be Polarized8 or BayerRGPolarized8. The destination image pixel format must be Mono32f or RGB32f respectively. The destination image height and width must be half of the source image.

Parameters

srcImage	The source image from which to extract polarization data
destAolpImg	The destination image in which to store the angle of linear polarization (aolp) image
colorProcessingAlg	The color processing algorithm to use for color images

◆ CreateDolp() [1/2]

static ImagePtr CreateDolp	(	const ImagePtr &	srcImage,
		const ColorProcessingAlgorithm	colorProcessingAlg = `SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR`
	)

static

Computes an image representing the fraction of incident light intensity in the linear polarization states.

The source image pixel format must be Polarized8 or BayerRGPolarized8. The destination image pixel format will be Mono32f or RGB32f respectively. The destination image height and width will be half of the source image.

Parameters

srcImage	The source image from which to extract polarization data
colorProcessingAlg	The color processing algorithm to use for color images

Returns: The degree of linear polarization (dolp) image

◆ CreateDolp() [2/2]

static void CreateDolp	(	const ImagePtr &	srcImage,
		ImagePtr &	destDolpImage,
		const ColorProcessingAlgorithm	colorProcessingAlg = `SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR`
	)

static

Computes an image representing the fraction of incident light intensity in the linear polarization states.

The source image pixel format must be Polarized8 or BayerRGPolarized8. The destination image pixel format must be Mono32f or RGB32f respectively. The destination image height and width must be half of the source image.

Parameters

srcImage	The source image from which to extract polarization data
destDolpImage	The destination image in which to store the degree of linear polarization (dolp) image
colorProcessingAlg	The color processing algorithm to use for color images

◆ CreateGlareReduced() [1/2]

static ImagePtr CreateGlareReduced ( const ImagePtr & srcImage )

static

Create a glare reduced image from the source image by choosing the darkest pixel from each polarization quadrant The source image pixel format must be Polarized8 or BayerRGPolarized8.

The destination image pixel format will be Mono8 or BayerRG8 respectively. The destination image height and width must be half of the source image.

Parameters

srcImage The source image from which to extract polarization data

Returns: The reduced glare image

◆ CreateGlareReduced() [2/2]

static void CreateGlareReduced	(	const ImagePtr &	srcImage,
		ImagePtr &	destGlareReducedImage
	)

static

Create a glare reduced image from the source image by choosing the darkest pixel from each polarization quadrant The source image pixel format must be Polarized8 or BayerRGPolarized8.

The destination image pixel format will be Mono8 or BayerRG8 respectively. The destination image height and width must be half of the source image.

Parameters

srcImage	The source image from which to apply glare reduction
destGlareReducedImage	The destination image in which to store the image with reduced glare

◆ CreateStokesS0() [1/2]

static ImagePtr CreateStokesS0	(	const ImagePtr &	srcImage,
		const ColorProcessingAlgorithm	colorProcessingAlg = `SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR`
	)

static

Computes an image representing the overall intensity of light from a polarized image.

The source image pixel format must be Polarized8 or BayerRGPolarized8. The destination image pixel format will be Mono16s or RGB16s respectively. The destination image height and width will be half of the source image.

Parameters

srcImage	The source image from which to extract polarization data
colorProcessingAlg	The color processing algorithm to use for color images

Returns: The Stokes' S0 image

◆ CreateStokesS0() [2/2]

static void CreateStokesS0	(	const ImagePtr &	srcImage,
		ImagePtr &	destStokesS0Image,
		const ColorProcessingAlgorithm	colorProcessingAlg = `SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR`
	)

static

Computes an image representing the overall intensity of light from a polarized image.

The source image pixel format must be Polarized8 or BayerRGPolarized8. The destination image pixel format must be Mono16s or RGB16s respectively. The destination image height and width must be half of the source image.

Parameters

srcImage	The source image from which to extract polarization data
destStokesS0Image	The destination image in which to store the Stokes' S0 image
colorProcessingAlg	The color processing algorithm to use for color images

◆ CreateStokesS1() [1/2]

static ImagePtr CreateStokesS1	(	const ImagePtr &	srcImage,
		const ColorProcessingAlgorithm	colorProcessingAlg = `SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR`
	)

static

Computes an image representing the difference in intensity accepted through the polarizers at 0 and 90 to the horizontal.

The source image pixel format must be Polarized8 or BayerRGPolarized8. The destination image pixel format will be Mono16s or RGB16s respectively. The destination image height and width will be half of the source image.

Parameters

srcImage	The source image from which to extract polarization data
colorProcessingAlg	The color processing algorithm to use for color images

Returns: The Stokes' S1 image

◆ CreateStokesS1() [2/2]

static void CreateStokesS1	(	const ImagePtr &	srcImage,
		ImagePtr &	destStokesS1Image,
		const ColorProcessingAlgorithm	colorProcessingAlg = `SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR`
	)

static

Computes an image representing the difference in intensity accepted through the polarizers at 0 and 90 to the horizontal.

The source image pixel format must be Polarized8 or BayerRGPolarized8. The destination image pixel format must be Mono16s or RGB16s respectively. The destination image height and width must be half of the source image.

Parameters

srcImage	The source image from which to extract polarization data
destStokesS1Image	The destination image in which to store the Stokes' S1 image
colorProcessingAlg	The color processing algorithm to use for color images

◆ CreateStokesS2() [1/2]

static ImagePtr CreateStokesS2	(	const ImagePtr &	srcImage,
		const ColorProcessingAlgorithm	colorProcessingAlg = `SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR`
	)

static

Computes an image representing the difference in intensity accepted through the polarizers at 45 and -45 to the horizontal.

The source image pixel format must be Polarized8 or BayerRGPolarized8. The destination image pixel format will be Mono16s or RGB16s respectively. The destination image height and width will be half of the source image.

Parameters

srcImage	The source image from which to extract polarization data
colorProcessingAlg	The color processing algorithm to use for color images

Returns: The Stokes' S2 image

◆ CreateStokesS2() [2/2]

static void CreateStokesS2	(	const ImagePtr &	srcImage,
		ImagePtr &	destStokesS2Image,
		const ColorProcessingAlgorithm	colorProcessingAlg = `SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR`
	)

static

Computes an image representing the difference in intensity accepted through the polarizers.

at 45 and -45 to the horizontal. The source image pixel format must be Polarized8 or BayerRGPolarized8. The destination image pixel format must be Mono16s or RGB16s respectively. The destination image height and width must be half of the source image.

Parameters

srcImage	The source image from which to extract polarization data
destStokesS2Image	The destination image in which to store the Stokes' S2 image
colorProcessingAlg	The color processing algorithm to use for color images

◆ ExtractPolarQuadrant() [1/2]

static ImagePtr ExtractPolarQuadrant	(	const ImagePtr &	srcImage,
		const PolarizationQuadrant	desiredQuadrant
	)

static

Extracts all pixels of a specified degree of linear polarization into a new image object.

The source image pixel format must be Polarized8 or BayerRGPolarized8. The destination image pixel format will be Mono8 or BayerRG8 respectively. The destination image height and width will be half of the source image.

Parameters

srcImage	The source image from which to extract polarization data
desiredQuadrant	The polarization quadrant to extract

Returns: The specified polarization quadrant image

◆ ExtractPolarQuadrant() [2/2]

static void ExtractPolarQuadrant	(	const ImagePtr &	srcImage,
		ImagePtr &	destQuadImage,
		const PolarizationQuadrant	desiredQuadrant
	)

static

Extracts all pixels of a specified degree of linear polarization into the provided image object.

The source image pixel format must be Polarized8 or BayerRGPolarized8. The destination image pixel format must be Mono8 or BayerRG8 respectively. The destination image height and width must be half of the source image.

Parameters

srcImage	The source image from which to extract polarization data
destQuadImage	The destination image in which to store the extracted polarization quadrant
desiredQuadrant	The polarization quadrant to extract

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

include/ImageUtilityPolarization.h

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ CreateAolp() [1/2]

◆ CreateAolp() [2/2]

◆ CreateDolp() [1/2]

◆ CreateDolp() [2/2]

◆ CreateGlareReduced() [1/2]

◆ CreateGlareReduced() [2/2]

◆ CreateStokesS0() [1/2]

◆ CreateStokesS0() [2/2]

◆ CreateStokesS1() [1/2]

◆ CreateStokesS1() [2/2]

◆ CreateStokesS2() [1/2]

◆ CreateStokesS2() [2/2]

◆ ExtractPolarQuadrant() [1/2]

◆ ExtractPolarQuadrant() [2/2]