Home > C: Programming > Function Descriptions > History back  Previous chapter  Next chapter  Print  

is_ColorTemperature

uEye Camera Manual Version 3.80

is_ColorTemperature

Windows_Logo

Linux_Logo

USB 2.0

GigE

USB 2.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.

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.

Hinweis

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

Color temperature

Light bulb (100 W)

2800

Halogen lamp

3200

Fluorescent lamp (cold white)

4000

Morning and evening sunlight

5000

Noon sunlight

5500-5800

Flash strobe

6000

Overcast daylight

6500-7500

Fog

8000

Hinweis

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

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

pParam

Pointer to a function parameter; which function parameter is referred to here depends on nCommand.

nSizeOfParam

Size (in bytes) of the memory area to which pParam refers.

Color Spaces

RGB_COLOR_MODEL_SRGB_D50

sRGB (standard RGB) color space with a white point of 5000 kelvins (warm light)

RGB_COLOR_MODEL_SRGB_D65

sRGB (standard RGB) color space with a white point of 6500 kelvins (mid daylight)

RGB_COLOR_MODEL_CIE_RGB_E

CIE-RGB color space with standard illumination E

RGB_COLOR_MODEL_ECI_RGB_D50

ECI-RGB color space with a white point of 5000 kelvins (warm light)

RGB_COLOR_MODEL_ADOBE_RGB_D65

Adobe RGB color space with a white point of 6500 kelvins (mid daylight). The Adobe RGB color space is larger than the sRGB color space, but not all devices can render it.

Return Values

IS_SUCCESS

Function executed successfully

IS_NO_SUCCESS

General error message

IS_INVALID_PARAMETER

One of the parameters passed is invalid

IS_NOT_SUPPORTED

This function is not supported by the current camera

Related Functions

is_SetHardwareGain()
is_SetAutoParameter()

Suggestion for improvement? Send us your short Feedback on this chapter. Thank you very much!


© 2010 IDS Imaging Development Systems GmbH
http://www.ids-imaging.com