© 2013 Thorlabs GmbH
4 Programming (SDK)
335
4.3.88 is_SetHWGainFactor
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
IS_GET_MASTER_GAIN_FACTOR
Returns the master gain factor.
Returns the red channel gain factor.
Returns the green channel gain factor.
Returns the blue channel gain factor.
IS_SET_MASTER_GAIN_FACTOR
Sets the master gain factor.
Sets the red channel gain factor.
Sets the green channel gain factor.
Sets the blue channel gain factor.
IS_GET_DEFAULT_MASTER_GAIN_FACTOR
Returns the default master gain factor.
IS_GET_DEFAULT_RED_GAIN_FACTOR
Returns the default red channel gain factor.
IS_GET_DEFAULT_GREEN_GAIN_FACTOR
Returns the default green channel gain factor.
IS_GET_DEFAULT_BLUE_GAIN_FACTOR
Returns the default blue channel gain factor.
IS_INQUIRE_MASTER_GAIN_FACTOR
Converts the index value for the master gain factor.
IS_INQUIRE_RED_GAIN_FACTOR
Converts the index value for the red channel gain factor.
IS_INQUIRE_GREEN_GAIN_FACTOR
Converts the index value for the green channel gain
factor.
IS_INQUIRE_BLUE_GAIN_FACTOR
Converts the index value for the blue channel gain
factor.
Gain value (100 = gain factor 1, i. e. no effect)
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
When used with
IS_GET_MASTER_GAIN_FACTOR
IS_GET_RED_GAIN_FACTOR
IS_GET_GREEN_GAIN_FACTOR
333
460
251
333
To Next Page
Loading...
Need help?
General
