THORLABS DCU223x User Manual

© 2013 Thorlabs GmbH
4 Programming (SDK)
167
4.3.4 is_AutoParameter
USB 2.0
USB 3.0
USB 2.0
USB 3.0
Syntax
INT is_AutoParameter(HIDS hCam, UINT nCommand, void* pParam, UINT cbSizeOfParam)
Description
This functions enables/diisables the auto white balance. With this function, you can require all supported types for
white balance. In addition to the older white balance with the Gray-World algorithm, there is also a color
temperature control according to Kelvin. In addition to the function the supported color spaces are queried and set.
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
cbSizeOfParam input parameter.
Note
In a later version the is_AutoParameter() function will replace the is_SetAutoParameter() function.
In version 4.20, it is only partly replaced.
Input parameters
hCam
Camera handle
nCommand
IS_AWB_CMD_GET_SUPPORTED_TYPES
Returns the supported types for auto white balance (Example 1
)
IS_AWB_GREYWORLD: 0x0001
IS_AWB_COLOR_TEMPERATURE: 0x0002
IS_AWB_CMD_GET_TYPE
Returns the current set type of the auto white balance
(Example 2 )
IS_AWB_GREYWORLD: 0x0001
IS_AWB_COLOR_TEMPERATURE: 0x0002
IS_AWB_CMD_SET_TYPE
Sets the type of the auto white balance (Example 2 )
IS_AWB_GREYWORLD: 0x0001
IS_AWB_COLOR_TEMPERATURE: 0x0002
IS_AWB_CMD_GET_ENABLE
Returns if the auto white balance is enabled (Example 3 )
IS_AUTOPARAMETER_DISABLE: 0
IS_AUTOPARAMETER_ENABLE: 1
IS_AUTOPARAMETER_ENABLE_RUNONCE: 2
IS_AWB_CMD_SET_ENABLE
Enables/Disables the auto white balance (Example 3 )
IS_AUTOPARAMETER_DISABLE: 0
IS_AUTOPARAMETER_ENABLE: 1
IS_AUTOPARAMETER_ENABLE_RUNONCE: 2
IS_AWB_CMD_GET_SUPPORTED_RGB_COLOR_
MODELS
Returns the supported color spaces for the auto white balance
(Example 4 )
RGB_COLOR_MODEL_SRGB_D50: 0x0001
RGB_COLOR_MODEL_SRGB_D65: 0x0002
RGB_COLOR_MODEL_CIE_RGB_E: 0x0004
RGB_COLOR_MODEL_ECI_RGB_D50: 0x0008
RGB_COLOR_MODEL_ADOBE_RGB_D65: 0x0010
IS_AWB_CMD_GET_RGB_COLOR_MODEL
Returns the current color space for the auto white balance
(Example 5 )
303
168
168
168
168
168
169
169

THORLABS DCU223x Specifications

General

Brand	THORLABS
Model	DCU223x
Category	Security Camera
Language	English