Is_Setcolorconverter - THORLABS DCU223x Operation Manual And Sdk

4.3.77 is_SetColorConverter

USB 2.0
USB 3.0
Syntax
INT is_SetColorConverter (HIDS hCam, INT ColorMode, INT ConvertMode)
Description
Using is_SetColorConverter(), you can select the type of Bayer conversion for color cameras. Software
conversion is done on the PC. The use of a larger filter mask results in a higher image quality, but increases the
computational load. For further information, please refer to the
Note
Software conversion with the large filter mask should only be used for sensors whose green pixels have the same
sensitivity. This applies to all DCU22xX CCD cameras.
For all other sensors, we recommend using the standard filter mask.
Attention
While free run mode is active, you cannot change the color conversion type. To do so, you must first stop the
capturing process using
is_SetExternalTrigger()
Input parameters
hCam
ColorMode
ConvertMode
IS_CONV_MODE_NONE
IS_CONV_MODE_SOFTWARE
IS_CONV_MODE_SOFTWARE_3X3
IS_CONV_MODE_SOFTWARE_5X5
IS_CONV_MODE_HARDWARE_3X3
IS_CONV_MODE_OPENCL_3X3
IS_CONV_MODE_OPENCL_5X5
Return values
IS_INVALID_COLOR_FORMAT
IS_CANT_COMMUNICATE_WITH_DRIVER
IS_CANT_OPEN_DEVICE
IS_CAPTURE_RUNNING
IS_INVALID_COLOR_FORMAT
IS_INVALID_CAMERA_HANDLE
IS_INVALID_PARAMETER
© 2013 Thorlabs GmbH
USB 2.0
USB 3.0
is_StopLiveVideo()
).
327
Camera basics: Color filters
or set the camera
353
Camera handle
Color mode for which the converter is to be set.
For a list of all available color formats and the
associated input parameters, see the
and memory formats
Conversion mode selection
No conversion
Only for monochrome cameras, if you want to add a
gamma
Software conversion using the standard filter mask
(default)
Software conversion using a large filter mask
(Not applicable to DCx Cameras)
Software conversion using the standard filter mask, but
conversion is done on the graphic board
(Not applicable to DCx Cameras)
Parameter invalid or not supported
ColorMode
Communication with the driver failed because no driver
has been loaded.
An attempt to initialize or select the camera failed (no
camera connected or initialization error).
A capturing operation is in progress and must be
terminated before you can start another one.
Invalid color format
Invalid camera handle
One of the submitted parameters is outside the valid
range or is not supported for this sensor or is not
4 Programming (SDK)
chapter.
26
to trigger mode
Appendix: Color
section.
502
(see
315