Algorithm

Enumerations
enum	peak_afl_controller_brightness_algorithm { PEAK_AFL_CONTROLLER_BRIGHTNESS_ALGORITHM_MEDIAN , PEAK_AFL_CONTROLLER_BRIGHTNESS_ALGORITHM_MEAN }
	brightness calculation algorithm More...

Functions
PEAK_AFL_API_STATUS	peak_afl_AutoController_BrightnessAlgorithm_Set (peak_afl_controller_handle controller, peak_afl_controller_brightness_algorithm algorithm)
	Set the brightness algorithm for a controller.
PEAK_AFL_API_STATUS	peak_afl_AutoController_BrightnessAlgorithm_Get (peak_afl_controller_handle controller, peak_afl_controller_brightness_algorithm *algorithm)
	Get the current brightness algorithm for a controller.
PEAK_AFL_API_STATUS	peak_afl_AutoController_BrightnessAlgorithm_IsSupported (peak_afl_controller_handle controller, peak_afl_BOOL8 *supported)
	Check if brightness algorithm is supported for a controller component.

Detailed Description

Sets the algorithm which will be used for the auto brightness calculation. With mean the average value is found by adding all pixel values and dividing by the number of pixel. With median the middle number is found by ordering all pixel and picking the middle.

Enumeration Type Documentation

peak_afl_controller_brightness_algorithm

enum peak_afl_controller_brightness_algorithm

brightness calculation algorithm

Enumerator
PEAK_AFL_CONTROLLER_BRIGHTNESS_ALGORITHM_MEDIAN	median brightness algorithm
PEAK_AFL_CONTROLLER_BRIGHTNESS_ALGORITHM_MEAN	mean brightness algorithm

Function Documentation

peak_afl_AutoController_BrightnessAlgorithm_Get()

PEAK_AFL_API_STATUS peak_afl_AutoController_BrightnessAlgorithm_Get	(	peak_afl_controller_handle	controller,
		peak_afl_controller_brightness_algorithm *	algorithm )

Get the current brightness algorithm for a controller.

Parameters

[in]	controller	controller handle
[out]	algorithm	brightness 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.6

peak_afl_AutoController_BrightnessAlgorithm_IsSupported()

PEAK_AFL_API_STATUS peak_afl_AutoController_BrightnessAlgorithm_IsSupported	(	peak_afl_controller_handle	controller,
		peak_afl_BOOL8 *	supported )

Check if brightness algorithm is supported for a controller component.

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

Parameters

[in]	controller	controller handle
[out]	supported	boolean if controller component supports brightness 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.6

peak_afl_AutoController_BrightnessAlgorithm_Set()

PEAK_AFL_API_STATUS peak_afl_AutoController_BrightnessAlgorithm_Set	(	peak_afl_controller_handle	controller,
		peak_afl_controller_brightness_algorithm	algorithm )

Set the brightness algorithm for a controller.

Will set the controller brightness algorithm to algorithm. See peak_afl_controller_brightness_algorithm for a list of valid values.

Parameters

[in]	controller	controller handle
[in]	algorithm	autofeature brightness 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.6