Logo
Programmer's Guide Baumer GAPI SDK Reference v2.10.0
Classes | Public Types | Public Member Functions | List of all members
BGAPI2::Polarizer Class Reference

Provides functionality to calculate several different formats out of the raw polarized camera data. More...

#include <bgapi2_genicam.hpp>

Classes

class  formatlist
 This class provides a iterator that can read or modify any element in the list. More...
 

Public Types

enum  Formats {
  AOP, DOLP, ADOLP, Intensity,
  Pol0Deg, Pol45Deg, Pol90Deg, Pol135Deg,
  ReflectionMin, ReflectionMax
}
 An enumeration containing the string representation of the possible polarization formats. More...
 

Public Member Functions

 Polarizer ()
 Parameterless constructor for creating of an Polarizer object.
 
 ~Polarizer ()
 Destructor to destroy an Polarizer object.
 
void Initialize (BGAPI2::Buffer *buffer)
 Initialize the Polarizer and provide the Buffer with the raw polarized data to calculate the. More...
 
void ReadCalibrationData (BGAPI2::Device *device)
 Get the calibration data and angle offset from the camera. More...
 
void EnableInterpolation (bo_bool interpolate)
 Keep output image the same size as the input buffer. The default is disabled. More...
 
void Enable (Formats format, bo_bool enable)
 Each component to be calculated must be enabled first. More...
 
void Get (Formats format, BGAPI2::Image *image)
 Get the calculated component (AOP, Pol45deg etc.) from the buffer provided through the Initialize() More...
 
String GetFormatString (Formats format)
 Get the string of the polarization format. More...
 
void SetMaxThreads (bo_uint number)
 Set the number of threads the Polarizer can use for calculations. More...
 

Detailed Description

Provides functionality to calculate several different formats out of the raw polarized camera data.

Definition at line 3426 of file bgapi2_genicam.hpp.

Member Enumeration Documentation

◆ Formats

An enumeration containing the string representation of the possible polarization formats.

Enumerator
AOP 

Enum value AOP - Angle of polarization

DOLP 

Enum value DOLP - Degree of linear polarization

ADOLP 

Enum value ADOLP - Angle and degree of linear polarization

Intensity 

Enum value Intensity - Gray scale image

Pol0Deg 

Enum value Pol0Deg - The polarization information 0 degrees

Pol45Deg 

Enum value Pol45Deg - The polarization information 45 degrees

Pol90Deg 

Enum value Pol90Deg - The polarization information 90 degrees

Pol135Deg 

Enum value Pol135Deg - The polarization information 135 degrees

ReflectionMin 

Enum value ReflectionMin - Image with suppressed reflections

ReflectionMax 

Enum value ReflectionMax - Image with enhanced reflections

Definition at line 3475 of file bgapi2_genicam.hpp.

Member Function Documentation

◆ Enable()

void BGAPI2::Polarizer::Enable ( Formats  format,
bo_bool  enable 
)

Each component to be calculated must be enabled first.

To speed up the calculation of the different components it is necessary to enable them first. This allows for the calculation to re-use and combine some of the necessary calculations.

Parameters
[in]formatThe format to enable or disable
[in]enableSet to true to enable or false to disable
See also
BGAPI2::Polarizer::Formats

◆ EnableInterpolation()

void BGAPI2::Polarizer::EnableInterpolation ( bo_bool  interpolate)

Keep output image the same size as the input buffer. The default is disabled.

If enabled, the calculated images will be interpolated to have the same size as the raw image buffer provided.

Parameters
[in]bo_boolinterpolate If set to true the result images will be interpolated.

◆ Get()

void BGAPI2::Polarizer::Get ( Formats  format,
BGAPI2::Image image 
)

Get the calculated component (AOP, Pol45deg etc.) from the buffer provided through the Initialize()

method.

For performance reasons when handling more than one component, a component must first be enabled via the Polarizer::Enable() method.

Parameters
[in]formatThe format to enable or disable

◆ GetFormatString()

String BGAPI2::Polarizer::GetFormatString ( Formats  format)

Get the string of the polarization format.

Parameters
[in]formatThe polarization format String The string of the polarization format.
See also
BGAPI2::Polarizer::Formats
Exceptions
Exceptions::InvalidParameterExceptionInvalid parameter

◆ Initialize()

void BGAPI2::Polarizer::Initialize ( BGAPI2::Buffer buffer)

Initialize the Polarizer and provide the Buffer with the raw polarized data to calculate the.

different polarized formats from.

Parameters
[in]bufferA valid buffer with polarized data acquired by a Baumer camera.
Exceptions
BGAPI2::InvalidParameterExceptionInvalid Buffer.

◆ ReadCalibrationData()

void BGAPI2::Polarizer::ReadCalibrationData ( BGAPI2::Device device)

Get the calibration data and angle offset from the camera.

Reads the calibration matrix and the configured polarization angle offset from the camera device to enhance the calculation of different polarization formats.

Parameters
[in]deviceThe BGAPI2::Device*, a pointer to the polarization camera (opened, must be able to read features from the camera)
Exceptions
Exceptions::InvalidParameterExceptionThe passed BGAPI device is not valid.
Exceptions::NotInitializedExceptionThe BGAPI device is not open.

◆ SetMaxThreads()

void BGAPI2::Polarizer::SetMaxThreads ( bo_uint  number)

Set the number of threads the Polarizer can use for calculations.

To speed up the calculation of components more than one thread can be used internally. The default is 4 threads on processors which have 8 or more logical cores, otherwise half of the logical cores are used. Depending on your application you can change this here.

Parameters
[in]numberThe amount of threads used internally.

The documentation for this class was generated from the following file:
bgapi: BGAPI::Camera Class Reference

Jan, 14 2020
Baumer Optronic GmbH, Badstrasse 30, 01454 D-Radeberg, Tel:+49-3528-4386-0, Fax:+49-3528-4386-86, Email:support.cameras@baumer.com