High-level interface for automatic camera feature control, providing access to algorithms such as auto-brightness, auto-exposure, auto-gain, white balance, and autofocus. The available functionality depends on the selected controller type (see peak_afl_controllerType). More...

#include <peak_afl/peak_afl.hpp>

Public Member Functions
	~Controller ()
bool	IsSkipFramesSupported () const
	Check if skip frames is supported for a controller.
void	SetSkipFrames (std::uint32_t count)
	Set number of frames skipped for a controller.
std::uint32_t	GetSkipFrames () const
	Get number of frames skipped for a controller.
Range< std::uint32_t >	GetSkipFramesRange () const
	Get range for frames skipped for a controller.
bool	IsROISupported () const
	Check if setting a region of interest is supported for a controller.
void	SetROI (peak_afl_rectangle rect)
	Set the autofeature region of interest for a controller.
peak_afl_rectangle	GetROI () const
	Get the autofeature region of interest for a controller.
bool	IsROIPresetSupported () const
	Check if ROI preset is supported for a controller.
void	SetROIPreset (peak_afl_roi_preset preset)
	Set the autofeature region of interest preset for a controller.
bool	IsModeSupported () const
	Check if auto mode is supported for a controller.
void	SetMode (peak_afl_controller_automode mode)
	Set the autofeature mode for a controller.
peak_afl_controller_automode	GetMode () const
	Get the current autofeature mode for a controller.
bool	IsBrightnessAlgorithmSupported () const
	Check if auto brightness algorithm is supported for a controller.
void	SetBrightnessAlgorithm (peak_afl_controller_brightness_algorithm algorithm)
	Set the autofeature brightness algorithm for a controller.
peak_afl_controller_brightness_algorithm	GetBrightnessAlgorithm () const
	Get the current autofeature brightness algorithm for a controller.
peak_afl_controller_status	Status () const
	Get the status for a controller.
std::uint8_t	GetLastAutoAverage () const
	Get the last auto average for a controller.
std::tuple< std::uint8_t, std::uint8_t, std::uint8_t >	GetLastAutoAverages () const
	Get the last auto average for a controller.
bool	IsAutoTargetSupported () const
	check if auto target is supported for a controller.
void	SetAutoTarget (uint32_t target)
	Set the auto target for a controller.
std::uint32_t	GetAutoTarget () const
	Get the currently set auto target for a controller.
Range< std::uint32_t >	GetAutoTargetRange () const
	Get the auto target range for a controller.
bool	IsAutoToleranceSupported () const
	check if auto tolerance is supported for a controller.
void	SetAutoTolerance (std::uint32_t tolerance)
	Set the auto tolerance for a controller.
std::uint32_t	GetAutoTolerance () const
	Get the current auto tolerance for a controller.
Range< std::uint32_t >	GetAutoToleranceRange () const
	Get the auto tolerance range for a controller.
bool	IsAutoPercentileSupported () const
	check if auto percentile is supported for a controller.
void	SetAutoPercentile (double percentile)
	Set the auto percentile for a controller.
double	GetAutoPercentile () const
	Get the auto percentile for a controller.
Range< double >	GetAutoPercentileRange () const
	Get the auto percentile range for a controller.
peak_afl_controllerType	Type () const
	Get the controller type.
bool	IsAlgorithmSupported () const
	check if setting an algorithm is supported for a controller.
void	SetAlgorithm (peak_afl_controller_algorithm algorithm)
	Set the used algorithm for a controller.
peak_afl_controller_algorithm	GetAlgorithm () const
	Get the used algorithm for a controller.
std::vector< peak_afl_controller_algorithm >	GetAlgorithmList () const
	Get the list of supported algorithms for a controller.
bool	IsSharpnessAlgorithmSupported () const
	check setting a sharpness algorithm is supported by a controller.
void	SetSharpnessAlgorithm (peak_afl_controller_sharpness_algorithm algorithm)
	Set the used sharpness algorithm for a controller.
peak_afl_controller_sharpness_algorithm	GetSharpnessAlgorithm () const
	Get the used sharpness algorithm for a controller.
std::vector< peak_afl_controller_sharpness_algorithm >	GetSharpnessAlgorithmList () const
	Get the list of supported sharpness algorithms for a controller.
void	RegisterFinishedCallback (const callback::FinishedCallback &callback)
	Set finished callback for a controller.
void	UnRegisterFinishedCallback ()
	Reset the finished callback for a controller.
void	RegisterComponentCallback (peak_afl_controller_brightness_component component, const callback::FinishedCallback &callback)
	Set component callback for a controller.
void	UnRegisterComponentCallback (peak_afl_controller_brightness_component component)
	Reset the component callback for a controller.
void	RegisterDataProcessingCallback (const callback::DataProcessingCallback &callback)
	Set the data callback for a controller.
