© 2016 Thorlabs Scientific Imaging144
DCx Camera Functional Description and SDK Manual
4.3.10 is_ColorTemperature
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.
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:
Fluorescent lamp (cold white)
Morning and evening sunlight
Note
The is_ColorTemperature() function cannot be used simultaneously with the automatic white
balance function in is_SetAutoParameter()/is_AutoParameter().
Input parameters
COLOR_TEMPERATURE_CMD_GET_SUPPORTED_RGB_C
OLOR_MODELS
Returns the supported color spaces.
More details
pParam: Pointer to a bit mask of type UINT
The bit mask returns the supported modes,