AutoController

Enumerations
enum	peak_afl_controllerType { PEAK_AFL_CONTROLLER_TYPE_INVALID, PEAK_AFL_CONTROLLER_TYPE_BRIGHTNESS, PEAK_AFL_CONTROLLER_TYPE_WHITE_BALANCE, PEAK_AFL_CONTROLLER_TYPE_AUTOFOCUS }
	controller types More...
enum	peak_afl_controller_automode { PEAK_AFL_CONTROLLER_AUTOMODE_OFF, PEAK_AFL_CONTROLLER_AUTOMODE_CONTINUOUS, PEAK_AFL_CONTROLLER_AUTOMODE_ONCE }
	controller automode More...
enum	peak_afl_controller_status {   PEAK_AFL_CONTROLLER_STATUS_UNDEFINED, PEAK_AFL_CONTROLLER_STATUS_OFF, PEAK_AFL_CONTROLLER_STATUS_IN_PROGRESS, PEAK_AFL_CONTROLLER_STATUS_FINISHED,   PEAK_AFL_CONTROLLER_STATUS_BUSY, PEAK_AFL_CONTROLLER_STATUS_CANCELED, PEAK_AFL_CONTROLLER_STATUS_ERROR }
	controller status More...
enum	peak_afl_controller_algorithm {   PEAK_AFL_CONTROLLER_ALGORITHM_AUTO, PEAK_AFL_CONTROLLER_ALGORITHM_GOLDEN_RATIO_SEARCH, PEAK_AFL_CONTROLLER_ALGORITHM_HILL_CLIMBING_SEARCH, PEAK_AFL_CONTROLLER_ALGORITHM_GLOBAL_SEARCH,   PEAK_AFL_CONTROLLER_ALGORITHM_FULL_SCAN }
	controller algorithm More...
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...
enum	peak_afl_controller_brightness_component { PEAK_AFL_CONTROLLER_BRIGHTNESS_COMPONENT_EXPOSURE, PEAK_AFL_CONTROLLER_BRIGHTNESS_COMPONENT_GAIN }
	controller brightness component More...
enum	peak_afl_roi_weight { PEAK_AFL_CONTROLLER_ROI_WEIGHT_WEAK, PEAK_AFL_CONTROLLER_ROI_WEIGHT_MEDIUM, PEAK_AFL_CONTROLLER_ROI_WEIGHT_STRONG }
	controller roi weight (focus) More...
enum	peak_afl_callback_type { PEAK_AFL_CONTROLLER_CALLBACK_FINISHED, PEAK_AFL_CONTROLLER_CALLBACK_PROCESSING_DATA }
	controller callback type More...
enum	peak_afl_roi_preset { PEAK_AFL_CONTROLLER_ROI_PRESET_CENTER }
	controller roi preset More...

Functions
peak_afl_status	peak_afl_AutoController_Create (peak_afl_controller_handle *controller, peak_afl_controllerType controllerType)
	Create a new controller. More...
peak_afl_status	peak_afl_AutoController_Destroy (peak_afl_controller_handle controller)
	Destroy a controller. Will fail if it is queued inside a manager. More...
peak_afl_status	peak_afl_AutoController_SkipFrames_IsSupported (peak_afl_controller_handle controller, peak_afl_BOOL8 *supported)
	Check if skip frames is supported for a controller. More...
peak_afl_status	peak_afl_AutoController_SkipFrames_Set (peak_afl_controller_handle controller, uint32_t count)
	Set number of frames skipped for a controller. More...
peak_afl_status	peak_afl_AutoController_SkipFrames_Get (peak_afl_controller_handle controller, uint32_t *count)
	Get number of frames skipped for a controller. More...
peak_afl_status	peak_afl_AutoController_SkipFrames_GetRange (peak_afl_controller_handle controller, uint32_t *min, uint32_t *max, uint32_t *inc)
	Get range for frames skipped for a controller. More...
peak_afl_status	peak_afl_AutoController_ROI_IsSupported (peak_afl_controller_handle controller, peak_afl_BOOL8 *supported)
	Check if setting a region of interest is supported for a controller. More...
peak_afl_status	peak_afl_AutoController_ROI_Set (peak_afl_controller_handle controller, peak_afl_rectangle roi)
	Set the autofeature region of interest for a controller. More...
peak_afl_status	peak_afl_AutoController_ROI_Get (peak_afl_controller_handle controller, peak_afl_rectangle *roi)
	Get the autofeature region of interest for a controller. More...
peak_afl_status	peak_afl_AutoController_ROI_Preset_IsSupported (peak_afl_controller_handle controller, peak_afl_BOOL8 *supported)
	Check if ROI preset is supported for a controller. More...
peak_afl_status	peak_afl_AutoController_ROI_Preset_Set (peak_afl_controller_handle controller, peak_afl_roi_preset roiPreset)
	Set the autofeature region of interest preset for a controller. More...
peak_afl_status	peak_afl_AutoController_Mode_IsSupported (peak_afl_controller_handle controller, peak_afl_BOOL8 *supported)
	Check if auto mode is supported for a controller. More...
