Predefined region of interest configurations for focus control. More...

Enumerations
enum	peak_afl_roi_preset { PEAK_AFL_CONTROLLER_ROI_PRESET_CENTER }
	Predefined ROI preset configurations. More...

Functions
PEAK_AFL_API_STATUS	peak_afl_AutoController_ROI_Preset_IsSupported (peak_afl_controller_handle controller, peak_afl_BOOL8 *supported)
	Check if ROI preset feature is supported for a controller.

PEAK_AFL_API_STATUS	peak_afl_AutoController_ROI_Preset_Set (peak_afl_controller_handle controller, peak_afl_roi_preset roiPreset)
	Set a predefined region of interest preset for a controller.

Detailed Description

Predefined region of interest configurations for focus control.

Enumeration Type Documentation

◆ peak_afl_roi_preset

enum peak_afl_roi_preset

Predefined ROI preset configurations.

Defines commonly used ROI configurations that can be quickly applied to controllers without manually specifying coordinates. These presets automatically adapt to the current image size.

See also: peak_afl_AutoController_ROI_Preset_Set(); peak_afl_AutoController_ROI_Set()

Enumerator

PEAK_AFL_CONTROLLER_ROI_PRESET_CENTER

Center region preset.

Sets the ROI to a centered region within the image. The exact size depends on the implementation but typically covers the center 25-50% of the image area.

Note: Automatically adapts to current image dimensions

Function Documentation

◆ peak_afl_AutoController_ROI_Preset_IsSupported()

PEAK_AFL_API_STATUS peak_afl_AutoController_ROI_Preset_IsSupported	(	peak_afl_controller_handle	controller,
		peak_afl_BOOL8 *	supported )

Check if ROI preset feature is supported for a controller.

Determines whether the specified controller supports predefined region of interest presets. ROI presets provide convenient, predefined rectangular regions that are commonly used for automatic feature processing, such as center regions, corner regions, or specific aspect ratio areas. This feature simplifies ROI configuration by offering standard options instead of requiring manual coordinate specification.

Parameters

[in]	controller	Controller handle to check for ROI preset support
[out]	supported	Pointer to receive support status: PEAK_AFL_TRUE: ROI preset feature is supported PEAK_AFL_FALSE: ROI preset feature is not supported

Returns: PEAK_AFL_STATUS_SUCCESS Operation completed successfully; PEAK_AFL_STATUS_NOT_INITIALIZED The library is not initialized; PEAK_AFL_STATUS_INVALID_PARAMETER Invalid controller handle or NULL supported pointer; PEAK_AFL_STATUS_ERROR An unexpected internal error occurred

Note: Check this function before attempting to use ROI preset functionality; ROI preset support is independent of basic ROI support; Presets provide convenient alternatives to manual ROI coordinate specification; Available presets may vary between different controller implementations

See also: peak_afl_AutoController_ROI_Preset_Set(); peak_afl_AutoController_ROI_Set(); peak_afl_roi_preset

Since: 1.0

◆ peak_afl_AutoController_ROI_Preset_Set()

PEAK_AFL_API_STATUS peak_afl_AutoController_ROI_Preset_Set	(	peak_afl_controller_handle	controller,
		peak_afl_roi_preset	roiPreset )

Set a predefined region of interest preset for a controller.

Configures the controller to use a predefined region of interest preset instead of manually specified coordinates. ROI presets provide convenient, standardized rectangular regions that are commonly used for automatic feature processing. This simplifies configuration by offering well-tested region definitions without requiring manual coordinate calculation.