Weighted region of interest

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

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

Detailed Description

Enumeration Type Documentation

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

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

Since

1.0

peak_afl_AutoController_Weighted_ROI_IsSupported()

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

Since

1.0

peak_afl_AutoController_Weighted_ROI_Min_Size()

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

Since

1.0

peak_afl_AutoController_Weighted_ROI_Set()

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

Since

1.0