peak_afl_status	peak_afl_AutoController_Mode_Set (peak_afl_controller_handle controller, peak_afl_controller_automode mode)
	Set the autofeature mode for a controller. More...
peak_afl_status	peak_afl_AutoController_Mode_Get (peak_afl_controller_handle controller, peak_afl_controller_automode *mode)
	Get the current autofeature mode for a controller. More...
peak_afl_status	peak_afl_AutoController_BrightnessComponent_Mode_IsSupported (peak_afl_controller_handle controller, peak_afl_BOOL8 *supported)
	Check if brightness component mode is supported for a controller component. More...
peak_afl_status	peak_afl_AutoController_BrightnessComponent_Mode_Set (peak_afl_controller_handle controller, peak_afl_controller_brightness_component component, peak_afl_controller_automode mode)
	Set the autofeature mode for a brightness component. More...
peak_afl_status	peak_afl_AutoController_BrightnessComponent_Mode_Get (peak_afl_controller_handle controller, peak_afl_controller_brightness_component component, peak_afl_controller_automode *mode)
	Get the current brightness component mode for a controller. More...
peak_afl_status	peak_afl_AutoController_BrightnessComponent_Status (peak_afl_controller_handle controller, peak_afl_controller_brightness_component component, peak_afl_controller_status *status)
	Get the status for a controller component. More...
peak_afl_status	peak_afl_AutoController_BrightnessComponent_Callback_Set (peak_afl_controller_handle controller, peak_afl_controller_brightness_component component, peak_afl_callback_type type, void *funcPtr, void *context)
	Set a callback for a controller component. More...
peak_afl_status	peak_afl_AutoController_Status (peak_afl_controller_handle controller, peak_afl_controller_status *status)
	Get the status for a controller. More...
peak_afl_status	peak_afl_AutoController_GetLastAutoAverage (peak_afl_controller_handle controller, uint8_t *average)
	Get the last auto average for a controller. More...
peak_afl_status	peak_afl_AutoController_GetLastAutoAverages (peak_afl_controller_handle controller, uint8_t *averageRed, uint8_t *averageGreen, uint8_t *averageBlue)
	Get the last auto average for a controller. More...
peak_afl_status	peak_afl_AutoController_AutoTarget_IsSupported (peak_afl_controller_handle controller, peak_afl_BOOL8 *supported)
	check if auto target is supported for a controller. More...
peak_afl_status	peak_afl_AutoController_AutoTarget_Set (peak_afl_controller_handle controller, uint32_t target)
	Set the auto target for a controller. More...
peak_afl_status	peak_afl_AutoController_AutoTarget_Get (peak_afl_controller_handle controller, uint32_t *target)
	Get the currently set auto target for a controller. More...
peak_afl_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. More...
peak_afl_status	peak_afl_AutoController_AutoTolerance_IsSupported (peak_afl_controller_handle controller, peak_afl_BOOL8 *supported)
	check if auto tolerance is supported for a controller. More...
peak_afl_status	peak_afl_AutoController_AutoTolerance_Set (peak_afl_controller_handle controller, uint32_t tolerance)
	Set the auto tolerance for a controller. More...
peak_afl_status	peak_afl_AutoController_AutoTolerance_Get (peak_afl_controller_handle controller, uint32_t *tolerance)
	Get the current auto tolerance for a controller. More...
peak_afl_status	peak_afl_AutoController_AutoTolerance_GetRange (peak_afl_controller_handle controller, uint32_t *min, uint32_t *max, uint32_t *inc)
	Get the auto tolerance range for a controller. More...
peak_afl_status	peak_afl_AutoController_AutoPercentile_IsSupported (peak_afl_controller_handle controller, peak_afl_BOOL8 *supported)
	check if auto percentile is supported for a controller. More...
peak_afl_status	peak_afl_AutoController_AutoPercentile_Set (peak_afl_controller_handle controller, double percentile)
	Set the auto percentile for a controller. More...
peak_afl_status	peak_afl_AutoController_AutoPercentile_Get (peak_afl_controller_handle controller, double *percentile)
	Get the auto percentile for a controller. More...
peak_afl_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. More...
peak_afl_status	peak_afl_AutoController_Type_Get (peak_afl_controller_handle controller, peak_afl_controllerType *type)
	Get the controller type. More...
peak_afl_status	peak_afl_AutoController_Algorithm_IsSupported (peak_afl_controller_handle controller, peak_afl_BOOL8 *supported)
	check if setting an algorithm is supported for a controller. More...
peak_afl_status	peak_afl_AutoController_Algorithm_Set (peak_afl_controller_handle controller, peak_afl_controller_algorithm algorithm)
	Set the used algorithm for a controller. More...
peak_afl_status	peak_afl_AutoController_Algorithm_Get (peak_afl_controller_handle controller, peak_afl_controller_algorithm *algorithm)
	Get the used algorithm for a controller. More...
peak_afl_status	peak_afl_AutoController_Algorithm_GetList (peak_afl_controller_handle controller, peak_afl_controller_algorithm *typeList, uint32_t *listSize)
	Get the list of supported algorithms for a controller. More...
