Gain analog limit

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

Functions
PEAK_AFL_API_STATUS	peak_afl_AutoController_GainAnalogLimit_Set (peak_afl_controller_handle controller, peak_afl_double_limit limit)
	Set autofeature analog gain limit for a controller.
PEAK_AFL_API_STATUS	peak_afl_AutoController_GainAnalogLimit_Get (peak_afl_controller_handle controller, peak_afl_double_limit *limit)
	Get autofeature analog gain limit for a controller.
PEAK_AFL_API_STATUS	peak_afl_AutoController_GainAnalogLimit_GetRange (peak_afl_controller_handle controller, peak_afl_double_limit *limit)
	Get autofeature analog gain limit range for a controller.

Detailed Description

Analog 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_GainAnalogLimit_Get()

PEAK_AFL_API_STATUS peak_afl_AutoController_GainAnalogLimit_Get	(	peak_afl_controller_handle	controller,
		peak_afl_double_limit *	limit )

Get autofeature analog gain limit for a controller.

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

The analog gain limits directly control the signal amplification at the sensor level, which is critical for maintaining optimal image quality. These limits help ensure that the analog gain stays within ranges that provide good signal-to-noise ratio without causing sensor saturation.

Parameters

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

PEAK_AFL_API_STATUS peak_afl_AutoController_GainAnalogLimit_GetRange	(	peak_afl_controller_handle	controller,
		peak_afl_double_limit *	limit )

Get autofeature analog gain limit range for a controller.

Retrieves the valid range of analog gain limit values that can be configured. Use this information to determine appropriate analog gain limits before calling peak_afl_AutoController_GainAnalogLimit_Set.

The analog gain range is determined by the sensor and camera hardware capabilities. Understanding this range is essential for setting effective limits that take advantage of the sensor's optimal operating region while avoiding problematic gain levels that could introduce excessive noise or saturation.

Parameters

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

PEAK_AFL_API_STATUS peak_afl_AutoController_GainAnalogLimit_Set	(	peak_afl_controller_handle	controller,
		peak_afl_double_limit	limit )

Set autofeature analog gain limit for a controller.

Configures the analog gain limits specifically for the analog gain stage. Analog gain is typically applied in the sensor or early in the signal chain and generally provides better signal-to-noise ratio than digital gain.

Analog gain limits are particularly important because they directly affect the signal quality at the earliest stage of image acquisition. By constraining analog gain appropriately, you can ensure optimal signal-to-noise ratio while preventing saturation or insufficient signal amplification at the sensor level.

The valid values are dependent on the analog 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_GainAnalogLimit_Get after this call.

Parameters

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