USB 2.0 USB 3.0 GigE	USB 2.0 USB 3.0 GigE

Syntax

INT is_ColorTemperature (HIDS hCam, UINT nCommand, void *pParam, UINT nSizeOfParam)

Description

Using is_ColorTemperature() you can fix a setting (in kelvins) for the color temperature of an image when you are using a color camera. The function will use the sensor's hardware gain controls for the setting, as far as possible. In addition, you can choose between different color spaces. A specific color temperature will result in slightly differing RGB values, depending on the selected color space.

Additionally you can set or return the color temperature for the UI-1007XS lens correction.

Note that the current LUT values are calculated at the first function call of is_ColorTemperature(). Depending on the system used, the first function call may take a little longer.

The nCommand input parameter is used to select the function mode. The pParam input parameter depends on the selected function mode. If you select functions for setting or returning a value, pParam contains a pointer to a variable of the UINT type. The size of the memory area to which pParam refers is specified in the nSizeOfParam input parameter.

The color temperature is the temperature to which a black body radiator has to be heated to glow and give off light in the corresponding color. Warm light (reddish) has a lower color temperature than cold light (bluish). The following table lists a few example values:

The is_ColorTemperature() function cannot be used simultaneously with the automatic white balance function in is_SetAutoParameter()/is_AutoParameter().

Input parameters

hCam	Camera handle
nCommand Setting the color space COLOR_TEMPERATURE_CMD_GET_SUPPORTED_RGB_COLOR_MODELS Returns the supported color spaces. More details pParam: Pointer to a bit mask of type UINT The bit mask returns the supported modes, linked by logical ORs (see Color spaces table). nSizeOfParam: 4 COLOR_TEMPERATURE_CMD_SET_RGB_COLOR_MODEL Sets a color space. More details pParam: Pointer to variable of type UINT that passes the value to be set. nSizeOfParam: 4 COLOR_TEMPERATURE_CMD_GET_RGB_COLOR_MODEL Returns the set color space. More details pParam: Pointer to variable of type UINT returning the current value. nSizeOfParam: 4 COLOR_TEMPERATURE_CMD_GET_RGB_COLOR_MODEL_DEFAULT Returns the default color space. More details pParam: Pointer to variable of type UINT returning the default value. nSizeOfParam: 4 Setting the color temperature COLOR_TEMPERATURE_CMD_SET_TEMPERATURE Sets a color temperature. More details pParam: Pointer to variable of type UINT that passes the value to be set. nSizeOfParam: 4 COLOR_TEMPERATURE_CMD_GET_TEMPERATURE Returns the set color temperature. More details pParam: Pointer to variable of type UINT returning the current value. nSizeOfParam: 4 COLOR_TEMPERATURE_CMD_GET_TEMPERATURE_MIN Returns the minimum value for the color temperature. More details pParam: Pointer to variable of type UINT returning the minimum value. nSizeOfParam: 4 COLOR_TEMPERATURE_CMD_GET_TEMPERATURE_MAX Returns the maximum value for the color temperature. More details pParam: Pointer to variable of type UINT returning the maximum value. nSizeOfParam: 4 COLOR_TEMPERATURE_CMD_GET_TEMPERATURE_INC Returns the increment for setting the color temperature. More details pParam: Pointer to variable of type UINT returning the increment. nSizeOfParam: 4 COLOR_TEMPERATURE_CMD_GET_TEMPERATURE_DEFAULT Returns the default value for the color temperature. More details pParam: Pointer to variable of type UINT returning the default value. nSizeOfParam: 4 Color temperature for lens correction (only UI-1007XS) COLOR_TEMPERATURE_CMD_GET_LENS_SHADING_MODEL Returns the set color temperature for lens correction. Example COLOR_TEMPERATURE_CMD_GET_LENS_SHADING_MODEL_DEFAULT Returns the default value for the color temperature for lens correction. COLOR_TEMPERATURE_CMD_GET_LENS_SHADING_MODEL_SUPPORTED Returns the supported color temperature for lens correction: •LSC_MODEL_AGL (0x0001): Color space with a white point of 3000 kelvins •LSC_MODEL_TL84 (0x0002): Color space with a white point of 4000 kelvins •LSC_MODEL_D50 (0x0004): Color space with a white point of 5000 kelvins •LSC_MODEL_D65 (0x0008): Color space with a white point of 6500 kelvins COLOR_TEMPERATURE_CMD_SET_LENS_SHADING_MODEL Sets the new color temperature for lens correction. Example
pParam	Pointer to a function parameter, whose function depends on nCommand.
nSizeOfParam	Size (in bytes) of the memory area to which pParam refers.

Color Spaces

Return values

Related functions

•is_SetHardwareGain()

•is_AutoParameter()

•is_SetAutoParameter()

Example

// set new lens correction
IS_U32 u32LscModel = LSC_MODEL_D50;
is_ColorTemperature(hCam, COLOR_TEMPERATURE_CMD_SET_LENS_SHADING_MODEL, (void*)&u32LscModel, sizeof(u32LscModel));
 
// get current lens correction
IS_U32 u32LscModel = 0;
is_ColorTemperature(hCam, COLOR_TEMPERATURE_CMD_GET_LENS_SHADING_MODEL, (void*)&u32LscModel, sizeof(u32LscModel));
 
if (u32LscModel == LSC_MODEL_TL84){
...
}
 
// get supported lens correction
IS_U32 u32LscModel = 0;
is_ColorTemperature(hCam, COLOR_TEMPERATURE_CMD_GET_LENS_SHADING_MODEL_SUPPORTED, (void*)&u32LscModel, sizeof(u32LscModel));
 
if ((u32LscModel & LSC_MODEL_TL84) == LSC_MODEL_TL84){
// LSC_MODEL_TL84 supported....
...
}