peak_afl_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. More...
peak_afl_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. More...
peak_afl_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. More...
peak_afl_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. More...
peak_afl_status	peak_afl_AutoController_Callback_Set (peak_afl_controller_handle controller, peak_afl_callback_type type, void *funcPtr, void *context)
	Set a callback for a controller. More...
peak_afl_status	peak_afl_AutoController_Weighted_ROI_IsSupported (peak_afl_controller_handle controller, peak_afl_BOOL8 *supported)
	Check if weighted region of interest is supported for a controller. More...
peak_afl_status	peak_afl_AutoController_Weighted_ROI_Min_Size (peak_afl_controller_handle controller, peak_afl_size *size)
	Get the autofeature minimum size for the weighted region of interest for a controller. More...
peak_afl_status	peak_afl_AutoController_Weighted_ROI_Set (peak_afl_controller_handle controller, const peak_afl_weighted_rectangle *weightedRoiList, uint32_t listSize)
	Set the autofeature weighted region of interest for a controller. More...
peak_afl_status	peak_afl_AutoController_Weighted_ROI_Get (peak_afl_controller_handle controller, peak_afl_weighted_rectangle *weightedRoiList, uint32_t *listSize)
	Get the autofeature weighted region of interest for a controller. More...
peak_afl_status	peak_afl_AutoController_Limit_IsSupported (peak_afl_controller_handle controller, peak_afl_BOOL8 *supported)
	Check if limit is supported for a controller. More...
peak_afl_status	peak_afl_AutoController_Limit_Default (peak_afl_controller_handle controller, peak_afl_controller_limit *limit)
	Get the autofeature default limit. More...
peak_afl_status	peak_afl_AutoController_Limit_Set (peak_afl_controller_handle controller, peak_afl_controller_limit limit)
	Set the autofeature limit for a controller. More...
peak_afl_status	peak_afl_AutoController_Limit_Get (peak_afl_controller_handle controller, peak_afl_controller_limit *limit)
	Get the autofeature limit for a controller. More...
peak_afl_status	peak_afl_AutoController_Hysteresis_IsSupported (peak_afl_controller_handle controller, peak_afl_BOOL8 *supported)
	Check if hysteresis is supported for a controller. More...
peak_afl_status	peak_afl_AutoController_Hysteresis_Default (peak_afl_controller_handle controller, uint8_t *hysteresis)
	Get the autofeature hysteresis default. More...
peak_afl_status	peak_afl_AutoController_Hysteresis_Set (peak_afl_controller_handle controller, uint8_t hysteresis)
	Set the autofeature hysteresis for a controller. More...
peak_afl_status	peak_afl_AutoController_Hysteresis_Get (peak_afl_controller_handle controller, uint8_t *hysteresis)
	Get the autofeature hysteresis for a controller. More...
peak_afl_status	peak_afl_AutoController_Hysteresis_GetRange (peak_afl_controller_handle controller, uint8_t *min, uint8_t *max, uint8_t *inc)
	Get autofeature hysteresis range for a controller. More...
peak_afl_status	peak_afl_AutoController_GainLimit_IsSupported (peak_afl_controller_handle controller, peak_afl_BOOL8 *supported)
	Check if gain limit is supported for a controller. More...
peak_afl_status	peak_afl_AutoController_GainLimit_Set (peak_afl_controller_handle controller, peak_afl_double_limit limit)
	Set autofeature gain limit for a controller. More...
peak_afl_status	peak_afl_AutoController_GainLimit_Get (peak_afl_controller_handle controller, peak_afl_double_limit *limit)
	Get autofeature gain limit for a controller. More...
peak_afl_status	peak_afl_AutoController_GainLimit_GetRange (peak_afl_controller_handle controller, peak_afl_double_limit *limit)
	Get autofeature gain limit range for a controller. More...

Detailed Description

Definitions on AutoController and values.

Enumeration Type Documentation

peak_afl_callback_type

enum peak_afl_callback_type

controller callback type

Enumerator
PEAK_AFL_CONTROLLER_CALLBACK_FINISHED	Controller callback type finished.
PEAK_AFL_CONTROLLER_CALLBACK_PROCESSING_DATA	Controller callback type processing data.

peak_afl_controller_algorithm

enum peak_afl_controller_algorithm

controller algorithm

Enumerator
PEAK_AFL_CONTROLLER_ALGORITHM_AUTO	Controller algorithm auto.
PEAK_AFL_CONTROLLER_ALGORITHM_GOLDEN_RATIO_SEARCH	Controller algorithm golden ratio search.
PEAK_AFL_CONTROLLER_ALGORITHM_HILL_CLIMBING_SEARCH	Controller algorithm hill climbing search.
PEAK_AFL_CONTROLLER_ALGORITHM_GLOBAL_SEARCH	Controller algorithm global search.
PEAK_AFL_CONTROLLER_ALGORITHM_FULL_SCAN	Controller algorithm full scan.

peak_afl_controller_automode

enum peak_afl_controller_automode

controller automode

