THORLABS DCU223 SERIES Operating and installation instructions

CCD and CMOS Cameras
DCU223x, DCU224x
DCC1240x
DCC1545M, DCC1645C
DCC3240X
DCC3260X
DCx Camera Functional
Description and SDK Manual
2016

Version:
Date: 4.80 8/11/2016
Copyright© 2016 Thorlabs Scientific Imaging

Foreword
Contents 9
1 General Information 10
101.1 Safety 121.2 Ordering Codes and Accessories 121.3 Requirements 131.4 DCx Camera Family 151.5 Contents 171.6 What's New in this Version?
2 Camera Basics 18
182.1 Operating Modes 182.1.1 Freerun Mode 202.1.2 Trigger Mode 212.1.3 Standby 222.2 Image Display Modes 252.3 Sensor 252.3.1 Sensor Sizes 262.3.2 Micro Lenses 292.3.3 Color Filter (Bayer filter) 312.3.4 Hot Pixels 332.3.5 Shutter Methods 372.3.6 Line Scan Mode 382.4 Reading Out Partial Images 382.4.1 Area of Interest (AOI) 422.4.2 Subsampling 432.4.3 Binning 442.5 Digitizing Images 442.5.1 Characteristics and LUT 472.5.2 Bit Depth and Digital Contrast Adjustment 502.6 Camera Parameters 502.6.1 Pixel Clock, Frame Rate, Exposure Time 512.6.2 Gain and Offset 512.6.3 Automatic Image Control 532.6.4 Applying New Parameters 532.7 Firmware and Camera Start 532.8 Digital Inputs / Outputs 542.8.1 Using Digital Inputs/Outputs 542.8.2 Flash Timing (Trigger Mode) 562.8.3 Flash Timing (Freerun Mode) 572.8.4 Serial Interface RS-232 (DC3240x only)

582.9 USB Interface 582.9.1 History and Development 582.9.2 Structure and Topology 592.9.3 USB 2.0 Cabling and Connectors 602.9.4 USB 3.0 Cabling and Connectors 602.9.5 Data Transmission and Bandwidth
3 Operation 62
623.1 uc480 Quick Start 643.2 Installation and Connection 643.2.1 System Requirements 653.2.2 DCx Driver Compatibility 653.2.3 Connecting a DCx Camera 673.3 Application Notes by Camera Model 673.3.1 DCC3260x Application Notes 683.3.2 DCC1240x / DCC3240x Application Notes 713.3.3 DCC1545M Application Notes 723.3.4 DCC1645C Application Notes 723.3.5 DCU223x Application Notes 723.3.6 DCU224x Application Notes 723.4 Installed uc480 Programs 733.4.1 uc480 Camera Manager 743.4.1.1 Camera List 743.4.1.2 Control Center 763.4.1.3 General Information 773.4.1.4 Camera Information 773.4.1.5 Creating a Support File 773.4.1.6 Additional Functions 813.4.1.7 Parameters 823.4.2 uc480 Hotpixel Editor
4 Programming (SDK) 85
864.1 First Steps to uc480 Programming 884.2 How to Proceed 884.2.1 Preparing Image Capture 884.2.1.1 Querying Information 894.2.1.2 Opening and Closing the Camera 894.2.1.3 Allocating Image Memory 914.2.1.4 Image Memory Sequences 924.2.2 Selecting the Display Mode 934.2.3 Capturing Images 934.2.3.1 Image Capture Modes 1014.2.3.2 Event / Message Handling

1054.2.4 Setting Camera Parameters 1054.2.4.1 Setting and Getting Parameters 1084.2.4.2 Automatic Image Control 1094.2.4.3 Image Pre-processing 1094.2.4.4 Get Camera Status 1094.2.4.5 Using the Camera EEPROM 1104.2.5 Saving Images and Videos 1104.2.5.1 Saving and Loading Single Frames 1104.2.5.2 Capturing AVIs 1134.2.6 Using Inputs and Outputs 1134.2.6.1 Input/Output Control 1164.3 Function Descriptions 1174.3.1 is_AddToSequence 1184.3.2 is_AllocImageMem 1204.3.3 is_AOI 1304.3.4 is_AutoParameter 1334.3.5 is_Blacklevel 1364.3.6 is_CameraStatus 1384.3.7 is_CaptureStatus 1414.3.8 is_CaptureVideo 1434.3.9 is_ClearSequence 1444.3.10 is_ColorTemperature 1484.3.11 is_Configuration 1554.3.12 is_Convert 1574.3.13 is_CopyImageMem 1584.3.14 is_CopyImageMemLines 1594.3.15 is_DeviceFeature 1614.3.15.1 Configuring the AOI Merge Mode 1654.3.15.2 Using the Log Mode 1684.3.15.3 Using Level Controlled Trigger 1694.3.15.4 Switching the Shutter Mode 1704.3.15.5 Using the Internal Image Memory 1724.3.15.6 Using the Line Scan Mode 1734.3.15.7 Configuring the Timestamp 1744.3.16 is_DeviceInfo 1774.3.17 is_DirectRenderer 1874.3.18 is_DisableEvent 1884.3.19 is_EdgeEnhancement 1914.3.20 is_EnableAutoExit 1924.3.21 is_EnableEvent 1954.3.22 is_EnableMessage 1974.3.23 is_ExitCamera

