Generic functions, types, and values

Topics
	Numeric types and values
	Status types and values
	Inference types and values

Enumerations
enum	peak_auto_feature_mode { PEAK_AUTO_FEATURE_MODE_INVALID , PEAK_AUTO_FEATURE_MODE_OFF , PEAK_AUTO_FEATURE_MODE_ONCE , PEAK_AUTO_FEATURE_MODE_CONTINUOUS }
	peak Auto feature mode More...
enum	peak_auto_feature_brightness_algorithm { PEAK_AUTO_FEATURE_BRIGHTNESS_ALGORITHM_INVALID , PEAK_AUTO_FEATURE_BRIGHTNESS_ALGORITHM_MEDIAN , PEAK_AUTO_FEATURE_BRIGHTNESS_ALGORITHM_MEAN }
	peak Auto feature brightness algorithm More...
enum	peak_auto_feature_roi_mode { PEAK_AUTO_FEATURE_ROI_MODE_INVALID , PEAK_AUTO_FEATURE_ROI_MODE_FULL_IMAGE , PEAK_AUTO_FEATURE_ROI_MODE_MANUAL }
	peak Auto feature ROI mode More...

Detailed Description

This basic functions, types, and values are used throughout the whole library interface.

Enumeration Type Documentation

peak_auto_feature_brightness_algorithm

enum peak_auto_feature_brightness_algorithm

peak Auto feature brightness algorithm

The auto feature brightness algorithm defines the calculation of the image brightness.

Enumerator
PEAK_AUTO_FEATURE_BRIGHTNESS_ALGORITHM_INVALID	Invalid auto feature brightness algorithm. Use this value for the initialization of variables of type peak_auto_feature_brightness_algorithm.
PEAK_AUTO_FEATURE_BRIGHTNESS_ALGORITHM_MEDIAN	default brightness algorithm The algorithm is set to median.
PEAK_AUTO_FEATURE_BRIGHTNESS_ALGORITHM_MEAN	brightness algorithm mean The algorithm is set to mean.

peak_auto_feature_mode

enum peak_auto_feature_mode

peak Auto feature mode

The auto feature mode defines the mode of operation for auto features.

Enumerator
PEAK_AUTO_FEATURE_MODE_INVALID	Invalid auto feature mode. Use this value for the initialization of variables of type peak_auto_feature_mode.
PEAK_AUTO_FEATURE_MODE_OFF	Auto feature Off. The auto feature is off. This is the default mode for all auto features.
PEAK_AUTO_FEATURE_MODE_ONCE	Auto feature mode Once. The auto feature is executed once.
PEAK_AUTO_FEATURE_MODE_CONTINUOUS	Auto feature mode Continuous. The auto feature is executed continuously.

peak_auto_feature_roi_mode

enum peak_auto_feature_roi_mode

peak Auto feature ROI mode

The auto feature ROI mode defines the mode of operation for auto feature ROIs.

Enumerator
PEAK_AUTO_FEATURE_ROI_MODE_INVALID	Invalid auto feature ROI mode. Use this value for the initialization of variables of type peak_auto_feature_roi_mode.
PEAK_AUTO_FEATURE_ROI_MODE_FULL_IMAGE	Auto feature ROI mode Full Image. The auto feature ROI automatically follows the image ROI. I.e. the auto feature always covers the whole image. This is the default mode for all auto features.
PEAK_AUTO_FEATURE_ROI_MODE_MANUAL	Auto feature ROI mode Manual. The auto feature ROI can be set manually inside of the bounds of the image ROI. If the image ROI size is reduced the auto feature ROI may be automatically clipped. If the auto feature ROI is out of the image ROI bounds after a change of the image ROI, the position of the auto feature ROI is adjusted and its size is set to minimum.