Enumerator
PEAK_AFL_CONTROLLER_AUTOMODE_OFF	Automode off.
PEAK_AFL_CONTROLLER_AUTOMODE_CONTINUOUS	Automode continuous.
PEAK_AFL_CONTROLLER_AUTOMODE_ONCE	Automode once.

peak_afl_controller_brightness_component

enum peak_afl_controller_brightness_component

controller brightness component

Enumerator
PEAK_AFL_CONTROLLER_BRIGHTNESS_COMPONENT_EXPOSURE	exposure
PEAK_AFL_CONTROLLER_BRIGHTNESS_COMPONENT_GAIN	gain

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.

peak_afl_controller_status

enum peak_afl_controller_status

controller status

Enumerator
PEAK_AFL_CONTROLLER_STATUS_UNDEFINED	Controller status undefined.
PEAK_AFL_CONTROLLER_STATUS_OFF	Controller status off.
PEAK_AFL_CONTROLLER_STATUS_IN_PROGRESS	Controller status in progress.
PEAK_AFL_CONTROLLER_STATUS_FINISHED	Controller status finished.
PEAK_AFL_CONTROLLER_STATUS_BUSY	Controller status busy.
PEAK_AFL_CONTROLLER_STATUS_CANCELED	Controller status canceled.
PEAK_AFL_CONTROLLER_STATUS_ERROR	Controller status error.

peak_afl_controllerType

enum peak_afl_controllerType

controller types

Enumerator
PEAK_AFL_CONTROLLER_TYPE_INVALID	Invalid controller.
PEAK_AFL_CONTROLLER_TYPE_BRIGHTNESS	Exposure controller.
PEAK_AFL_CONTROLLER_TYPE_WHITE_BALANCE	White balance controller.
PEAK_AFL_CONTROLLER_TYPE_AUTOFOCUS	Autofocus Controller.

peak_afl_roi_preset

enum peak_afl_roi_preset

controller roi preset

Enumerator
PEAK_AFL_CONTROLLER_ROI_PRESET_CENTER	controller roi preset center

peak_afl_roi_weight

enum peak_afl_roi_weight

controller roi weight (focus)

Enumerator
PEAK_AFL_CONTROLLER_ROI_WEIGHT_WEAK	Controller roi weight weak.
PEAK_AFL_CONTROLLER_ROI_WEIGHT_MEDIUM	Controller roi weight middle.
PEAK_AFL_CONTROLLER_ROI_WEIGHT_STRONG	Controller roi weight strong.

Function Documentation

peak_afl_AutoController_Algorithm_Get()

peak_afl_status peak_afl_AutoController_Algorithm_Get	(	peak_afl_controller_handle	controller,
		peak_afl_controller_algorithm *	algorithm
	)

Get the used algorithm for a controller.

Parameters

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

peak_afl_AutoController_Algorithm_GetList()

peak_afl_status peak_afl_AutoController_Algorithm_GetList	(	peak_afl_controller_handle	controller,
		peak_afl_controller_algorithm *	typeList,
		uint32_t *	listSize
	)

Get the list of supported algorithms for a controller.

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

Parameters

[in]	controller	controller handle
[out]	typeList	Pointer to a user allocated list of peak_afl_controller_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_algorithm to hold the list typeList unequal NULL: in: size of the provided lastErrorMessage in counts of peak_afl_controller_algorithm out: number of peak_afl_controller_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.

peak_afl_AutoController_Algorithm_IsSupported()

peak_afl_status peak_afl_AutoController_Algorithm_IsSupported	(	peak_afl_controller_handle	controller,
		peak_afl_BOOL8 *	supported
	)

check if setting an algorithm is supported for a controller.

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

Call peak_afl_AutoController_Algorithm_GetList to get a list of supported algorithms.

Parameters

[in]	controller	controller handle
[out]	supported	boolean if controller supports setting an 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.

peak_afl_AutoController_Algorithm_Set()

peak_afl_status peak_afl_AutoController_Algorithm_Set	(	peak_afl_controller_handle	controller,
		peak_afl_controller_algorithm	algorithm
	)

Set the used algorithm for a controller.

To get a list of supported algorithms, see peak_afl_AutoController_Algorithm_GetList.

Parameters

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

peak_afl_AutoController_AutoPercentile_Get()

peak_afl_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.

peak_afl_AutoController_AutoPercentile_GetRange()

peak_afl_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.

peak_afl_AutoController_AutoPercentile_IsSupported()

peak_afl_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.

peak_afl_AutoController_AutoPercentile_Set()

peak_afl_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.

peak_afl_AutoController_AutoTarget_Get()

peak_afl_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.

peak_afl_AutoController_AutoTarget_GetRange()

peak_afl_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.

peak_afl_AutoController_AutoTarget_IsSupported()

peak_afl_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.

peak_afl_AutoController_AutoTarget_Set()

peak_afl_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.

peak_afl_AutoController_AutoTolerance_Get()

peak_afl_status peak_afl_AutoController_AutoTolerance_Get	(	peak_afl_controller_handle	controller,
		uint32_t *	tolerance
	)

