Auto percentile

Functions
PEAK_AFL_API_STATUS	peak_afl_AutoController_AutoPercentile_IsSupported (peak_afl_controller_handle controller, peak_afl_BOOL8 *supported)
	check if auto percentile is supported for a controller.
PEAK_AFL_API_STATUS	peak_afl_AutoController_AutoPercentile_Set (peak_afl_controller_handle controller, double percentile)
	Set the auto percentile for a controller.
PEAK_AFL_API_STATUS	peak_afl_AutoController_AutoPercentile_Get (peak_afl_controller_handle controller, double *percentile)
	Get the auto percentile for a controller.
PEAK_AFL_API_STATUS	peak_afl_AutoController_AutoPercentile_GetRange (peak_afl_controller_handle controller, double *min, double *max, double *inc)
	Get the auto percentile range for a controller.

Detailed Description

Defines the percentage of pixels that must be brighter than the target value. The percentile value is only used for the Median brightness calculation algorithm.

Function Documentation

peak_afl_AutoController_AutoPercentile_Get()

PEAK_AFL_API_STATUS peak_afl_AutoController_AutoPercentile_Get	(	peak_afl_controller_handle	controller,
		double *	percentile )

Get the auto percentile for a controller.

Parameters

[in]	controller	controller handle
[out]	percentile	auto percentile value

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

PEAK_AFL_API_STATUS peak_afl_AutoController_AutoPercentile_GetRange	(	peak_afl_controller_handle	controller,
		double *	min,
		double *	max,
		double *	inc )

Get the auto percentile range for a controller.

Call this function to get the range of valid values which can be set by a call to peak_afl_AutoController_AutoPercentile_Set.

Parameters

[in]	controller	controller handle
[out]	min	auto percentile minimum value
[out]	max	auto percentile maximum value
[out]	inc	auto percentile increment value

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

PEAK_AFL_API_STATUS peak_afl_AutoController_AutoPercentile_IsSupported	(	peak_afl_controller_handle	controller,
		peak_afl_BOOL8 *	supported )

check if auto percentile is supported for a controller.

If supported is PEAK_AFL_TRUE auto percentile is supported, otherwise it is unsupported.

Parameters

[in]	controller	controller handle
[out]	supported	boolean if controller supports auto percentile

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

PEAK_AFL_API_STATUS peak_afl_AutoController_AutoPercentile_Set	(	peak_afl_controller_handle	controller,
		double	percentile )

Set the auto percentile for a controller.

This is the used percentile value for a controller. To get the valid range, call peak_afl_AutoController_AutoPercentile_GetRange.

Parameters

[in]	controller	controller handle
[in]	percentile	auto percentile value

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