Weighted region of interest

Multi-region focus evaluation with configurable weights. More...

Data Structures
struct	peak_afl_weighted_rectangle
	Weighted region of interest for focus control. More...

Enumerations
enum	peak_afl_roi_weight { PEAK_AFL_CONTROLLER_ROI_WEIGHT_WEAK , PEAK_AFL_CONTROLLER_ROI_WEIGHT_MEDIUM , PEAK_AFL_CONTROLLER_ROI_WEIGHT_STRONG }
	ROI weight values for focus control. 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

Multi-region focus evaluation with configurable weights.

Enumeration Type Documentation

peak_afl_roi_weight

enum peak_afl_roi_weight

ROI weight values for focus control.

Defines the relative importance weights that can be assigned to regions of interest for focus analysis. Higher weights give more influence to a region's focus metrics in the overall focus calculation.

See also

peak_afl_weighted_rectangle

peak_afl_AutoController_Weighted_ROI_Set()

Enumerator
PEAK_AFL_CONTROLLER_ROI_WEIGHT_WEAK	Low importance weight. This region has minimal influence on focus calculations. Use for background areas or regions of lesser importance.
PEAK_AFL_CONTROLLER_ROI_WEIGHT_MEDIUM	Medium importance weight. This region has moderate influence on focus calculations. Use for areas of average importance in the scene.
PEAK_AFL_CONTROLLER_ROI_WEIGHT_STRONG	High importance weight. This region has strong influence on focus calculations. Use for critical areas that must be in sharp focus.

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.

Retrieves the currently configured weighted regions of interest. This returns the same regions that were previously set using peak_afl_AutoController_Weighted_ROI_Set. Each region includes its rectangular coordinates and associated weight value.

Uses the Two Staged Data Query principle: call first with NULL to get the required buffer size, then call again with an allocated buffer to retrieve the actual ROI list.

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	Size of weightedRoiList: 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.

Determines whether the controller supports weighted regions of interest (ROI). Weighted ROIs allow you to specify multiple rectangular areas within the image with different importance weights for the automatic adjustment calculations. This feature enables more sophisticated control over which parts of the image are prioritized during automatic processing.

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.

Retrieves the minimum dimensions required for weighted regions of interest. ROIs smaller than this minimum size will be rejected. This constraint ensures that the regions are large enough to provide meaningful statistical data for the automatic adjustment algorithms.

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.

Configures one or more weighted regions of interest that the controller will use for automatic adjustments. Each region can have a different weight value, allowing you to prioritize certain areas of the image over others. For example, you might give higher weight to the center of the image or to areas containing important subjects.

The weights are relative values - the controller will normalize them internally. Areas outside the specified regions will have zero weight in the calculations.

Already set weighted regions of interest will be overwritten by this call.

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