void	UnRegisterDataProcessingCallback ()
	Reset the data callback for a controller.
void	RegisterProcessingCallback (const callback::ProcessingCallback &callback)
	Set the data callback for a controller.
void	UnRegisterProcessingCallback ()
	Reset the data callback for a controller.
bool	IsWeightedROISupported () const
	Check if weighted region of interest is supported for a controller.
void	SetWeightedROIs (const std::vector< peak_afl_weighted_rectangle > &list)
	Set the autofeature weighted region of interest for a controller.
void	SetWeightedROI (const peak_afl_weighted_rectangle &rect)
	Set single autofeature weighted region of interest for a controller.
peak_afl_size	GetWeightedROIMinSize () const
	Get the autofeature minimum size of weighted region of interest for a controller.
std::vector< peak_afl_weighted_rectangle >	GetWeightedROIs () const
	Get the autofeature weighted region of interest for a controller.
bool	IsLimitSupported () const
	Check if limit is supported for a controller.
void	SetLimit (peak_afl_controller_limit limit)
	Set the autofeature limit for a controller.
peak_afl_controller_limit	GetLimit () const
	Get the autofeature limit for a controller.
peak_afl_controller_limit	GetDefaultLimit () const
	Get the autofeature default limit.
bool	IsHysteresisSupported () const
	Check if hysteresis is supported for a controller.
void	SetHysteresis (std::uint8_t hysteresis)
	Set the autofeature hysteresis for a controller.
std::uint8_t	GetHysteresis () const
	Get the autofeature hysteresis for a controller.
std::uint8_t	GetDefaultHysteresis () const
	Get the autofeature hysteresis default.
Range< std::uint8_t >	GetHysteresisRange () const
	Get autofeature hysteresis range for a controller.
bool	IsBrightnessComponentModeSupported () const
	Check if auto mode is supported for a brightness controller component.
bool	IsBrightnessComponentUnitSupported (peak_afl_controller_brightness_component component) const
	Check if a specific unit is supported for a brightness controller component.
void	BrightnessComponentSetMode (peak_afl_controller_brightness_component component, peak_afl_controller_automode mode)
	Set the autofeature mode for a brightness controller component.
peak_afl_controller_automode	BrightnessComponentGetMode (peak_afl_controller_brightness_component component) const
	Get the current autofeature mode for a brightness controller component.
peak_afl_controller_status	BrightnessComponentStatus (peak_afl_controller_brightness_component component) const
	Get the status for a brightness controller component.
bool	IsGainLimitSupported () const
	Check if auto gain limit is supported for a controller.
void	SetGainLimit (peak_afl_double_limit limit)
	Set the gain limit for a controller.
peak_afl_double_limit	GetGainLimit () const
	Get autofeature gain limit for a controller.
peak_afl_double_limit	GetGainLimitRange () const
	Get autofeature gain limit range for a controller.
void	SetGainAnalogLimit (peak_afl_double_limit limit)
	Set the analog gain limit for a controller.
peak_afl_double_limit	GetGainAnalogLimit () const
	Get autofeature analog gain limit for a controller.
peak_afl_double_limit	GetGainAnalogLimitRange () const
	Get autofeature analog gain limit range for a controller.
void	SetGainDigitalLimit (peak_afl_double_limit limit)
	Set the digital gain limit for a controller.
peak_afl_double_limit	GetGainDigitalLimit () const
	Get autofeature digital gain limit for a controller.
peak_afl_double_limit	GetGainDigitalLimitRange () const
	Get autofeature digital gain limit range for a controller.
void	SetGainCombinedLimit (peak_afl_double_limit limit)
	Set the combined gain limit for a controller.
peak_afl_double_limit	GetGainCombinedLimit () const
	Get autofeature combined gain limit for a controller.
peak_afl_double_limit	GetGainCombinedLimitRange () const
	Get autofeature combined gain limit range for a controller.
void	SetGainHostLimit (peak_afl_double_limit limit)
	Set the host gain limit for a controller.
peak_afl_double_limit	GetGainHostLimit () const
	Get autofeature host gain limit for a controller.
peak_afl_double_limit	GetGainHostLimitRange () const
	Get autofeature host gain limit range for a controller.
void	SetExposureLimit (peak_afl_double_limit limit)
	Set the exposure limit for a controller.
peak_afl_double_limit	GetExposureLimit () const
	Get autofeature exposure limit for a controller.
peak_afl_double_limit	GetExposureLimitRange () const
	Get autofeature exposure limit range for a controller.

Static Public Member Functions
static std::shared_ptr< Controller >	Create (peak_afl_controllerType type)
	Create a new controller.

Detailed Description

High-level interface for automatic camera feature control, providing access to algorithms such as auto-brightness, auto-exposure, auto-gain, white balance, and autofocus. The available functionality depends on the selected controller type (see peak_afl_controllerType).

