Please enable JavaScript to view this site.

IDS Software Suite 4.96.1

Windows_Logo
Linux_Logo

USB 2.0

USB 3.x

GigE

USB 2.0

USB 3.x

GigE

Syntax

INT is_SetAutoParameter (HIDS hCam, INT param, double* pval1, double* pval2)

Description

Using is_SetAutoParameter(), you can control the automatic gain, exposure shutter, frame rate and white balance control values.

For further information on automatic control, please refer to the Automatic image control chapter.

Control is only active as long as the camera is capturing images.

A manual change of the exposure time and gain settings disables the auto functions.

When the auto exposure shutter function is enabled, you cannot modify the pixel clock frequency.

The auto frame rate function is only available when the auto shutter control is on. Auto frame rate and auto gain control cannot be used simultaneously.

The auto gain function can only be used for cameras with master gain control. Auto white balance is only available for cameras with hardware RGB gain control.

The sensor's internal auto features are only supported by the sensors of the following camera models.
Please also read the notes on using these sensors.

oUI-122x/UI-322x/UI-522x

oUI-1007XS
Sensor's internal white balance

hint_info

Notes on the sensor's internal control functionality

Automatic control by the sensor and the software is not possible simultaneously. To use the sensor's internal control functionality, disable software control, and vice versa.

hint_info

Note on automatic controls when using very high frame rates

Using very high frame rates can cause that too many control commands are sent to the camera. When using frame rates higher than 100 fps you should increase the value for IS_SET_AUTO_SKIPFRAMES. Thus, less image will be used for the automatic controls which takes load off the camera.

Input parameters

hCam

Camera handle

param

Configure auto function

pval1

Control parameter, can have a variable value depending on the corresponding auto function

pval2

Control parameter, can have a variable value depending on the corresponding auto function

*1 Not all sensors support this feature

*2 Not with use of sensor's internal control functionality

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_INCOMPATIBLE_SETTING

Because of other incompatible settings the function is not possible.

IS_INVALID_CAMERA_TYPE

The camera type defined in the .ini file does not match the current camera model.

IS_INVALID_CAMERA_HANDLE

Invalid camera handle

IS_INVALID_MODE

Camera is in standby mode, function not allowed

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_INVALID_WB_BINNING_MODE

Mono binning/mono sub-sampling do not support automatic white balance.

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_CALIBRATED

The camera does not contain any calibration data.

IS_NOT_SUPPORTED

The camera model used here does not support this function or setting.

IS_NULL_POINTER

Invalid array

IS_SUCCESS

Function executed successfully

IS_TIMED_OUT

A timeout occurred. An image capturing process could not be terminated within the allowable period.

Related functions

is_ParameterSet()

is_GetAutoInfo()

is_SetHardwareGain()

is_SetHWGainFactor()

is_Exposure()

is_SetFrameRate()

is_AOI()

Example 1

//Enable auto gain control:
double dEnable = 1;
int ret = is_SetAutoParameter (hCam, IS_SET_ENABLE_AUTO_GAIN, &dEnable, 0);
 
//Set brightness setpoint to 128:
double nominal = 128;
int ret = is_SetAutoParameter (hCam, IS_SET_AUTO_REFERENCE, &nominal, 0);
 
//Return shutter control limit:
double maxShutter;
int ret = is_SetAutoParameter (hCam, IS_GET_AUTO_SHUTTER_MAX, &maxShutter, 0);

Example 2

// Query default offset
double dOffsetRDefault, dOffsetBDefault;
int ret = is_SetAutoParameter (hCam, IS_GET_AUTO_WB_OFFSET_DEF, &dOffsetRDefault, &dOffsetBDefault);
 
// Query minimum offset
double dOffsetRMin, dOffsetBMin;
int ret = is_SetAutoParameter (hCam, IS_GET_AUTO_WB_OFFSET_MIN, &dOffsetRMin, &dOffsetBMin);
 
// Query maximum offset
double dOffsetRMax, dOffsetBMax;
int ret = is_SetAutoParameter (hCam, IS_GET_AUTO_WB_OFFSET_MAX, &dOffsetRMax, &dOffsetBMax);

Example 3

// Disable auto exposure
double dblEnable = 0;
double dblDummy = 0;
ret = is_SetAutoParameter(m_hCam, IS_SET_ENABLE_AUTO_SENSOR_GAIN_SHUTTER, &dblEnable, &dblDummy);
 
// Set exposure manually
double newExposure = 50.0;
ret = is_Exposure(m_hCam, IS_EXPOSURE_CMD_SET_EXPOSURE, &newExposure, 8);

© 2022 IDS Imaging Development Systems GmbH