1984.3.24 is_ExitEvent 1994.3.25 is_ExitImageQueue 2004.3.26 is_Exposure 2024.3.26.1 Setting the Exposure Time 2054.3.26.2 Exposure Time with Fine Increments 2074.3.26.3 Setting the Long Exposure 2084.3.26.4 Setting the Dual Exposure 2104.3.27 is_ForceTrigger 2124.3.28 is_FreeImageMem 2144.3.29 is_FreezeVideo 2164.3.30 is_Gamma 2174.3.31 is_GetActiveImageMem 2194.3.32 is_GetActSeqBuf 2214.3.33 is_GetAutoInfo 2254.3.34 is_GetBusSpeed 2264.3.35 is_GetCameraInfo 2284.3.36 is_GetCameraList 2304.3.37 is_GetCameraLUT 2314.3.38 is_GetColorConverter 2324.3.39 is_GetColorDepth 2334.3.40 is_GetDLLVersion 2344.3.41 is_GetError 2354.3.42 is_GetFramesPerSecond 2364.3.43 is_GetFrameTimeRange 2384.3.44 is_GetImageHistogram 2414.3.45 is_GetImageInfo 2454.3.46 is_GetImageMem 2464.3.47 is_GetImageMemPitch 2484.3.48 is_GetNumberOfCameras 2494.3.49 is_GetOsVersion 2504.3.50 is_GetSensorInfo 2524.3.51 is_GetSensorScalerInfo 2534.3.52 is_GetSupportedTestImages 2554.3.53 is_GetTestImageValueRange 2564.3.54 is_GetTimeout 2574.3.55 is_GetUsedBandwidth 2584.3.56 is_GetVsyncCount 2594.3.57 is_HasVideoStarted 2604.3.58 is_HotPixel 2654.3.59 is_ImageFile 2694.3.60 is_ImageFormat 2764.3.61 is_InitCamera

2804.3.62 is_InitEvent 2824.3.63 is_InitImageQueue 2844.3.64 is_InquireImageMem 2864.3.65 is_IO 2994.3.66 is_IsVideoFinish 3014.3.67 is_LockSeqBuf 3024.3.68 is_LUT 3054.3.69 is_Measure 3094.3.70 is_ParameterSet 3124.3.71 is_PixelClock 3154.3.72 is_ReadEEPROM 3174.3.73 is_RenderBitmap 3194.3.74 is_ResetToDefault 3214.3.75 is_SetAllocatedImageMem 3244.3.76 is_SetAutoParameter 3324.3.77 is_SetBinning 3354.3.78 is_SetCameraID 3374.3.79 is_SetColorConverter 3394.3.80 is_SetColorCorrection 3414.3.81 is_SetColorMode 3454.3.82 is_SetDisplayMode 3494.3.83 is_SetDisplayPos 3504.3.84 is_SetErrorReport 3514.3.85 is_SetExternalTrigger 3534.3.86 is_SetFrameRate 3554.3.87 is_SetGainBoost 3564.3.88 is_SetGamma 3584.3.89 is_SetHardwareGain 3614.3.90 is_SetHWGainFactor 3634.3.91 is_SetImageMem 3644.3.92 is_SetOptimalCameraTiming 3664.3.93 is_SetRopEffect 3684.3.94 is_SetSaturation 3694.3.95 is_SetSensorScaler 3724.3.96 is_SetSensorTestImage 3744.3.97 is_SetSubSampling 3784.3.98 is_SetTimeout 3804.3.99 is_SetTriggerCounter 3814.3.100 is_SetTriggerDelay 3824.3.101 is_StopLiveVideo 3834.3.102 is_Trigger 3854.3.103 is_TriggerDebounce