The Controller class represents a managed interface to one of the available automatic camera feature controllers provided by the auto-feature system. A controller encapsulates all logic necessary to tune a specific set of camera parameters — such as exposure time, gain, brightness, white balance, or focus — depending on the selected controller type (see peak_afl_controllerType).

Controller Types

A Controller instance is created using Create() and initialized with a specific controller type. Each type specializes in a particular automatic feature:

PEAK_AFL_CONTROLLER_TYPE_BRIGHTNESS Controls automatic brightness by adjusting exposure, gain (analog, digital, combined, host), and related limits or algorithms.
PEAK_AFL_CONTROLLER_TYPE_WHITE_BALANCE Controls automatic white-balance algorithms and channel gain adjustments.
PEAK_AFL_CONTROLLER_TYPE_AUTOFOCUS Controls focus algorithms, sharpness evaluation, and focus search modes.

The chosen type determines which features, ranges, and algorithms are available.

Feature Management

A controller provides a broad set of functions for querying capabilities, configuring parameters, and selecting algorithms. Before using optional features—such as ROI handling, limits, or specific algorithms—you must first check whether the controller supports them. Parameter getters typically return Range values with inclusive endpoints and a defined step size, and component-specific controls are available where applicable.

Regions of Interest

Controllers may support simple ROIs, weighted ROIs, or predefined ROI presets, each of which restricts the image region used by the auto-feature algorithm. Support for these features must be checked beforehand using IsROISupported(), IsWeightedROISupported(), and IsROIPresetSupported().

Callback Management

Controllers allow registration of several callback types:

Finished callbacks (when an algorithm iteration completes),
Component callbacks (per exposure/gain component),
Processing callbacks (image data or metadata processing),

All callbacks are RAII-managed via an internal template mechanism that ensures correct registration and safe automatic unregistration.

Lifetime and Ownership

Controller instances are always created as std::shared_ptr<Controller> via Create().

Exceptions

Almost all operations may throw peak::afl::error::Exception if the underlying API call fails. Capability checks should be performed before attempting unsupported operations.

In summary, the Controller class acts as the central C++ abstraction for interacting with the automatic camera feature system, providing complete management of parameters, algorithms, ROI behavior, limits, and callbacks for all supported controller types.

Constructor & Destructor Documentation

◆ ~Controller()

~Controller ( )

inline

Destructor for the controller

Member Function Documentation

◆ BrightnessComponentGetMode()

peak_afl_controller_automode BrightnessComponentGetMode ( peak_afl_controller_brightness_component component ) const

inline

Get the current autofeature mode for a brightness controller component.

Parameters

[in] component autofeature brightness component

Returns: autofeature mode

Exceptions

peak::afl::error::Exception if function fails

Since: 1.2

◆ BrightnessComponentSetMode()

void BrightnessComponentSetMode	(	peak_afl_controller_brightness_component	component,
		peak_afl_controller_automode	mode )

inline

Set the autofeature mode for a brightness controller component.

Will set the controller mode to mode. See peak_afl_controller_automode for a list of valid values.

Parameters

[in]	component	autofeature brightness component
[in]	mode	autofeature mode

Exceptions

peak::afl::error::Exception if function fails

Since: 1.2

◆ BrightnessComponentStatus()

peak_afl_controller_status BrightnessComponentStatus ( peak_afl_controller_brightness_component component ) const

inline

Get the status for a brightness controller component.

See peak_afl_controller_status for a list of values.

Parameters

[in] component autofeature brightness component

Returns: controller status

Exceptions

peak::afl::error::Exception if function fails

Since: 1.2

◆ Create()

std::shared_ptr< Controller > Create ( peak_afl_controllerType type )

inlinestatic

Create a new controller.

Parameters

[in] type controller type

Returns: the shared ptr to the created controller

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ GetAlgorithm()

peak_afl_controller_algorithm GetAlgorithm ( ) const

inline

Get the used algorithm for a controller.

Returns: auto controller algorithm

Since: 1.1

◆ GetAlgorithmList()

std::vector< peak_afl_controller_algorithm > GetAlgorithmList ( ) const

inline

Get the list of supported algorithms for a controller.

To set a value, see SetAlgorithm.

Returns: vector of supported algorithms

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ GetAutoPercentile()

double GetAutoPercentile ( ) const

inline

Get the auto percentile for a controller.

Returns: auto percentile value

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ GetAutoPercentileRange()

Range< double > GetAutoPercentileRange ( ) const

inline

Get the auto percentile range for a controller.

Call this function to get the range of valid values which can be set by a call to SetAutoPercentile.

Returns: peak::afl::Range with valid values

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ GetAutoTarget()

std::uint32_t GetAutoTarget ( ) const

inline

Get the currently set auto target for a controller.