Get the current auto tolerance for a controller.

Parameters

[in]	controller	controller handle
[out]	tolerance	auto tolerance 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.

peak_afl_AutoController_AutoTolerance_GetRange()

peak_afl_status peak_afl_AutoController_AutoTolerance_GetRange	(	peak_afl_controller_handle	controller,
		uint32_t *	min,
		uint32_t *	max,
		uint32_t *	inc
	)

Get the auto tolerance 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_AutoTolerance_Set.

Parameters

[in]	controller	controller handle
[out]	min	auto tolerance minimum value
[out]	max	auto tolerance maximum value
[out]	inc	auto tolerance 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.

peak_afl_AutoController_AutoTolerance_IsSupported()

peak_afl_status peak_afl_AutoController_AutoTolerance_IsSupported	(	peak_afl_controller_handle	controller,
		peak_afl_BOOL8 *	supported
	)

check if auto tolerance is supported for a controller.

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

Parameters

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

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.

peak_afl_AutoController_AutoTolerance_Set()

peak_afl_status peak_afl_AutoController_AutoTolerance_Set	(	peak_afl_controller_handle	controller,
		uint32_t	tolerance
	)

Set the auto tolerance for a controller.

Sets the +/- tolerance for the auto target value.

Parameters

[in]	controller	controller handle
[in]	tolerance	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.

peak_afl_AutoController_BrightnessComponent_Callback_Set()

peak_afl_status peak_afl_AutoController_BrightnessComponent_Callback_Set	(	peak_afl_controller_handle	controller,
		peak_afl_controller_brightness_component	component,
		peak_afl_callback_type	type,
		void *	funcPtr,
		void *	context
	)

Set a callback for a controller component.

Set funcPtr to NULL to disable the callback. Set funcPtr to !NULL to enable the callback.

The callback set by funcPtr will be called with context as its last parameter.

For a list of valid types see peak_afl_callback_type.

Parameters

[in]	controller	controller handle
[out]	component	brightness component
[in]	type	callback type
[in]	funcPtr	function pointer
[in]	context	pointer

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.

peak_afl_AutoController_BrightnessComponent_Mode_Get()

peak_afl_status peak_afl_AutoController_BrightnessComponent_Mode_Get	(	peak_afl_controller_handle	controller,
		peak_afl_controller_brightness_component	component,
		peak_afl_controller_automode *	mode
	)

Get the current brightness component mode for a controller.

Parameters

[in]	controller	controller handle
[out]	component	brightness component
[out]	mode	autofeature mode

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.

peak_afl_AutoController_BrightnessComponent_Mode_IsSupported()

peak_afl_status peak_afl_AutoController_BrightnessComponent_Mode_IsSupported	(	peak_afl_controller_handle	controller,
		peak_afl_BOOL8 *	supported
	)

Check if brightness component mode is supported for a controller component.

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

Parameters

[in]	controller	controller handle
[out]	supported	boolean if controller component supports auto mode

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.

peak_afl_AutoController_BrightnessComponent_Mode_Set()

peak_afl_status peak_afl_AutoController_BrightnessComponent_Mode_Set	(	peak_afl_controller_handle	controller,
		peak_afl_controller_brightness_component	component,
		peak_afl_controller_automode	mode
	)

Set the autofeature mode for a brightness component.

Will set the controller component to component. See peak_afl_controller_brightness_component for a list of valid values.

Parameters

[in]	controller	controller handle
[in]	component	brightness component
[in]	mode	autofeature mode

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.

peak_afl_AutoController_BrightnessComponent_Status()

peak_afl_status peak_afl_AutoController_BrightnessComponent_Status	(	peak_afl_controller_handle	controller,
		peak_afl_controller_brightness_component	component,
		peak_afl_controller_status *	status
	)

Get the status for a controller component.

See peak_afl_controller_status for a list of values.

Parameters

[in]	controller	controller handle
[out]	component	brightness component
[out]	status	controller status

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.

peak_afl_AutoController_Callback_Set()

peak_afl_status peak_afl_AutoController_Callback_Set	(	peak_afl_controller_handle	controller,
		peak_afl_callback_type	type,
		void *	funcPtr,
		void *	context
	)

Set a callback for a controller.

Set funcPtr to NULL to disable the callback. Set funcPtr to !NULL to enable the callback.

The callback set by funcPtr will be called with context as its last parameter.

For a list of valid types see peak_afl_callback_type.

Parameters

[in]	controller	controller handle
[in]	type	callback type
[in]	funcPtr	function pointer
[in]	context	pointer

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.

peak_afl_AutoController_Create()

peak_afl_status peak_afl_AutoController_Create	(	peak_afl_controller_handle *	controller,
		peak_afl_controllerType	controllerType
	)

Create a new controller.

Parameters

[out]	controller	controller handle
[in]	controllerType	controller type

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.

peak_afl_AutoController_Destroy()

peak_afl_status peak_afl_AutoController_Destroy

(

peak_afl_controller_handle

controller

)

Destroy a controller. Will fail if it is queued inside a manager.

Parameters

[in]

controller

