is_SetHardwareGain

USB 2.0

USB 3.0

GigE

USB 2.0

USB 3.0

GigE

Syntax

INT is_SetHardwareGain (HIDS hCam, INT nMaster, INT nRed, INT nGreen, INT nBlue)

Description

is_SetHardwareGain() controls the sensor gain channels. These can be set between 0 % and 100 % independently of of each other. The actual gain factor obtained for the value 100 % depends on the sensor and is specified in Camera and sensor data chapter.

For HDR camera models UI-112x/UI-512x, this function changes the white level of the image (see also UI-112x/UI-512x application notes)

You can use the is_GetSensorInfo() function to query the available gain controls.

Hinweis

Note on using sensor gain

A signal gain will also result in a noise gain. High gain settings are therefore not recommended.

We suggest the following gain settings:

1.Enable the gain boost function is_SetGainBoost().

2.If required, adjust the gain setting with is_SetHardwareGain()

New gain settings might only become effective when the next image is captured. This depends on the time when the gain settings are changed.

Hinweis

Note on the linearity of sensor gain

On uEye cameras, you can set the gain factor in increments from 0 to 100. These increments are not graduated linearly throughout the range due to the sensor. The increments will typically be greater in the upper range than in the lower range.

The maximum gain factor settings also vary from sensor to sensor.

Hinweis

Note on default settings for RGB gains

The default setting values for the red, green and blue channel gain factors depend on the color correction matrix that has been set. If you select a different color correction matrix, the returned default values might change (see also is_SetColorCorrection()).

Input parameters

hCam	Camera handle
nMaster	Sets the overall gain factor (0...100).
IS_IGNORE_PARAMETER	The master gain factor will not be changed.
IS_GET_MASTER_GAIN	Returns the master gain factor.
IS_GET_RED_GAIN	Returns the red channel gain factor.
IS_GET_GREEN_GAIN	Returns the green channel gain factor.
IS_GET_BLUE_GAIN	Returns the blue channel gain factor.
IS_GET_DEFAULT_MASTER	Returns the default master gain factor.
IS_GET_DEFAULT_RED	Returns the default red channel gain factor.
IS_GET_DEFAULT_GREEN	Returns the default green channel gain factor.
IS_GET_DEFAULT_BLUE	Returns the default blue channel gain factor.
IS_SET_ENABLE_AUTO_GAIN	Enables the auto gain functionality (see also is_SetAutoParameter()). You can disable the auto gain functionality by setting a value for nMaster.
nRed	Sets the red channel gain factor (0...100).
IS_IGNORE_PARAMETER	The red channel gain factor will not be changed.
nGreen	Sets the green channel gain factor (0...100).
IS_IGNORE_PARAMETER	The green channel gain factor will not be changed.
nBlue	Sets the blue channel gain factor (0...100).
IS_IGNORE_PARAMETER	The blue channel gain factor will not be changed.

Return values

When used with IS_GET_MASTER_GAIN IS_GET_RED_GAIN IS_GET_GREEN_GAIN IS_GET_BLUE_GAIN	Current setting
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_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_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_SetHWGainFactor()

•is_GetSensorInfo()

•is_SetGainBoost()

•is_SetAutoParameter()

Suggestion for improvement? Send us your short Feedback on this chapter. Thank you very much!

For technical questions please contact you local distributor or use the support form on our website.

Home > C: Programming > Function descriptions >	History back Previous chapter Next chapter Print
is_SetHardwareGain