Returns: auto target value

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ GetAutoTargetRange()

Range< std::uint32_t > GetAutoTargetRange ( ) const

inline

Get the auto target range for a controller.

Call this function to get the range of valid values which can be set by a call to SetAutoTarget.

Returns: peak::afl::Range with valid values

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ GetAutoTolerance()

uint32_t GetAutoTolerance ( ) const

inline

Get the current auto tolerance for a controller.

Returns: auto tolerance value

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ GetAutoToleranceRange()

Range< uint32_t > GetAutoToleranceRange ( ) const

inline

Get the auto tolerance range for a controller.

Call this function to get the range of valid values which can be set by a call to SetAutoTolerance.

Returns: peak::afl::Range with valid values

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ GetBrightnessAlgorithm()

peak_afl_controller_brightness_algorithm GetBrightnessAlgorithm ( ) const

inline

Get the current autofeature brightness algorithm for a controller.

Returns: autofeature brightness algorithm

Exceptions

peak::afl::error::Exception if function fails

◆ GetDefaultHysteresis()

std::uint8_t GetDefaultHysteresis ( ) const

inline

Get the autofeature hysteresis default.

Returns: the default hysteresis

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ GetDefaultLimit()

peak_afl_controller_limit GetDefaultLimit ( ) const

inline

Get the autofeature default limit.

Returns: the default limit set

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ GetExposureLimit()

peak_afl_double_limit GetExposureLimit ( ) const

inline

Get autofeature exposure limit for a controller.

Returns: the current exposure limit

Exceptions

peak::afl::error::Exception if function fails

Since: 1.4

◆ GetExposureLimitRange()

peak_afl_double_limit GetExposureLimitRange ( ) const

inline

Get autofeature exposure limit range for a controller.

Returns: the current exposure limit range

Exceptions

peak::afl::error::Exception if function fails

Since: 1.4

◆ GetGainAnalogLimit()

peak_afl_double_limit GetGainAnalogLimit ( ) const

inline

Get autofeature analog gain limit for a controller.

Returns: the current analog gain limit

Exceptions

peak::afl::error::Exception if function fails

Since: 1.6

◆ GetGainAnalogLimitRange()

peak_afl_double_limit GetGainAnalogLimitRange ( ) const

inline

Get autofeature analog gain limit range for a controller.

Returns: the possible range for analog gain limit

Exceptions

peak::afl::error::Exception if function fails

Since: 1.6

◆ GetGainCombinedLimit()

peak_afl_double_limit GetGainCombinedLimit ( ) const

inline

Get autofeature combined gain limit for a controller.

Returns: the current combined gain limit

Exceptions

peak::afl::error::Exception if function fails

Since: 1.6

◆ GetGainCombinedLimitRange()

peak_afl_double_limit GetGainCombinedLimitRange ( ) const

inline

Get autofeature combined gain limit range for a controller.

Returns: the possible range for combined gain limit

Exceptions

peak::afl::error::Exception if function fails

Since: 1.6

◆ GetGainDigitalLimit()

peak_afl_double_limit GetGainDigitalLimit ( ) const

inline

Get autofeature digital gain limit for a controller.

Returns: the current digital gain limit

Exceptions

peak::afl::error::Exception if function fails

Since: 1.6

◆ GetGainDigitalLimitRange()

peak_afl_double_limit GetGainDigitalLimitRange ( ) const

inline

Get autofeature digital gain limit range for a controller.

Returns: the possible range for digital gain limit

Exceptions

peak::afl::error::Exception if function fails

Since: 1.6

◆ GetGainHostLimit()

peak_afl_double_limit GetGainHostLimit ( ) const

inline

Get autofeature host gain limit for a controller.

Returns: the current host gain limit

Exceptions

peak::afl::error::Exception if function fails

Since: 1.6

◆ GetGainHostLimitRange()

peak_afl_double_limit GetGainHostLimitRange ( ) const

inline

Get autofeature host gain limit range for a controller.

Returns: the possible range for host gain limit

Exceptions

peak::afl::error::Exception if function fails

Since: 1.6

◆ GetGainLimit()

peak_afl_double_limit GetGainLimit ( ) const

inline

Get autofeature gain limit for a controller.

Returns: the current gain limit

Exceptions

peak::afl::error::Exception if function fails

Since: 1.3

◆ GetGainLimitRange()

peak_afl_double_limit GetGainLimitRange ( ) const

inline

Get autofeature gain limit range for a controller.

Returns: the possible range for gain limit

Exceptions

peak::afl::error::Exception if function fails

Since: 1.3

◆ GetHysteresis()

std::uint8_t GetHysteresis ( ) const

inline

Get the autofeature hysteresis for a controller.

Returns: the hysteresis set

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ GetHysteresisRange()