controller handle

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_ACCESS_DENIED The operation is not allowed. Remove the instance from a manager first.

PEAK_AFL_STATUS_ERROR An unexpected internal error occurred.

peak_afl_AutoController_GainLimit_Get()

peak_afl_status peak_afl_AutoController_GainLimit_Get	(	peak_afl_controller_handle	controller,
		peak_afl_double_limit *	limit
	)

Get autofeature gain limit for a controller.

Parameters

[in]	controller	controller handle
[out]	limit	the current gain limit

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.

peak_afl_AutoController_GainLimit_GetRange()

peak_afl_status peak_afl_AutoController_GainLimit_GetRange	(	peak_afl_controller_handle	controller,
		peak_afl_double_limit *	limit
	)

Get autofeature gain limit range for a controller.

Parameters

[in]	controller	controller handle
[out]	limit	the possible range for gain limit

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.

peak_afl_AutoController_GainLimit_IsSupported()

peak_afl_status peak_afl_AutoController_GainLimit_IsSupported	(	peak_afl_controller_handle	controller,
		peak_afl_BOOL8 *	supported
	)

Check if gain limit is supported for a controller.

If supported is PEAK_AFL_TRUE gain limit is supported, otherwise it is unsupported.

Parameters

[in]	controller	controller handle
[out]	supported	true if auto gain limit is supported, otherwise returns false.

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.

peak_afl_AutoController_GainLimit_Set()

peak_afl_status peak_afl_AutoController_GainLimit_Set	(	peak_afl_controller_handle	controller,
		peak_afl_double_limit	limit
	)

Set autofeature gain limit for a controller.

The valid values are dependent on the used gain node and can be between minimum and maximum. Default is the complete range. The used priority list is: Analog -> Digital -> Any -> IPL (if supplied).

If any value of the limit is out of range, the value is clamped to be valid. In this case, the function returns with #PEAK_AFL_STATUS_VALUE_ADJUSTED. It is recommended to check the current values by calling peak_afl_AutoController_GainLimit_Get after this call.

Parameters

[in]	controller	controller handle
[in]	limit	Limits the controller to adjust the gain to the supplied range between min and max of limit.

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_VALUE_ADJUSTED At least one value of the limit is out of range. The limit was adjusted accordingly.

PEAK_AFL_STATUS_NOT_SUPPORTED The function is not supported.

PEAK_AFL_STATUS_ERROR An unexpected internal error occurred.

peak_afl_AutoController_GetLastAutoAverage()

peak_afl_status peak_afl_AutoController_GetLastAutoAverage	(	peak_afl_controller_handle	controller,
		uint8_t *	average
	)

Get the last auto average for a controller.

Used by Controllers processing a mono image.

Parameters

[in]	controller	controller handle
[out]	average	autofeature average

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.

peak_afl_AutoController_GetLastAutoAverages()

peak_afl_status peak_afl_AutoController_GetLastAutoAverages	(	peak_afl_controller_handle	controller,
		uint8_t *	averageRed,
		uint8_t *	averageGreen,
		uint8_t *	averageBlue
	)

Get the last auto average for a controller.

Used by Controllers processing a color image.

Parameters

[in]	controller	controller handle
[out]	averageRed	autofeature average red channel
[out]	averageGreen	autofeature average green channel
[out]	averageBlue	autofeature average blue channel

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.

peak_afl_AutoController_Hysteresis_Default()

peak_afl_status peak_afl_AutoController_Hysteresis_Default	(	peak_afl_controller_handle	controller,
		uint8_t *	hysteresis
	)

Get the autofeature hysteresis default.

Parameters

[in]	controller	controller handle
[out]	hysteresis	the default hysteresis

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.

peak_afl_AutoController_Hysteresis_Get()

peak_afl_status peak_afl_AutoController_Hysteresis_Get	(	peak_afl_controller_handle	controller,
		uint8_t *	hysteresis
	)

Get the autofeature hysteresis for a controller.

Parameters

[in]	controller	controller handle
[out]	hysteresis	the hysteresis

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.

peak_afl_AutoController_Hysteresis_GetRange()

peak_afl_status peak_afl_AutoController_Hysteresis_GetRange	(	peak_afl_controller_handle	controller,
		uint8_t *	min,
		uint8_t *	max,
		uint8_t *	inc
	)

Get autofeature hysteresis range for a controller.

Parameters

[in]	controller	controller handle
[out]	min	minimum number of hysteresis
[out]	max	maximum number of hysteresis
[out]	inc	increment number of hysteresis

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.

peak_afl_AutoController_Hysteresis_IsSupported()

peak_afl_status peak_afl_AutoController_Hysteresis_IsSupported	(	peak_afl_controller_handle	controller,
		peak_afl_BOOL8 *	supported
	)

Check if hysteresis is supported for a controller.

If supported is PEAK_AFL_TRUE hysteresis is supported, otherwise it is unsupported.

Parameters

[in]	controller	controller handle
[out]	supported	boolean if controller supports hysteresis

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.

peak_afl_AutoController_Hysteresis_Set()

