Limit

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

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.

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.

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.

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.

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