IDS Software Suite 4.96.1

Syntax

INT is_SetHWGainFactor (HIDS hCam, INT nMode, INT nFactor)

Description

is_SetHWGainFactor() uses gain factors to control sensor gain channels. These channels can be set independently of each other. The is_SetHardwareGain() does not use factors for setting the gain channels, but standardized values between 0 and 100. The actual gain factor is sensor-dependent and can be found in Camera and sensor data chapter.

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

Depending on the time when the gain settings are changed, these changes might only become effective when the next image is captured.

Input parameters

For converting a gain value from the is_SetHardwareGain() function, you can set the nMode parameter to one of the IS_INQUIRE_x_FACTOR values. In this case, the value range for nFactor is between 0 and 100.

To set the gain using IS_SET_..._GAIN_FACTOR, you must set the nFactor parameter to an integer value in the range from 100 to the maximum value. By calling IS_INQUIRE_x_FACTOR and specifying the value 100 for nFactor, you can query the maximum value. A gain value of 100 means no gain, a gain value of 200 means gain to the double level (factor 2), etc.

Return values

Related functions

•is_SetHardwareGain()

•is_SetHardwareGamma()

•is_SetGainBoost()

•is_SetAutoParameter()

•is_GetSensorInfo()

Example

//Set master gain factor to 3.57:
INT ret = is_SetHWGainFactor (hCam, IS_SET_MASTER_GAIN_FACTOR, 357);
//ret has the value 363 for the UI-1460-C
 
//Query the maximum gain factor for the red channel:
ret = is_SetHWGainFactor (hCam, IS_INQUIRE_RED_GAIN_FACTOR, 100);
//ret has the value 725 for the UI-1460-C