Gain host limit

Host-side gain range limits for brightness control. More...

Functions
PEAK_AFL_API_STATUS	peak_afl_AutoController_GainHostLimit_Set (peak_afl_controller_handle controller, peak_afl_double_limit limit)
	Set autofeature host gain limit for a controller.
PEAK_AFL_API_STATUS	peak_afl_AutoController_GainHostLimit_Get (peak_afl_controller_handle controller, peak_afl_double_limit *limit)
	Get autofeature host gain limit for a controller.
PEAK_AFL_API_STATUS	peak_afl_AutoController_GainHostLimit_GetRange (peak_afl_controller_handle controller, peak_afl_double_limit *limit)
	Get autofeature host gain limit range for a controller.

Detailed Description

Host-side gain range limits for brightness control.

With this feature it is possible to define precisely the allowed range of the exposure time or gains for automatic adjustments, when auto brightness is enabled.

Function Documentation

peak_afl_AutoController_GainHostLimit_Get()

PEAK_AFL_API_STATUS peak_afl_AutoController_GainHostLimit_Get	(	peak_afl_controller_handle	controller,
		peak_afl_double_limit *	limit )

Get autofeature host gain limit for a controller.

Retrieves the currently configured host gain limits. This returns the same limits that were previously set using peak_afl_AutoController_GainHostLimit_Set, or the default limits if none were set.

Parameters

[in]	controller	controller handle
[out]	limit	the current host gain limit

Returns

PEAK_AFL_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_AFL_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_AFL_STATUS_INVALID_PARAMETER The argument is invalid.

PEAK_AFL_STATUS_NOT_SUPPORTED The function is not supported.

PEAK_AFL_STATUS_ERROR An unexpected internal error occurred.

Since

1.6

peak_afl_AutoController_GainHostLimit_GetRange()

PEAK_AFL_API_STATUS peak_afl_AutoController_GainHostLimit_GetRange	(	peak_afl_controller_handle	controller,
		peak_afl_double_limit *	limit )

Get autofeature host gain limit range for a controller.

Retrieves the valid range of host gain limit values that can be configured for this controller. Host gain is applied in software on the host system and provides maximum flexibility. Use this information to determine appropriate host gain limits before calling peak_afl_AutoController_GainHostLimit_Set.

Parameters

[in]	controller	controller handle
[out]	limit	the possible range for host gain limit

Returns

PEAK_AFL_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_AFL_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_AFL_STATUS_INVALID_PARAMETER The argument is invalid.

PEAK_AFL_STATUS_NOT_SUPPORTED The function is not supported.

PEAK_AFL_STATUS_ERROR An unexpected internal error occurred.

Since

1.6

peak_afl_AutoController_GainHostLimit_Set()

PEAK_AFL_API_STATUS peak_afl_AutoController_GainHostLimit_Set	(	peak_afl_controller_handle	controller,
		peak_afl_double_limit	limit )

Set autofeature host gain limit for a controller.

Configures the host gain limits for gain processing performed on the host system (CPU/software-based gain). Host gain provides maximum flexibility and precision but may have performance implications compared to hardware-based gain stages.

The valid values are dependent 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, the function returns with PEAK_AFL_STATUS_VALUE_ADJUSTED. It is recommended to check the current values by calling peak_afl_AutoController_GainHostLimit_Get after this call.

Parameters

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

Returns

PEAK_AFL_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_AFL_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_AFL_STATUS_INVALID_PARAMETER The argument is invalid.

PEAK_AFL_STATUS_VALUE_ADJUSTED At least one value of the limit is out of range. The limit was adjusted accordingly.

PEAK_AFL_STATUS_NOT_SUPPORTED The function is not supported.

PEAK_AFL_STATUS_ERROR An unexpected internal error occurred.

Since

1.6