Auto target

Functions
PEAK_AFL_API_STATUS	peak_afl_AutoController_AutoTarget_IsSupported (peak_afl_controller_handle controller, peak_afl_BOOL8 *supported)
	check if auto target is supported for a controller.
PEAK_AFL_API_STATUS	peak_afl_AutoController_AutoTarget_Set (peak_afl_controller_handle controller, uint32_t target)
	Set the auto target for a controller.
PEAK_AFL_API_STATUS	peak_afl_AutoController_AutoTarget_Get (peak_afl_controller_handle controller, uint32_t *target)
	Get the currently set auto target for a controller.
PEAK_AFL_API_STATUS	peak_afl_AutoController_AutoTarget_GetRange (peak_afl_controller_handle controller, uint32_t *min, uint32_t *max, uint32_t *inc)
	Get the auto target range for a controller.

Detailed Description

Sets the target value for auto brightness control. The percentage of pixels, that must be brighter than the target value, is defined in target Percentile. The value of target value does not relate to the pixel format for the process image and can be specified in the range from 0 to 255.

Note

Increasing the target value results in brighter images, decreasing its value results in darker images. If the target value is set to a high value and percentile is set to its minimum, it behaves similar to a peak white algorithm. It is not recommended to push target value to its limits. Keep distance from the limits, i.e. use "250" instead of "255", or "5" instead of "0".

Function Documentation

peak_afl_AutoController_AutoTarget_Get()

PEAK_AFL_API_STATUS peak_afl_AutoController_AutoTarget_Get	(	peak_afl_controller_handle	controller,
		uint32_t *	target )

Get the currently set auto target for a controller.

Parameters

[in]	controller	controller handle
[out]	target	auto target 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_AutoTarget_GetRange()

PEAK_AFL_API_STATUS peak_afl_AutoController_AutoTarget_GetRange	(	peak_afl_controller_handle	controller,
		uint32_t *	min,
		uint32_t *	max,
		uint32_t *	inc )

Get the auto target 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_AutoTarget_Set.

Parameters

[in]	controller	controller handle
[out]	min	auto target minimum value
[out]	max	auto target maximum value
[out]	inc	auto target 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_AutoTarget_IsSupported()

PEAK_AFL_API_STATUS peak_afl_AutoController_AutoTarget_IsSupported	(	peak_afl_controller_handle	controller,
		peak_afl_BOOL8 *	supported )

check if auto target is supported for a controller.

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

Parameters

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

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

PEAK_AFL_API_STATUS peak_afl_AutoController_AutoTarget_Set	(	peak_afl_controller_handle	controller,
		uint32_t	target )

Set the auto target for a controller.

Set an auto target. Call peak_afl_AutoController_AutoTarget_GetRange to get the valid range. End value which will be targeted by the controller.

Parameters

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