 |
 |
|---|---|
USB 2.0 USB 3.0 GigE |
USB 2.0 USB 3.0 GigE |
Syntax
INT is_SetBlCompensation (HIDS hCam, INT nEnable, INT offset, INT reserved)
Description
|
This function is obsolete and should not be used anymore. We recommend to use the is_Blacklevel() function instead. |
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.
UI-112x/UI-512x only: On models with HDR sensor the function is_SetBlCompensation() controls the black level when a contrast adjustment is performed.
 Fig. 2: Black level correction - Auto |
 Fig. 3: Black level correction - Auto + offset |
 Fig. 4: Schwarzwert-Korrektur nur Offset |
Input parameters
hCam |
Camera handle |
offset |
Contains the offset value used for compensation. Valid values are between 0 and 255. |
IS_IGNORE_PARAMETER |
The offset parameter is ignored. |
reserved |
Reserved. 0 must be passed. |
Return values
When used together with IS_GET_BL_SUPPORTED_MODE |
Supported modes |
When used together with IS_GET_BL_COMPENSATION |
Current mode |
When used together with IS_GET_BL_OFFSET |
Current offset |
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. |