Range< std::uint8_t > GetHysteresisRange ( ) const

inline

Get autofeature hysteresis range for a controller.

Returns: the peak::afl::Range of the hysteresis

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ GetLastAutoAverage()

std::uint8_t GetLastAutoAverage ( ) const

inline

Get the last auto average for a controller.

Used by Controllers processing a mono image.

Returns: autofeature average

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ GetLastAutoAverages()

std::tuple< std::uint8_t, std::uint8_t, std::uint8_t > GetLastAutoAverages ( ) const

inline

Get the last auto average for a controller.

Used by Controllers processing a color image.

Returns: std::tuple<red, green, blue> in that order

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ GetLimit()

peak_afl_controller_limit GetLimit ( ) const

inline

Get the autofeature limit for a controller.

Returns: the limit set

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ GetMode()

peak_afl_controller_automode GetMode ( ) const

inline

Get the current autofeature mode for a controller.

Returns: autofeature mode

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ GetROI()

peak_afl_rectangle GetROI ( ) const

inline

Get the autofeature region of interest for a controller.

Get the region of interest for a controller. The processed image will be cropped to the region of interest set.

Returns: region of interest

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ GetSharpnessAlgorithm()

peak_afl_controller_sharpness_algorithm GetSharpnessAlgorithm ( ) const

inline

Get the used sharpness algorithm for a controller.

Returns: auto controller sharpness algorithm

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ GetSharpnessAlgorithmList()

std::vector< peak_afl_controller_sharpness_algorithm > GetSharpnessAlgorithmList ( ) const

inline

Get the list of supported sharpness algorithms for a controller.

To set a value, see SetSharpnessAlgorithm.

Returns: vector of supported algorithms

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ GetSkipFrames()

std::uint32_t GetSkipFrames ( ) const

inline

Get number of frames skipped for a controller.

Gets the skipped frames for the controller. Only every N-th image will be processed.

Returns: number of frames skipped

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ GetSkipFramesRange()

Range< std::uint32_t > GetSkipFramesRange ( ) const

inline

Get range for frames skipped for a controller.

Returns: valid peak::afl::Range for frames skipped

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ GetWeightedROIMinSize()

peak_afl_size GetWeightedROIMinSize ( ) const

inline

Get the autofeature minimum size of weighted region of interest for a controller.

Returns: the minimum size

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ GetWeightedROIs()

std::vector< peak_afl_weighted_rectangle > GetWeightedROIs ( ) const

inline

Get the autofeature weighted region of interest for a controller.

Returns: vector with set peak_afl_weighted_rectangle

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ IsAlgorithmSupported()

bool IsAlgorithmSupported ( ) const

inline

check if setting an algorithm is supported for a controller.

True if algorithm is supported, otherwise it is unsupported.

Call GetAlgorithmList to get a list of supported algorithms.

Returns: boolean if controller supports setting an algorithm

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ IsAutoPercentileSupported()

bool IsAutoPercentileSupported ( ) const

inline

check if auto percentile is supported for a controller.

True if auto percentile is supported, otherwise it is unsupported.

Returns: boolean if controller supports auto percentile

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ IsAutoTargetSupported()

bool IsAutoTargetSupported ( ) const

inline

check if auto target is supported for a controller.

True if auto target is supported, otherwise it is unsupported.

Returns: boolean if controller supports auto target

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ IsAutoToleranceSupported()

bool IsAutoToleranceSupported ( ) const

inline

check if auto tolerance is supported for a controller.

True if auto tolerance is supported, otherwise it is unsupported.

Returns: boolean if controller supports auto tolerance

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ IsBrightnessAlgorithmSupported()

bool IsBrightnessAlgorithmSupported ( ) const

inline

Check if auto brightness algorithm is supported for a controller.

true if auto brightness algorithm is supported, otherwise it is unsupported.

Returns: boolean if controller supports auto brightness algorithm

Exceptions

peak::afl::error::Exception if function fails

Since: 1.6

◆ IsBrightnessComponentModeSupported()

bool IsBrightnessComponentModeSupported ( ) const

inline

Check if auto mode is supported for a brightness controller component.

true if auto mode is supported, otherwise it is unsupported.

Returns: boolean if controller supports auto mode

Exceptions

peak::afl::error::Exception if function fails

Since: 1.2

◆ IsBrightnessComponentUnitSupported()

bool IsBrightnessComponentUnitSupported ( peak_afl_controller_brightness_component component ) const

inline

Check if a specific unit is supported for a brightness controller component.

true if auto unit is supported, otherwise it is unsupported.

Parameters

[in] component autofeature brightness unit

Returns: boolean if controller supports auto unit

Exceptions

peak::afl::error::Exception if function fails

Since: 1.6

◆ IsGainLimitSupported()

bool IsGainLimitSupported ( ) const

inline

