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

is_SetHardwareGain

uEye Camera Manual Version 3.80

is_SetHardwareGain

Windows_Logo

Linux_Logo

USB 2.0

GigE

USB 2.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 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

IS_SUCCESS

Function executed successfully

IS_NO_SUCCESS

General error message

Current setting
When used together with
IS_GET_MASTER_GAIN
IS_GET_RED_GAIN
IS_GET_GREEN_GAIN
IS_GET_BLUE_GAIN


IS_INVALID_MODE

Camera is in standby mode, function not allowed.

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!


© 2010 IDS Imaging Development Systems GmbH
http://www.ids-imaging.com