Gain limit

Functions
PEAK_AFL_API_STATUS	peak_afl_AutoController_GainLimit_IsSupported (peak_afl_controller_handle controller, peak_afl_BOOL8 *supported)
	Check if gain limit is supported for a controller.
PEAK_AFL_API_STATUS	peak_afl_AutoController_GainLimit_Set (peak_afl_controller_handle controller, peak_afl_double_limit limit)
	Set autofeature gain limit for a controller.
PEAK_AFL_API_STATUS	peak_afl_AutoController_GainLimit_Get (peak_afl_controller_handle controller, peak_afl_double_limit *limit)
	Get autofeature gain limit for a controller.
PEAK_AFL_API_STATUS	peak_afl_AutoController_GainLimit_GetRange (peak_afl_controller_handle controller, peak_afl_double_limit *limit)
	Get autofeature gain limit range for a controller.

Detailed Description

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_GainLimit_Get()

PEAK_AFL_API_STATUS peak_afl_AutoController_GainLimit_Get	(	peak_afl_controller_handle	controller,
		peak_afl_double_limit *	limit )

Get autofeature gain limit for a controller.

Parameters

[in]	controller	controller handle
[out]	limit	the current 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.3

peak_afl_AutoController_GainLimit_GetRange()

PEAK_AFL_API_STATUS peak_afl_AutoController_GainLimit_GetRange	(	peak_afl_controller_handle	controller,
		peak_afl_double_limit *	limit )

Get autofeature gain limit range for a controller.

Parameters

[in]	controller	controller handle
[out]	limit	the possible range for 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.3

peak_afl_AutoController_GainLimit_IsSupported()

PEAK_AFL_API_STATUS peak_afl_AutoController_GainLimit_IsSupported	(	peak_afl_controller_handle	controller,
		peak_afl_BOOL8 *	supported )

Check if gain limit is supported for a controller.

If supported is PEAK_AFL_TRUE gain limit is supported, otherwise it is unsupported.

Parameters

[in]	controller	controller handle
[out]	supported	true if auto gain limit is supported, otherwise returns false.

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_ERROR An unexpected internal error occurred.

Since

1.3

peak_afl_AutoController_GainLimit_Set()

PEAK_AFL_API_STATUS peak_afl_AutoController_GainLimit_Set	(	peak_afl_controller_handle	controller,
		peak_afl_double_limit	limit )

Set autofeature gain limit for a controller.

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

Parameters

[in]	controller	controller handle
[in]	limit	Limits the controller to adjust the 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.3