 |
IDS peak AFL v2.1.0
|
|
IDS peak AFL v2.1.0
|
General gain range limits for brightness control. More...
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. | |
General 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.
| 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.
Retrieves the currently configured gain limits for the controller. This returns the same limits that were previously set using peak_afl_AutoController_GainLimit_Set, or the default limits if none were set.
The returned limits reflect the current constraints applied to the overall gain control strategy. These limits affect how the controller manages gain across all available gain types (analog, digital, combined, host) according to the priority order established by the implementation.
| [in] | controller | controller handle |
| [out] | limit | the current gain limit |
| 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.
Retrieves the valid range of gain limit values that can be configured for this controller. The range provides the minimum and maximum allowable gain values, helping you determine appropriate limits before calling peak_afl_AutoController_GainLimit_Set.
The range represents the overall gain capabilities of the system, taking into account all available gain types and their combined effect. This information is essential for setting realistic and effective gain limits that work within the hardware and software capabilities of the imaging system.
| [in] | controller | controller handle |
| [out] | limit | the possible range for gain limit |
| 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.
Determines whether the controller supports configurable gain limits. Gain limits allow you to constrain the range of gain values that the controller can apply during automatic brightness adjustments. This is useful for preventing excessive noise (from high gain) or underexposure (from insufficient gain).
The gain limit feature provides control over the automatic gain adjustments by setting boundaries within which the controller can operate. This helps maintain image quality by preventing the controller from applying gain values that would result in unacceptable noise levels or insufficient signal amplification.
If supported is PEAK_AFL_TRUE gain limit is supported, otherwise it is unsupported.
| [in] | controller | controller handle |
| [out] | supported | true if auto gain limit is supported, otherwise returns false. |
| 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.
Configures the gain limits that constrain the automatic brightness adjustments. This prevents the controller from applying gain values outside the specified range, helping to maintain image quality by avoiding excessive noise or underexposure.
The gain limit applies to the overall gain control strategy used by the controller. When multiple gain types are available, the controller will prioritize them according to the following order for optimal signal-to-noise ratio: Analog -> Digital -> Any -> IPL (if supplied). This ensures that analog gain (which typically provides better noise performance) is used before digital gain when possible.
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.
| [in] | controller | controller handle |
| [in] | limit | Limits the controller to adjust the gain to the supplied range between min and max of limit. |