Auto percentile

Percentile-based brightness analysis configuration. More...

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

Percentile-based brightness analysis configuration.

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.

Retrieves the currently configured percentile value used for statistical analysis by the controller. This is the same value that was previously set using peak_afl_AutoController_AutoPercentile_Set.

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.

Retrieves the valid range of percentile values that can be configured for this controller. Percentile values are typically expressed as decimal values between 0.0 and 1.0 (representing 0% to 100%). The range provides the minimum and maximum allowable percentile values, as well as the increment step size.

Call this function to determine valid percentile values before calling peak_afl_AutoController_AutoPercentile_Set to ensure the desired percentile is within the supported range.

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 sets the percentile value used for statistical analysis by the controller. The percentile determines which portion of the histogram is used for calculations. For example, a value of 0.95 means the 95th percentile will be used. 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