Limit

Focus position range limits and boundaries. More...

Data Structures
struct	peak_afl_controller_limit
	Controller parameter limit range. More...

Functions
PEAK_AFL_API_STATUS	peak_afl_AutoController_Limit_IsSupported (peak_afl_controller_handle controller, peak_afl_BOOL8 *supported)
	Check if limit is supported for a controller.
PEAK_AFL_API_STATUS	peak_afl_AutoController_Limit_Default (peak_afl_controller_handle controller, peak_afl_controller_limit *limit)
	Get the autofeature default limit.
PEAK_AFL_API_STATUS	peak_afl_AutoController_Limit_Set (peak_afl_controller_handle controller, peak_afl_controller_limit limit)
	Set the autofeature limit for a controller.
PEAK_AFL_API_STATUS	peak_afl_AutoController_Limit_Get (peak_afl_controller_handle controller, peak_afl_controller_limit *limit)
	Get the autofeature limit for a controller.

Detailed Description

Focus position range limits and boundaries.

With the minimum and maximum limit the focus search range for the focus_algorithm can be limited. The focus_limit affects whether and where a maximum value is found.

Function Documentation

peak_afl_AutoController_Limit_Default()

PEAK_AFL_API_STATUS peak_afl_AutoController_Limit_Default	(	peak_afl_controller_handle	controller,
		peak_afl_controller_limit *	limit )

Get the autofeature default limit.

Retrieves the default limit values that the controller uses when no custom limits have been set. These defaults typically represent the full range of values that the controller can work with, providing unrestricted operation.

Parameters

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

peak_afl_AutoController_Limit_Get()

PEAK_AFL_API_STATUS peak_afl_AutoController_Limit_Get	(	peak_afl_controller_handle	controller,
		peak_afl_controller_limit *	limit )

Get the autofeature limit for a controller.

Retrieves the currently configured operational limits for the controller. This returns the same limits that were previously set using peak_afl_AutoController_Limit_Set, or the default limits if none were set.

Parameters

[in]	controller	controller handle
[out]	limit	the limit to get

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.0

peak_afl_AutoController_Limit_IsSupported()

PEAK_AFL_API_STATUS peak_afl_AutoController_Limit_IsSupported	(	peak_afl_controller_handle	controller,
		peak_afl_BOOL8 *	supported )

Check if limit is supported for a controller.

Determines whether the controller supports configurable limits for its operation. Limits allow you to constrain the range of values that the controller can set during automatic adjustments. This is useful for preventing the controller from making adjustments that are too extreme or outside acceptable bounds.

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

Parameters

[in]	controller	controller handle
[out]	supported	boolean if controller supports 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_ERROR An unexpected internal error occurred.

Since

1.0

peak_afl_AutoController_Limit_Set()

PEAK_AFL_API_STATUS peak_afl_AutoController_Limit_Set	(	peak_afl_controller_handle	controller,
		peak_afl_controller_limit	limit )

Set the autofeature limit for a controller.

Configures the operational limits for the controller, constraining the range of values it can set during automatic adjustments. This prevents the controller from making adjustments outside the specified bounds, which is useful for maintaining image quality within acceptable parameters.

Sets the minimum and maximum limit for the algorithm set by peak_afl_AutoController_Algorithm_Set.

Parameters

[in]	controller	controller handle
[in]	limit	the limit to set

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.0