Check if auto gain limit is supported for a controller.

Returns: true if auto gain limit is supported, otherwise returns false.

Exceptions

peak::afl::error::Exception if function fails

Since: 1.3

◆ IsHysteresisSupported()

bool IsHysteresisSupported ( ) const

inline

Check if hysteresis is supported for a controller.

True if hysteresis is supported, otherwise it is unsupported.

Returns: boolean if controller supports hysteresis

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ IsLimitSupported()

bool IsLimitSupported ( ) const

inline

Check if limit is supported for a controller.

True if limit is supported, otherwise it is unsupported.

Returns: boolean if controller supports limit

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ IsModeSupported()

bool IsModeSupported ( ) const

inline

Check if auto mode is supported for a controller.

true if auto mode is supported, otherwise it is unsupported.

Returns: boolean if controller supports auto mode

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ IsROIPresetSupported()

bool IsROIPresetSupported ( ) const

inline

Check if ROI preset is supported for a controller.

true if ROI preset is supported, otherwise it is unsupported.

Returns: boolean if controller supports ROI preset

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ IsROISupported()

bool IsROISupported ( ) const

inline

Check if setting a region of interest is supported for a controller.

If true region of interest is supported, otherwise it is unsupported.

Returns: boolean if controller supports setting a region of interest

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ IsSharpnessAlgorithmSupported()

bool IsSharpnessAlgorithmSupported ( ) const

inline

check setting a sharpness algorithm is supported by a controller.

True if sharpness algorithm is supported, otherwise it is unsupported.

Call GetSharpnessAlgorithmList to get a list of supported sharpness algorithms.

Returns: boolean if controller supports setting a sharpness algorithm

Exceptions

peak::afl::error::Exception if function fails

◆ IsSkipFramesSupported()

bool IsSkipFramesSupported ( ) const

inline

Check if skip frames is supported for a controller.

Returns: boolean if controller supports skipping frames

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ IsWeightedROISupported()

bool IsWeightedROISupported ( ) const

inline

Check if weighted region of interest is supported for a controller.

True if weighted region of interest is supported, otherwise it is unsupported.

Returns: boolean if controller supports weighted roi

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ RegisterComponentCallback()

void RegisterComponentCallback	(	peak_afl_controller_brightness_component	component,
		const callback::FinishedCallback &	callback )

inline

Set component callback for a controller.

Parameters

component	the controller brightness component
callback	the component finished callback

Since: 1.2

◆ RegisterDataProcessingCallback()

void RegisterDataProcessingCallback ( const callback::DataProcessingCallback & callback )

inline

Set the data callback for a controller.

Parameters

callback the Data processing callback

Deprecated: use RegisterProcessingCallback instead

Since: 1.1

◆ RegisterFinishedCallback()

void RegisterFinishedCallback ( const callback::FinishedCallback & callback )

inline

Set finished callback for a controller.

Registers the controller finished callback.

Parameters

callback the finished callback

Since: 1.1

◆ RegisterProcessingCallback()

void RegisterProcessingCallback ( const callback::ProcessingCallback & callback )

inline

Set the data callback for a controller.

Parameters

callback the processing callback

Since: 1.7

◆ SetAlgorithm()

void SetAlgorithm ( peak_afl_controller_algorithm algorithm )

inline

Set the used algorithm for a controller.

To get a list of supported algorithms see peak_afl_AutoController_Algorithm_GetList.

Parameters

[in] algorithm auto controller algorithm

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ SetAutoPercentile()

void SetAutoPercentile ( double percentile )

inline

Set the auto percentile for a controller.

This is the used percentile value for a controller. To get the valid range, call peak_afl_AutoController_AutoPercentile_GetRange.

Parameters

[in] percentile auto percentile value

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ SetAutoTarget()

void SetAutoTarget ( uint32_t target )

inline

Set the auto target for a controller.

Set an auto target. Call peak_afl_AutoController_AutoTarget_GetRange to get the valid range. End value which will be targeted by the controller.

Parameters

[in] target auto target value

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ SetAutoTolerance()

void SetAutoTolerance ( std::uint32_t tolerance )

inline

Set the auto tolerance for a controller.

Sets the +/- tolerance for the auto target value.

Parameters

[in] tolerance auto target value

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ SetBrightnessAlgorithm()

void SetBrightnessAlgorithm ( peak_afl_controller_brightness_algorithm algorithm )

inline

Set the autofeature brightness algorithm for a controller.

Will set the controller brightness algorithm to algorithm. See peak_afl_controller_brightness_algorithm for a list of valid values.

Parameters

[in] algorithm autofeature brightness algorithm

Exceptions

peak::afl::error::Exception if function fails

Since: 1.6

◆ SetExposureLimit()

void SetExposureLimit ( peak_afl_double_limit limit )

inline

Set the exposure limit for a controller.

