is_SetColorCorrection

USB 2.0

USB 3.0

GigE

USB 2.0

USB 3.0

GigE

Syntax

INT is_SetColorCorrection (HIDS hCam, INT nEnable, double* factors)

Description

For color cameras, is_SetColorCorrection() enables color correction in the uEye driver. This enhances the rendering of colors for cameras with color sensors. Color correction is a digital correction based on a color matrix which is adjusted individually for each sensor.

This function is currently not supported by the following camera models:

•UI-3013XC

•UI-1007XS

If you perform Bayer conversion for USB 3 uEye CPLE/ML color cameras in the camera itself, color conversion will automatically also take place in the camera.

After changing this parameter, perform manual or automatic white balancing in order to obtain correct color rendering (see also is_SetAutoParameter()).

Input parameters

hCam

Camera handle

factors

Sets the strength of the color correction between 0.0 (no correction) and 1.0 (strong correction).

Return values

When used together with IS_GET_CCOR_MODE	Current setting
When used together with IS_GET_SUPPORTED_CCOR_MODE	When used for color cameras and together with IS_GET_SUPPORTED_CCOR_MODE, this parameter returns the supported values linked by a logical OR: •IS_CCOR_ENABLE_NORMAL •IS_CCOR_ENABLE_BG40_ENHANCED •IS_CCOR_ENABLE_HQ_ENHANCED When used for monochrome cameras, the system returns 0.
When used together with IS_GET_DEFAULT_CCOR_MODE	When used for color cameras and together with IS_GET_DEFAULT_CCOR_MODE, this parameter returns the default color correction mode: •IS_CCOR_ENABLE_NORMAL •IS_CCOR_ENABLE_HQ_ENHANCED When used for monochrome cameras, the system returns 0.
When used together with IS_CCOR_FACTOR	When used for color cameras, this parameter returns the supported values linked by a logical OR: •IS_CCOR_ENABLE_NORMAL \| IS_CCOR_FACTOR •IS_CCOR_ENABLE_BG40_ENHANCED \| IS_CCOR_FACTOR •IS_CCOR_ENABLE_HQ_ENHANCED \| IS_CCOR_FACTOR When used for monochrome cameras, the system returns 0.
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_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_IR_FILTER	No IR filter available
IS_NO_SUCCESS	General error message
IS_NOT_SUPPORTED	The camera model used here does not support this function or setting.
IS_SUCCESS	Function executed successfully

Related functions

•is_SetColorConverter()

•is_SetColorMode()

•is_SetAutoParameter()

Suggestion for improvement? Send us your short Feedback on this chapter. Thank you very much!
For technical questions please contact your local distributor or use the support form on our website.