Gain digital limit

Digital gain range limits for brightness control. More...

Functions
PEAK_AFL_API_STATUS	peak_afl_AutoController_GainDigitalLimit_Set (peak_afl_controller_handle controller, peak_afl_double_limit limit)
	Set autofeature digital gain limit for a controller.
PEAK_AFL_API_STATUS	peak_afl_AutoController_GainDigitalLimit_Get (peak_afl_controller_handle controller, peak_afl_double_limit *limit)
	Get autofeature digital gain limit for a controller.
PEAK_AFL_API_STATUS	peak_afl_AutoController_GainDigitalLimit_GetRange (peak_afl_controller_handle controller, peak_afl_double_limit *limit)
	Get autofeature digital gain limit range for a controller.

Detailed Description

Digital 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_GainDigitalLimit_Get()

PEAK_AFL_API_STATUS peak_afl_AutoController_GainDigitalLimit_Get	(	peak_afl_controller_handle	controller,
		peak_afl_double_limit *	limit )

Get autofeature digital gain limit for a controller.

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

Parameters

[in]	controller	controller handle
[out]	limit	the current digital 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_GainDigitalLimit_GetRange()

PEAK_AFL_API_STATUS peak_afl_AutoController_GainDigitalLimit_GetRange	(	peak_afl_controller_handle	controller,
		peak_afl_double_limit *	limit )

Get autofeature digital gain limit range for a controller.

Retrieves the valid range of digital gain limit values that can be configured for this controller. The range provides the minimum and maximum allowable digital gain values, helping you determine appropriate limits before calling peak_afl_AutoController_GainDigitalLimit_Set.

Parameters

[in]	controller	controller handle
[out]	limit	the possible range for digital 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_GainDigitalLimit_Set()

PEAK_AFL_API_STATUS peak_afl_AutoController_GainDigitalLimit_Set	(	peak_afl_controller_handle	controller,
		peak_afl_double_limit	limit )

Set autofeature digital gain limit for a controller.

Configures the digital gain limits specifically for the digital gain stage. Digital gain is applied after analog-to-digital conversion and can introduce more noise than analog gain, but provides finer control and wider range.

Digital gain limits are important for balancing image brightness requirements with noise performance. While digital gain can provide extensive amplification ranges, higher values amplify both signal and noise, potentially degrading image quality. Setting appropriate limits helps maintain acceptable noise levels.

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_GainDigitalLimit_Get after this call.

Parameters

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