3894.3.104 is_UnlockSeqBuf 3904.3.105 is_WaitEvent 3914.3.106 is_WaitForNextImage 3934.3.107 is_WriteEEPROM 3954.4 AVI Function Descriptions 3954.4.1 isavi_AddFrame 3964.4.2 isavi_CloseAVI 3964.4.3 isavi_DisableEvent 3974.4.4 isavi_EnableEvent 3984.4.5 isavi_ExitAVI 3994.4.6 isavi_ExitEvent 4004.4.7 isavi_GetAVIFileName 4014.4.8 isavi_GetAVIFileNameW 4024.4.9 isavi_GetAVISize 4034.4.10 isavi_GetnCompressedFrames 4044.4.11 isavi_GetnLostFrames 4054.4.12 isavi_InitAVI 4064.4.13 isavi_InitEvent 4074.4.14 isavi_OpenAVI 4084.4.15 isavi_OpenAVIW 4094.4.16 isavi_ResetFrameCounters 4104.4.17 isavi_SetFrameRate 4114.4.18 isavi_SetImageQuality 4124.4.19 isavi_SetImageSize 4144.4.20 isavi_StartAVI 4154.4.21 isavi_StopAVI 4164.5 RAW function descriptions 4164.5.1 israw_AddFrame 4164.5.2 israw_CloseFile 4174.5.3 israw_ExitFile 4174.5.4 israw_GetFrame 4184.5.5 israw_GetImageInfo 4194.5.6 israw_GetSize 4194.5.7 israw_InitFile 4204.5.8 israw_OpenFile 4214.5.9 israw_SeekFrame 4214.5.10 israw_SetImageInfo 4224.6 Obsolete functions 4254.7 Programming Notes 4254.7.1 Programming in C/C++ 4264.7.2 Programming in C# 4274.7.3 Programming in VB.NET

4274.7.4 Programming in Delphi 4274.7.5 Programming with ActiveX 4274.7.6 Thread Programming 4294.8 Lists 4294.8.1 Complete List of All Return Values 4334.8.2 Error Codes of AVI Functions 4334.8.3 Linux: Not Supported Functions
5 Specifications 435
4365.1 Model Comparison 4385.2 Model Naming Conventions 4385.3 Camera and Sensor Data 4395.3.1 DCC3260x 4405.3.2 DCC1240x / DCC3240x 4445.3.3 DCC1545M 4465.3.4 DCC1645C 4485.3.5 DCU223x 4515.3.6 DCU224x 4545.4 Mechanical Specifications 4555.4.1 DCU223x, DCU224x 4565.4.2 DCC1240x 4575.4.3 DCC3240x 4585.4.4 DCC1545M, DCC1645C 4595.4.5 Flange Back Distance 4595.4.5.1 Calculating the Flange Back Distance 4615.4.5.2 Maximum Immersion Depth for Lenses 4625.4.6 Position Accuracy of the Sensor 4635.4.7 Filter Glasses 4635.4.7.1 Filter Types 4675.4.7.2 Mounting the Filter 4685.4.7.3 Cleaning the Filter Glasses 4705.4.8 Ambient Conditions 4715.5 Camera Interface 4715.5.1 DCU223x, DCU224x, DCC1240x 4715.5.1.1 I/O Connector - Pin Assignment 4735.5.1.2 Digital Input (Trigger) Circuit 4745.5.1.3 Digital Output (Flash) Circuit 4765.5.2 DCC3240x 4765.5.2.1 I/O Connector Pin Assignment 4775.5.2.2 GPIO Interface 4795.5.2.3 Digital Input (Trigger) Circuit 4805.5.2.4 Digital Output (Flash) Circuit 4815.5.2.5 RS-232 Serial Interface

4825.5.3 Camera EEPROM Specification 4835.6 Accessories for DCx cameras 4835.6.1 Accessories for DCU22xX / DCC1240X 4845.6.2 Accessories for DCC1x45X 4845.6.3 Accessories for DCC3240x / DCC3260x
6 Appendix 485
4856.1 Troubleshooting/FAQ 4866.1.1 PCs with Energy Saving CPU Technology 4876.2 Status LED on USB DCx Cameras 4896.3 Color and Memory Formats 4926.4 uc480 Parameter File (ini file) 4996.5 Definition of IP Protection Classes 4996.6 History of API functions 5016.7 Certifications and Compliances 5036.8 Thorlabs 'End of Life' Policy (WEEE) 5046.9 Exclusion of Liability and Copyright 5056.10Thorlabs Worldwide Contacts