Home > C: Programming > Function Descriptions > | History back Previous chapter Next chapter Print |
is_GetAutoInfo |
uEye Camera Manual Version 3.80
is_GetAutoInfo
USB 2.0 GigE |
USB 2.0 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.
|
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 for automatic brightness control is supported |
|
AC_SENSOR_ |
Use of face detection as field of view for automatic brightness control is supported |
|
AC_SENSOR_ |
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_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. |
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. |
AG_PM_SENS_PORTRAIT |
Metering is based on that part of the field of view that corresponds to the portrait format. |
AG_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 (daylight type) |
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_SUCCESS |
Function executed successfully |
IS_NO_SUCCESS |
General error message |
Related Functions