© 2013 Thorlabs GmbH
4 Programming (SDK)
421
4.5.31 is_SetBlCompensation
Syntax
INT is_SetBlCompensation (HIDS hCam, INT nEnable, INT offset, INT reserved)
Description
Attention
This function is obsolete and should not be used anymore. We recommend to use the is_Blacklevel()
function instead (see also Obsolete functions ).
is_SetBlCompensation() enables the black level correction function which might improve the image quality
under certain circumstances. By default, the sensor adjusts the black level value for each pixel automatically. If the
environment is very bright, it can be necessary to adjust the black level manually by the offset parameter.
Black level correction - Auto
Black level correction - Auto +
offset
Black level correction - Offset
Input parameters
IS_BL_COMPENSATION_DISABLE
Disables automatic black level correction. The offset
value is used as black level instead. This mode is only
supported by sensors of the UI-154x/UI-554x series.
IS_BL_COMPENSATION_ENABLE
Enables automatic black level correction. The offset
value is added to the automatic black level value.
Returns the current mode.
Returns the currently set value for offset.
Returns the default mode.
Returns the default value for offset.
Returns the supported modes.
Possible values:
IS_BL_COMPENSATION_ENABLE
The sensor supports automatic black level correction.
IS_BL_COMPENSATION_OFFSET
For the sensor used, it is also possible to set the offset
manual.
The nEnable parameter is ignored.
Contains the offset value used for compensation. Valid
values are between 0 and 255.
The offset parameter is ignored.
Reserved. 0 must be passed.
170
379
464