Is_Setcolorcorrection - THORLABS DCU223x Operation Manual And Sdk

4.3.78 is_SetColorCorrection

USB 2.0
USB 3.0
Syntax
INT is_SetColorCorrection (HIDS hCam, INT nEnable, double* factors)
Description
For color cameras, is_SetColorCorrection() enables color correction in the uc480 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.
Note
After changing this parameter, perform manual or automatic white balancing in order to obtain correct color
rendering (see also
is_SetAutoParameter()
Input parameters
hCam
nEnable
IS_CCOR_ENABLE_NORMAL
IS_CCOR_ENABLE_BG40_ENHANCED
IS_CCOR_ENABLE_HQ_ENHANCED
IS_CCOR_SET_IR_AUTOMATIC
IS_CCOR_DISABLE
IS_GET_CCOR_MODE
IS_GET_SUPPORTED_CCOR_MODE
IS_GET_DEFAULT_CCOR_MODE
factors
Return values
When used together with
IS_GET_CCOR_MODE
When used together with
IS_GET_SUPPORTED_CCOR_MODE
When used together with
IS_GET_DEFAULT_CCOR_MODE
© 2013 Thorlabs GmbH
USB 2.0
USB 3.0
).
303
Camera handle
Enables simple color correction. This parameter
replaces IS_CCOR_ENABLE.
Enables color correction for cameras with optical IR
filter glasses of the BG40 type.
Enables color correction for cameras with optical IR
filter glasses of the HQ type.
Enables color correction for cameras with optical IR
filter glasses. The glass type is set automatically as
specified in the camera EEPROM.
Disables color correction.
Returns the current setting.
Returns all supported color correction modes. See the
Return values section.
Returns the default color correction mode.
Sets the strength of the color correction between 0.0 (no
correction) and 1.0 (strong correction).
Current setting
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 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
4 Programming (SDK)
317