IDS Software Suite 4.96.1
 |
 |
|---|---|
USB 2.0 USB 3.x GigE |
USB 2.0 USB 3.x GigE |
Syntax
INT is_GetAutoInfo (HIDS hCam, UEYE_AUTO_INFO* pInfo)
Description
Using the is_GetAutoInfo() function, you can query status information on the automatic image control features. This information is written to the UEYE_AUTO_INFO structure.
For further information on automatic control, please refer to the Automatic image control chapter.
|
The status information returned in the UEYE_AUTO_INFO structure is only valid if at least one of the auto control feature has been enabled using is_SetAutoParameter(). |
Input parameters
hCam |
Camera handle |
pinfo |
UEYE_AUTO_INFO structure (see below) |
Contents of the UEYE_AUTO_INFO Structure
INT |
AutoAbility |
Supported auto control features •AC_SHUTTER: Auto exposure shutter is supported •AC_SENSOR_SHUTTER: The sensor's internal auto exposure shutter is supported •AC_FRAMERATE: Auto frame rate is supported •AC_SENSOR_FRAMERATE: The sensor's internal auto frame rate is supported •AC_GAIN: Auto gain control is supported •AC_SENSOR_GAIN: The sensor's internal auto gain control is supported •AC_SENSOR_AUTO_CONTRAST_CORRECTION: Auto contrast correction for automatic brightness control is supported •AC_SENSOR_AUTO_BACKLIGHT_COMP: Backlight compensation for automatic brightness control is supported •AC_WHITEBAL: Auto white balance is supported •AC_SENSOR_WB: The sensor's internal auto white balance is supported |
AUTO_BRIGHT_STATUS |
sBrightCtrlStatus |
Status of automatic brightness control, see below |
AUTO_WB_STATUS |
sWBCtrlStatus |
Status of auto white balance, see below |
DWORD |
AShutterPhotomCaps |
Returns a bit mask containing all supported photometry settings (fields of view) for auto exposure shutter, see below. |
DWORD |
AGainPhotomCaps |
Returns a bit mask containing all supported photometry settings (fields of view) for auto gain control, see below. |
DWORD |
AAntiFlickerCaps |
Returns a bit mask containing all supported anti flicker settings for automatic control, see below. |
DWORD |
SensorWBModeCaps |
Returns a bit mask containing all supported settings for the sensor's auto white balance, see below. |
DWORD |
reserved[8] |
Reserved space for extensions |
Contents of the UEYE_AUTO_INFO::AUTO_BRIGHT_STATUS Structure
INT |
curValue |
Current average brightness of the image (actual value); the following rule applies independently of the image bit depth: •0 = black •255 = white |
INT |
curError |
Current control deviation (error) |
INT |
curController |
Current parameter value •AC_SHUTTER: Exposure time (shutter) •AC_GAIN: Gain |
INT |
curCtrlStatus |
Current control status •ACS_ADJUSTING: Control is active. •ACS_FINISHED: Control is completed. •ACS_DISABLED: Control is disabled. |
Contents of the UEYE_AUTO_INFO::AUTO_WB_STATUS Structure
INT |
curController |
Current white balance control •AC_WB_RED_CHANNEL: Value of the red channel •AC_WB_GREEN_CHANNEL: Value of the green channel •AC_WB_BLUE_CHANNEL: Value of the blue channel |
AUTO_WB_CHANNEL_STATUS |
RedChannel |
See AUTO_WB_CHANNEL_STATUS |
AUTO_WB_CHANNEL_STATUS |
GreenChannel |
See AUTO_WB_CHANNEL_STATUS |
AUTO_WB_CHANNEL_STATUS |
BlueChannel |
See AUTO_WB_CHANNEL_STATUS |
Contents of the UEYE_AUTO_INFO::AUTO_WB_STATUS::AUTO_WB_CHANNEL_STATUS Structure
INT |
curValue |
Current average grayscale value (actual value) |
INT |
curError |
Current control deviation (error) |
INT |
curCtrlStatus |
Current control status •ACS_ADJUSTING: Control is active. •ACS_FINISHED: Control is completed. •ACS_DISABLED: Control is disabled. |
Status flags in UEYE_AUTO_INFO::AShutterPhotomCaps
AS_PM_NONE |
The entire field of view is used for metering. |
AS_PM_SENS_CENTER_AVERAGE |
Metering is based on the entire field of view, but all areas are equally weighted and an average value is determined. |
AS_PM_SENS_CENTER_WEIGHTED |
Metering is based on the entire field of view, but gives greater emphasis to the center area of the image. |
AS_PM_SENS_CENTER_SPOT |
Only a small area in the image center is used for metering. |
AS_PM_SENS_PORTRAIT |
Metering is based on that part of the field of view that corresponds to the portrait format. |
AS_PM_SENS_LANDSCAPE |
Metering is based on that part of the field of view that corresponds to the landscape format. |
Status flags in UEYE_AUTO_INFO::AGainPhotomCaps
AG_PM_NONE |
The entire field of view is used for metering. |
AS_PM_SENS_CENTER_AVERAGE |
Metering is based on the entire field of view, but all areas are equally weighted and an average value is determined. |
AG_PM_SENS_CENTER_WEIGHTED |
Metering is based on the entire field of view, but gives greater emphasis to the center area of the image. |
AG_PM_SENS_CENTER_SPOT |
Only a small area in the image center is used for metering. |
AS_PM_SENS_PORTRAIT |
Metering is based on that part of the field of view that corresponds to the portrait format. |
AS_PM_SENS_LANDSCAPE |
Metering is based on that part of the field of view that corresponds to the landscape format. |
Status flags in UEYE_AUTO_INFO::AAntiFlickerCaps
ANTIFLCK_MODE_OFF |
Anti flicker function disabled. |
ANTIFLCK_MODE_SENS_AUTO |
The anti flicker mode is selected automatically (50 or 60 Hz). |
ANTIFLCK_MODE_SENS_50_FIXED |
The anti flicker mode is set to a fixed value of 50 Hz. |
ANTIFLCK_MODE_SENS_60_FIXED |
The anti flicker mode is set to a fixed value of 60 Hz. |
Status flags in UEYE_AUTO_INFO::SensorWBModeCaps
WB_MODE_DISABLE |
Disables the sensor's auto white balance |
WB_MODE_AUTO |
Sensor automatically determines auto white balance |
WB_MODE_ALL_PULLIN |
Sensor automatically determines auto white balance using the Gray World algorithm. This algorithm assumes that the average color value in the scene is gray. |
WB_MODE_INCANDESCENT_LAMP |
Sensor sets auto white balance to incandescent light |
WB_MODE_FLUORESCENT_DL |
Sensor sets auto white balance to fluorescent light (day light) |
WB_MODE_FLUORESCENT_LAMP |
Sensor sets auto white balance to fluorescent light (warm white) |
WB_MODE_FLUORESCENT_NL |
Sensor sets auto white balance to fluorescent light (ccol white) |
WB_MODE_OUTDOOR_CLEAR_SKY |
Sensor sets auto white balance to direct daylight |
WB_MODE_OUTDOOR_CLOUDY |
Sensor sets auto white balance to cloudy sky |
Return values
IS_CANT_COMMUNICATE_WITH_DRIVER |
Communication with the driver failed because no driver has been loaded. |
IS_CANT_OPEN_DEVICE |
An attempt to initialize or select the camera failed (no camera connected or initialization error). |
IS_INVALID_CAMERA_HANDLE |
Invalid camera handle |
IS_INVALID_PARAMETER |
One of the submitted parameters is outside the valid range or is not supported for this sensor or is not available in this mode. |
IS_IO_REQUEST_FAILED |
An IO request from the uEye driver failed. Possibly the versions of the ueye_api.dll (API) and the driver file (ueye_usb.sys or ueye_eth.sys) do not match. |
IS_NO_SUCCESS |
General error message |
IS_NOT_SUPPORTED |
The camera model used here does not support this function or setting. |
IS_SUCCESS |
Function executed successfully |
Related functions