Parameters

[in] limit limits the controller to adjust the exposure to the supplied range between min and max of limit.

Exceptions

peak::afl::error::Exception if function fails

Since: 1.4

◆ SetGainAnalogLimit()

void SetGainAnalogLimit ( peak_afl_double_limit limit )

inline

Set the analog gain limit for a controller.

The valid values are dependend on the used gain node and can be between minimum and maximum. Default is the complete range.

If any value of the limit is out of range, the value is clamped to be valid. In this case no exception is thrown. It is recommended to check the current values by calling SetGainAnalogLimit after this call.

Parameters

[in] limit limits the controller to adjust the analog gain to the supplied range between min and max of limit.

Exceptions

peak::afl::error::Exception if function fails

Since: 1.6

◆ SetGainCombinedLimit()

void SetGainCombinedLimit ( peak_afl_double_limit limit )

inline

Set the combined gain limit for a controller.

The valid values are dependend on the used gain node and can be between minimum and maximum. Default is the complete range.

If any value of the limit is out of range, the value is clamped to be valid. In this case no exception is thrown. It is recommended to check the current values by calling GetGainCombinedLimit after this call.

Parameters

[in] limit limits the controller to adjust the combined gain to the supplied range between min and max of limit.

Exceptions

peak::afl::error::Exception if function fails

Since: 1.6

◆ SetGainDigitalLimit()

void SetGainDigitalLimit ( peak_afl_double_limit limit )

inline

Set the digital gain limit for a controller.

The valid values are dependend on the used gain node and can be between minimum and maximum. Default is the complete range.

If any value of the limit is out of range, the value is clamped to be valid. In this case no exception is thrown. It is recommended to check the current values by calling GetGainDigitalLimit after this call.

Parameters

[in] limit limits the controller to adjust the digital gain to the supplied range between min and max of limit.

Exceptions

peak::afl::error::Exception if function fails

Since: 1.6

◆ SetGainHostLimit()

void SetGainHostLimit ( peak_afl_double_limit limit )

inline

Set the host gain limit for a controller.

The valid values are dependend on the used gain node and can be between minimum and maximum. Default is the complete range.

If any value of the limit is out of range, the value is clamped to be valid. In this case no exception is thrown. It is recommended to check the current values by calling GetGainHostLimit after this call.

Parameters

[in] limit limits the controller to adjust the host gain to the supplied range between min and max of limit.

Exceptions

peak::afl::error::Exception if function fails

Since: 1.6

◆ SetGainLimit()

void SetGainLimit ( peak_afl_double_limit limit )

inline

Set the gain limit for a controller.

The valid values are dependend on the used gain node and can be between minimum and maximum. Default is the complete range. The used priority list is: Analog -> Digital -> Any -> IPL (if supplied).

If any value of the limit is out of range, the value is clamped to be valid. In this case no exception is thrown. It is recommended to check the current values by calling GetGainLimit after this call.

Parameters

[in] limit limits the controller to adjust the gain to the supplied range between min and max of limit.

Exceptions

peak::afl::error::Exception if function fails

Since: 1.3

◆ SetHysteresis()

void SetHysteresis ( std::uint8_t hysteresis )

inline

Set the autofeature hysteresis for a controller.

Set the hysteresis for the algorithm set by SetAlgorithm

Parameters

[in] hysteresis the hysteresis to set

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ SetLimit()

void SetLimit ( peak_afl_controller_limit limit )

inline

Set the autofeature limit for a controller.

Sets the minimum and maximum limit for the algorithm set by peak_afl_AutoController_Algorithm_Set

Parameters

[in] limit the limit to set

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ SetMode()

void SetMode ( peak_afl_controller_automode mode )

inline

Set the autofeature mode for a controller.

Will set the controller mode to mode. See peak_afl_controller_automode for a list of valid values.

Parameters

[in] mode autofeature mode

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ SetROI()

void SetROI ( peak_afl_rectangle rect )

inline

Set the autofeature region of interest for a controller.

Set the region of interest for a controller. The processed image will be cropped to the region of interest set.

Parameters

[in] rect region of interest

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ SetROIPreset()

void SetROIPreset ( peak_afl_roi_preset preset )

inline

Set the autofeature region of interest preset for a controller.

Will set the supplied preset as region of interest. See also SetROI.

Parameters

[in] preset region of interest preset

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ SetSharpnessAlgorithm()

void SetSharpnessAlgorithm ( peak_afl_controller_sharpness_algorithm algorithm )

inline

Set the used sharpness algorithm for a controller.

To get a list of supported algorithms see peak_afl_AutoController_SharpnessAlgorithm_GetList.

Parameters

[in] algorithm auto controller sharpness algorithm

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ SetSkipFrames()

void SetSkipFrames ( std::uint32_t count )

inline

