Functions
PEAK_AFL_API_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.

PEAK_AFL_API_STATUS	peak_afl_AutoController_ROI_Set (peak_afl_controller_handle controller, peak_afl_rectangle roi)
	Set the autofeature region of interest for a controller.

PEAK_AFL_API_STATUS	peak_afl_AutoController_ROI_Get (peak_afl_controller_handle controller, peak_afl_rectangle *roi)
	Get the autofeature region of interest for a controller.

Detailed Description

If a smaller part of the image should be processed, a region of interest (ROI) can be set.

Note: If a ROI does not fit into the processed image dimension the processing callback is called with corresponding error status.

Note: The ROI for automatic control is set to the full size of the processed image by default.

Function Documentation

PEAK_AFL_API_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. If no ROI is set, all values are set to 0.

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_API_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_API_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. If no ROI is set, the complete image is evaluated. To reset a ROI all values must be set to 0.

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.