Is_Colortemperature - THORLABS DCU223x Operation Manual And Sdk

DCx Cameras

4.3.10 is_ColorTemperature

USB 2.0
USB 3.0
Syntax
INT is_ColorTemperature (HIDS hCam, UINT nCommand,
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:
Light source
Light bulb (100 W)
Halogen lamp
Fluorescent lamp (cold white)
Morning and evening sunlight
Noon sunlight
Flash strobe
Overcast daylight
Fog
Note
The is_ColorTemperature() function cannot be used simultaneously with the automatic white balance function
in
is_SetAutoParameter()
Input parameters
hCam
nCommand
Setting the color space
COLOR_TEMPERATURE_CMD_GET_SUPPORTED_RGB_C
OLOR_MODELS
COLOR_TEMPERATURE_CMD_SET_RGB_COLOR_MODEL Sets a
COLOR_TEMPERATURE_CMD_GET_RGB_COLOR_MODEL Returns the set
180
USB 2.0
USB 3.0
void *pParam, UINT nSizeOfParam)
/is_AutoParameter()
303
Color temperature
2800
3200
4000
5000
5500-5800
6000
6500-7500
8000
.
167
Camera handle
Returns the supported
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
nSizeOfParam: 4
color space .
182
More details
pParam: Pointer to variable of type UINT that passes
the value to be set.
nSizeOfParam: 4
color space
color spaces .
182
table).
182
.
182
© 2013 Thorlabs GmbH