Set number of frames skipped for a controller.

Sets the skipped frames for the controller. Only every N-th image will be processed.

Parameters

[in] count number of frames skipped

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ SetWeightedROI()

void SetWeightedROI ( const peak_afl_weighted_rectangle & rect )

inline

Set single autofeature weighted region of interest for a controller.

Already set weighted regions of interest will be overwritten

Parameters

[in] rect weighted region of interest

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ SetWeightedROIs()

void SetWeightedROIs ( const std::vector< peak_afl_weighted_rectangle > & list )

inline

Set the autofeature weighted region of interest for a controller.

Already set weighted regions of interest will be overwritten

Parameters

[in] list vector of weighted region of interest

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ Status()

peak_afl_controller_status Status ( ) const

inline

Get the status for a controller.

See peak_afl_controller_status for a list of values.

Returns: controller status

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ Type()

peak_afl_controllerType Type ( ) const

inline

Get the controller type.

See peak_afl_controllerType for a list of values.

Returns: auto controller type

Exceptions

peak::afl::error::Exception if function fails

Since: 1.1

◆ UnRegisterComponentCallback()

void UnRegisterComponentCallback ( peak_afl_controller_brightness_component component )

inline

Reset the component callback for a controller.

Removes the previously registered component callback.

Parameters

component the controller brightness component

Since: 1.2

◆ UnRegisterDataProcessingCallback()

void UnRegisterDataProcessingCallback ( )

inline

Reset the data callback for a controller.

Deprecated: use UnRegisterProcessingCallback instead

Since: 1.1

◆ UnRegisterFinishedCallback()

void UnRegisterFinishedCallback ( )

inline

Reset the finished callback for a controller.

Removes the previously registered finished callback.

Since: 1.1

◆ UnRegisterProcessingCallback()

void UnRegisterProcessingCallback ( )

inline

Reset the data callback for a controller.

Removes the previously registered callback.

Since: 1.7

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

peak_afl/peak_afl.hpp

Public Member Functions

Static Public Member Functions

Detailed Description

Controller Types

Feature Management

Regions of Interest

Callback Management

Lifetime and Ownership

Exceptions

Constructor & Destructor Documentation

◆ ~Controller()

Member Function Documentation

◆ BrightnessComponentGetMode()

◆ BrightnessComponentSetMode()

◆ BrightnessComponentStatus()

◆ Create()

◆ GetAlgorithm()

◆ GetAlgorithmList()

◆ GetAutoPercentile()

◆ GetAutoPercentileRange()

◆ GetAutoTarget()

◆ GetAutoTargetRange()

◆ GetAutoTolerance()

◆ GetAutoToleranceRange()

◆ GetBrightnessAlgorithm()

◆ GetDefaultHysteresis()

◆ GetDefaultLimit()

◆ GetExposureLimit()

◆ GetExposureLimitRange()

◆ GetGainAnalogLimit()

◆ GetGainAnalogLimitRange()

◆ GetGainCombinedLimit()

◆ GetGainCombinedLimitRange()

◆ GetGainDigitalLimit()

◆ GetGainDigitalLimitRange()

◆ GetGainHostLimit()

◆ GetGainHostLimitRange()

◆ GetGainLimit()

◆ GetGainLimitRange()

◆ GetHysteresis()

◆ GetHysteresisRange()

◆ GetLastAutoAverage()

◆ GetLastAutoAverages()

◆ GetLimit()

◆ GetMode()

◆ GetROI()

◆ GetSharpnessAlgorithm()

◆ GetSharpnessAlgorithmList()

◆ GetSkipFrames()

◆ GetSkipFramesRange()

◆ GetWeightedROIMinSize()

◆ GetWeightedROIs()

◆ IsAlgorithmSupported()

◆ IsAutoPercentileSupported()

◆ IsAutoTargetSupported()

◆ IsAutoToleranceSupported()

◆ IsBrightnessAlgorithmSupported()

◆ IsBrightnessComponentModeSupported()

◆ IsBrightnessComponentUnitSupported()

◆ IsGainLimitSupported()

◆ IsHysteresisSupported()

◆ IsLimitSupported()

◆ IsModeSupported()

◆ IsROIPresetSupported()

◆ IsROISupported()

◆ IsSharpnessAlgorithmSupported()

◆ IsSkipFramesSupported()

◆ IsWeightedROISupported()

◆ RegisterComponentCallback()

◆ RegisterDataProcessingCallback()

◆ RegisterFinishedCallback()

◆ RegisterProcessingCallback()

◆ SetAlgorithm()

◆ SetAutoPercentile()

◆ SetAutoTarget()

◆ SetAutoTolerance()

◆ SetBrightnessAlgorithm()

◆ SetExposureLimit()

◆ SetGainAnalogLimit()

◆ SetGainCombinedLimit()