peak_afl_status peak_afl_AutoController_Hysteresis_Set	(	peak_afl_controller_handle	controller,
		uint8_t	hysteresis
	)

Set the autofeature hysteresis for a controller.

Set the hysteresis for the algorithm set by peak_afl_AutoController_Algorithm_Set

Parameters

[in]	controller	controller handle
[in]	hysteresis	the hysteresis to set

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.

peak_afl_AutoController_Limit_Default()

peak_afl_status peak_afl_AutoController_Limit_Default	(	peak_afl_controller_handle	controller,
		peak_afl_controller_limit *	limit
	)

Get the autofeature default limit.

Parameters

[in]	controller	controller handle
[out]	limit	the default limit

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.

peak_afl_AutoController_Limit_Get()

peak_afl_status peak_afl_AutoController_Limit_Get	(	peak_afl_controller_handle	controller,
		peak_afl_controller_limit *	limit
	)

Get the autofeature limit for a controller.

Parameters

[in]	controller	controller handle
[out]	limit	the limit to get

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.

peak_afl_AutoController_Limit_IsSupported()

peak_afl_status peak_afl_AutoController_Limit_IsSupported	(	peak_afl_controller_handle	controller,
		peak_afl_BOOL8 *	supported
	)

Check if limit is supported for a controller.

If supported is PEAK_AFL_TRUE limit is supported, otherwise it is unsupported.

Parameters

[in]	controller	controller handle
[out]	supported	boolean if controller supports limit

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.

peak_afl_AutoController_Limit_Set()

peak_afl_status peak_afl_AutoController_Limit_Set	(	peak_afl_controller_handle	controller,
		peak_afl_controller_limit	limit
	)

Set the autofeature limit for a controller.

Sets the minimum and maximum limit for the algorithm set by peak_afl_AutoController_Algorithm_Set

Parameters

[in]	controller	controller handle
[in]	limit	the limit to set

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.

peak_afl_AutoController_Mode_Get()

peak_afl_status peak_afl_AutoController_Mode_Get	(	peak_afl_controller_handle	controller,
		peak_afl_controller_automode *	mode
	)

Get the current autofeature mode for a controller.

Parameters

[in]	controller	controller handle
[out]	mode	autofeature mode

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.

peak_afl_AutoController_Mode_IsSupported()

peak_afl_status peak_afl_AutoController_Mode_IsSupported	(	peak_afl_controller_handle	controller,
		peak_afl_BOOL8 *	supported
	)

Check if auto mode is supported for a controller.

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

Parameters

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

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.

peak_afl_AutoController_Mode_Set()

peak_afl_status peak_afl_AutoController_Mode_Set	(	peak_afl_controller_handle	controller,
		peak_afl_controller_automode	mode
	)

Set the autofeature mode for a controller.

Will set the controller mode to mode. See peak_afl_controller_automode for a list of valid values.

Parameters

[in]	controller	controller handle
[in]	mode	autofeature mode

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.

peak_afl_AutoController_ROI_Get()

peak_afl_status peak_afl_AutoController_ROI_Get	(	peak_afl_controller_handle	controller,
		peak_afl_rectangle *	roi
	)

Get the autofeature region of interest for a controller.

Get the region of interest for a controller. The processed image will be cropped to the region of interest set.

Parameters

[in]	controller	controller handle
[out]	roi	region of interest

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.

peak_afl_AutoController_ROI_IsSupported()

peak_afl_status peak_afl_AutoController_ROI_IsSupported	(	peak_afl_controller_handle	controller,
		peak_afl_BOOL8 *	supported
	)

Check if setting a region of interest is supported for a controller.

If supported is PEAK_AFL_TRUE region of interest is supported, otherwise it is unsupported.

Parameters

[in]	controller	controller handle
[out]	supported	boolean if controller supports setting a region of interest

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.

peak_afl_AutoController_ROI_Preset_IsSupported()

peak_afl_status peak_afl_AutoController_ROI_Preset_IsSupported	(	peak_afl_controller_handle	controller,
		peak_afl_BOOL8 *	supported
	)

Check if ROI preset is supported for a controller.

If supported is PEAK_AFL_TRUE ROI preset is supported, otherwise it is unsupported.

Parameters

[in]	controller	controller handle
[out]	supported	boolean if controller supports ROI preset

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.

peak_afl_AutoController_ROI_Preset_Set()

peak_afl_status peak_afl_AutoController_ROI_Preset_Set	(	peak_afl_controller_handle	controller,
		peak_afl_roi_preset	roiPreset
	)

Set the autofeature region of interest preset for a controller.

Will set the supplied preset as the region of interest. See also peak_afl_AutoController_ROI_Set.

Parameters

[in]	controller	controller handle
[in]	roiPreset	region of interest preset

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.

peak_afl_AutoController_ROI_Set()

peak_afl_status peak_afl_AutoController_ROI_Set	(	peak_afl_controller_handle	controller,
		peak_afl_rectangle	roi
	)

Set the autofeature region of interest for a controller.

Set the region of interest for a controller. The processed image will be cropped to the region of interest set.

Parameters

