Class Spinnaker::ImageUtilityPolarization¶

ClassList > Spinnaker > ImageUtilityPolarization

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

#include <ImageUtilityPolarization.h>

Public Static Functions¶

Type	Name
ImagePtr	CreateAolp (const ImagePtr & srcImage, const ColorProcessingAlgorithm colorProcessingAlg=SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR)
void	CreateAolp (const ImagePtr & srcImage, ImagePtr & destAolpImg, const ColorProcessingAlgorithm colorProcessingAlg=SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR)
ImagePtr	CreateDolp (const ImagePtr & srcImage, const ColorProcessingAlgorithm colorProcessingAlg=SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR)
void	CreateDolp (const ImagePtr & srcImage, ImagePtr & destDolpImage, const ColorProcessingAlgorithm colorProcessingAlg=SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR)
ImagePtr	CreateGlareReduced (const ImagePtr & srcImage)
void	CreateGlareReduced (const ImagePtr & srcImage, ImagePtr & destGlareReducedImage)
ImagePtr	CreateStokesS0 (const ImagePtr & srcImage, const ColorProcessingAlgorithm colorProcessingAlg=SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR)
void	CreateStokesS0 (const ImagePtr & srcImage, ImagePtr & destStokesS0Image, const ColorProcessingAlgorithm colorProcessingAlg=SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR)
ImagePtr	CreateStokesS1 (const ImagePtr & srcImage, const ColorProcessingAlgorithm colorProcessingAlg=SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR)
void	CreateStokesS1 (const ImagePtr & srcImage, ImagePtr & destStokesS1Image, const ColorProcessingAlgorithm colorProcessingAlg=SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR)
ImagePtr	CreateStokesS2 (const ImagePtr & srcImage, const ColorProcessingAlgorithm colorProcessingAlg=SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR)
void	CreateStokesS2 (const ImagePtr & srcImage, ImagePtr & destStokesS2Image, const ColorProcessingAlgorithm colorProcessingAlg=SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR)
ImagePtr	ExtractPolarQuadrant (const ImagePtr & srcImage, const PolarizationQuadrant desiredQuadrant)
void	ExtractPolarQuadrant (const ImagePtr & srcImage, ImagePtr & destQuadImage, const PolarizationQuadrant desiredQuadrant)

Public Static Functions Documentation¶

function CreateAolp [1/2]¶

static ImagePtr Spinnaker::ImageUtilityPolarization::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. 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

function CreateAolp [2/2]¶

static void Spinnaker::ImageUtilityPolarization::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. 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

function CreateDolp [1/2]¶

static ImagePtr Spinnaker::ImageUtilityPolarization::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. 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

function CreateDolp [2/2]¶

static void Spinnaker::ImageUtilityPolarization::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. 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

function CreateGlareReduced [1/2]¶

static ImagePtr Spinnaker::ImageUtilityPolarization::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. 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

function CreateGlareReduced [2/2]¶

static void Spinnaker::ImageUtilityPolarization::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. 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

function CreateStokesS0 [1/2]¶

static ImagePtr Spinnaker::ImageUtilityPolarization::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. 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

function CreateStokesS0 [2/2]¶

static void Spinnaker::ImageUtilityPolarization::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. 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

function CreateStokesS1 [1/2]¶

static ImagePtr Spinnaker::ImageUtilityPolarization::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. 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

function CreateStokesS1 [2/2]¶

static void Spinnaker::ImageUtilityPolarization::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. 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

function CreateStokesS2 [1/2]¶

static ImagePtr Spinnaker::ImageUtilityPolarization::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. 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

function CreateStokesS2 [2/2]¶

static void Spinnaker::ImageUtilityPolarization::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. 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

function ExtractPolarQuadrant [1/2]¶

static ImagePtr Spinnaker::ImageUtilityPolarization::ExtractPolarQuadrant (
    const ImagePtr & srcImage,
    const PolarizationQuadrant desiredQuadrant
)

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

function ExtractPolarQuadrant [2/2]¶

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

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 C:/workspace/include/ImageUtilityPolarization.h