Peak search algorithm

Enumerations
enum	peak_afl_controller_algorithm {   PEAK_AFL_CONTROLLER_ALGORITHM_AUTO , PEAK_AFL_CONTROLLER_ALGORITHM_GOLDEN_RATIO_SEARCH , PEAK_AFL_CONTROLLER_ALGORITHM_HILL_CLIMBING_SEARCH , PEAK_AFL_CONTROLLER_ALGORITHM_GLOBAL_SEARCH ,   PEAK_AFL_CONTROLLER_ALGORITHM_FULL_SCAN }
	controller algorithm More...

Functions
PEAK_AFL_API_STATUS	peak_afl_AutoController_Algorithm_IsSupported (peak_afl_controller_handle controller, peak_afl_BOOL8 *supported)
	check if setting an algorithm is supported for a controller.
PEAK_AFL_API_STATUS	peak_afl_AutoController_Algorithm_Set (peak_afl_controller_handle controller, peak_afl_controller_algorithm algorithm)
	Set the used algorithm for a controller.
PEAK_AFL_API_STATUS	peak_afl_AutoController_Algorithm_Get (peak_afl_controller_handle controller, peak_afl_controller_algorithm *algorithm)
	Get the used algorithm for a controller.
PEAK_AFL_API_STATUS	peak_afl_AutoController_Algorithm_GetList (peak_afl_controller_handle controller, peak_afl_controller_algorithm *typeList, uint32_t *listSize)
	Get the list of supported algorithms for a controller.

Detailed Description

Sets the algorithm for the maximum value search.

Note

If no maximum value can be found after 300 iterations, the search is aborted and the focus value is reset to the previous value.

• Auto: Defaults to PEAK_AFL_CONTROLLER_ALGORITHM_GOLDEN_RATIO_SEARCH
• Golden Ratio Search: Within the preset interval range, the focus function repeatedly divides into new intervals using the Golden Ratio. The interval range is decreased with each new calculation. This process continues until the interval range is less than or equal to the set hysteresis.
• Hill Climbing Search: Within the preset interval range, the focus function scans the register values for a maximum with medium step width until two falling sharpness values occur at the last two steps. Based on these values and the step width, the interval range and step width are reduced and the scan is repeated within this interval. This process continues until the interval range is less than or equal to the set hysteresis.
• Global Search: Within the preset interval range, the focus function completely scans with medium step width and the maximum that occurred is memorized. Based on the maximum, the interval range and the step width are reduced and the scan is repeated within this interval. This process continues until the interval range is less than or equal to the set hysteresis.
• Full Scan: Within the preset interval range, the focus function scans with a constant step width for an optimal result (step width: hysteresis).

Enumeration Type Documentation

peak_afl_controller_algorithm

enum peak_afl_controller_algorithm

controller algorithm

Enumerator
PEAK_AFL_CONTROLLER_ALGORITHM_AUTO	Controller algorithm auto.
PEAK_AFL_CONTROLLER_ALGORITHM_GOLDEN_RATIO_SEARCH	Controller algorithm golden ratio search.
PEAK_AFL_CONTROLLER_ALGORITHM_HILL_CLIMBING_SEARCH	Controller algorithm hill climbing search.
PEAK_AFL_CONTROLLER_ALGORITHM_GLOBAL_SEARCH	Controller algorithm global search.
PEAK_AFL_CONTROLLER_ALGORITHM_FULL_SCAN	Controller algorithm full scan.

Function Documentation

peak_afl_AutoController_Algorithm_Get()

PEAK_AFL_API_STATUS peak_afl_AutoController_Algorithm_Get	(	peak_afl_controller_handle	controller,
		peak_afl_controller_algorithm *	algorithm )

Get the used algorithm for a controller.

Parameters

[in]	controller	controller handle
[out]	algorithm	auto controller algorithm

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_Algorithm_GetList()

PEAK_AFL_API_STATUS peak_afl_AutoController_Algorithm_GetList	(	peak_afl_controller_handle	controller,
		peak_afl_controller_algorithm *	typeList,
		uint32_t *	listSize )

Get the list of supported algorithms for a controller.

Uses the Two Staged Data Query principle. To set a value, see peak_afl_AutoController_Algorithm_Set.

Parameters

[in]	controller	controller handle
[out]	typeList	Pointer to a user allocated list of peak_afl_controller_algorithm. If this parameter is NULL, listSize will contain the needed count of typeList.
[in,out]	listSize	typeList equal NULL: out: minimal size of listSize in count of peak_afl_controller_algorithm to hold the list typeList unequal NULL: in: size of the provided lastErrorMessage in counts of peak_afl_controller_algorithm out: number of peak_afl_controller_algorithm used by the function

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_BUFFER_TOO_SMALL The supplied buffer is too small.

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_Algorithm_IsSupported()

PEAK_AFL_API_STATUS peak_afl_AutoController_Algorithm_IsSupported	(	peak_afl_controller_handle	controller,
		peak_afl_BOOL8 *	supported )

check if setting an algorithm is supported for a controller.

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

Call peak_afl_AutoController_Algorithm_GetList to get a list of supported algorithms.

Parameters

[in]	controller	controller handle
[out]	supported	boolean if controller supports setting an algorithm

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_Algorithm_Set()

PEAK_AFL_API_STATUS peak_afl_AutoController_Algorithm_Set	(	peak_afl_controller_handle	controller,
		peak_afl_controller_algorithm	algorithm )

Set the used algorithm for a controller.

To get a list of supported algorithms, see peak_afl_AutoController_Algorithm_GetList.

Parameters

[in]	controller	controller handle
[in]	algorithm	auto controller algorithm

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