Sharpness algorithm

Enumerations
enum	peak_afl_controller_sharpness_algorithm {   PEAK_AFL_CONTROLLER_SHARPNESS_ALGORITHM_AUTO , PEAK_AFL_CONTROLLER_SHARPNESS_ALGORITHM_TENENGRAD , PEAK_AFL_CONTROLLER_SHARPNESS_ALGORITHM_SOBEL , PEAK_AFL_CONTROLLER_SHARPNESS_ALGORITHM_MEAN_SCORE ,   PEAK_AFL_CONTROLLER_SHARPNESS_ALGORITHM_HISTOGRAM_VARIANCE }
	controller sharpness algorithm (focus) More...

Functions
PEAK_AFL_API_STATUS	peak_afl_AutoController_SharpnessAlgorithm_IsSupported (peak_afl_controller_handle controller, peak_afl_BOOL8 *supported)
	check setting a sharpness algorithm is supported by a controller.
PEAK_AFL_API_STATUS	peak_afl_AutoController_SharpnessAlgorithm_Set (peak_afl_controller_handle controller, peak_afl_controller_sharpness_algorithm algorithm)
	Set the used sharpness algorithm for a controller.
PEAK_AFL_API_STATUS	peak_afl_AutoController_SharpnessAlgorithm_Get (peak_afl_controller_handle controller, peak_afl_controller_sharpness_algorithm *algorithm)
	Get the used sharpness algorithm for a controller.
PEAK_AFL_API_STATUS	peak_afl_AutoController_SharpnessAlgorithm_GetList (peak_afl_controller_handle controller, peak_afl_controller_sharpness_algorithm *typeList, uint32_t *listSize)
	Get the list of supported sharpness algorithms for a controller.

Detailed Description

Sets the algorithm for the sharpness calculation.

• Auto: Defaults to PEAK_AFL_CONTROLLER_SHARPNESS_ALGORITHM_TENENGRAD
• Tenengrad: Sobel factors in x- and y-direction and summation of the euclidean distances.
• Mean Score: Summation of the difference between two mean values from two pixel values each in x- and y-direction.
• Histogram Variance: Standard deviation of the gray values in the histogram of the mean value.

Enumeration Type Documentation

peak_afl_controller_sharpness_algorithm

enum peak_afl_controller_sharpness_algorithm

controller sharpness algorithm (focus)

Enumerator
PEAK_AFL_CONTROLLER_SHARPNESS_ALGORITHM_AUTO	Controller sharpness algorithm auto.
PEAK_AFL_CONTROLLER_SHARPNESS_ALGORITHM_TENENGRAD	Controller sharpness algorithm tenengrad.
PEAK_AFL_CONTROLLER_SHARPNESS_ALGORITHM_SOBEL	Controller sharpness algorithm sobel.
PEAK_AFL_CONTROLLER_SHARPNESS_ALGORITHM_MEAN_SCORE	Controller sharpness algorithm mean score.
PEAK_AFL_CONTROLLER_SHARPNESS_ALGORITHM_HISTOGRAM_VARIANCE	Controller sharpness algorithm histogram variance.

Function Documentation

peak_afl_AutoController_SharpnessAlgorithm_Get()

PEAK_AFL_API_STATUS peak_afl_AutoController_SharpnessAlgorithm_Get	(	peak_afl_controller_handle	controller,
		peak_afl_controller_sharpness_algorithm *	algorithm )

Get the used sharpness algorithm for a controller.

Parameters

[in]	controller	controller handle
[out]	algorithm	auto controller sharpness 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_SharpnessAlgorithm_GetList()

PEAK_AFL_API_STATUS peak_afl_AutoController_SharpnessAlgorithm_GetList	(	peak_afl_controller_handle	controller,
		peak_afl_controller_sharpness_algorithm *	typeList,
		uint32_t *	listSize )

Get the list of supported sharpness algorithms for a controller.

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

Parameters

[in]	controller	controller handle
[out]	typeList	Pointer to a user allocated list of peak_afl_controller_sharpness_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_sharpness_algorithm to hold the list typeList unequal NULL: in: size of the provided lastErrorMessage in counts of peak_afl_controller_sharpness_algorithm out: number of peak_afl_controller_sharpness_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_SharpnessAlgorithm_IsSupported()

PEAK_AFL_API_STATUS peak_afl_AutoController_SharpnessAlgorithm_IsSupported	(	peak_afl_controller_handle	controller,
		peak_afl_BOOL8 *	supported )

check setting a sharpness algorithm is supported by a controller.

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

Call peak_afl_AutoController_SharpnessAlgorithm_GetList to get a list of supported sharpness algorithms.

Parameters

[in]	controller	controller handle
[out]	supported	boolean if controller supports setting a sharpness 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_SharpnessAlgorithm_Set()

PEAK_AFL_API_STATUS peak_afl_AutoController_SharpnessAlgorithm_Set	(	peak_afl_controller_handle	controller,
		peak_afl_controller_sharpness_algorithm	algorithm )

Set the used sharpness algorithm for a controller.

To get a list of supported algorithms, see peak_afl_AutoController_SharpnessAlgorithm_GetList.

Parameters

[in]	controller	controller handle
[in]	algorithm	auto controller sharpness 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