[in]	controller	controller handle
[in]	roi	region of interest

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.

peak_afl_AutoController_SharpnessAlgorithm_Get()

peak_afl_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.

peak_afl_AutoController_SharpnessAlgorithm_GetList()

peak_afl_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.

peak_afl_AutoController_SharpnessAlgorithm_IsSupported()

peak_afl_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.

peak_afl_AutoController_SharpnessAlgorithm_Set()

peak_afl_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.

peak_afl_AutoController_SkipFrames_Get()

peak_afl_status peak_afl_AutoController_SkipFrames_Get	(	peak_afl_controller_handle	controller,
		uint32_t *	count
	)

Get number of frames skipped for a controller.

Gets the skipped frames for the controller. Only every N-th image will be processed.

Parameters

[in]	controller	controller handle
[out]	count	number of frames skipped

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.

peak_afl_AutoController_SkipFrames_GetRange()

peak_afl_status peak_afl_AutoController_SkipFrames_GetRange	(	peak_afl_controller_handle	controller,
		uint32_t *	min,
		uint32_t *	max,
		uint32_t *	inc
	)

Get range for frames skipped for a controller.

Parameters

[in]	controller	controller handle
[out]	min	minimum number of frames skipped
[out]	max	maximum number of frames skipped
[out]	inc	increment number of frames skipped

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.

peak_afl_AutoController_SkipFrames_IsSupported()

peak_afl_status peak_afl_AutoController_SkipFrames_IsSupported	(	peak_afl_controller_handle	controller,
		peak_afl_BOOL8 *	supported
	)

Check if skip frames is supported for a controller.

Parameters

[in]	controller	controller handle
[out]	supported	boolean if controller supports skipping frames

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.

peak_afl_AutoController_SkipFrames_Set()

peak_afl_status peak_afl_AutoController_SkipFrames_Set	(	peak_afl_controller_handle	controller,
		uint32_t	count
	)

Set number of frames skipped for a controller.

Sets the skipped frames for the controller. Only every N-th image will be processed.

Parameters

[in]	controller	controller handle
[in]	count	number of frames skipped

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.

peak_afl_AutoController_Status()

peak_afl_status peak_afl_AutoController_Status	(	peak_afl_controller_handle	controller,
		peak_afl_controller_status *	status
	)

Get the status for a controller.

See peak_afl_controller_status for a list of values.

Parameters

[in]	controller	controller handle
[out]	status	controller status

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.

peak_afl_AutoController_Type_Get()

peak_afl_status peak_afl_AutoController_Type_Get	(	peak_afl_controller_handle	controller,
		peak_afl_controllerType *	type
	)

Get the controller type.

See peak_afl_controllerType for a list of values.

Parameters

[in]	controller	controller handle
[out]	type	auto controller type

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.

peak_afl_AutoController_Weighted_ROI_Get()

peak_afl_status peak_afl_AutoController_Weighted_ROI_Get	(	peak_afl_controller_handle	controller,
		peak_afl_weighted_rectangle *	weightedRoiList,
		uint32_t *	listSize
	)

Get the autofeature weighted region of interest for a controller.

Uses the Two Staged Data Query principle.

Parameters

[in]	controller	controller handle
[out]	weightedRoiList	Pointer to a user allocated list of peak_afl_weighted_rectangle. If this parameter is NULL, listSize will contain the needed count of typeList.
[in,out]	listSize	weightedRoiList equal NULL: out: minimal size of listSize in count of peak_afl_weighted_rectangle to hold the list typeList unequal NULL: in: size of the provided lastErrorMessage in counts of peak_afl_weighted_rectangle out: number of peak_afl_weighted_rectangle 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.

peak_afl_AutoController_Weighted_ROI_IsSupported()

peak_afl_status peak_afl_AutoController_Weighted_ROI_IsSupported	(	peak_afl_controller_handle	controller,
		peak_afl_BOOL8 *	supported
	)

Check if weighted region of interest is supported for a controller.

If supported is PEAK_AFL_TRUE weighted region of interest is supported, otherwise it is unsupported.

Parameters

[in]	controller	controller handle
[out]	supported	boolean if controller supports weighted roi

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.

peak_afl_AutoController_Weighted_ROI_Min_Size()

peak_afl_status peak_afl_AutoController_Weighted_ROI_Min_Size	(	peak_afl_controller_handle	controller,
		peak_afl_size *	size
	)

Get the autofeature minimum size for the weighted region of interest for a controller.

Parameters

[in]	controller	controller handle
[out]	size	the minimum size

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.

peak_afl_AutoController_Weighted_ROI_Set()

peak_afl_status peak_afl_AutoController_Weighted_ROI_Set	(	peak_afl_controller_handle	controller,
		const peak_afl_weighted_rectangle *	weightedRoiList,
		uint32_t	listSize
	)

Set the autofeature weighted region of interest for a controller.

Already set weighted regions of interest will be overwritten

Parameters

[in]	controller	controller handle
[in]	weightedRoiList	list of weighted region of interest
[in]	listSize	count of weighted region of interest in /p weightedRoiList

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.