Region of interest presets

Enumerations
enum	peak_afl_roi_preset { PEAK_AFL_CONTROLLER_ROI_PRESET_CENTER }
	controller roi preset 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 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 the autofeature region of interest preset for a controller.

Detailed Description

Enumeration Type Documentation

peak_afl_roi_preset

enum peak_afl_roi_preset

controller roi preset

Enumerator
PEAK_AFL_CONTROLLER_ROI_PRESET_CENTER	controller roi preset center

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

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

Since

1.0