THORLABS DCU223x Operation Manual And Sdk
  1. Manuals
  2. Brands
  3. THORLABS Manuals
  4. Security Camera
  5. DCC 3240X
  6. Operation manual and sdk

THORLABS DCU223x Operation Manual And Sdk

Cdd and cmos cameras
Hide thumbs Also See for DCU223x:
1
2
Table Of Contents
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
Table of Contents

Advertisement

Quick Links

CDD and CMOS Cameras
DCU223x, DCU224x
DCC1240x
DCC1545M, DCC1645C
DCC3240X
Operation Manual and SDK
2013

Advertisement

Table of Contents
loading

Related Manuals for THORLABS DCU223x

Summary of Contents for THORLABS DCU223x

  • Page 1 CDD and CMOS Cameras DCU223x, DCU224x DCC1240x DCC1545M, DCC1645C DCC3240X Operation Manual and SDK 2013...
  • Page 2 Version: 4.20 Date: 25.03.2013 Copyright © 2013 Thorlabs GmbH...

  • Page 3: Table Of Contents

    Contents Foreword 1 General Information 1.1 Safety 1.2 Ordering Codes and Accessories 1.3 Requirements 1.4 DCx Camera Family 1.5 Contents 1.6 What's New in this Version? 2 Camera Basics 2.1 Operating Modes 2.1.1 Freerun Mode 2.1.2 Trigger Mode 2.1.3 Standby 2.2 Image Display Modes 2.3 Sensor 2.3.1...
  • Page 4 3.3 Application Notes by Camera Model 3.3.1 DCC1240x / DCC3240x Application Notes 3.3.2 DCC1545M Application Notes 3.3.3 DCC1645C Application Notes 3.3.4 DCU223x Application Notes 3.3.5 DCU224x Application Notes 3.4 Installed uc480 Programs 3.4.1 uc480 Camera Manager 3.4.1.1 Camera List 3.4.1.2 Control Center 3.4.1.3...
  • Page 5 3.4.3.4 Video Window and Full Screen Mode 3.4.4 uc480 Hotpixel Editor 4 Programming (SDK) 4.1 First Steps to uc480 Programming 4.2 How to Proceed 4.2.1 Preparing Image Capture 4.2.1.1 Querying Information 4.2.1.2 Opening and Closing the Camera 4.2.1.3 Allocating Image Memory 4.2.1.4 Image Memory Sequences 4.2.2...
  • Page 6 4.3.17 is_DirectRenderer 4.3.18 is_DisableEvent 4.3.19 is_EdgeEnhancement 4.3.20 is_EnableAutoExit 4.3.21 is_EnableEvent 4.3.22 is_EnableMessage 4.3.23 is_ExitCamera 4.3.24 is_ExitEvent 4.3.25 is_ExitImageQueue 4.3.26 is_Exposure 4.3.27 is_ForceTrigger 4.3.28 is_FreeImageMem 4.3.29 is_FreezeVideo 4.3.30 is_GetActiveImageMem 4.3.31 is_GetActSeqBuf 4.3.32 is_GetAutoInfo 4.3.33 is_GetBusSpeed 4.3.34 is_GetCameraInfo 4.3.35 is_GetCameraList 4.3.36 is_GetCameraLUT 4.3.37 is_GetColorConverter 4.3.38 is_GetColorDepth 4.3.39 is_GetDLLVersion...
  • Page 7 4.3.60 is_InitCamera 4.3.61 is_InitEvent 4.3.62 is_InitImageQueue 4.3.63 is_InquireImageMem 4.3.64 is_IO 4.3.65 is_IsVideoFinish 4.3.66 is_LockSeqBuf 4.3.67 is_Measure 4.3.68 is_ParameterSet 4.3.69 is_PixelClock 4.3.70 is_ReadEEPROM 4.3.71 is_RenderBitmap 4.3.72 is_ResetToDefault 4.3.73 is_SetAllocatedImageMem 4.3.74 is_SetAutoParameter 4.3.75 is_SetBinning 4.3.76 is_SetCameraID 4.3.77 is_SetColorConverter 4.3.78 is_SetColorCorrection 4.3.79 is_SetColorMode 4.3.80 is_SetDisplayMode 4.3.81 is_SetDisplayPos 4.3.82 is_SetErrorReport...
  • Page 8 4.3.103 is_WriteEEPROM 4.4 AVI Function Descriptions 4.4.1 isavi_AddFrame 4.4.2 isavi_CloseAVI 4.4.3 isavi_DisableEvent 4.4.4 isavi_EnableEvent 4.4.5 isavi_ExitAVI 4.4.6 isavi_ExitEvent 4.4.7 isavi_GetAVIFileName 4.4.8 isavi_GetAVIFileNameW 4.4.9 isavi_GetAVISize 4.4.10 isavi_GetnCompressedFrames 4.4.11 isavi_GetnLostFrames 4.4.12 isavi_InitAVI 4.4.13 isavi_InitEvent 4.4.14 isavi_OpenAVI 4.4.15 isavi_OpenAVIW 4.4.16 isavi_ResetFrameCounters 4.4.17 isavi_SetFrameRate 4.4.18 isavi_SetImageQuality 4.4.19 isavi_SetImageSize 4.4.20 isavi_StartAVI...
  • Page 9 4.5.20 is_ResetCaptureErrorInfo 4.5.21 is_SaveBadPixelCorrectionTable 4.5.22 is_SaveImage 4.5.23 is_SaveImageEx 4.5.24 is_SaveImageMem 4.5.25 is_SaveImageMemEx 4.5.26 is_SaveParameters 4.5.27 is_SetAOI 4.5.28 is_SetBadPixelCorrection 4.5.29 is_SetBadPixelCorrectionTable 4.5.30 is_SetBayerConversion 4.5.31 is_SetBlCompensation 4.5.32 is_SetConvertParam 4.5.33 is_SetDDUpdateTime 4.5.34 is_SetEdgeEnhancement 4.5.35 is_SetExposureTime 4.5.36 is_SetFlashDelay 4.5.37 is_SetFlashStrobe 4.5.38 is_SetHwnd 4.5.39 is_SetImageAOI 4.5.40 is_SetImagePos 4.5.41 is_SetImageSize 4.5.42 is_SetIO...
  • Page 10 Filter Types 5.4.7.2 Mounting the Filter 5.4.7.3 Cleaning the Filter Glasses 5.4.8 Ambient Conditions 5.5 Camera Interface 5.5.1 DCU223x, DCU224x, DCC1240x 5.5.1.1 I/O Connector - Pin Assignment 5.5.1.2 Digital Input (Trigger) Circuit 5.5.1.3 Digital Output (Flash) Circuit 5.5.2 DCC3240x 5.5.2.1 I/O Connector Pin Assignment 5.5.2.2...
  • Page 11 6.5 Definition of IP Protection Classes 6.6 History of uc480 Software Versions 6.7 History of uc480 API Functions 6.8 Thorlabs Worldwide Contacts 6.9 Certifications and Compliances 6.10 Thorlabs 'End of Life' Policy (WEEE) 6.11 Warranty 6.12 Exclusion of Liability and Copyright...

  • Page 12: Foreword

    Paragraphs preceeded by this symbol explain hazards that could damage the instrument and the connected equipment or may cause loss of data. Note This manual also contains "NOTES" and "HINTS" written in this form. Please read these advices carefully! © 2013 Thorlabs GmbH...

  • Page 13: General Information

    All modules must only be operated with proper shielded connection cables. Only with written consent from Thorlabs may changes to single components be carried out or components not supplied by Thorlabs be used.

  • Page 14: Ordering Codes And Accessories

    Trigger cable for DCU22xX and DCC1240X cameras (Trigger In only) CAB-DCU-T3 I/O cable for DC3240 CMOS USB 3.0 cameras Thorlabs C Mount Camera Lenses (objectives): See Thorlabs' website 1.3 Requirements For operating the DCx cameras, the following system requirements must be met:...
  • Page 15 The standard C library libc/glibc 2.0 or higher GNU Compiler Collection gcc 3.4 or higher POSIX Thread Library (POSIX Threads Enabled libc) bash or sh shell (for running the installation script) Qt (for compiling the demo program) © 2013 Thorlabs GmbH...

  • Page 16: Dcx Camera Family

    The LE models are designed for professional use in non-industrial applications. Through the use of the widespread USB 2.0 technology, the cameras can easily be interfaced with a vast variety of systems. These cameras are available with a plastic housing with CS-mount lens adapter. © 2013 Thorlabs GmbH...

  • Page 17: Contents

    Here you will find a list of accessories for DCx Cameras sorted by model. Appendix Information on Troubleshooting Status LEDs on USB DCx cameras Color and memory formats uc480 parameter file (ini file) Definition of IP protection classes © 2013 Thorlabs GmbH...

  • Page 18: What's New In This Version

    Please make sure to also read the file named WhatsNew.txt which you will find in the C:\Program Files \Thorlabs\DCx Cameras\Help directory when the installation is completed. This file contains late-breaking information on new functions and fixed issues.

  • Page 19: Camera Basics

    In freerun mode the flash function starts with the second image as the setting of the flash timing depends on the finish of the first image. If you change the flash timing during operation, the freerun mode will restart. Therefore the first image after the change is black. © 2013 Thorlabs GmbH...
  • Page 20 The next image exposed by the sensor will be transferred. In this mode, flash is not making sense (only manually). Freerun mode (snap mode) See also: Basics: Shutter methods Basics: Trigger mode Basics: Applying new parameters Programming: Capture modes © 2013 Thorlabs GmbH...

  • Page 21: Trigger Mode

    PC. Trigger events that occur during image exposure or data transfer are ignored. An internal counter records the number of ignored trigger events and can be read out from the PC. © 2013 Thorlabs GmbH...

  • Page 22: Standby

    Standby is the default state when the camera is not open in the software. When you open the camera or switch to a different mode (freerun or trigger mode), the camera wakes up from standby mode. Note In standby mode, you can continue to use the camera's digital inputs or outputs. © 2013 Thorlabs GmbH...

  • Page 23: Image Display Modes

    Direct3D OpenGL is not only available under Windows but also under Linux and Mac OS, if OpenGL is supported ® by the graphics hardware. There are several implementations of OpenGL, such as e.g. NVIDIA or AMD/ATI. The © 2013 Thorlabs GmbH...
  • Page 24 Access to image Direct access possible. Possible using Steal Mode. Direct access to graphics memory Image data already provided Single images can be copied card and image memory. in user memory. to the user memory. © 2013 Thorlabs GmbH...

  • Page 25: Sensor

    The size of each single sensor cell (pixel) depends on the size of the active sensor area and the resolution. In general, less pixels over the same sensor area (or a larger sensor area with the same resolution) will result in © 2013 Thorlabs GmbH...

  • Page 26: Micro Lenses

    90 % or more. Micro lenses collect the light that falls onto a photocell, thus increasing the useable sensor area. Using micro lenses to increase the effective fill factor CMOS pixel design with Bayer filter (red) and micro lens © 2013 Thorlabs GmbH...
  • Page 27 Using parallel light on sensors with CRA correction may cause slight color variations. These may occur, for example, if telecentric lenses are used. The following models are equipped with sensors with offset micro lenses: DCC1240x/DCC3240x DCC1645C © 2013 Thorlabs GmbH...

  • Page 28: Color Filter (Bayer Filter)

    Software conversion with high quality should only be used for sensors whose green pixels have the same sensitivity. This applies to the following sensors: DCU223C / DCU224C DCC1240C, DCC3240C For all other sensors, we recommend using the standard filter mask. © 2013 Thorlabs GmbH...
  • Page 29 2 Camera Basics Bayer conversion using the standard mask See also: Color conversion: is_SetColorConverter() uc480 Viewer: Format © 2013 Thorlabs GmbH...

  • Page 30: Hot Pixels

    A list of the coordinates of each hot pixel is stored in the camera EEPROM. The hotpixel correction is done in the uc480 driver. However, some sensors also provide an internal hotpixel correction. The maximum number of hot pixels stored in a DCx camera is: © 2013 Thorlabs GmbH...
  • Page 31 DCC1240x, DCC1545M, DCC1645C, DCC3240x (CMOS) DCU223x, DCU224x (CCD) How many hot pixels are on the camera's internal list depends above all on the defined threshold values. It is not an indication of the quality of the sensors used.

  • Page 32: Shutter Methods

    Sensors that use the global shutter system are more complex in design than rolling shutter sensors. All CCD sensors as well as some CMOS sensors use the global shutter method. Global shutter sensor in live mode © 2013 Thorlabs GmbH...
  • Page 33 Some CMOS senors with global shutter can be operated also with rolling shutter. The operation in the rolling shutter mode is used to reduce the image noise. This function is only supported from the camera models DCC1240x/DCC3240x Rolling shutter sensor in live mode © 2013 Thorlabs GmbH...
  • Page 34 Rolling shutter sensor in trigger mode with global start function * Optional flash function. The start time and duration are defined by the flash delay and duration parameters (see also Camera settings: I/O © 2013 Thorlabs GmbH...

  • Page 35: Line Scan Mode

    The line scan mode is currently only supported by the monochrome DCC1240M and DCC3240M,N models in form of the fast line scan mode. The triggered line scan mode is not supported by any camera model yet. See also: uc480 Viewer: Properties > Shutter Programming: Function: is_DeviceFeature() © 2013 Thorlabs GmbH...

  • Page 36: Reading Out Partial Images

    Camera and sensor data and click a camera model. Please note that, after defining an AOI, the resulting image may be darker if the camera cannot maintain the originally set exposure time due to the increased frame rate. © 2013 Thorlabs GmbH...
  • Page 37 Only DCC1240x models support this feature. In the Multi AOI mode you can define two or four AOIs in one image and transfer them simultaneously. The AOIs are positioned side by side or one below the other, and share the same X or Y axis. uc480 Demo - Multi AOI on the DCC1240C © 2013 Thorlabs GmbH...
  • Page 38 AOIs, which need to have the same size but may differ in position, exposure time or gain settings. uc480 Viewer - sequence AOI mode See also: uc480 Viewer: Size uc480 Viewer: Multi AOI uc480 Viewer: Sequence AOI Programming: is_AOI() © 2013 Thorlabs GmbH...

  • Page 39: Subsampling

    Depending on the model, DCx Cameras support different subsampling factors. Subsampling of horizontal and vertical pixels can be enabled independently. Camera and sensor datas chapter lists the subsampling methods and factors supported by each camera model. Subsampling on monochrome sensors Subsampling on color sensors © 2013 Thorlabs GmbH...

  • Page 40: Binning

    Depending on the model, DCx Cameras support different binning factors. Binning of horizontal and vertical pixels can be enabled independently. Camera and sensor data chapter lists the binning methods and factors the individual camera models support. Binning on monochrome sensors Binning on color sensors © 2013 Thorlabs GmbH...

  • Page 41: Digitizing Images

    Imaging with gamma characteristic Such a gamma characteristic brightens dark areas of an image, which corresponds more to the perception of the human eye. In light areas of an image, the differences in brightness are condensed for this. © 2013 Thorlabs GmbH...
  • Page 42 8 bit image, for example, this LUT would replace all pixels with gray values 0...127 with value 0 and all pixels with gray values 128...255 with value 255. Using LUTs has the advantage that calculations can be done very fast. Typical applications of LUTs are enhancing image contrast, or gamma characteristics. LUT characteristic for binarizing an image © 2013 Thorlabs GmbH...
  • Page 43 0 and the highest value (255 in 8-bit images). If an image has low contrast, the histogram only includes a small number of the values; the image appears dull: © 2013 Thorlabs GmbH...
  • Page 44 The second example shows the same output image with a 10 bit bit depth right at the time of capture. This image also has low contrast, as it features only average brightness values. The greater bit depth allows the brightness © 2013 Thorlabs GmbH...
  • Page 45 This type of contrast adjustment can already be done in the camera when an image is digitized in 10 bits and transferred in 8 bit. In this case, optimum utilization of the 8 bit data is also important for image processing. © 2013 Thorlabs GmbH...

  • Page 46: Camera Parameters

    Note Using Sensor Gain: A signal gain will also result in a noise gain. High gain settings are therefore not recommended. We suggest the following gain settings: 1. Enable the Gain boost function (is_SetGainBoost() © 2013 Thorlabs GmbH...

  • Page 47: Automatic Image Control

    You can disable the control functionality automatically once the target value has been reached (approximately) and after 3 regulations no improvement has been reached (API parameters IS_SET_AUTO_WB_ONCE and IS_SET_AUTO_BRIGHTNESS_ONCE). An event/a message notifies the system of this (see also is_InitEvent() © 2013 Thorlabs GmbH...

  • Page 48: Applying New Parameters

    This is normal standard behavior of the operating system. The USB DCx Cameras firmware is part of the driver. The automatic upload always loads the firmware that matches the driver installed in the camera. © 2013 Thorlabs GmbH...

  • Page 49: Digital Inputs / Outputs

    The disadvantage is that the flash signal is active slightly longer than the exposure time. The flash duration with automatic flash is longer for rolling shutter sensors than for global shutter sensors. © 2013 Thorlabs GmbH...
  • Page 50 (global flash function). Using , you can query the appropriate values. is_IO() Note The flash output is reset with the start of the next image capture. This also applies if you have set a longer flash duration. © 2013 Thorlabs GmbH...

  • Page 51: Flash Timing (Freerun Mode)

    It is recommended to synchronize the flash manually in freerun mode. This applies to both rolling and global shutter sensors. In freerun mode, the manual flash synchronization works in the same way as in trigger mode. © 2013 Thorlabs GmbH...

  • Page 52: Serial Interface Rs-232 (Dc3240X Only)

    COM port. To set up and use the serial interface, the "Additional functions" dialog box is provided in the uc480 Camera Manager. For the serial interface specifications, please refer to the DC3240x Serial Interface Wiring (RS-232) chapters. © 2013 Thorlabs GmbH...

  • Page 53: Usb Interface

    Therefore, the maximum possible frame rate will be reduced if image data from multiple USB cameras is transferred simultaneously. The available bandwidth might also be decreased when you use hubs or repeaters. You can reduce the bandwidth © 2013 Thorlabs GmbH...

  • Page 54: Usb 2.0 Cabling And Connectors

    Basic design of a USB 3.0 cable Connector types On the PC side, USB 3.0 cables are equipped with a standard A type plug (8 pins) and on the device side either with a standard B plug or a micro-B plug. © 2013 Thorlabs GmbH...

  • Page 55: Data Transmission And Bandwidth

    USB bus than completely black images. USB 3.0 Compared to USB 2.0, USB 3.0 offers a tenfold increased bandwidth of 5 Gbit/s, i.e. images can be transmitted with a bandwidth of 400 Mbytes/s. © 2013 Thorlabs GmbH...

  • Page 56: Operation

    On the "Image" tab, you find various sensor gain controllers. Use the "Master gain" controller to increase image brightness if no longer exposure time setting is possible. Switch to the "AES/AGC" tab to enable the Auto Exposure Shutter (AES) and Auto Gain Control (AGC) features. © 2013 Thorlabs GmbH...
  • Page 57 (parameter set 1/2). To load the saved settings, select the "Load parameters" option. See also: uc480 Viewer: Record dialog uc480 Player © 2013 Thorlabs GmbH...

  • Page 58: Installation And Connection

    On the "Display" page of the diagnostic tool, click the button for testing the Direct3D functions. OpenGL graphics functions For OpenGL version 1.4 or higher must be installed. The OpenGL graphics functions do not work with QT under Linux. Software Requirements under Linux © 2013 Thorlabs GmbH...
  • Page 59 The standard C library libc/glibc 2.0 or higher GNU Compiler Collection gcc 3.4 or higher POSIX Thread Library (POSIX Threads Enabled libc) bash or sh shell (for running the installation script) Qt (for compiling the demo program) © 2013 Thorlabs GmbH...

  • Page 60: Dcx Driver Compatibility

    The software for DCx Cameras is delivered on a CD. Alternatively, or if the CD is lost, the software can be downloaded from Thorlabs' website. Please insert the delivered with the DCx Cameras CD to the drive of your PC and start the software installation: © 2013 Thorlabs GmbH...
  • Page 61 3 Operation Click 'Next >' to continue. Click 'I accept...' if you do so, then 'Next >' to continue. Click 'Next >' to continue. © 2013 Thorlabs GmbH...
  • Page 62 Click 'Install' to allow the installation of the USB driver software. The following window appears: This is a normal of the DirectShow driver, included in the installation package, because no camera is connected yet. Please click OK or Cancel to resume software installation. © 2013 Thorlabs GmbH...

  • Page 63: Installing The Uc480 Software Under Linux

    The model will be immediately recognized whenever you connect the camera to this port again. If you use a different port, the registration will be repeated. Under Windows the camera will show up in the uc480 Camera Manager's camera list. © 2013 Thorlabs GmbH...
  • Page 64 Many USB ports on PCI/PCIe cards and the USB ports on the front of the PC often supply lower bandwidth. Attention USB cables with non-standard connectors must be connected to the camera first and then to the PC. Otherwise the camera might not be recognized correctly. © 2013 Thorlabs GmbH...

  • Page 65: Application Notes By Camera Model

    The factory setting of the offset control are so selected that the black level is always slightly increased to avoid losing image information by cutting underneath the origin. For linearity measurements the black level must be © 2013 Thorlabs GmbH...
  • Page 66 When using binning the frame is slightly shifted horizontally. Binning can only be enabled for both horizontal and vertical pixels. For this reason, the parameters of the function have passed together (IS_BINNING_2X_VERTICAL is_SetBinning() IS_BINNING_2X_HORIZONTAL) to enable binning. Scaling, AOI © 2013 Thorlabs GmbH...
  • Page 67 C mount lenses is compensated. The shift is constant from the center to the corner and has a maximum of 12 degrees. When using a telecentric lens or parallel light incidence the shift must be considered as little shading effects may occur. © 2013 Thorlabs GmbH...

  • Page 68: Dcc1545M Application Notes

    At very long exposure times and minimum gain, the white level may not be reached. The gain should be increased by one step in this case. The RGB gain controls have no effect for values >90. 3.3.4 DCU223x Application Notes For the technical specifications of this model go to: Camera and sensor data > DCU223x Sensor Long exposure times will increase the number of hotpixels.

  • Page 69: Installed Uc480 Programs

    Windows 7 and Windows XP (32 bit) only Control center In the control center , you can access the configuration and display detailed information on the connected DCx Cameras. © 2013 Thorlabs GmbH...

  • Page 70: Camera List

    Camera Manager additionally displays the Parameters box on the right. There you will find detailed information on the DCx camera selected in the camera list Click in the figure to get help on the functions. © 2013 Thorlabs GmbH...
  • Page 71 If the option is disabled, the data in the tree structure is only updated when a different camera is selected. All other "Control Center" buttons are described in detail in the following sections: General information Camera information Creating a support file Additional functions (COM port) © 2013 Thorlabs GmbH...

  • Page 72: General Information

    This list shows the location and version of the uc480 interface files that have been installed on your system for third-party software. USB controller and network adapters All USB controllers and network adapters that are available in your system are shown in a tree structure. © 2013 Thorlabs GmbH...

  • Page 73: Camera Information

    Here, you can set whether to apply the parameters stored on the camera automatically when opening the camera. You must first store the camera parameters on the camera using the function or via the is_ParameterSet() corresponding function in the uc480 Viewer. © 2013 Thorlabs GmbH...
  • Page 74 During the first installation of a virtual COM port, an additional broadcast port with number 255 is installed. Data sent to this port will be forwarded to all paired cameras. You can install any number of virtual COM ports on a single system. © 2013 Thorlabs GmbH...
  • Page 75 This drop down box allows appending the special characters "CR" (Carriage Return) and "LF" (Line Feed) to the ASCII text you want to transmit. Some devices with serial interface require ASCII strings to be terminated with CR/LF. Send file © 2013 Thorlabs GmbH...

  • Page 76: Parameters

    Indicates which hub and port a USB camera is connected to. In addition, the full path through all hubs to the USB controller on the computer is displayed. o Controller Indicates the USB controller to which the camera is connected. Local driver o Indicates the USB version of the camera driver © 2013 Thorlabs GmbH...

  • Page 77: Uc480 Viewer

    Viewer is available named uc480 Demo. Please note that uc480 Viewer does not guarantee completeness and operational reliability in all modes and all computing environments. uc480 Viewer is intended solely for demonstrating the uc480 software library and camera functionality. © 2013 Thorlabs GmbH...

  • Page 78: Start Dialog

    Viewer by default provides the basic icons and menus for operating the camera. If you select the "Start uc480 Viewer in expert mode" check box, additional functions, toolbars and menus are available in uc480 Viewer. This setting is recommended for advanced users. See also: Creating profiles "Profiles" menu Customizing uc480 Viewer © 2013 Thorlabs GmbH...

  • Page 79: Toolbars

    Delete reference area for auto white balance Measure sharpness in a defined AOI Save image as bitmap Open the dialog box for AVI recording Open/close Histogram window Open/close Horizontal Line View window Open/close Vertical Line View window Open/close Zoom window © 2013 Thorlabs GmbH...
  • Page 80 Deactivate display Draw freehand in image Draw line in image Measure distance in image Draw rectangle in image Draw circle in image Add text to image Choose colors for drawing functions Clear all drawn elements Show/hide time © 2013 Thorlabs GmbH...

  • Page 81: Status Bar

    "Select Camera" dialog box is displayed. You can use multiple cameras simultaneously by opening multiple instances of uc480 Viewer. DCx cameras that have already been opened or that have not been correctly configured are marked "No" in the "Available" column. © 2013 Thorlabs GmbH...

  • Page 82: Menus

    Scale display down to quarter size Half size Scale display down to half size Double size Scale display up to double size Mirror up/down Mirror display on horizontal axis Show only AOI AOI is displayed without black border © 2013 Thorlabs GmbH...
  • Page 83 , but by the application is_SetAllocatedImageMem() Sound on transfer failed Output an acoustic signal if a transmission error occurs Error report Errors are displayed in a dialog box Clear counters Reset the counters (see uc480 Viewer status bar) © 2013 Thorlabs GmbH...
  • Page 84 Show texts Show/hide texts New text Write new text Delete text Delete text Time stamp Set time stamp position Time stamp position (top left, top right, bottom left, bottom right) Show time stamp Show/hide time stamp © 2013 Thorlabs GmbH...
  • Page 85 List of profiles available in the program directory Attention Do not remove or rename the profile files created in the C:\Program Files\Thorlabs\DCx Cameras \Profile\ folder when you install the application. Otherwise program functions in uc480 Viewer may not work correctly.

  • Page 86: Dialog Boxes

    Once the AVI file has been created, the following parameters of the input image can no longer be changed: Color format AOI, binning and subsampling Show only AOI Note AVI recording is only possible in the "Device Independent Bitmap (DIB)" display mode © 2013 Thorlabs GmbH...
  • Page 87 Viewer at program start. The following options are available: Restore uc480 Viewer parameters when camera is opened If you select this check box, the currently set camera parameters will be restored when the same DCxCamera © 2013 Thorlabs GmbH...
  • Page 88 This function is only available when a color camera is running in "Direct raw Bayer" mode. If you select this check box, the histogram represents the individual Bayer color components as red, green and blue channels. © 2013 Thorlabs GmbH...
  • Page 89 To set the cursor position you want to display in the window, place the cursor at that position in the image, hold the CTRL key and right-click. Alternatively, you can set the image position using the context menu. © 2013 Thorlabs GmbH...
  • Page 90 To set the cursor position you want to monitor in the Waterfall window, place the cursor at that position in the image, hold the Ctrl key and right-click. Alternatively, you can set the image position using the context menu. © 2013 Thorlabs GmbH...
  • Page 91 Clear Window The Clear Window button deletes the current messages. Save The "Save" button opens the Windows "Save as" dialog box, allowing you to save the messages displayed in the log window in ASCII format (.txt file). © 2013 Thorlabs GmbH...
  • Page 92 USB transfer failed The image was not transferred over the USB bus. DEV timeout The maximum allowable time for image capturing in the camera was exceeded. ETH buffer overrun Not applicable to DCx Cameras ETH missed images © 2013 Thorlabs GmbH...
  • Page 93 Check the quality of the USB cabling and components The selected timeout value is too low for image Reduce the exposure time capture Increase the timeout Camera image buffers, Resent packets Not applicable to DCx Cameras. See also: Troubleshooting Programming: is_GetImageInfo() © 2013 Thorlabs GmbH...

  • Page 94: Properties

    Depending on the camera model opened and the user mode set not all of the property pages might be available. Camera Image Size Format Color Trigger Input/output AES/AGC (automatic brightness control) AWB (auto white balance) Miscellaneous Multi AOI Sequence AOI Shutter © 2013 Thorlabs GmbH...
  • Page 95 If the "Exposure (AES)" (automatic exposure) option is enabled in the AES/AGC tab the pixel clock cannot be set manually. Frame rate (Freerun) Sets the frame rate in freerun mode. The available frame rate range depends on the pixel clock setting. © 2013 Thorlabs GmbH...
  • Page 96 Fine increment Select this check box to set the exposure time in fine increments. This option is not supported by all camera models. Default Click this button to reset all parameters to the model-specific defaults. © 2013 Thorlabs GmbH...
  • Page 97 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 © 2013 Thorlabs GmbH...
  • Page 98 Hardware sensor gamma This option enables gamma correction by the hardware, using a fixed factor. Default Click this button to reset all parameters to the model-specific defaults. See also: Characteristics and LUT: Gamma Programming: Color Temperature: is_ColorTemperature() © 2013 Thorlabs GmbH...
  • Page 99 With these options, you can select the binning subsampling settings for the image. Binning Horizontal/Vertical These radio buttons allow setting the binning factor. The image resolution is then reduced by the selected factor. You can use binning to increase the frame rate. © 2013 Thorlabs GmbH...
  • Page 100 Default Click this button to reset all parameters to the model-specific defaults. See also: Basics: Reading out partial images Programming: Area of interest: is_AOI() Binning: is_SetBinning() Subsampling: is_SetSubSampling() Profiles/image formats: is_ImageFormat() © 2013 Thorlabs GmbH...
  • Page 101 The conversion is performed in the camera. The standard filter mask is used for the conversion. This radio button is not available for DCx cameras. Note Color conversion with Open CL is not supported by all graphic cards. Open CL is not supported by mono cameras. © 2013 Thorlabs GmbH...
  • Page 102 We recommend 32 bit RGB mode for TrueColor applications. Y8 mode is usually used for monochrome applications. Note Images with a bit depths of more than 8 bits can be saved in the PNG format. 12 bit formats are converted in 16 bits. © 2013 Thorlabs GmbH...
  • Page 103 Basics: Color filter (Bayer filter) Basics: Display modes Basics: Bit depth and digital contrast adjustment Basics: Characteristics and LUT Programming: is_SetColorMode() Programming (Open MP): is_Configuration() Color formats in memory: Appendix: Color formats Graphics card: System requirements © 2013 Thorlabs GmbH...
  • Page 104 The color correction factor is stepless adjustable between 0 (no correction) and 1 (full correction). Activating the sensor color correction may increase CPU load. Default Click this button to reset all parameters to the model-specific defaults. © 2013 Thorlabs GmbH...
  • Page 105 Global start (trigger mode) If you select this check box, all rows of a rolling shutter sensor are exposed simultaneously. Activating Global start only makes sense when using a flash. This function is not supported by all models. © 2013 Thorlabs GmbH...
  • Page 106 Flash output With these radio buttons, you choose which digital output function you want to activate on the camera: The digital output is disabled. Constant high © 2013 Thorlabs GmbH...
  • Page 107 Sets the GPIO as flash output. The settings you made in the "Flash output" box are used. Note Detailed information on wiring the DCxCamera inputs and outputs is provided in the "Electrical Specifications" section of the Specifications chapter. Default Click this button to reset all parameters to the model-specific defaults. © 2013 Thorlabs GmbH...
  • Page 108 If the maximum exposure time is not sufficient for a brighter image, you can use AFR to reduce the frame rate and so extend the exposure time. Gain (AGC) Enables the automatic gain, i.e. the control automatically adjusts the gain to achieve the set brightness reference value. © 2013 Thorlabs GmbH...
  • Page 109 The histogram area specifies which area of the image will be used for calculating the average grayscale value of the image. You can set the size of the histogram area by using the tools on the toolbar. Default Click this button to reset all parameters to the model-specific defaults. © 2013 Thorlabs GmbH...
  • Page 110 Shifts the respective color intensity relative to green Example: If the Gray World algorithm controls to an average value of 65 and a blue offset is set of -40, the blue gain so is adjusted that blue has an average value of 25. © 2013 Thorlabs GmbH...
  • Page 111 The histogram area specifies which area of the image will be used for calculating the average value of the image. You can set the size of the histogram area by using the tools on the toolbar. Default Click this button to reset all parameters to the model-specific defaults. © 2013 Thorlabs GmbH...
  • Page 112 The camera transmits a selectable test image that you can use for testing the data transmission. You can choose from different types of test images, depending on the camera type. Selection Parameter value You can adjust the appearance of some of the test images with the "Parameter value" slider. © 2013 Thorlabs GmbH...
  • Page 113 Enabling the edge enhancement function increases the CPU load during image capture. This function is not relevant for DCx Cameras. Default Click this button to reset all parameters to the model-specific defaults. See also: Basics: Hot pixels Programming: Hotpixel: is_HotPixel() Edge enhancement: is_EdgeEnhancement() Test image: is_SetSensorTestImage() © 2013 Thorlabs GmbH...
  • Page 114 Displays a preview image and allows graphically setting the individual AOIs by moving the colored boxes that are displayed at the end of each axis. Default Click this button to reset all parameters to the model-specific defaults. © 2013 Thorlabs GmbH...
  • Page 115 AOI 1. In the area below you define the further AOIs. Number of used AOIs Here, you define the numbers of additional AOI. If you select further AOIs, the parameters of AOI 1 are copied for © 2013 Thorlabs GmbH...
  • Page 116 Here, you can define for AOI 2-4 how often they are readout and the images are transferred. AOI 1 is always readout once. Hint If capturing the same AOI with different exposure times, you can create via software a HDR image from the single images. © 2013 Thorlabs GmbH...
  • Page 117 For further information see "Basics": Shutter methods Line Note Currently, only the monochrome DCC1240M and DCC3240M/N camera models support the "fast line scan" mode. Fast linescan Enables the sensor's fast line scan mode. © 2013 Thorlabs GmbH...
  • Page 118 Example: A low level results in a low gain and may display more details in the overexposed image areas. A higher level gives a higher gain, thereby a darker image can be brightened (see also DCC1240x / DCC3240x Application Notes Default Click this button to reset all parameters to the model-specific defaults. © 2013 Thorlabs GmbH...

  • Page 119: Creating Profiles

    . The profile names shown in the menu are named after the files. Attention Do not remove or rename the profile files created in the C:\Program Files\Thorlabs\DCx Cameras \Profile\ folder when you install the application. Otherwise program functions in uc480 Viewer may not work correctly.

  • Page 120: Auto White Balance

    // 0 = min, 100 = max [AWB] WHITEBALANCE // 1 = on, 0 = off SPEED // 0 = min, 100 = max SKIPFRAMES // 0 = min, 100 = max See also: "Choose mode" start dialog "Profiles" menu © 2013 Thorlabs GmbH...

  • Page 121: Uc480 Player

    Player is enabled. Using the left mouse button, you can now select an area within the video image that will be resized to fill the window (Zoom In), even during playback. Double-clicking the left mouse button inside the window will revert the display to its original size (Zoom Out). © 2013 Thorlabs GmbH...

  • Page 122: Overview Of The Operation Controls

    One frame forward Fast forward Jump to end of video Go to specific frame. When you click this button, a small dialog box will open where you can enter the frame number. Start Loop mode (blue text) © 2013 Thorlabs GmbH...
  • Page 123 Playback speed in relation to the recording speed from 0.1 to 200 fps. The values are set in increments. Using the button, you can jump directly to a specific frame. To do so, enter a numerical value between 1 and the total number of frames in the video sequence. © 2013 Thorlabs GmbH...

  • Page 124: Loop Mode

    Key combinations in full screen mode CTRL + F Start/stop full screen mode Quit full screen mode CTRL + O Open video file <- (Arrow key left) One frame back -> (Arrow key right) One frame forward Space Start/stop video playback © 2013 Thorlabs GmbH...

  • Page 125: Uc480 Hotpixel Editor

    Writes the list of the hot pixel to the EEPROM. Add Badpixel Writes the marked hot pixel in the hot pixel list of the program. Delete Badpixel Deletes a hot pixel from the hot pixel list of the program. © 2013 Thorlabs GmbH...
  • Page 126 Here, the camera settings can be changed for a better hot pixels visualization. By default, exposure time is set to max. and master gain to 50. Note that the frame rate is limited to lower values. © 2013 Thorlabs GmbH...
  • Page 127 The "Clear old badpixel list" option removes the old user list before the search. Note The number of bad pixels, stored to the EEPROM, is limited. If the number of detected bad pixels exceeds the memory capacity, please increase the bad pixel detection threshold and repeat the detection procedure. © 2013 Thorlabs GmbH...

  • Page 128: Programming (Sdk)

    See also: First steps to uc480 programming How to proceed Function descriptions AVI function descriptions Obsolete functions Programming notes Lists © 2013 Thorlabs GmbH...

  • Page 129: First Steps To Uc480 Programming

    Saving images and videos Close the camera When you want to exit your application, close the camera with . The camera is_ExitCamera() and the allocated memory are automatically released. All previously set camera parameters will be lost, © 2013 Thorlabs GmbH...
  • Page 130 So, if you want to save specific settings, use the function before is_ParameterSet() closing the camera. The next time you start the application, you can simply load the settings again by using the same function. © 2013 Thorlabs GmbH...

  • Page 131: How To Proceed

    With the following functions, you can read out additional information on cameras and software. Returns the event counters and other information. is_CameraStatus() Enables standby mode. Returns the camera information of an opened camera. is_GetCameraInfo() Returns the version of the is_GetDLLVersion() uc480_api.dll. Returns the operating system version. is_GetOsVersion() © 2013 Thorlabs GmbH...

  • Page 132: Opening And Closing The Camera

    Returns the pointer to the starting address of the image memory. is_GetImageMem() Returns the line offset used in the image memory. is_GetImageMemPitch() Returns the properties of an image memory. is_InquireImageMem() Note Image memory sequences should be used for frame sequence capture. © 2013 Thorlabs GmbH...
  • Page 133 4 Programming (SDK) Flowchart: Allocating memory Click in the figure to get help on the functions. © 2013 Thorlabs GmbH...

  • Page 134: Image Memory Sequences

    Determines the image memory currently used for the sequence. is_SetImageMem() Makes the indicated image memory the active memory. is_LockSeqBuf() Protects the sequence image memory from being overwritten. is_UnlockSeqBuf() Releases the sequence image memory for overwriting. © 2013 Thorlabs GmbH...

  • Page 135: Selecting The Display Mode

    Outputs the contents of the active image memory to a window. is_RenderBitmap() Enables offsetting the image output inside the window. is_SetDisplayPos() Flowchart: Image display in DIB mode Click in the figure to get help on the functions. © 2013 Thorlabs GmbH...

  • Page 136: Capturing Images

    The possible frame rate in trigger mode depends on the exposure time. Example: At the maximum exposure time, the frame rate is about half as high as in freerun mode; at the minimum exposure time, the frame rate is about the same. © 2013 Thorlabs GmbH...
  • Page 137 Wait parameter. If no image arrives within this timeout period, a timeout error message is issued. Under Windows, a dialog box is displayed if you have enabled error reports (see is_SetErrorReport() ). Information on the error cause can be queried using is_CaptureStatus() © 2013 Thorlabs GmbH...
  • Page 138 Returns whether the capture process has been started or not. is_HasVideoStarted() Returns whether the capture process has been terminated or not. is_IsVideoFinish() is_SetSensorTestImage() Enables test image output from sensor (all cameras). Terminates the capturing process (live video or single frame). is_StopLiveVideo() © 2013 Thorlabs GmbH...
  • Page 139 4 Programming (SDK) Flowchart: Single Capture Click in the figure to get help on the functions. Flowchart - Single Capture (1 of 2) © 2013 Thorlabs GmbH...
  • Page 140 DCx Cameras Flowchart - Single Capture (2 of 2) © 2013 Thorlabs GmbH...
  • Page 141 4 Programming (SDK) Flowchart: Sequence Capture Flowchart - Capturing a frame sequence (1 of 2) © 2013 Thorlabs GmbH...
  • Page 142 DCx Cameras Flowchart - Capturing a frame sequence (2 of 2) © 2013 Thorlabs GmbH...

  • Page 143: Event / Message Handling

    IS_SET_EVENT_SEQ completed (see also is_AddToSequence() * Optional function. The start time and duration of the flash signal are defined by the "Flash delay" and "Duration" parameters (see is_IO() © 2013 Thorlabs GmbH...
  • Page 144 Initializes the event handler (Windows only) is_InitEvent() Automatically releases the camera resources when the camera is disconnected is_EnableAutoExit() from the PC. Waits for DCxCamera events (Linux only) is_WaitEvent() Flowchart: Enable events Click in the figure to get help on the functions. © 2013 Thorlabs GmbH...
  • Page 145 4 Programming (SDK) Flowchart: Enabling Messages © 2013 Thorlabs GmbH...

  • Page 146: Setting Camera Parameters

    Processing image data The following set of functions refers to the further processing of image data in the PC: Determines the desktop color mode set in the graphics is_GetColorDepth() card. Returns the user-defined timeout values. is_GetTimeout() © 2013 Thorlabs GmbH...
  • Page 147 Selects a color mode. is_SetColorMode() Conversion parameters for raw Bayer conversion. is_Convert() Sets edge enhancement. is_EdgeEnhancement() Sets the image saturation (digital post-processing). is_SetSaturation() Enables test image output from sensor. is_SetSensorTestImage() Sets user-defined timeout values. is_SetTimeout() © 2013 Thorlabs GmbH...
  • Page 148 DCx Cameras Flowchart: Changing camera timing Click in the figure to get help on the functions. © 2013 Thorlabs GmbH...

  • Page 149: Automatic Image Control

    All controls are configured using the SDK function. is_SetAutoParameter() For more information on the automatic image control see Camera basics: Automatic image control Flowchart: Enable Auto Brightness Click in the figure to get help on the functions. © 2013 Thorlabs GmbH...

  • Page 150: Image Pre-Processing

    The non-volatile EEPROM of every DCx camera can hold user data or camera settings. Returns the factory-set information (e.g. revision information for the is_GetCameraInfo() individual DCxCamera components). Returns the sensor information. is_GetSensorInfo() Reads out the writable data area of the EEPROM. is_ReadEEPROM() Writes user data to the EEPROM. is_WriteEEPROM() © 2013 Thorlabs GmbH...

  • Page 151: Saving Images And Videos

    The supported input color formats are RGB32, RGB24, Y8 and raw Bayer. The output file will always be in RGB24 format, regardless of the input data format. You can adjust the size of the images to be stored by defining a freely selectable area of interest (AOI). © 2013 Thorlabs GmbH...
  • Page 152 AVI files you have captured using the uc480_tools.dll can also be played back in external applications, such as Windows Media Player. To do this, you need to install the uc480 MJPEG codec on your system: Open the uc480 installation directory (default: C:\Program Files\Thorlabs\DCx Cameras\Tools32 or C:\Program Files\Thorlabs\DCx Cameras\Tools64 ).
  • Page 153 4 Programming (SDK) Flowchart: AVI capture Click in the figure to get help on the functions. © 2013 Thorlabs GmbH...

  • Page 154: Using Inputs And Outputs

    With these commands you can activate additional functions or use GPIOs on some DCx Cameras. Sets the additional digital outputs (GPIO). is_IO() Defines each port as a digital input or output (GPIO). is_IO() Toggles the color of the status LED for DCU22x and DCC1240x is_IO() cameras. © 2013 Thorlabs GmbH...
  • Page 155 4 Programming (SDK) Flowchart: Digital input Click in the figure to get help on the functions. © 2013 Thorlabs GmbH...
  • Page 156 DCx Cameras Flowchart: Digital output © 2013 Thorlabs GmbH...

  • Page 157: Function Descriptions

    For some functions, C++ programming samples are have been added. Sample programs Some descriptions include references to uc480 SDK sample programs. When you install the uc480 software, the demo applications are copied to the C:\Program Files\Thorlabs\DCx Cameras\Samples directory. The associated source code can be found under C:\Program Files\Thorlabs\DCx Cameras\Develop \Source.

  • Page 158: Is_Addtosequence

    Input parameters hCam Camera handle pcMem Pointer to image memory Image memory ID Return values IS_INVALID_CAMERA_HANDLE Invalid camera handle IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_AllocImageMem() is_InitImageQueue() is_SetImageMem() is_SetAllocatedImageMem() Sample programs uc480Sequence (C++) © 2013 Thorlabs GmbH...

  • Page 159: Is_Allocimagemem

    RAM at a time. Input parameters hCam Camera handle width Image width height Image height bitspixel Image bit depth (bits per pixel). ppcImgMem Returns the pointer to the memory starting address Returns the ID of this memory © 2013 Thorlabs GmbH...
  • Page 160 General error message IS_OUT_OF_MEMORY No memory could be allocated. IS_SEQUENCE_BUF_ALREADY_ The memory could not be locked. The pointer to the buffer is invalid. LOCKED IS_SUCCESS Function executed successfully Related functions is_FreeImageMem() is_AddToSequence() is_SetImageMem() is_SetAllocatedImageMem() is_GetColorDepth() is_GetImgMemPitch() © 2013 Thorlabs GmbH...

  • Page 161: Is_Aoi

    (see is_AllocImageMem() Changes to the image size affect the value ranges of the frame rate and exposure time. After executing is_AOI(), calling the following functions is recommended in order to keep the defined camera settings: © 2013 Thorlabs GmbH...
  • Page 162 Returns the largest possible size in an object. IS_SIZE_2D IS_AOI_IMAGE_GET_POS_INC Returns the increment for the position in an object. IS_POINT_2D IS_AOI_IMAGE_GET_SIZE_INC Returns the increment for the size in an object. IS_SIZE_2D IS_AOI_IMAGE_GET_POS_X_ABS Returns an object indicating whether UINT IS_AOI_IMAGE_POS_ABSOLUTE © 2013 Thorlabs GmbH...
  • Page 163 DCC3240x camera models). Note: IS_AOI_SEQUENCE_SET_PARAMS must be called after IS_AOI_SEQUENCE_SET_ENABLE, with enabling the sequence AOI mode all AOIs are set to the same value and therefore the parameters are lost. Sample 3 for sequence AOI mode © 2013 Thorlabs GmbH...
  • Page 164 1 = a change of exposure time, gain or position of AOI 1 does not affect the parameters of AOI 2, 3 and 4. Double dblScalerFactor Scaling factor (not supported in version 4.20) BYTE byReserved[64] Reserved © 2013 Thorlabs GmbH...
  • Page 165 IS_TIMED_OUT A timeout occurred. An image capturing process could not be terminated within the allowable period. IS_TRIGGER_ACTIVATED The function cannot be used because the camera is waiting for a trigger signal. Related functions is_ImageFormat() is_SetBinning() is_SetSubSampling() © 2013 Thorlabs GmbH...
  • Page 166 // set else if (nAbsPos == 0) // not set Examples for setting absolute AOI positions in memory x = 100 y = 100 AOI without absolute memory positioning x = 100 | IS_AOI_IMAGE_POS_ABSOLUTE y = 100 © 2013 Thorlabs GmbH...
  • Page 167 INT nRet = is_AOI(hCam, IS_AOI_MULTI_DISABLE_AOI | IS_AOI_MULTI_MODE_X_Y_AXES, NULL, NULL); Sample 1 for sequence AOI mode INT nSequenceAOI = 0; (is_AOI(m_hCam, IS_AOI_SEQUENCE_GET_SUPPORTED, (void*)&nSequenceAOI, sizeof(nSequenceAOI)) == IS_SUCCESS) // Sequence AOI 2 is supported ((nSequenceAOI & IS_AOI_SEQUENCE_INDEX_AOI_2) != 0); © 2013 Thorlabs GmbH...
  • Page 168 = is_AOI(m_hCam, IS_AOI_SEQUENCE_SET_ENABLE, (void*)&nMask, sizeof(nMask)); // Enable AOI 1, 2, 3 and 4 nMask = IS_AOI_SEQUENCE_INDEX_AOI_1 | IS_AOI_SEQUENCE_INDEX_AOI_2 | IS_AOI_SEQUENCE_INDEX_AOI_3 | IS_AOI_SEQUENCE_INDEX_AOI_4; nRet = is_AOI(m_hCam, IS_AOI_SEQUENCE_SET_ENABLE, (void*)&nMask, sizeof(nMask)); // Get current AOI mask INT nRet = is_AOI(m_hCam, IS_AOI_SEQUENCE_GET_ENABLE, (void*)&nMask, sizeof(nMask)); © 2013 Thorlabs GmbH...

  • Page 169: Is_Autoparameter

    Returns the supported color spaces for the auto white balance (Example 4 MODELS 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 © 2013 Thorlabs GmbH...
  • Page 170 = IS_AWB_GREYWORLD; nRet = is_AutoParameter(m_hCam, IS_AWB_CMD_SET_TYPE, (void*)&nType, sizeof(nType)); Example 3 // Is AWB enabled? UINT nEnable; INT nRet = is_AutoParameter(m_hCam, IS_AWB_CMD_GET_ENABLE, (void*)&nEnable, sizeof(nEnable)); // Enable AWB (once) nEnable = IS_AUTOPARAMETER_ENABLE_RUNONCE; nRet = is_AutoParameter(m_hCam, IS_AWB_CMD_SET_ENABLE, (void*)&nEnable, sizeof(nEnable)); © 2013 Thorlabs GmbH...
  • Page 171 ((nSupportedRGBColorModels & RGB_COLOR_MODEL_SRGB_D50) != 0) // Color model SRGB D50 is supported. See uc480.h for color model defines Example 5 UINT nRGBColorModel = 0; INT nRet = is_AutoParameter(m_hCam, IS_AWB_CMD_GET_RGB_COLOR_MODEL, (void*)&nRGBColorModel, sizeof(nRGBColorModel) nRGBColorModel = RGB_COLOR_MODEL_CIE_RGB_E; nRet = is_AutoParameter(m_hCam, IS_AWB_CMD_SET_RGB_COLOR_MODEL, (void*)&nRGBColorModel, sizeof(nRGBColorModel) © 2013 Thorlabs GmbH...

  • Page 172: Is_Blacklevel

    IS_BLACKLEVEL_CMD_GET_OFFSET Returns the current offset (Example 3 IS_BLACKLEVEL_CMD_SET_OFFSET Sets the offset (Example 3 pParam Pointer to a function parameter, whose function depends on nCommand. cbSizeOfParam Size (in bytes) of the memory area to which pParam refers. © 2013 Thorlabs GmbH...
  • Page 173 INT nOffsetMin = nRange.s32Min; INT nOffsetMax = nRange.s32Max; INT nOffsetInc = nRange.s32Inc; // Get current blacklevel offset nRet = is_Blacklevel(hCam, IS_BLACKLEVEL_CMD_GET_OFFSET, (void*)&nOffset, sizeof(nOffset)); // Set new offset nOffset = 100; nRet = is_Blacklevel(hCam, IS_BLACKLEVEL_CMD_SET_OFFSET, (void*)&nOffset, sizeof(nOffset)); © 2013 Thorlabs GmbH...

  • Page 174: Is_Camerastatus

    FALSE The camera changes to freerun mode IS_STANDBY_SUPPORTED Queries whether the camera supports standby mode (read-only). Return values: The camera supports standby mode TRUE FALSE The camera does not support standby mode ulValue IS_GET_STATUS Returns the information specified by nInfo. © 2013 Thorlabs GmbH...
  • Page 175 The camera model used here does not support this function or setting. IS_OUT_OF_MEMORY No memory could be allocated. IS_SUCCESS Function executed successfully IS_TIMED_OUT A timeout occurred. An image capturing process could not be terminated within the allowable period. Related functions is_GetCameraInfo() is_GetError() is_SetErrorReport() is_SetTriggerCounter() © 2013 Thorlabs GmbH...

  • Page 176: Is_Capturestatus

    Release locked destination memory Allocate more destination memory Reduce the frame rate so that there is more time to process the filled destination memory IS_CAP_STATUS_DRV_OUT_OF_BUFFERS No free internal image memory is available to the driver. The image © 2013 Thorlabs GmbH...
  • Page 177 IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_GetError() is_CameraStatus() is_SetErrorReport() Example 1 uc480_CAPTURE_STATUS_INFO CaptureStatusInfo; INT nRet = is_CaptureStatus(m_hCam, IS_CAPTURE_STATUS_INFO_CMD_GET, (void*)&CaptureStatusInfo, sizeof(CaptureStatusInfo)); (nRet == IS_SUCCESS) UINT nConversionFailed = CaptureStatusInfo.adwCapStatusCnt_Detail[IS_CAP_STATUS_API_CONVERSION_FAILED]); UINT nTotalInfos = CaptureStatusInfo.dwCapStatusCnt_Total; © 2013 Thorlabs GmbH...
  • Page 178 DCx Cameras Example 2 INT nRet = is_CaptureStatus(m_hCam, IS_CAPTURE_STATUS_INFO_CMD_RESET, NULL, © 2013 Thorlabs GmbH...

  • Page 179: Is_Capturevideo

    An IO request from the uc480 driver failed. Possibly the versions of the uc480_api.dll (API) and the driver file (uc480_usb.sys) do not match. IS_NO_ACTIVE_IMG_MEM No active image memory available. You must set the memory to active using the is_SetImageMem() function or create a sequence using the is_AddToSequence() function. © 2013 Thorlabs GmbH...
  • Page 180 A timeout occurred. An image capturing process could not be terminated within the allowable period. IS_TRIGGER_ACTIVATED The function cannot be used because the camera is waiting for a trigger signal. Related functions is_FreezeVideo() is_StopLiveVideo() is_SetExternalTrigger() is_ForceTrigger() is_SetTimeout() is_CaptureStatus() Sample programs SimpleLive (C++) © 2013 Thorlabs GmbH...

  • Page 181: Is_Clearsequence

    Input parameters hCam Camera handle Return values IS_INVALID_CAMERA_HANDLE Invalid camera handle IS_NO_SUCCESS General error message IS_SEQUENCE_LIST_EMPTY The sequence list is empty and cannot be deleted. IS_SUCCESS Function executed successfully Related functions is_AddToSequence() is_FreeImageMem() is_SetImageMem() © 2013 Thorlabs GmbH...

  • Page 182: Is_Colortemperature

    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 © 2013 Thorlabs GmbH...
  • Page 183 Pointer to variable of type UINT returning the default value. nSizeOfParam: 4 pParam Pointer to a function parameter, whose function depends on nCommand. nSizeOfParam Size (in bytes) of the memory area to which pParam refers. © 2013 Thorlabs GmbH...
  • Page 184 IS_NO_SUCCESS General error message IS_NOT_SUPPORTED The camera model used here does not support this function or setting. IS_SUCCESS Function executed successfully Related functions is_SetHardwareGain() is_AutoParameter() is_SetAutoParameter() © 2013 Thorlabs GmbH...

  • Page 185: Is_Configuration

    IS_CONFIG_CPU_IDLE_STATES_CMD_GET_ENABL Returns whether the current settings allow low power consumption operating states (unequal C0). Additional information pParam: Pointer to a UINT bitmask. The status flags from are returned in the CONFIGURATION_SEL bitmask. nSizeOfParam: 4 Example 2 © 2013 Thorlabs GmbH...
  • Page 186 EEPROM when the camera is opened. Additional information pParam: Pointer to a UINT variable, IS_CONFIG_INITIAL_PARAMETERSET_NONE IS_CONFIG_INITIAL_PARAMETERSET_1 IS_CONFIG_INITIAL_PARAMETERSET_2 nSizeOfParam: 4 Example 5 IS_CONFIG_INITIAL_PARAMETERSET_CMD_GET Returns which parameter set will be read and applied from the camera EEPROM when the camera is opened. © 2013 Thorlabs GmbH...
  • Page 187 IS_NO_IMAGE_MEM_ALLOCATED The driver could not allocate memory. IS_NO_SUCCESS General error message IS_NOT_SUPPORTED The camera model used here does not support this function or setting. IS_OPERATING_SYSTEM_NOT_SUPPORTED Operating system not supported IS_SUCCESS Function executed successfully Related functions is_ParameterSet() © 2013 Thorlabs GmbH...
  • Page 188 (nRet == IS_SUCCESS) (nCpuStates & IS_CONFIG_CPU_IDLE_STATES_BIT_AC_VALUE) // CPU idle states for mains power are deactivated when camera is opened (nCpuStates & IS_CONFIG_CPU_IDLE_STATES_BIT_DC_VALUE) // CPU idle states for battery power are deactivated when camera is opened © 2013 Thorlabs GmbH...
  • Page 189 // No parameter set specified else if (nNumber == IS_CONFIG_INITIAL_PARAMETERSET_1) // Parameter set 1 else if (nNumber == IS_CONFIG_INITIAL_PARAMETERSET_2) // Parameter set 2 nNumber = IS_CONFIG_INITIAL_PARAMETERSET_2; is_Configuration(IS_CONFIG_INITIAL_PARAMETERSET_CMD_SET, (void*)&nNumber, sizeof(nNumber)); (nRet == IS_SUCCESS) // Set to parameter set 2 © 2013 Thorlabs GmbH...

  • Page 190: Is_Convert

    IS_CONVERT_CMD_APPLY_PARAMS_AND_CONVERT_B Converts a raw Bayer buffer with the passed conversion parameters UFFER pParam Pointer to a function parameter, whose function depends on nCommand. cbSizeOfParam Size (in bytes) of the memory area to which pParam refers. © 2013 Thorlabs GmbH...
  • Page 191 BUFFER_CONVERSION_PARAMS conversionParams; conversionParams.nDestPixelFormat = IS_CM_BGRA8_PACKED; conversionParams.nDestPixelConverter = IS_CONV_MODE_SOFTWARE_3X3; conversionParams.nDestColorCorrectionMode = IS_CCOR_DISABLE; conversionParams.nDestGamma = 100; conversionParams.nDestSaturationU = 100; conversionParams.nDestSaturationV = 100; conversionParams.nDestEdgeEnhancement = 0; conversionParams.pSourceBuffer = pSourceBuffer; conversionParams.pDestBuffer = pDestBuffer; INT nRet = is_Convert(m_hCam, IS_CONVERT_CMD_APPLY_PARAMS_AND_CONVERT_BUFFER, (void*)&conversionParams, sizeof(conversionParams) © 2013 Thorlabs GmbH...
  • Page 192 IS_IO_REQUEST_FAILED An IO request from the uc480 driver failed. Possibly the versions of the uc480_api.dll (API) and the driver file (uc480_usb.sys) do not match. IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_AllocImageMem() is_SetAllocatedImageMem() © 2013 Thorlabs GmbH...

  • Page 193: Is_Copyimagemem

    IS_IO_REQUEST_FAILED An IO request from the uc480 driver failed. Possibly the versions of the uc480_api.dll (API) and the driver file (uc480_usb.sys) do not match. IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_AllocImageMem() is_SetAllocatedImageMem() © 2013 Thorlabs GmbH...

  • Page 194: Is_Devicefeature

    IS_DEVICE_FEATURE_CMD_GET_LOG_MODE_MANUA Returns the range of the manual value of the Log mode. L_VALUE_RANGE IS_DEVICE_FEATURE_CMD_GET_LOG_MODE_MANUA Returns the current manual value of the Log mode L_VALUE (Example 5 IS_DEVICE_FEATURE_CMD_SET_LOG_MODE_MANUA Sets the manual value of the Log mode L_VALUE © 2013 Thorlabs GmbH...
  • Page 195 IS_DEVICE_FEATURE_CAP_LOG_MODE LinLog pixel mode is supported/Set mode LOG_MODES IS_LOG_MODE_FACTORY_DEFAULT Default settings for the Log mode IS_LOG_MODE_OFF Log mode off IS_LOG_MODE_MANUAL Manual Log mode. In this case the LogMode value and the LogMode gain are effective. © 2013 Thorlabs GmbH...
  • Page 196 INT nRet = is_DeviceFeature(hCam, IS_DEVICE_FEATURE_CMD_GET_LOG_MODE_DEFAULT, (void*)&nDefaultLogMode, sizeof(nDefaultLogMode)); (nRet == IS_SUCCESS) { nRet = is_DeviceFeature(hCam, IS_DEVICE_FEATURE_CMD_SET_LOG_MODE, (void*)&nDefaultLogMode, sizeof(nDefaultLogMode)); Example 3 /* Read current Log pixel mode */ UINT nLogMode = 0; INT nRet = is_DeviceFeature(hCam, IS_DEVICE_FEATURE_CMD_GET_LOG_MODE, (void*)&nLogMode, sizeof(nLogMode)); © 2013 Thorlabs GmbH...
  • Page 197 INT nMax = nLogModeManualGainRange.s32Max; INT nInc = nLogModeManualGainRange.s32Inc; Example 7 UINT nLogModeGain = 0; /* Read current Log mode gain */ nRet = is_DeviceFeature(hCam, IS_DEVICE_FEATURE_CMD_GET_LOG_MODE_MANUAL_GAIN, (void*)&nLogModeGain, sizeof(nLogModeGain)); /* Set Log mode gain*/ nRet = is_DeviceFeature(hCam, IS_DEVICE_FEATURE_CMD_SET_LOG_MODE_MANUAL_GAIN, (void*)&nLogModeGain, sizeof(nLogModeGain)); © 2013 Thorlabs GmbH...

  • Page 198: Is_Deviceinfo

    Bit 14...11: filled according to algebraic sign Bit 10...4: temperature (places before the decimal point) Bit 3...0: temperature (places after the decimal point) See the Ambient conditions chapter for permissible temperature range. WORD wLinkSpeed_Mb Transfer rate: IS_USB_HIGH_SPEED = 480 IS_USB_SUPER_SPEED = 4000 © 2013 Thorlabs GmbH...
  • Page 199 Example 1 // The camera has the device ID 1 UINT nDeviceId = 1; IS_DEVICE_INFO deviceInfo; memset(&deviceInfo, 0, sizeof(IS_DEVICE_INFO)); INT nRet = is_DeviceInfo((HIDS)(nDeviceId | IS_USE_DEVICE_ID), IS_DEVICE_INFO_CMD_GET_DEVICE_INFO, (void*)&deviceInfo, sizeof(deviceInfo)); (nRet == IS_SUCCESS) WORD wTemperature = deviceInfo.infoDevHeartbeat.wTemperature; © 2013 Thorlabs GmbH...

  • Page 200: Is_Directrenderer

    Returns either if Direct3D or OpenGL is supported by the graphics card. More details IS_SET_DM_DIRECT3D: Tests if Direct3D is suppported. IS_SET_DM_OPENGL: Tests if OpenGL is supported. Example DR_GET_OVERLAY_DC Direct3D only: Returns the device context (DC) handle to the overlay area of the graphics card. © 2013 Thorlabs GmbH...
  • Page 201 With all other colors, the camera image will be visible with the overlay superimposed. The key color has no effect in semi-transparent mode! Example © 2013 Thorlabs GmbH...
  • Page 202 DR_GET_OVERLAY_DATA OpenGL only: Returns a pointer to the overlay. DR_UPDATE_OVERLAY_DATA OpenGL only: Updates the overlay. pParam Pointer to a function parameter, whose function depends on nCommand. nSize Size (in bytes) of the data object or array. © 2013 Thorlabs GmbH...
  • Page 203 (void*)&nType, sizeof(nType)) == IS_SUCCESS) // OpenGL is supported Example DC handle //------------------------------------ DC-Handle //------------------------------------ // Get DC handle for Overlay HDC hDC; is_DirectRenderer (hCam, DR_GET_OVERLAY_DC, (void*)&hDC, sizeof (hDC)); // Release DC handle is_DirectRenderer (hCam, DR_RELEASE_OVERLAY_DC, NULL, NULL); © 2013 Thorlabs GmbH...
  • Page 204 (hCam, DR_ENABLE_SCALING, NULL, NULL); // Disable scaling is_DirectRenderer (hCam, DR_DISABLE_SCALING, NULL, NULL); Example transparency //------------------------------------ Transparency //------------------------------------ // Enable semi-transparent overlay is_DirectRenderer (hCam, DR_ENABLE_SEMI_TRANSPARENT_OVERLAY, NULL, NULL); // Disable semi-transparent overlay is_DirectRenderer (hCam, DR_DISABLE_SEMI_TRANSPARENT_OVERLAY, NULL, NULL); © 2013 Thorlabs GmbH...
  • Page 205 // Set new window handle for image display is_DirectRenderer (hCam, DR_SET_HWND, (void*)&hWnd, sizeof (hWnd)); Example compatibility //------------------------------------ Compatibility //------------------------------------ // Check graphics card compatibility INT nRet = is_DirectRenderer (hCam, DR_CHECK_COMPATIBILITY, NULL, NULL); (nRet == IS_DR_DEVICE_CAPS_INSUFFICIENT ) // Graphics card does not support Direct3D © 2013 Thorlabs GmbH...

  • Page 206: Sample Programs

    (cr, 1, 0.2, 0.2, 0.6); cairo_arc (cr, 10.0, 135.0, 5.12, 0, 2*3.14); cairo_close_path (cr); cairo_arc (cr, 70.0, 165.0, 5.12, 0, 2*3.14); cairo_fill (cr); cairo_destroy (cr); cairo_surface_destroy (surface); // update overlay is_DirectRenderer(hCam, DR_UPDATE_OVERLAY_DATA, NULL, 0); Sample programs uc480DirectRenderer uc480Steal © 2013 Thorlabs GmbH...

  • Page 207: Is_Disableevent

    One of the submitted parameters is outside the valid range or is not supported for this sensor or is not available in this mode. IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_EnableEvent() Windows only: is_InitEvent() Windows only: is_ExitEvent() Linux only: is_WaitEvent() © 2013 Thorlabs GmbH...

  • Page 208: Is_Edgeenhancement

    One of the submitted parameters is outside the valid range or is not supported for this sensor or is not available in this mode. IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_SetColorMode() is_SetColorConverter() © 2013 Thorlabs GmbH...
  • Page 209 UINT nEdgeEnhancementInc = nRange[2]; Example 2 UINT nDefault; INT nRet = is_EdgeEnhancement(m_hCam, IS_EDGE_ENHANCEMENT_CMD_GET_DEFAULT, (void*)&nDefault, sizeof(nDefault) Example 3 UINT nEdgeEnhancement; INT nRet = is_EdgeEnhancement(m_hCam, IS_EDGE_ENHANCEMENT_CMD_GET, (void*)&nEdgeEnhancement, sizeof(nEdgeEnhancement) Example 4 UINT nEdgeEnhancement = 4; INT nRet = is_EdgeEnhancement(m_hCam, IS_EDGE_ENHANCEMENT_CMD_SET, (void*)&nEdgeEnhancement, sizeof(nEdgeEnhancement) © 2013 Thorlabs GmbH...

  • Page 210: Is_Enableautoexit

    IS_ENABLE_AUTO_EXIT Enables automatic closing IS_DISABLE_AUTO_EXIT Disables automatic closing IS_GET_AUTO_EXIT_ENABLED Returns the current setting Return values Current setting when used together withIS_GET_AUTO_EXIT_ENABLED IS_INVALID_CAMERA_HANDLE Invalid camera handle IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_ExitCamera() © 2013 Thorlabs GmbH...

  • Page 211: Is_Enableevent

    IS_SET_EVENT_NEW_DEVICE A new camera was connected. This is independent of the device handle (hCam is ignored). IS_SET_EVENT_OVERLAY_DATA_LOST Direct3D/OpenGL mode: Because of a re-programming the parameters of the overlay are invalid. The overlay must be draw new. © 2013 Thorlabs GmbH...
  • Page 212 Example Linux is_EnableEvent(hCam, IS_SET_EVENT_FRAME); is_FreezeVideo(hCam, IS_DONT_WAIT); INT nRet = is_WaitEvent(hCam, IS_SET_EVENT_FRAME, 1000); (nRet == IS_TIMED_OUT) /* wait timed out */ else if (nRet == IS_SUCCESS) /* event signalled */ is_DisableEvent(hCam, IS_SET_EVENT_FRAME); Sample programs SimpleLive (C++) uc480Event (C++) © 2013 Thorlabs GmbH...

  • Page 213: Is_Enablemessage

    A camera was removed. IS_WB_FINISHED Automatic white balance control is completed (only if this control was started using the IS_SET_AUTO_WB_ONCE function). IS_AUTOBRIGHTNESS_FINISHED Automatic brightness control is completed (only if this control was started using the IS_SET_AUTO_BRIGHTNESS_ONCE function). © 2013 Thorlabs GmbH...
  • Page 214 IS_INVALID_PARAMETER One of the submitted parameters is outside the valid range or is not supported for this sensor or is not available in this mode. IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_InitEvent() © 2013 Thorlabs GmbH...

  • Page 215: Is_Exitcamera

    An IO request from the uc480 driver failed. Possibly the versions of the uc480_api.dll (API) and the driver file (uc480_usb.sys) do not match. IS_NO_IMAGE_MEM_ALLOCATED The driver could not allocate memory. IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_InitCamera() is_EnableAutoExit() © 2013 Thorlabs GmbH...

  • Page 216: Is_Exitevent

    One of the submitted parameters is outside the valid range or is not supported for this sensor or is not available in this mode. IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_EnableEvent() is_InitEvent() Example See also is_ForceTrigger() © 2013 Thorlabs GmbH...

  • Page 217: Is_Exitimagequeue

    The image memories will be unlocked. The memory sequence itself persists and can be deleted with is_ClearSequence() Input parameters hCam Camera handle Return values IS_INVALID_CAMERA_HANDLE Invalid camera handle IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_InitImageQueue() is_WaitForNextImage() © 2013 Thorlabs GmbH...

  • Page 218: Is_Exposure

    You can avoid this behavior by additionally adding the value INCREMENT/2.f (half increment) when calculating with n*INCREMENT. This ensures that the desired value will be set even after rounding. © 2013 Thorlabs GmbH...
  • Page 219 (in exactly this order). nSizeOfParam: 24 IS_EXPOSURE_CMD_GET_FINE_INCREMENT_RANGE_ Returns the minimum exposure time in fine increments for some sensors. More details pParam: Pointer to variable of type double returning © 2013 Thorlabs GmbH...
  • Page 220 : Pointer to variable of the type returning pParam double the increment. nSizeOfParam Returns the value range for long exposure. IS_EXPOSURE_CMD_GET_LONG_EXPOSURE_RANGE More information : Pointer to an array of the type pParam double returning the minmum and maximum values and the © 2013 Thorlabs GmbH...
  • Page 221 The camera model used here does not support this function or setting. IS_SUCCESS Function executed successfully IS_TIMED_OUT A timeout occurred. An image capturing process could not be terminated within the allowable period. Related functions is_SetFrameRate() is_PixelClock() is_SetOptimalCameraTiming() is_SetAutoParameter() is_AutoParameter() is_SetHardwareGain() © 2013 Thorlabs GmbH...
  • Page 222 (void*)&dblMax, sizeof(dblMax) INT nRet = is_Exposure(m_hCam, IS_EXPOSURE_CMD_GET_FINE_INCREMENT_RANGE_INC, (void*)&dblInc, sizeof(dblInc) Example 3 double dblRange[3]; double dblMin, dblMax, dblInc; INT nRet = is_Exposure(m_hCam, IS_EXPOSURE_CMD_GET_FINE_INCREMENT_RANGE, (void*)dblRange, sizeof(dblRange) (nRet == IS_SUCCESS) dblMin = dblRange[0]; dblMax = dblRange[1]; dblInc = dblRange[2]; © 2013 Thorlabs GmbH...

  • Page 223: Is_Forcetrigger

    HANDLE hEvent = CreateEvent(NULL, TRUE, FALSE, ""); ( hEvent != NULL ) is_InitEvent(hCam, m_hEvent, IS_SET_EVENT_FRAME); is_EnableEvent(hCam, IS_SET_EVENT_FRAME); is_SetExternalTrigger(hCam, IS_SET_TRIGGER_HI_LO); is_FreezeVideo(hCam, IS_DONT_WAIT); (WaitForSingleObject(m_hEvent, 1000) != WAIT_OBJECT_0) // No trigger has been received, so force image capture is_ForceTrigger(hCam); is_DisableEvent(hCam, IS_SET_EVENT_FRAME); is_ExitEvent(hCam, IS_SET_EVENT_FRAME); © 2013 Thorlabs GmbH...

  • Page 224: Is_Freeimagemem

    IS_IO_REQUEST_FAILED An IO request from the uc480 driver failed. Possibly the versions of the uc480_api.dll (API) and the driver file (uc480_usb.sys) do not match. IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_AllocImageMem() © 2013 Thorlabs GmbH...

  • Page 225: Is_Freezevideo

    No active image memory available. You must set the memory to active using the is_SetImageMem() function or create a sequence using the is_AddToSequence() function. IS_NO_USB20 The camera is connected to a port which does not support the USB 2.0 high-speed standard. © 2013 Thorlabs GmbH...
  • Page 226 Enable trigger mode, set high-active flash mode and capture an image: is_SetExternalTrigger(hCam, IS_SET_TRIGGER_SOFTWARE); // Set the flash to a high active pulse for each image in the trigger mode UINT nMode = IO_FLASH_MODE_TRIGGER_HI_ACTIVE; is_IO(m_hCam, IS_IO_CMD_FLASH_SET_MODE, (void*)&nMode, sizeof(nMode)); is_FreezeVideo(hCam, IS_WAIT); Sample programs SimpleAcquire (C++) uc480C# Demo (C#) © 2013 Thorlabs GmbH...

  • Page 227: Is_Getactiveimagemem

    An IO request from the uc480 driver failed. Possibly the versions of the uc480_api.dll (API) and the driver file (uc480_usb.sys) do not match. IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_AllocImageMem() is_GetImageMem() is_SetImageMem() is_SetAllocatedImageMem() © 2013 Thorlabs GmbH...

  • Page 228: Is_Getactseqbuf

    An IO request from the uc480 driver failed. Possibly the versions of the uc480_api.dll (API) and the driver file (uc480_usb.sys) do not match. IS_NO_SUCCESS General error message IS_SEQUENCE_LIST_EMPTY The sequence list is empty and cannot be deleted. IS_SUCCESS Function executed successfully Related functions is_AddToSequence() is_GetImageMem() © 2013 Thorlabs GmbH...

  • Page 229: Is_Getautoinfo

    DWORD AAntiFlickerCaps Returns a bit mask containing all supported anti flicker settings for automatic control, see below. DWORD SensorWBModeCaps Returns a bit mask containing all supported settings for the sensor's auto white balance, see © 2013 Thorlabs GmbH...
  • Page 230 Status Flags in UC480_AUTO_INFO::AGainPhotomCaps AG_PM_NONE The entire field of view is used for metering. AG_PM_SENS_CENTER_WEIGHTED Metering is based on the entire field of view, but gives greater emphasis to the center area of the image. © 2013 Thorlabs GmbH...
  • Page 231 (API) and the driver file (uc480_usb.sys) do not match. IS_NO_SUCCESS General error message IS_NOT_SUPPORTED The camera model used here does not support this function or setting. IS_SUCCESS Function executed successfully Related functions is_SetAutoParameter() © 2013 Thorlabs GmbH...

  • Page 232: Is_Getbusspeed

    Function executed successfully IS_USB_10 The controller to which the camera is connected does not support USB 2.0. IS_USB_20 The camera is connected to a USB 2.0 controller. IS_USB_30 The camera is connected to a USB 3.0 controller. © 2013 Thorlabs GmbH...

  • Page 233: Is_Getcamerainfo

    For technical reasons, the following values for CAMINFO::Type are internally redirected to the same value: IS_CAMERA_TYPE_UC480_USB_SE and IS_CAMERA_TYPE_UC480_USB_RE You can use the parameter strSensorName of the function to discern the camera is_GetSensorInfo() models DCU223x, DCU224x and DCC1240x. Input parameters hCam Camera handle pInfo...
  • Page 234 DCx Cameras is_GetSensorInfo() © 2013 Thorlabs GmbH...

  • Page 235: Is_Getcameralist

    An attempt to initialize or select the camera failed (no camera connected or initialization error). IS_INVALID_PARAMETER One of the submitted parameters is outside the valid range or is not supported for this sensor or is not available in this mode. © 2013 Thorlabs GmbH...
  • Page 236 = nNumCam; //Retrieve camera info (is_GetCameraList(pucl) == IS_SUCCESS) { iCamera; (iCamera = 0; iCamera < (int)pucl->dwCount; iCamera++) { //Test output of camera info on the screen printf("Camera %i Id: %d", iCamera, pucl->uci[iCamera].dwCameraID); delete [] pucl; © 2013 Thorlabs GmbH...

  • Page 237: Is_Getcameralut

    Pointer to the array to which the blue channel values of the LUT are written. Return values IS_INVALID_CAMERA_HANDLE Invalid camera handle IS_NO_SUCCESS General error message IS_NOT_SUPPORTED The camera model used here does not support this function or setting. IS_SUCCESS Function executed successfully © 2013 Thorlabs GmbH...

  • Page 238: Is_Getcolorconverter

    All converters supported for this color mode. Possible converters are: IS_CONV_MODE_NONE IS_CONV_MODE_SOFTWARE_3X3 IS_CONV_MODE_SOFTWARE_5X5 IS_CONV_MODE_HARDWARE_3X3 Return values IS_INVALID_COLOR_FORMAT Invalid color format IS_INVALID_CAMERA_HANDLE Invalid camera handle IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_SetColorConverter() is_SetColorMode() © 2013 Thorlabs GmbH...

  • Page 239: Is_Getcolordepth

    One of the submitted parameters is outside the valid range or is not supported for this sensor or is not available in this mode. IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_SetColorMode() is_AllocImageMem() © 2013 Thorlabs GmbH...

  • Page 240: Is_Getdllversion

    Example version = is_GetDLLVersion(); build = version & 0xFFFF; version = version >> 16; minor = version & 0xFF; version = version >> 8; major = version & 0xFF; printf("API version %d.%d.%d \n\n", major, minor, build); © 2013 Thorlabs GmbH...

  • Page 241: Is_Geterror

    One of the submitted parameters is outside the valid range or is not supported for this sensor or is not available in this mode. IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_CaptureStatus() is_SetErrorReport() is_CameraStatus() © 2013 Thorlabs GmbH...

  • Page 242: Is_Getframespersecond

    One of the submitted parameters is outside the valid range or is not supported for this sensor or is not available in this mode. IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_GetFrameTimeRange() is_SetFrameRate() is_PixelClock() is_Exposure() © 2013 Thorlabs GmbH...

  • Page 243: Is_Getframetimerange

    One of the submitted parameters is outside the valid range or is not supported for this sensor or is not available in this mode. IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_GetFramesPerSecond() is_SetFrameRate() is_PixelClock() is_Exposure() © 2013 Thorlabs GmbH...

  • Page 244: Is_Getimagehistogram

    An IO request from the uc480 driver failed. Possibly the versions of the uc480_api.dll (API) and the driver file (uc480_usb.sys) do not match. IS_NO_SUCCESS General error message IS_NULL_POINTER Invalid array IS_SUCCESS Function executed successfully Related functions is_SetColorMode() © 2013 Thorlabs GmbH...
  • Page 245 //Create pointer for each histogram color DWORD * pBlueHisto = bgrBuffer; DWORD *pGreenHisto = bgrBuffer + 256; DWORD * pRedHisto = bgrBuffer + 512; //Retrieve histogram and release memory is_GetImageHistogram (hCam, nIDSource, IS_CM_RGB8_PACKED, bgrBuffer); is_FreeImageMem (hCam, pcSource, nIDSource); © 2013 Thorlabs GmbH...

  • Page 246: Is_Getimageinfo

    UEYETIME below DWORD dwIoStatus With DCC3240x Cameras: Returns the states of the digital I/Os at the time of image capture: Digital input (trigger): Pending signal GPIO as input: Pending signal GPIO as output: Set level © 2013 Thorlabs GmbH...
  • Page 247 This may happen when e.g.: more memory is allocated than the UC480IMAGEINFO structure needs nImageBufferID <= 0 pImageInfo == NULL nImageInfoSize <= 0 IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully © 2013 Thorlabs GmbH...

  • Page 248: Sample Program

    = ImageInfo.u64TimestampDevice; CString Str; // Read out timestamp in system time Str.Format("%02d.%02d.%04d, %02d:%02d:%02d:%03d", ImageInfo.TimestampSystem.wDay, ImageInfo.TimestampSystem.wMonth, ImageInfo.TimestampSystem.wYear, ImageInfo.TimestampSystem.wHour, ImageInfo.TimestampSystem.wMinute, ImageInfo.TimestampSystem.wSecond, ImageInfo.TimestampSystem.wMilliseconds); DWORD dwTotalBuffers = ImageInfo.dwImageBuffers; DWORD dwUsedBuffers = ImageInfo.dwImageBuffersInUse; Sample Program uc480Timestamp (C++) © 2013 Thorlabs GmbH...

  • Page 249: Is_Getimagemem

    An IO request from the uc480 driver failed. Possibly the versions of the uc480_api.dll (API) and the driver file (uc480_usb.sys) do not match. IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_GetImageMemPitch() is_AllocImageMem() is_AddToSequence() is_SetImageMem() is_SetAllocatedImageMem() Sample programs uc480PixelPeek (C++) © 2013 Thorlabs GmbH...

  • Page 250: Is_Getimagemempitch

    An IO request from the uc480 driver failed. Possibly the versions of the uc480_api.dll (API) and the driver file (uc480_usb.sys) do not match. IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_GetImageMem() is_AllocImageMem() is_AddToSequence() is_SetImageMem() is_SetAllocatedImageMem() © 2013 Thorlabs GmbH...

  • Page 251: Is_Getnumberofcameras

    Returns the number of connected cameras. Return values IS_INVALID_PARAMETER One of the submitted parameters is outside the valid range or is not supported for this sensor or is not available in this mode. IS_SUCCESS Function executed successfully Related functions is_GetCameraList() is_DeviceInfo() © 2013 Thorlabs GmbH...

  • Page 252: Is_Getosversion

    Windows 2000 operating system IS_OS_WINXP Windows XP operating system IS_OS_WINSERVER2003 Windows Server 2003 operating system IS_OS_WINVISTA Windows Vista operating system IS_OS_WIN7 Windows 7 operating system IS_OS_LINUX26 Linux 2.6 operating system IS_OS_UNDETERMINED Unknown operating system Related functions is_GetDLLVersion() © 2013 Thorlabs GmbH...

  • Page 253: Is_Getsensorinfo

    IS_NO_SUCCESS General error message IS_NOT_SUPPORTED The camera model used here does not support this function or setting. IS_SUCCESS Function executed successfully Related functions is_GetCameraInfo() is_CameraStatus() © 2013 Thorlabs GmbH...

  • Page 254: Is_Getsensorscalerinfo

    IS_NO_SUCCESS General error message IS_NOT_SUPPORTED The camera model used here does not support this function or setting. IS_SUCCESS Function executed successfully Related functions is_SetSensorScaler() © 2013 Thorlabs GmbH...

  • Page 255: Is_Getsupportedtestimages

    Camera image overlaid with a grid of blue dots IS_TEST_IMAGE_HOTPIXEL_GRID Camera image overlaid with a grid of red dots IS_TEST_IMAGE_VARIABLE_GREY Adjustable grayscale image IS_TEST_IMAGE_VARIABLE_RED_PART Image with adjustable red content IS_TEST_IMAGE_VARIABLE_GREEN_PART Image with adjustable green content IS_TEST_IMAGE_VARIABLE_BLUE_PART Image with adjustable blue content © 2013 Thorlabs GmbH...
  • Page 256 IS_NO_SUCCESS General error message IS_NOT_SUPPORTED The camera model used here does not support this function or setting. IS_SUCCESS Function executed successfully Related functions is_SetSensorTestImage() is_GetTestImageValueRange() © 2013 Thorlabs GmbH...

  • Page 257: Is_Gettestimagevaluerange

    General error message IS_NOT_SUPPORTED The camera model used here does not support this function or setting. In this case, the TestImageValueMin and TestImageValueMax parameters are equal to 0. IS_SUCCESS Function executed successfully Related functions is_GetSupportedTestImages() is_SetSensorTestImage() © 2013 Thorlabs GmbH...

  • Page 258: Is_Gettimeout

    IS_NOT_SUPPORTED The camera model used here does not support this function or setting. IS_SUCCESS Function executed successfully Related functions is_SetTimeout() is_CaptureVideo() is_FreezeVideo() is_SetExternalTrigger() Example // Return user-defined timeout UINT nTimeout; INT ret = is_GetTimeout(hCam, IS_TRIGGER_TIMEOUT, &nTimeout); © 2013 Thorlabs GmbH...

  • Page 259: Is_Getusedbandwidth

    (bits per pixel). The actual data load on the bus can slightly deviate from this value. Input parameters hCam Camera handle Return values INT value The total current bus bandwidth (in MByte/s) Related functions is_PixelClock() © 2013 Thorlabs GmbH...

  • Page 260: Is_Getvsynccount

    VSYNC counter. It will be incremented by 1 each time the sensor starts capturing an image. Input parameters hCam Camera handle pIntr Current VSYNC count pActIntr Current Frame SYNC count Return values IS_INVALID_CAMERA_HANDLE Invalid camera handle IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_GetFramesPerSecond() © 2013 Thorlabs GmbH...

  • Page 261: Is_Hasvideostarted

    Returns the digitizing status: 0 = Image capturing has not started yet. 1 = Image capturing has started. Return values IS_INVALID_CAMERA_HANDLE Invalid camera handle IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_FreezeVideo() is_IsVideoFinish() © 2013 Thorlabs GmbH...

  • Page 262: Is_Hotpixel

    (Example 2 IS_HOTPIXEL_GET_SUPPORTED_CORRECTION_MO Returns the supported hot pixel correction modes.The return value is a bitmask with the following constants (combined by OR): IS_HOTPIXEL_ENABLE_CAMERA_CORRECTION: Hot pixel correction is possible via the hot pixel list in the camera EEPROM. © 2013 Thorlabs GmbH...
  • Page 263 Communication with the driver failed because no driver has been loaded. IS_CANT_OPEN_DEVICE An attempt to initialize or select the camera failed (no camera connected or initialization error). IS_INVALID_CAMERA_TYPE The camera type defined in the .ini file does not match © 2013 Thorlabs GmbH...
  • Page 264 // Change a value and save the list. // The number of the hot pixel has to be specified in pList[0] pList[1] = 100; nRet = is_HotPixel(hCam, IS_HOTPIXEL_SET_SOFTWARE_USER_LIST, (void*)pList, (1 + 2 * nNumber) * sizeof(WORD)); // Delete unneeded list delete [] pList; © 2013 Thorlabs GmbH...
  • Page 265 // Additional memory space of one WORD per hot pixel is required for numbering. WORD *pList = WORD[1 + 2 * nNumber]; nRet = is_HotPixel(hCam, IS_HOTPIXEL_GET_MERGED_CAMERA_LIST, (void*)pList, (1 + 2 * nNumber) * sizeof(WORD)); // Delete unneeded list delete [] pList; © 2013 Thorlabs GmbH...

  • Page 266: Is_Imagefile

    Saves an image file (bmp, jpg, png) (Example 2 The function can be used with UNICODE file names. pParam Pointer to a function parameter, whose function depends on nCommand. cbSizeOfParam Size (in bytes) of the memory area to which pParam refers. © 2013 Thorlabs GmbH...
  • Page 267 IS_NO_SUCCESS General error message IS_NOT_SUPPORTED The camera model used here does not support this function or setting. IS_SUCCESS Function executed successfully Related functions is_GetImageMem() is_SetImageMem() © 2013 Thorlabs GmbH...
  • Page 268 // Save png from special memory with quality 50 (with file open dialog) ImageFileParams.pwchFileName = NULL; ImageFileParams.pnImageID = &nID; // valid ID ImageFileParams.ppcImageMem = &pcMemory; // valid buffer ImageFileParams.nFileType = IS_IMG_PNG; ImageFileParams.nQuality = 50; nRet = is_ImageFile(m_hCam, IS_IMAGE_FILE_CMD_SAVE, (void*)&ImageFileParams, sizeof(ImageFileParams)); © 2013 Thorlabs GmbH...

  • Page 269: Is_Imageformat

    Pointer to variable of type UINT indicating if free AOI selection is supported: 0 = No free AOI supported 1 = Free AOI supported nSizeOfParam: 4 pParam Pointer to a function parameter, whose function depends on nCommand. © 2013 Thorlabs GmbH...
  • Page 270 Software triggered mode, single frame CAPTMODE_TRIGGER_SOFT_CONTINUOUS Software triggered mode, continuous CAPTMODE_TRIGGER_HW_SINGLE Hardware triggered mode, single frame CAPTMODE_TRIGGER_HW_CONTINUOUS Hardware triggered mode, continuous For further information on the image capture modes, see also in the Basics: Operating modes chapter. © 2013 Thorlabs GmbH...
  • Page 271 (CIF) 288x352 (CIF Portrait) 320x240 (QVGA) 240x320 (QVGA Portrait) 1600x1200 (UXGA) 3840x2748 (10M) 1920x1080 (Full HD 16:9, HQ) 2560x1920 (5M) 768x576 (CCIR) 1280x1024 (1.3M SXGA) 2448x2048 (5M) 1024x768 (XGA) 1024x1024 (1M) 800x600 (SVGA) 1360x1024 (1.4M 4:3) © 2013 Thorlabs GmbH...
  • Page 272 A capturing operation is in progress and must be terminated before you can start another one. IS_DR_CANNOT_CREATE_SURFACE The image surface or overlay surface could not be created. IS_DR_CANNOT_CREATE_TEXTURE The texture could not be created. IS_DR_CANNOT_CREATE_VERTEX_BUFFER The vertex buffer could not be created. © 2013 Thorlabs GmbH...
  • Page 273 The memory could not be locked. The pointer to the buffer is invalid. IS_SUCCESS Function executed successfully IS_TIMED_OUT A timeout occurred. An image capturing process could not be terminated within the allowable period. IS_TRIGGER_ACTIVATED The function cannot be used because the camera is waiting for a trigger signal. © 2013 Thorlabs GmbH...
  • Page 274 = formatInfo.nHeight; // Allocate image mem for current format, set format nRet = is_AllocImageMem(hCam, width, height, 24, &pMem, &memID); nRet = is_SetImageMem(hCam, pMem, memID); nRet = is_ImageFormat(hCam, IMGFRMT_CMD_SET_FORMAT, &formatInfo.nFormatID, 4); // Capture image nRet = is_FreezeVideo(hCam, IS_WAIT); © 2013 Thorlabs GmbH...

  • Page 275: Is_Initcamera

    If hWnd = NULL, DIB mode will be used for image display. Return values IS_ALL_DEVICES_BUSY All cameras are in use IS_BAD_STRUCTURE_SIZE An internal structure has an incorrect size. IS_CANT_ADD_TO_SEQUENCE The image memory is already included in the sequence and cannot be added again. © 2013 Thorlabs GmbH...
  • Page 276 IS_NO_IMAGE_MEM_ALLOCATED The driver could not allocate memory. IS_NO_IR_FILTER No IR filter available IS_NO_SUCCESS General error message IS_NOT_CALIBRATED The camera does not contain any calibration data. © 2013 Thorlabs GmbH...
  • Page 277 //Upload new starter firmware during initialization hCam = hCam | IS_ALLOW_STARTER_FW_UPLOAD; nRet = is_InitCamera (&hCam, NULL); end progress bar Sample programs uc480MultipleCameraScan (C++) uc480Console (C++) uc480C# Demo (C#) © 2013 Thorlabs GmbH...

  • Page 278: Is_Initevent

    One of the submitted parameters is outside the valid range or is not supported for this sensor or is not available in this mode. IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_EnableEvent() is_DisableEvent() is_ExitEvent() © 2013 Thorlabs GmbH...
  • Page 279 IS_SET_EVENT_FRAME); is_FreezeVideo(hCam, IS_DONT_WAIT); DWORD dwRet = WaitForSingleObject(hEvent, 1000); (dwRet == WAIT_TIMEOUT) /* wait timed out */ else if (dwRet == WAIT_OBJECT_0) /* event signalled */ is_DisableEvent(hCam, IS_SET_EVENT_FRAME); is_ExitEvent(hCam, IS_SET_EVENT_FRAME); CloseHandle(hEvent); Sample programs SimpleLive (C++) uc480Event (C++) © 2013 Thorlabs GmbH...

  • Page 280: Is_Initimagequeue

    // Note: image memories have to be allocated before this is_InitImageQueue (m_hCam, 0); INT nMemID = 0; char *pBuffer = NULL; while (IS_SUCCESS == is_WaitForNextImage(m_hCam, 1000, &pBuffer, &nMemID)) is_SaveImageMem (m_hCam, "image.bmp", pBuffer, nMemID); is_UnlockSeqBuf (m_hCam, nMemID, pBuffer); is_ExitImageQueue (m_hCam); © 2013 Thorlabs GmbH...

  • Page 281: Is_Inquireimagemem

    An IO request from the uc480 driver failed. Possibly the versions of the uc480_api.dll (API) and the driver file (uc480_usb.sys) do not match. IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_AllocImageMem() is_SetImageMem() is_SetAllocatedImageMem() is_GetColorDepth() © 2013 Thorlabs GmbH...

  • Page 282: Is_Io

    UINT type. The size of the memory area to which pParam refers is specified in the cbSizeOfParam input parameter. Note The following functions are obsolete by the is_IO() function: is_GetGlobalFlashDelays() is_SetFlashDelay() is_SetFlashStrobe() is_SetIO() is_SetIOMask() © 2013 Thorlabs GmbH...
  • Page 283 Returns the parameters for the global exposure window (Example 4 IS_IO_CMD_FLASH_APPLY_GLOBAL_PARAMS Returns the parameters for the global exposure window and sets them as flash parameters (Examplel 4 IS_IO_CMD_FLASH_GET_PARAMS Returns the current values for flash delay and duration © 2013 Thorlabs GmbH...
  • Page 284 IO_LED_STATE_2: Sets LED to green. IS_IO_CMD_LED_TOGGLE_STATE Toggles between the LED states (Example 3 pParam Pointer to a function parameter, whose function depends on nCommand. cbSizeOfParam Size (in bytes) of the memory area to which pParam refers. © 2013 Thorlabs GmbH...
  • Page 285 The camera model used here does not support this function or setting. IS_SUCCESS Function executed successfully IS_TRIGGER_ACTIVATED The function cannot be used because the camera is waiting for a trigger signal. IS_TRIGGER_NOT_ACTIVATED The function is not possible as trigger is disabled. © 2013 Thorlabs GmbH...
  • Page 286 INT nRet = is_IO(m_hCam, IS_IO_CMD_FLASH_GET_GLOBAL_PARAMS, (void*)&flashParams, sizeof(flashParams)); (nRet == IS_SUCCESS) INT nDelay = flashParams.s32Delay; UINT nDuration = flashParams.u32Duration; // Read the global flash params and set the flash params to these values INT nRet = is_IO(m_hCam, IS_IO_CMD_FLASH_APPLY_GLOBAL_PARAMS, NULL, 0); © 2013 Thorlabs GmbH...
  • Page 287 // Set the flash to a high active pulse for each image in the trigger mode nMode = IO_FLASH_MODE_TRIGGER_HI_ACTIVE; nRet = is_IO(m_hCam, IS_IO_CMD_FLASH_SET_MODE, (void*)&nMode, sizeof(nMode)); // Get the current flash mode nRet = is_IO(m_hCam, IS_IO_CMD_FLASH_GET_MODE, (void*)&nMode, sizeof(nMode)); © 2013 Thorlabs GmbH...
  • Page 288 // Set GPIO1, GPIO2 and the flash pin as PWM output nMode = IO_GPIO_1 | IO_GPIO_2 | IS_FLASH_MODE_PWM; nRet = is_IO(m_hCam, IS_IO_CMD_PWM_SET_MODE, (void*)&nMode, sizeof(nMode)); // Get the current PWM mode nRet = is_IO(m_hCam, IS_IO_CMD_PWM_GET_MODE, (void*)&nMode, sizeof(nMode)); © 2013 Thorlabs GmbH...
  • Page 289 // Get the minimum values for the GPIO flash delay and flash duration nRet = is_IO(m_hCam, IS_IO_CMD_FLASH_GET_GPIO_PARAMS_MIN, (void*)&flashParams, sizeof(flashParams)); // Set the minimum values for flash delay and flash duration. Be careful: The normal flash does not work with val nRet = is_IO(m_hCam, IS_IO_CMD_FLASH_SET_GPIO_PARAMS, (void*)&flashParams, sizeof(flashParams)); © 2013 Thorlabs GmbH...

  • Page 290: Is_Isvideofinish

    One of the submitted parameters is outside the valid range or is not supported for this sensor or is not available in this mode. IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_FreezeVideo() is_HasVideoStarted() © 2013 Thorlabs GmbH...

  • Page 291: Is_Lockseqbuf

    One of the submitted parameters is outside the valid range or is not supported for this sensor or is not available in this mode. IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_UnlockSeqBuf() is_AddToSequence() is_SetImageMem() is_SetAllocatedImageMem() © 2013 Thorlabs GmbH...

  • Page 292: Is_Measure

    IS_NO_ACTIVE_IMG_MEM No active image memory available. You must set the memory to active using the is_SetImageMem() function or create a sequence using the © 2013 Thorlabs GmbH...
  • Page 293 = 0; nRet = is_Measure(m_hCam, IS_MEASURE_CMD_SHARPNESS_AOI_INQUIRE, (void*)&measureSharpnessInfo, sizeof(measureSharpnessInfo)); (nRet == IS_SUCCESS) UINT s32Sharpness = measureSharpnessInfo.u32SharpnessValue; Example 3 INT nRet = IS_SUCCESS; /* Set preset */ UINT nPreset = IS_MEASURE_SHARPNESS_AOI_PRESET_1; nRet = is_Measure(m_hCam, IS_MEASURE_CMD_SHARPNESS_AOI_SET_PRESET, (void*)&nPreset, sizeof(nPreset)); © 2013 Thorlabs GmbH...

  • Page 294: Is_Parameterset

    NULL the "Save as" dialog opens. IS_PARAMETERSET_CMD_GET_NUMBER_SUPPORTE Returns the number of supported parameter sets in the camera EEPROM (Example 5 ). At the moment this is "1" for all cameras. pParam Pointer to a function parameter, whose function depends on nCommand. © 2013 Thorlabs GmbH...
  • Page 295 // Save parameters to specified file nRet = is_ParameterSet(m_hCam, IS_PARAMETERSET_CMD_SAVE_FILE, L"file.ini", NULL); Example 5 // Get the number of supported parameter sets in the camera EEPROM UINT nNumber; INT nRet = is_ParameterSet(m_hCam, IS_PARAMETERSET_CMD_GET_NUMBER_SUPPORTED, (void*) &nNumber, sizeof(nNumber)); © 2013 Thorlabs GmbH...

  • Page 296: Is_Pixelclock

    IS_NO_SUCCESS General error message IS_NOT_SUPPORTED The camera model used here does not support this function or setting. IS_SUCCESS Function executed successfully © 2013 Thorlabs GmbH...
  • Page 297 = is_PixelClock(hCam, IS_PIXELCLOCK_CMD_GET, (void*)&nPixelClock, sizeof(nPixelClock)); Example 4 UINT nPixelClockDefault; // Get default pixel clock INT nRet = is_PixelClock(hCam, IS_PIXELCLOCK_CMD_GET_DEFAULT, (void*)&nPixelClockDefault, sizeof(nPixelClockDefault)); (nRet == IS_SUCCESS) // Set this pixel clock nRet = is_PixelClock(hCam, IS_PIXELCLOCK_CMD_SET, (void*)&nPixelClockDefault, sizeof(nPixelClockDefault)); © 2013 Thorlabs GmbH...

  • Page 298: Is_Readeeprom

    IS_NOT_CALIBRATED The camera does not contain any calibration data. IS_NOT_SUPPORTED The camera model used here does not support this function or setting. IS_SUCCESS Function executed successfully Related functions is_WriteEEPROM() Example char buffer[64]; is_ReadEEPROM( hCam, 0x00, buffer, © 2013 Thorlabs GmbH...

  • Page 299: Is_Renderbitmap

    An attempt to initialize or select the camera failed (no camera connected or initialization error). IS_INVALID_CAMERA_HANDLE Invalid camera handle IS_INVALID_MEMORY_POINTER Invalid pointer or invalid memory ID IS_INVALID_PARAMETER One of the submitted parameters is outside the valid © 2013 Thorlabs GmbH...
  • Page 300 General error message IS_SUCCESS Function executed successfully Related functions is_AllocImageMem() is_SetColorMode() is_SetDisplayMode() is_DirectRenderer() Example Fit image to window and display it upside down: is_RenderBitmap (hCam, nMemID, hwnd, IS_RENDER_FIT_TO_WINDOW | IS_RENDER_MIRROR_UPDOWN); Sample programs SimpleAcquire (C++) SimpleLive (C++) © 2013 Thorlabs GmbH...

  • Page 301: Is_Resettodefault

    No memory could be allocated. IS_SEQUENCE_BUF_ALREADY_LOCKED The memory could not be locked. The pointer to the buffer is invalid. IS_SUCCESS Function executed successfully IS_TIMED_OUT A timeout occurred. An image capturing process could not be terminated within the allowable period. © 2013 Thorlabs GmbH...
  • Page 302 DCx Cameras Related functions is_ParameterSet() © 2013 Thorlabs GmbH...

  • Page 303: Is_Setallocatedimagemem

    IS_NO_SUCCESS General error message IS_OUT_OF_MEMORY No memory could be allocated. IS_SEQUENCE_BUF_ALREADY_LOCKED The memory could not be locked. The pointer to the buffer is invalid. IS_SUCCESS Function executed successfully © 2013 Thorlabs GmbH...
  • Page 304 = is_FreeImageMem(hCam, pcMem, iMemID); GlobalUnlock(hMem); GlobalFree(hMem); Example Linux char* pcMem = (char*)malloc(uImageSize); iRet = mlock(pcMem, uImageSize); INT nRet = is_SetAllocatedImageMem(hCam, uWidth, uHeight, uBitspixel, pcMem, &iMemID); […] nRet = is_FreeImageMem(hCam, pcMem, iMemID); iRet = munlock(pcMem, uImageSize); free(pcMem); © 2013 Thorlabs GmbH...

  • Page 305: Is_Setautoparameter

    = 1 enables control, 0 disables control IS_GET_ENABLE_AUTO_SENSOR_GAIN Returns the current auto gain setting of the sensor Control parameters pval1: returns the current setting IS_SET_ENABLE_AUTO_SHUTTER Enables/disables the auto exposure shutter function. Control parameters pval1 = 1 enables control, 0 disables control © 2013 Thorlabs GmbH...
  • Page 306 Returns the sensor's current auto frame rate setting Control parameters pval1: returns the current setting Adjusting auto gain control/auto exposure shutter IS_SET_AUTO_REFERENCE Sets the setpoint for auto gain control/auto exposure shutter. Control parameters pval1: defines the setpoint (average brightness of the © 2013 Thorlabs GmbH...
  • Page 307 (default: 4) IS_GET_AUTO_SKIPFRAMES Returns the number of frames to be skipped during automatic control. Control parameters pval1: returns the current setting IS_GET_AUTO_SKIPFRAMES_RANGE Returns the permissible range for the number of frames to be skipped. © 2013 Thorlabs GmbH...
  • Page 308 IS_GET_SENS_AUTO_GAIN_PHOTOM_DEF Returns the default photometry mode for auto gain control. Control parameters pval1: returns the default Adjusting auto white balance IS_SET_AUTO_WB_OFFSET Sets the offset values for the red and blue channels. © 2013 Thorlabs GmbH...
  • Page 309 (default: 4) IS_GET_AUTO_WB_SKIPFRAMES Returns the number of frames to be skipped during automatic control. Control parameters pval1: returns the current setting IS_GET_AUTO_WB_SKIPFRAMES_RANGE Returns the permissible range for the number of frames to be skipped. Control parameters © 2013 Thorlabs GmbH...
  • Page 310 (API) and the driver file (uc480_usb.sys) do not match. IS_NO_SUCCESS General error message IS_NOT_CALIBRATED The camera does not contain any calibration data. IS_NOT_SUPPORTED The camera model used here does not support this function or setting. © 2013 Thorlabs GmbH...
  • Page 311 = is_SetAutoParameter (hCam, IS_SET_ENABLE_AUTO_GAIN, &dEnable, 0); //Set brightness setpoint to 128: double nominal = 128; ret = is_SetAutoParameter (hCam, IS_SET_AUTO_REFERENCE, &nominal, 0); //Return shutter control limit: double maxShutter; ret = is_SetAutoParameter (hCam, IS_GET_AUTO_SHUTTER_MAX, &maxShutter, 0); © 2013 Thorlabs GmbH...

  • Page 312: Is_Setbinning

    Enables horizontal binning with factor 2. IS_BINNING_3X_HORIZONTAL Enables horizontal binning with factor 3. IS_BINNING_4X_HORIZONTAL Enables horizontal binning with factor 4. IS_BINNING_5X_HORIZONTAL Enables horizontal binning with factor 5. IS_BINNING_6X_HORIZONTAL Enables horizontal binning with factor 6. IS_BINNING_8X_HORIZONTAL Enables horizontal binning with factor 8. © 2013 Thorlabs GmbH...
  • Page 313 IS_INVALID_PIXEL_CLOCK This setting is not available for the currently set pixel clock frequency. IS_IO_REQUEST_FAILED An IO request from the uc480 driver failed. Possibly the versions of the uc480_api.dll (API) and the driver file © 2013 Thorlabs GmbH...
  • Page 314 A timeout occurred. An image capturing process could not be terminated within the allowable period. IS_TRIGGER_ACTIVATED The function cannot be used because the camera is waiting for a trigger signal. Related functions is_SetSubSampling() is_AOI() is_SetImagePos() is_PixelClock() © 2013 Thorlabs GmbH...

  • Page 315: Is_Setcameraid

    The camera model used here does not support this function or setting. IS_NULL_POINTER Invalid array IS_SUCCESS Function executed successfully IS_TIMED_OUT A timeout occurred. An image capturing process could not be terminated within the allowable period. Related functions is_InitCamera() © 2013 Thorlabs GmbH...
  • Page 316 DCx Cameras is_GetCameraInfo() is_CameraStatus() © 2013 Thorlabs GmbH...

  • Page 317: Is_Setcolorconverter

    IS_INVALID_COLOR_FORMAT Invalid color format IS_INVALID_CAMERA_HANDLE Invalid camera handle IS_INVALID_PARAMETER One of the submitted parameters is outside the valid range or is not supported for this sensor or is not © 2013 Thorlabs GmbH...
  • Page 318 No IR filter available IS_NO_SUCCESS General error message IS_NOT_SUPPORTED The camera model used here does not support this function or setting. IS_OUT_OF_MEMORY No memory could be allocated. IS_SUCCESS Function executed successfully Related functions is_GetColorConverter() is_SetColorMode() is_Convert() © 2013 Thorlabs GmbH...

  • Page 319: Is_Setcolorcorrection

    OR: IS_CCOR_ENABLE_NORMAL IS_CCOR_ENABLE_BG40_ENHANCED IS_CCOR_ENABLE_HQ_ENHANCED When used for monochrome cameras, the system returns When used together with When used for color cameras and together with IS_GET_DEFAULT_CCOR_MODE IS_GET_DEFAULT_CCOR_MODE, this parameter returns the default color correction mode: IS_CCOR_ENABLE_NORMAL IS_CCOR_ENABLE_HQ_ENHANCED © 2013 Thorlabs GmbH...
  • Page 320 (API) and the driver file (uc480_usb.sys) do not match. IS_NO_IR_FILTER No IR filter available IS_NO_SUCCESS General error message IS_NOT_SUPPORTED The camera model used here does not support this function or setting. IS_SUCCESS Function executed successfully Related functions is_SetColorConverter() is_SetColorMode() is_SetAutoParameter() © 2013 Thorlabs GmbH...

  • Page 321: Is_Setcolormode

    IS_CM_BGRA12_PACKED BGR48 (12 12 12), for monochrome and color cameras, LUT/gamma active IS_CM_BGRA8_PACKED BGR32 (8 8 8), for monochrome and color cameras, LUT/gamma active IS_CM_BGRY8_PACKED BGRY (8 8 8), for monochrome and color cameras, LUT/gamma active © 2013 Thorlabs GmbH...
  • Page 322 Invalid array IS_OUT_OF_MEMORY No memory could be allocated. IS_SUCCESS Function executed successfully IS_TIMED_OUT A timeout occurred. An image capturing process could not be terminated within the allowable period. Related functions is_SetDisplayMode() is_SetColorConverter() is_SetColorCorrection() is_GetColorDepth() is_AllocImageMem() is_RenderBitmap() © 2013 Thorlabs GmbH...
  • Page 323 IS_SET_CM_Y8 IS_CM_MONO8 IS_SET_CM_BAYER IS_CM_BAYER_RG8 IS_SET_CM_UYVY IS_CM_UYVY_PACKED IS_SET_CM_UYVY_MONO IS_CM_UYVY_MONO_PACKED IS_SET_CM_UYVY_BAYER IS_CM_UYVY_BAYER_PACKED IS_SET_CM_CBYCRY IS_CM_CBYCRY_PACKED IS_SET_CM_RGBY IS_CM_BGRY8_PACKED IS_SET_CM_RGB30 IS_CM_BGR10V2_PACKED IS_SET_CM_Y12 IS_CM_MONO12 IS_SET_CM_BAYER12 IS_CM_BAYER_RG12 IS_SET_CM_Y16 IS_CM_MONO16 IS_SET_CM_BAYER16 IS_CM_BAYER_RG16 IS_CM_BGR10V2_PACKED IS_CM_BGR10_PACKED IS_CM_RGB10V2_PACKED IS_CM_RGB10_PACKED IS_CM_BGR555_PACKED IS_CM_BGR5_PACKED IS_CM_BAYER_RG8 IS_CM_SENSOR_RAW8 IS_CM_BAYER_RG12 IS_CM_SENSOR_RAW12 IS_CM_BAYER_RG16 IS_CM_SENSOR_RAW16 © 2013 Thorlabs GmbH...

  • Page 324: Is_Setdisplaymode

    DirectDraw. It is advisable not to use these modes any longer (see also Obsolete functions ). To activate the obsolete modes, do the following: IS_SET_DM_DIRECTDRAW | Image display in DirectDraw BackBuffer mode IS_SET_DM_BACKBUFFER IS_SET_DM_DIRECTDRAW | Image display in DirectDraw Overlay Surface mode © 2013 Thorlabs GmbH...
  • Page 325 The memory could not be locked. The pointer to the buffer is invalid. IS_SUCCESS Function executed successfully IS_TIMED_OUT A timeout occurred. An image capturing process could not be terminated within the allowable period. Related functions is_RenderBitmap() is_SetColorMode() is_DirectRenderer() © 2013 Thorlabs GmbH...
  • Page 326 DCx Cameras Example is_SetDisplayMode (hCam, Mode); //Bitmap mode (images are digitized and stored in system memory): Mode = IS_SET_DM_DIB //Direct3D mode Mode = IS_SET_DM_DIRECT3D © 2013 Thorlabs GmbH...

  • Page 327: Is_Setdisplaypos

    Offset in x direction, measured from the top left corner of the output window Offset in y direction, measured from the top left corner of the output window Return values IS_INVALID_CAMERA_HANDLE Invalid camera handle IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_AOI() is_RenderBitmap() is_SetDisplayMode() © 2013 Thorlabs GmbH...

  • Page 328: Is_Seterrorreport

    Or 0 if no camera has been initialized yet Mode IS_DISABLE_ERR_REP Disables error reporting. IS_ENABLE_ERR_REP Enables error reporting. IS_GET_ERR_REP_MODE Current status of error reporting. Return values When used with Current setting IS_GET_ERR_REP_MODE IS_SUCCESS Function executed successfully Related functions is_GetError() is_CaptureStatus() is_CameraStatus() © 2013 Thorlabs GmbH...

  • Page 329: Is_Setexternaltrigger

    Returns the current signal level at the trigger input IS_GET_TRIGGER_STATUS When used with Returns the supported modes linked by logical ORs IS_GET_SUPPORTED_TRIGGER_MODE IS_INVALID_CAPTURE_MODE The function can not be executed in the current camera operating mode (free run, trigger or standby). IS_INVALID_CAMERA_HANDLE Invalid camera handle © 2013 Thorlabs GmbH...
  • Page 330 IS_SET_TRIGGER_SOFTWARE); // Set the flash to a high active pulse for each image in the trigger mode UINT nMode = IO_FLASH_MODE_TRIGGER_HI_ACTIVE; is_IO(m_hCam, IS_IO_CMD_FLASH_SET_MODE, (void*)&nMode, sizeof(nMode)); is_FreezeVideo(hCam, IS_WAIT); Sample programs uc480 Simple Trigger (C++) uc480 IO (C++) © 2013 Thorlabs GmbH...

  • Page 331: Is_Setframerate

    Camera is in standby mode, function not allowed IS_INVALID_PARAMETER One of the submitted parameters is outside the valid range or is not supported for this sensor or is not available in this mode. IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully © 2013 Thorlabs GmbH...
  • Page 332 DCx Cameras Related functions is_GetFramesPerSecond() is_GetFrameTimeRange() is_PixelClock() is_SetOptimalCameraTiming() is_Exposure() is_SetAutoParameter() is_AOI() is_SetSubSampling() is_SetBinning() is_CaptureVideo() © 2013 Thorlabs GmbH...

  • Page 333: Is_Setgainboost

    Returns IS_SET_GAINBOOST_ON if the function is IS_GET_SUPPORTED_GAINBOOST supported, otherwise it returns IS_SET_GAINBOOST_OFF. IS_INVALID_CAMERA_HANDLE Invalid camera handle IS_INVALID_MODE Camera is in standby mode, function not allowed IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_SetHardwareGain() is_SetHWGainFactor() is_SetAutoParameter() © 2013 Thorlabs GmbH...

  • Page 334: Is_Setgamma

    (uc480_usb.sys) do not match. IS_NO_SUCCESS General error message IS_NOT_SUPPORTED The camera model used here does not support this function or setting. IS_SUCCESS Function executed successfully See also: Basics: Characteristics and LUT Basics: Color filter (Bayer filter) Programming: is_SetColorConverter() © 2013 Thorlabs GmbH...

  • Page 335: Is_Sethardwaregain

    Sets the red channel gain factor (0...100). IS_IGNORE_PARAMETER The red channel gain factor will not be changed. nGreen Sets the green channel gain factor (0...100). IS_IGNORE_PARAMETER The green channel gain factor will not be changed. © 2013 Thorlabs GmbH...
  • Page 336 The camera model used here does not support this function or setting. IS_NULL_POINTER Invalid array IS_SUCCESS Function executed successfully IS_TIMED_OUT A timeout occurred. An image capturing process could not be terminated within the allowable period. Related functions is_SetHWGainFactor() is_GetSensorInfo() is_SetGainBoost() is_SetAutoParameter() © 2013 Thorlabs GmbH...

  • Page 337: Is_Sethwgainfactor

    A gain value of 100 means no gain, a gain value of 200 means gain to the double level (factor 2), etc. Return values When used with Current setting IS_GET_MASTER_GAIN_FACTOR IS_GET_RED_GAIN_FACTOR IS_GET_GREEN_GAIN_FACTOR © 2013 Thorlabs GmbH...
  • Page 338 INT ret = is_SetHWGainFactor (hCam, IS_SET_MASTER_GAIN_FACTOR, 357); //ret has the value 363 for the UI-1460-C //Query the maximum gain factor for the red channel: ret = is_SetHWGainFactor (hCam, IS_INQUIRE_RED_GAIN_FACTOR, 100); //ret has the value 725 for the UI-1460-C © 2013 Thorlabs GmbH...

  • Page 339: Is_Setimagemem

    Pointer to the starting position in the memory. ID of this memory. Return values IS_INVALID_CAMERA_HANDLE Invalid camera handle IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_AllocImageMem() is_FreeImageMem() is_AddToSequence() is_SetAllocatedImageMem() is_GetColorDepth() is_GetImageMem() is_GetImageMemPitch() © 2013 Thorlabs GmbH...

  • Page 340: Is_Setoptimalcameratiming

    IS_NOT_SUPPORTED The camera model used here does not support this function or setting. IS_TRIGGER_ACTIVATED The function cannot be used because the camera is waiting for a trigger signal. © 2013 Thorlabs GmbH...
  • Page 341 4 Programming (SDK) Related functions is_PixelClock() is_SetFrameRate() is_SetAutoParameter() is_CaptureVideo() © 2013 Thorlabs GmbH...

  • Page 342: Is_Setropeffect

    IS_NOT_SUPPORTED The camera model used here does not support this function or setting. IS_NULL_POINTER Invalid array IS_SUCCESS Function executed successfully IS_TIMED_OUT A timeout occurred. An image capturing process could not be terminated within the allowable period. © 2013 Thorlabs GmbH...
  • Page 343 4 Programming (SDK) Related functions is_SetBinning() is_SetSubSampling() is_AOI() © 2013 Thorlabs GmbH...

  • Page 344: Is_Setsaturation

    One of the submitted parameters is outside the valid range or is not supported for this sensor or is not available in this mode. IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_SetColorMode() is_SetColorCorrection() is_SetColorConverter() © 2013 Thorlabs GmbH...

  • Page 345: Is_Setsensorscaler

    The camera model used here does not support this function or setting. IS_NULL_POINTER Invalid array IS_SUCCESS Function executed successfully IS_TIMED_OUT A timeout occurred. An image capturing process could not be terminated within the allowable period. Related functions is_GetSensorScalerInfo() © 2013 Thorlabs GmbH...
  • Page 346 SENSORSCALERINFO Info; INT nRet; double dblNewFactor; // Query information on image scaling nRet = is_GetSensorScalerInfo (hCam, &Info, sizeof(Info)); // Enable scaling with anti aliasing dblNewFactor = Info.dblMinFactor + Info.dblFactorIncrement; nRet = is_SetSensorScaler (hCam, IS_ENABLE_SENSOR_SCALER | IS_ENABLE_ANTI_ALIASING, dblNewFactor); © 2013 Thorlabs GmbH...

  • Page 347: Is_Setsensortestimage

    IS_NO_SUCCESS General error message IS_NOT_CALIBRATED The camera does not contain any calibration data. IS_NOT_SUPPORTED The camera model used here does not support this function or setting. IS_NULL_POINTER Invalid array IS_SUCCESS Function executed successfully © 2013 Thorlabs GmbH...
  • Page 348 DCx Cameras IS_TIMED_OUT A timeout occurred. An image capturing process could not be terminated within the allowable period. IS_TRIGGER_ACTIVATED The function cannot be used because the camera is waiting for a trigger signal. Related functions is_GetSupportedTestImages() is_GetTestImageValueRange() © 2013 Thorlabs GmbH...

  • Page 349: Is_Setsubsampling

    Enables horizontal sub-sampling with factor 5. IS_SUBSAMPLING_6X_HORIZONTAL Enables horizontal sub-sampling with factor 6. IS_SUBSAMPLING_8X_HORIZONTAL Enables horizontal sub-sampling with factor 8. IS_SUBSAMPLING_16X_HORIZONTAL Enables horizontal sub-sampling with factor 16. IS_GET_SUBSAMPLING Returns the current setting. IS_GET_SUBSAMPLING_FACTOR_VERTICAL Returns the vertical sub-sampling factor © 2013 Thorlabs GmbH...
  • Page 350 IS_INVALID_PIXEL_CLOCK This setting is not available for the currently set pixel clock frequency. IS_IO_REQUEST_FAILED An IO request from the uc480 driver failed. Possibly the versions of the uc480_api.dll © 2013 Thorlabs GmbH...
  • Page 351 A timeout occurred. An image capturing process could not be terminated within the allowable period. IS_TRIGGER_ACTIVATED The function cannot be used because the camera is waiting for a trigger signal. Related functions is_SetBinning() is_AOI() is_ImageFormat() is_PixelClock() © 2013 Thorlabs GmbH...

  • Page 352: Is_Settimeout

    General error message IS_NOT_SUPPORTED The camera model used here does not support this function or setting. IS_SUCCESS Function executed successfully Related functions is_GetTimeout() is_CaptureVideo() is_FreezeVideo() is_SetExternalTrigger() Example // Set user-defined timeout to 120 seconds is_SetTimeout(hCam, IS_TRIGGER_TIMEOUT, 12000); © 2013 Thorlabs GmbH...

  • Page 353: Is_Settriggercounter

    IS_IO_REQUEST_FAILED An IO request from the uc480 driver failed. Possibly the versions of the uc480_api.dll (API) and the driver file (uc480_usb.sys) do not match. IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_SetExternalTrigger() is_CameraStatus() © 2013 Thorlabs GmbH...

  • Page 354: Is_Settriggerdelay

    IS_IO_REQUEST_FAILED An IO request from the uc480 driver failed. Possibly the versions of the uc480_api.dll (API) and the driver file (uc480_usb.sys) do not match. IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_IO() is_SetExternalTrigger() © 2013 Thorlabs GmbH...

  • Page 355: Is_Stoplivevideo

    IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully IS_TIMED_OUT A timeout occurred. An image capturing process could not be terminated within the allowable period. Related functions is_FreezeVideo() is_CaptureVideo() is_SetDisplayMode() © 2013 Thorlabs GmbH...

  • Page 356: Is_Unlockseqbuf

    One of the submitted parameters is outside the valid range or is not supported for this sensor or is not available in this mode. IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_LockSeqBuf() is_WaitForNextImage() © 2013 Thorlabs GmbH...

  • Page 357: Is_Waitevent

    //Start image capture and wait 1000 ms for event to occur is_FreezeVideo(hCam, IS_DONT_WAIT); INT nRet = is_WaitEvent(hCam, IS_SET_EVENT_FRAME, 1000); (nRet == IS_TIMED_OUT) /* wait timed out */ else if (nRet == IS_SUCCESS) /* event signalled */ is_DisableEvent(hCam, IS_SET_EVENT_FRAME); © 2013 Thorlabs GmbH...

  • Page 358: Is_Waitfornextimage

    A timeout occurred. An image capturing process could not be terminated within the allowable period. IS_CAPTURE_STATUS A transfer error occurred or no image memory was available for saving. The parameter IS_CAPTURE_STATUS replaces the previous parameter IS_TRANSFER_FAILED. © 2013 Thorlabs GmbH...
  • Page 359 Related functions is_InitImageQueue() is_ExitImageQueue() is_UnlockSeqBuf() See also: How to proceed: Image memory sequences How to proceed: Allocating image memory Transfer error: uc480 Viewer Image infos Transfer error: is_GetImageInfo() © 2013 Thorlabs GmbH...

  • Page 360: Is_Writeeeprom

    The camera model used here does not support this function or setting. IS_NULL_POINTER Invalid array IS_SUCCESS Function executed successfully IS_TIMED_OUT A timeout occurred. An image capturing process could not be terminated within the allowable period. Related functions is_ReadEEPROM() © 2013 Thorlabs GmbH...

  • Page 361: Avi Function Descriptions

    AVI ID is invalid or the instance has already been deleted using isavi_ExitAVI() IS_AVI_ERR_COMPRESS The last image compression failed. IS_AVI_ERR_COMPRESSION_RUN The current image could not be processed since compression is still in progress. IS_AVI_ERR_INVALID_FILE The file has no valid AVI format. Related functions isavi_InitAVI() © 2013 Thorlabs GmbH...

  • Page 362: Isavi_Closeavi

    Function executed successfully. IS_AVI_ERR_INVALID_ID The indicated AVI instance could not be found. Either the AVI ID is invalid or the instance has already been deleted using isavi_ExitAVI() IS_AVI_ERR_PARAMETER One of the submitted parameters is outside the valid range. © 2013 Thorlabs GmbH...

  • Page 363: Isavi_Enableevent

    The indicated AVI instance could not be found. Either the AVI ID is invalid or the instance has already been deleted using isavi_ExitAVI() IS_AVI_ERR_PARAMETER One of the submitted parameters is outside the valid range. Related functions isavi_DisableEvent() © 2013 Thorlabs GmbH...

  • Page 364: Isavi_Exitavi

    The indicated AVI instance could not be found. Either the AVI ID is invalid or the instance has already been deleted using isavi_ExitAVI() IS_AVI_ERR_INVALID_FILE The file has no valid AVI format. Related functions isavi_InitAVI() isavi_OpenAVI() isavi_CloseAVI() © 2013 Thorlabs GmbH...

  • Page 365: Isavi_Exitevent

    The indicated AVI instance could not be found. Either the AVI ID is invalid or the instance has already been deleted using isavi_ExitAVI() IS_AVI_ERR_PARAMETER One of the submitted parameters is outside the valid range. Related functions isavi_InitEvent() isavi_EnableEvent() isavi_DisableEvent() © 2013 Thorlabs GmbH...

  • Page 366: Isavi_Getavifilename

    When NULL is passed the function returns the length of the filename. Return values IS_AVI_NO_ERR Function executed successfully. IS_AVI_ERR_INVALID_ID The indicated AVI instance could not be found. Either the AVI ID is invalid or the instance has already been deleted using isavi_ExitAVI() Related functions isavi_GetAVISize() isavi_OpenAVI() © 2013 Thorlabs GmbH...

  • Page 367: Isavi_Getavifilenamew

    When NULL is passed the function returns the length of the filename. Return values IS_AVI_NO_ERR Function executed successfully. IS_AVI_ERR_INVALID_ID The indicated AVI instance could not be found. Either the AVI ID is invalid or the instance has already been deleted using isavi_ExitAVI() Related functions isavi_GetAVISize() isavi_OpenAVIW() © 2013 Thorlabs GmbH...

  • Page 368: Isavi_Getavisize

    The size in kBytes Return values IS_AVI_NO_ERR Function executed successfully. IS_AVI_ERR_INVALID_ID The indicated AVI instance could not be found. Either the AVI ID is invalid or the instance has already been deleted using isavi_ExitAVI() Related functions isavi_GetAVIFileName() © 2013 Thorlabs GmbH...

  • Page 369: Isavi_Getncompressedframes

    The number of frames Return values IS_AVI_NO_ERR Function executed successfully. IS_AVI_ERR_INVALID_ID The indicated AVI instance could not be found. Either the AVI ID is invalid or the instance has already been deleted using isavi_ExitAVI() Related functions isavi_GetnLostFrames() isavi_ResetFrameCounters() © 2013 Thorlabs GmbH...

  • Page 370: Isavi_Getnlostframes

    The number of frames Return values IS_AVI_NO_ERR Function executed successfully. IS_AVI_ERR_INVALID_ID The indicated AVI instance could not be found. Either the AVI ID is invalid or the instance has already been deleted using isavi_ExitAVI() Related functions isavi_GetnCompressedFrames() isavi_ResetFrameCounters() © 2013 Thorlabs GmbH...

  • Page 371: Isavi_Initavi

    One of the submitted parameters is outside the valid range. IS_AVI_ERR_NO_CODEC_AVAIL The maximum number of instances allowed in this system has been reached. It is not possible to create another instance. IS_AVI_ERR_INVALID_UEYE No DCx camera was found. Related functions isavi_ExitAVI() isavi_OpenAVI() isavi_CloseAVI() © 2013 Thorlabs GmbH...

  • Page 372: Isavi_Initevent

    HANDLE hEvent = CreateEvent( NULL, TRUE, FALSE, "" ( hEvent != NULL ) isavi_InitEvent( AviDest, hEvent, IS_AVI_SET_EVENT_FRAME_SAVED ); isavi_EnableEvent( AviDest, IS_AVI_SET_EVENT_FRAME_SAVED ); ( WaitForSingleObject( hEvent, 1000 ) == WAIT_OBJECT_0 ) //Frame was captured successfully... isavi_DisableEvent( AviDest, IS_AVI_SET_EVENT_FRAME_SAVED ); isavi_ExitEvent( AviDest, IS_AVI_SET_EVENT_FRAME_SAVED ); © 2013 Thorlabs GmbH...

  • Page 373: Isavi_Openavi

    Another capturing operation is in progress or an AVI file is still open. IS_AVI_ERR_INVALID_FILE The file has no valid AVI format. IS_AVI_ERR_NEW_FAILED No memory could be allocated for the AVI file. IS_AVI_ERR_CREATESTREAM No AVI stream could be created. Related functions isavi_GetAVIFileName() isavi_CloseAVI() isavi_InitAVI() isavi_ExitAVI() © 2013 Thorlabs GmbH...

  • Page 374: Isavi_Openaviw

    Another capturing operation is in progress or an AVI file is still open. IS_AVI_ERR_INVALID_FILE The file has no valid AVI format. IS_AVI_ERR_NEW_FAILED No memory could be allocated for the AVI file. IS_AVI_ERR_CREATESTREAM No AVI stream could be created. Related functions isavi_GetAVIFileNameW() isavi_CloseAVI() isavi_InitAVI() isavi_ExitAVI() © 2013 Thorlabs GmbH...

  • Page 375: Isavi_Resetframecounters

    Return values IS_AVI_NO_ERR Function executed successfully. IS_AVI_ERR_INVALID_ID The indicated AVI instance could not be found. Either the AVI ID is invalid or the instance has already been deleted using isavi_ExitAVI() Related functions isavi_GetnCompressedFrames() isavi_GetnLostFrames() © 2013 Thorlabs GmbH...

  • Page 376: Isavi_Setframerate

    The indicated AVI instance could not be found. Either the AVI ID is invalid or the instance has already been deleted using isavi_ExitAVI() IS_AVI_ERR_WRITE_INFO The AVI file could not be modified. IS_AVI_ERR_INVALID_FILE The file has no valid AVI format. Related functions isavi_SetImageQuality() isavi_SetImageSize() © 2013 Thorlabs GmbH...

  • Page 377: Isavi_Setimagequality

    The indicated AVI instance could not be found. Either the AVI ID is invalid or the instance has already been deleted using isavi_ExitAVI() IS_AVI_ERR_INVALID_VALUE The q parameter is outside the range of 1…100. IS_AVI_ERR_INVALID_FILE The file has no valid AVI format. Related functions isavi_SetFrameRate() isavi_SetImageSize() © 2013 Thorlabs GmbH...

  • Page 378: Isavi_Setimagesize

    Another capturing operation is in progress or an AVI file is still open. IS_AVI_ERR_ALLOC_MEMORY No memory could be allocated. IS_AVI_ERR_INVALID_CM The submitted color mode is not supported for AVI capturing. IS_AVI_ERR_INVALID_SIZE The submitted size is invalid. IS_AVI_ERR_INVALID_POSITION The submitted position is invalid. Related functions isavi_SetFrameRate() isavi_SetImageQuality() © 2013 Thorlabs GmbH...

  • Page 379: Isavi_Startavi

    The indicated AVI instance could not be found. Either the AVI ID is invalid or the instance has already been deleted using isavi_ExitAVI() IS_AVI_ERR_INVALID_FILE The file has no valid AVI format. IS_AVI_ERR_PLAY_RUNNING A playback is already running. Related functions isavi_StopAVI() isavi_InitEvent() isavi_ExitAVI() © 2013 Thorlabs GmbH...

  • Page 380: Isavi_Stopavi

    The indicated AVI instance could not be found. Either the AVI ID is invalid or the instance has already been deleted using isavi_ExitAVI() IS_AVI_ERR_INVALID_FILE The file has no valid AVI format. IS_AVI_ERR_PLAY_NOT_RUNNING No playback is running. Related functions isavi_StartAVI() isavi_InitEvent() isavi_ExitAVI() © 2013 Thorlabs GmbH...

  • Page 381: Obsolete Functions

    The uc480 memory board is not supported any 3.30 longer. is_ReleaseDC() is_DirectRenderer() is_ResetCaptureErrorInfo() is_CaptureStatus() is_ResetMemory() The uc480 memory board is not supported any 3.30 longer. is_SaveBadPixelCorrectionTable() is_HotPixel() © 2013 Thorlabs GmbH...
  • Page 382 The uc480 memory board is not supported any 3.30 longer. is_PixelClock() is_SetPixelClock() is_SetWhiteBalance() 3.31 is_SetAutoParameter() is_SetWhiteBalanceMultipliers() is_ShowDDOverlay() is_DirectRenderer() is_StealVideo() is_TransferImage() The uc480 memory board is not supported any 3.30 longer. is_TransferMemorySequence() is_UnlockDDMem() is_UnlockDDOverlayMem() is_DirectRenderer() is_UpdateDisplay() Attention © 2013 Thorlabs GmbH...
  • Page 383 4 Programming (SDK) The is_SetWhiteBalance() and is_SetWhiteBalanceMultipliers() functions have been completely replaced by the function and are no longer supported by the uc480 API. is_SetAutoParameter() © 2013 Thorlabs GmbH...

  • Page 384: Is_Convertimage

    (API) and the driver file (uc480_usb.sys) do not match. IS_NO_SUCCESS General error message IS_OUT_OF_MEMORY No memory could be allocated. IS_SEQUENCE_BUF_ALREADY_LOCKED The memory could not be locked. The pointer to the buffer is invalid. IS_SUCCESS Function executed successfully © 2013 Thorlabs GmbH...

  • Page 385: Is_Disableddoverlay

    In DirectDraw BackBuffer mode, is_DisableDDOverlay() disables overlay mode and releases the memory allocated to the overlay. This results in discarding of the overlay data. Input parameters hCam Camera handle Return values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related functions is_EnableDDOverlay() is_HideDDOverlay() is_SetDisplayMode() is_ShowDDOverlay() is_GetDDOvlSurface() © 2013 Thorlabs GmbH...

  • Page 386: Is_Enableddoverlay

    Input parameters hCam Camera handle Return values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related functions is_SetDisplayMode() is_DisableDDOverlay() is_ShowDDOverlay() is_HideDDOverlay() is_GetDDOvlSurface() © 2013 Thorlabs GmbH...

  • Page 387: Is_Getcameratype

    This function is obsolete and should not be used anymore. We recommend to use the is_GetCameraInfo() function instead (see also Obsolete functions Input parameters hCam Camera handle Return values IS_CAMERA_TYPE_UEYE_USB_SE DCU223x, DCU224x and DCC1240xUSB camera IS_CAMERA_TYPE_UEYE_USB_LE DCC1545M / DCC1645CUSB camera IS_CAMERA_TYPE_UEYE_USB3_CP DCC3240x camera © 2013 Thorlabs GmbH...

  • Page 388: Is_Getcaptureerrorinfo

    The camera is no longer available. It is not possible to access images that have already been transferred. IS_CAPERR_USB_TRANSFER_FAILED The image was not transferred over the USB bus. 6 IS_CAPERR_DEV_TIMEOUT The maximum allowable time for image capturing in the camera was exceeded. © 2013 Thorlabs GmbH...
  • Page 389 Increase the value for the receive descriptors in transfer the image the network card settings Return values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related functions is_ResetCaptureErrorInfo() is_GetError() is_CameraStatus() is_SetErrorReport() See also: Troubleshooting © 2013 Thorlabs GmbH...

  • Page 390: Is_Getdc

    Input parameters hCam Camera handle phDC Pointer to the variable that is supposed to contain the device context handle Return values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related functions is_ReleaseDC() is_ShowDDOverlay() is_DisableDDOverlay() is_EnableDDOverlay() is_GetDDOvlSurface() is_SetDisplayMode() © 2013 Thorlabs GmbH...

  • Page 391: Is_Getddovlsurface

    Thus, the functionality provided by the DirectDraw Surface interface can be used. Input parameters hCam Camera handle ppDDSurf Contains the pointer to the DirectDraw Surface interface Return values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related functions is_SetDisplayMode() is_DisableDDOverlay() is_EnableDDOverlay() is_ShowDDOverlay() is_HideDDOverlay() © 2013 Thorlabs GmbH...

  • Page 392: Is_Getexposurerange

    Returns the maximum available exposure time. intervall Returns the increment you can use to change the image exposure time. Return values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related functions is_SetExposureTime() is_PixelClock() is_GetFrameTimeRange() is_GetFramesPerSecond() is_SetFrameRate() © 2013 Thorlabs GmbH...

  • Page 393: Is_Getglobalflashdelays

    Pointer to the variable that returns the flash delay in µs. pulDuration Pointer to the variable that returns the flash duration in µs. Return values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related functions is_SetFlashStrobe() is_SetFlashDelay() is_SetTriggerDelay() © 2013 Thorlabs GmbH...

  • Page 394: Is_Getpixelclockrange

    Input parameters hCam Camera handle pnMin Returns the lower limit value. pnMax Returns the upper limit value. Return values IS_INVALID_CAMERA_HANDLE Invalid camera handle IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_PixelClock() is_GetFramesPerSecond() is_GetFrameTimeRange() is_Exposure() © 2013 Thorlabs GmbH...

  • Page 395: Is_Hideddoverlay

    This way, the frame rate is higher on some systems than with the overlay shown. By hiding the overlay, its data is not lost. Input parameters hCam Camera handle Return values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related functions is_ShowDDOverlay() is_DisableDDOverlay() is_EnableDDOverlay() is_GetDDOvlSurface() is_SetDisplayMode() © 2013 Thorlabs GmbH...

  • Page 396: Is_Loadbadpixelcorrectiontable

    Pointer to a string which contains the name of the file where the coordinates are stored. You can either pass an absolute or a relative path. If NULL is passed, the "Open File" dialog opens. Return values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related functions is_SaveBadPixelCorrectionTable() is_SetBadPixelCorrection() is_SetBadPixelCorrectionTable() © 2013 Thorlabs GmbH...

  • Page 397: Is_Loadimage

    IS_NO_SUCCESS General error message IS_NOT_SUPPORTED The camera model used here does not support this function or setting. IS_SUCCESS Function executed successfully Related functions Is_ImageFile() is_GetImageMem() is_SetImageMem() © 2013 Thorlabs GmbH...

  • Page 398: Is_Loadimagemem

    The camera model used here does not support this function or setting. IS_OUT_OF_MEMORY No memory could be allocated. IS_SEQUENCE_BUF_ALREADY_LOCKED The memory could not be locked. The pointer to the buffer is invalid. IS_SUCCESS Function executed successfully Related functions © 2013 Thorlabs GmbH...
  • Page 399 4 Programming (SDK) is_ImageFile() is_GetImageMem() is_SetImageMem() © 2013 Thorlabs GmbH...

  • Page 400: Is_Loadparameters

    IS_FILE_WRITE_OPEN_ERROR File cannot be opened for writing or reading. IS_INVALID_CAMERA_TYPE The camera type defined in the .ini file does not match the current camera model. IS_INVALID_CAPTURE_MODE The function can not be executed in the current camera © 2013 Thorlabs GmbH...
  • Page 401 The memory could not be locked. The pointer to the buffer is invalid. IS_SUCCESS Function executed successfully IS_TIMED_OUT A timeout occurred. An image capturing process could not be terminated within the allowable period. Related functions is_ParameterSet() © 2013 Thorlabs GmbH...

  • Page 402: Is_Lockddmem

    Pointer to the variable that holds the address pointer pPitch Pointer to the variable that holds the pitch value Return values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related functions is_UnlockDDMem() is_LockDDOverlayMem() is_UnlockDDOverlayMem() is_LockSeqBuf() is_UnlockSeqBuf() is_UpdateDisplay() © 2013 Thorlabs GmbH...

  • Page 403: Is_Lockddoverlaymem

    Pointer to the variable that holds the address pointer pPitch Pointer to the variable that holds the pitch value Return values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related functions is_UnlockDDOverlayMem() is_LockDDMem() is_UnlockDDMem() is_LockSeqBuf() is_UnlockSeqBuf() © 2013 Thorlabs GmbH...

  • Page 404: Is_Preparestealvideo

    This option displays the frame with DirectDraw and copies it to the currently active image memory. Input parameters hCam Camera handle Mode IS_SET_STEAL_NORMAL Normal mode IS_SET_STEAL_COPY Copy mode StealColorMode reserved Return values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related functions is_StealVideo() is_SetDisplayMode() is_AllocImageMem() is_SetImageMem() © 2013 Thorlabs GmbH...

  • Page 405: Is_Releasedc

    Input parameters hCam Camera handle Device context handle returned by is_GetDC() Return values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related functions is_GetDC() is_ShowDDOverlay() is_DisableDDOverlay() is_EnableDDOverlay() is_GetDDOvlSurface() is_SetDisplayMode() © 2013 Thorlabs GmbH...

  • Page 406: Is_Resetcaptureerrorinfo

    You can retrieve this list using the function. is_GetCaptureErrorInfo() Input parameters hCam Camera handle Return values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related functions is_GetCaptureErrorInfo() is_GetError() is_CameraStatus() © 2013 Thorlabs GmbH...

  • Page 407: Is_Savebadpixelcorrectiontable

    You can either pass an absolute or a relative path. If NULL is passed, the "Save as" dialog will be displayed. Return values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related functions is_LoadBadPixelCorrectionTable() is_SetBadPixelCorrection() is_SetBadPixelCorrectionTable() © 2013 Thorlabs GmbH...

  • Page 408: Is_Saveimage

    The camera model used here does not support this function or setting. IS_OUT_OF_MEMORY No memory could be allocated. IS_SEQUENCE_BUF_ALREADY_LOCKED The memory could not be locked. The pointer to the buffer is invalid. IS_SUCCESS Function executed successfully Related functions is_ImageFile() is_GetImageMem() is_SetImageMem() © 2013 Thorlabs GmbH...

  • Page 409: Is_Saveimageex

    The camera model used here does not support this function or setting. IS_OUT_OF_MEMORY No memory could be allocated. IS_SEQUENCE_BUF_ALREADY_LOCKED The memory could not be locked. The pointer to the buffer is invalid. IS_SUCCESS Function executed successfully © 2013 Thorlabs GmbH...
  • Page 410 DCx Cameras Related functions is_ImageFile() is_GetImageMem() is_SetImageMem() © 2013 Thorlabs GmbH...

  • Page 411: Is_Saveimagemem

    The camera model used here does not support this function or setting. IS_OUT_OF_MEMORY No memory could be allocated. IS_SEQUENCE_BUF_ALREADY_LOCKED The memory could not be locked. The pointer to the buffer is invalid. IS_SUCCESS Function executed successfully Related functions is_ImageFile() is_GetImageMem() is_SetImageMem() © 2013 Thorlabs GmbH...

  • Page 412: Is_Saveimagememex

    When you use IS_IMG_JPG or IS_IMG_PNG to specify the file format, you can set the quality by specifying a value between 1 and 100 for Param. If Param=0, the system uses the default quality (75). If you use IS_IMG_BMP, Param does not take effect. © 2013 Thorlabs GmbH...
  • Page 413 The camera model used here does not support this function or setting. IS_OUT_OF_MEMORY No memory could be allocated. IS_SEQUENCE_BUF_ALREADY_LOCKED The memory could not be locked. The pointer to the buffer is invalid. IS_SUCCESS Function executed successfully Related functions is_ImageFile() is_GetImageMem() is_SetImageMem() © 2013 Thorlabs GmbH...

  • Page 414: Is_Saveparameters

    IS_NOT_SUPPORTED The camera model used here does not support this function or setting. IS_NULL_POINTER Invalid array IS_SUCCESS Function executed successfully IS_TIMED_OUT A timeout occurred. An image capturing process could not be terminated within the allowable period. © 2013 Thorlabs GmbH...
  • Page 415 4 Programming (SDK) Related functions is_ParameterSet() is_CameraStatus() © 2013 Thorlabs GmbH...

  • Page 416: Is_Setaoi

    Returns the current setting when used together with the IS_GET_… parameters. 0...XPosMax Applies the absolute position to the memory as well. | IS_SET_IMAGEPOS_X_ABS pYPos Pointer to the vertical position of the AOI Returns the current setting when used together with the IS_GET_… parameters. © 2013 Thorlabs GmbH...
  • Page 417 IS_GET_… parameters. pHeight Pointer to the height of the AOI Returns the current setting when used together with the IS_GET_…. parameters. Return values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related functions is_SetImagePos() is_SetBinning() is_SetSubSampling() is_SetAutoParameter() © 2013 Thorlabs GmbH...
  • Page 418 DCx Cameras Example © 2013 Thorlabs GmbH...

  • Page 419: Is_Setbadpixelcorrection

    Returns the current threshold value. threshold Currently not used Return values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message When used with Current mode IS_GET_BPC_MODE When used with Current threshold value IS_GET_BPC_THRESHOLD Related functions is_LoadBadPixelCorrectionTable() is_SaveBadPixelCorrectionTable() is_SetBadPixelCorrectionTable() © 2013 Thorlabs GmbH...

  • Page 420: Is_Setbadpixelcorrectiontable

    Return values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message When used with Number of coordinates in the list IS_GET_LIST_SIZE If the list contains no coordinates, the return value is -1. Related functions is_LoadBadPixelCorrectionTable() is_SaveBadPixelCorrectionTable() is_SetBadPixelCorrection() © 2013 Thorlabs GmbH...
  • Page 421 (nCount > 0) // Allocate memory for the entire list pList = WORD[1 * nCount]; // Read out list is_SetBadPixelCorrectionTable (hCam, IS_GET_BADPIXEL_LIST, pList); // Release the list again delete [] pList; else // No hot pixel list programmed © 2013 Thorlabs GmbH...

  • Page 422: Is_Setbayerconversion

    IS_SET_BAYER_CV_BEST Best quality and edge acuity, higher computational load IS_GET_BAYER_CV_MODE Returns the current setting. Return values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message When used with Current setting IS_GET_BAYER_CV_MODE Related functions is_SetColorConverter() is_SetColorMode() is_SetColorCorrection() © 2013 Thorlabs GmbH...

  • Page 423: Is_Setblcompensation

    For the sensor used, it is also possible to set the offset manual. IS_IGNORE_PARAMETER The nEnable parameter is ignored. offset Contains the offset value used for compensation. Valid values are between 0 and 255. IS_IGNORE_PARAMETER The offset parameter is ignored. reserved Reserved. 0 must be passed. © 2013 Thorlabs GmbH...
  • Page 424 IS_NOT_SUPPORTED The camera model used here does not support this function or setting. IS_NULL_POINTER Invalid array IS_SUCCESS Function executed successfully IS_TIMED_OUT A timeout occurred. An image capturing process could not be terminated within the allowable period. © 2013 Thorlabs GmbH...

  • Page 425: Is_Setconvertparam

    One of the submitted parameters is outside the valid range or is not supported for this sensor or is not available in this mode. IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_ConvertImage() is_SetColorMode() is_SetColorConverter() © 2013 Thorlabs GmbH...
  • Page 426 = is_SetConvertParam(hCam, TRUE, IS_SET_BAYER_CV_BETTER, IS_CM_RGB8_PACKED, Gamma, rgbGains); // Convert image (nRet == IS_SUCCESS) pcDest = NULL; is_ConvertImage(hCam, pcSource, nIDSource, &pcDest, &nIDDest, 0); // Release allocated image memory is_FreeImageMem (hCam, pcSource, nIDSource); is_FreeImageMem (hCam, pcDest, nIDDest); © 2013 Thorlabs GmbH...

  • Page 427: Is_Setddupdatetime

    DirectDraw BackBuffer mode. Input parameters hCam Camera handle Time in milliseconds. Valid range: 20...2000 ms Return values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related functions is_SetDisplayMode() is_UpdateDisplay() © 2013 Thorlabs GmbH...

  • Page 428: Is_Setedgeenhancement

    One of the submitted parameters is outside the valid range or is not supported for this sensor or is not available in this mode. IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_SetColorMode() is_SetColorConverter() © 2013 Thorlabs GmbH...

  • Page 429: Is_Setexposuretime

    You can avoid this behavior by additionally adding or subtracting the value INCREMENT/2.f (half intervall) when calculating with n*INCREMENT. This ensures that the desired value will be set even after rounding. © 2013 Thorlabs GmbH...
  • Page 430 Returns the queried value (e. g. current exposure time) Return values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message IS_NOT_SUPPORTED The camera model used here does not support this function or setting. Related functions is_SetFrameRate() is_Exposure() is_PixelClock() is_SetOptimalCameraTiming() is_SetAutoParameter() © 2013 Thorlabs GmbH...

  • Page 431: Is_Setflashdelay

    If 0 is passed, the flash output will be active until the end of the exposure time. For sensors with Global Start Shutter this is the time until the end of exposure of the last sensor row © 2013 Thorlabs GmbH...
  • Page 432 DCx Cameras Return values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message When used with Current setting IS_GET_FLASH_DELAY IS_GET_FLASH_DURATION Related functions is_IO() is_SetExternalTrigger() is_SetTriggerDelay() © 2013 Thorlabs GmbH...

  • Page 433: Is_Setflashstrobe

    Additionally enables the flash strobe via the first general purpose I/O (GPIO 1) if supported by the camera model. IS_SET_FLASH_IO_2 Additionally enables the flash strobe via the second general purpose I/O (GPIO 2) if supported by the © 2013 Thorlabs GmbH...
  • Page 434 (hCam, IS_WAIT); // Flash additionally on second GPIO output is_SetFlashStrobe (hCam, IS_SET_FLASH_HI_ACTIVE | IS_SET_FLASH_IO_2, 0); // Flash only on normal flash output is_SetFlashStrobe (hCam, IS_SET_FLASH_HI_ACTIVE, 0); Sample programs uc480 Flash Strobe (C++) uc480 IO (C++) © 2013 Thorlabs GmbH...

  • Page 435: Is_Sethwnd

    DirectDraw mode. The new handle and the image output will only be effective when is called for the next time. is_SetDisplayMode() Input parameters hCam Camera handle hwnd Window handle Return values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related functions is_SetDisplayMode() © 2013 Thorlabs GmbH...

  • Page 436: Is_Setimageaoi

    Y position of the upper left corner. width Image width height Image height Return values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message IS_INVALID_MODE Camera is in standby mode, function not allowed Related functions is_AOI() is_SetBinning() is_SetSubSampling() © 2013 Thorlabs GmbH...

  • Page 437: Is_Setimagepos

    Returns the minimum value for the vertical AOI position. IS_GET_IMAGE_POS_Y_MAX Returns the maximum value for the vertical AOI position. IS_GET_IMAGE_POS_Y_INC Returns the increment for the vertical AOI position. IS_GET_IMAGE_POS_Y_ABS Returns the absolute vertical position in the memory. © 2013 Thorlabs GmbH...
  • Page 438 One of the submitted parameters is outside the valid range or is not supported for this sensor or is not available in this mode. When used with Current setting IS_GET_IMAGE_POS parameters IS_INVALID_MODE Camera is in standby mode, function not allowed Related functions is_AOI() is_ImageFormat() © 2013 Thorlabs GmbH...
  • Page 439 4 Programming (SDK) Example Examples for is_SetImagePos © 2013 Thorlabs GmbH...

  • Page 440: Is_Setimagesize

    IS_GET_IMAGE_SIZE_Y Returns the current image height. IS_GET_IMAGE_SIZE_Y_MIN Returns the minimum AOI image height IS_GET_IMAGE_SIZE_Y_MAX Returns the maximum AOI image height IS_GET_IMAGE_SIZE_Y_INC Returns the increment for the AOI image height 1...yMax Sets the image height Return settings © 2013 Thorlabs GmbH...
  • Page 441 4 Programming (SDK) Return values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message When used with Current setting IS_GET_IMAGE_SIZE parameters IS_INVALID_MODE Camera is in standby mode, function not allowed Related functions is_AOI() © 2013 Thorlabs GmbH...

  • Page 442: Is_Setio

    Reads the states of the GPIOs. If a GPIO is configured as input this reads the signal applied to the GPIO. Return values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message When used with Current setting IS_GET_IO Related functions is_SetIOMask() is_GetImageInfo() is_SetFlashStrobe() is_SetExternalTrigger() © 2013 Thorlabs GmbH...

  • Page 443: Is_Setiomask

    Returns the IOs to be used as outputs. Return values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Wen used with Current setting IS_GET_IO When used with Bit masks of the IOs to be used. IS_GET_INPUT_MASK IS_GET_OUTPUT_MASK Related functions is_SetIO() is_GetImageInfo() is_SetFlashStrobe() is_SetExternalTrigger() © 2013 Thorlabs GmbH...

  • Page 444: Is_Setkeycolor

    Green content of the key color (0...255). Blue content of the key color (0...255). Return values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message When used with Color value IS_GET_KC_RGB IS_GET_KC_RED IS_GET_KC_GREEN IS_GET_KC_BLUE Related functions is_SetDisplayMode() is_ShowDDOverlay() is_HideDDOverlay() is_DisableDDOverlay() is_EnableDDOverlay() is_GetDDOvlSurface() is_SetColorMode() © 2013 Thorlabs GmbH...

  • Page 445: Is_Setled

    Input parameters hCam Camera handle nValue IS_SET_LED_OFF Switches LED to red. IS_SET_LED_ON Switches LED to green. IS_SET_LED_TOGGLE Toggles between red and green. Return values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related functions is_IO() is_SetExternalTrigger() © 2013 Thorlabs GmbH...

  • Page 446: Is_Setpixelclock

    One of the submitted parameters is outside the valid range or is not supported for this sensor or is not available in this mode. IS_IO_REQUEST_FAILED An IO request from the uc480 driver failed. Possibly the versions of the uc480_api.dll (API) and the driver file © 2013 Thorlabs GmbH...
  • Page 447 The camera model used here does not support this function or setting. IS_NULL_POINTER Invalid array IS_SUCCESS Function executed successfully IS_TIMED_OUT A timeout occurred. An image capturing process could not be terminated within the allowable period. Related functions is_SetOptimalCameraTiming() is_SetFrameRate() is_Exposure() is_SetAutoParameter() is_SetBinning() is_SetSubSampling() is_AOI() © 2013 Thorlabs GmbH...

  • Page 448: Is_Showddoverlay

    With some graphics cards, overlay display may reduce the frame rate. Input parameters hCam Camera handle Return values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related functions is_HideDDOverlay() is_DisableDDOverlay() is_EnableDDOverlay() is_GetDDOvlSurface() is_SetDisplayMode() © 2013 Thorlabs GmbH...

  • Page 449: Is_Stealvideo

    Camera handle Wait IS_WAIT The function waits until the image save is complete. IS_DONT_WAIT The function returns immediately. Return values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related functions is_PrepareStealVideo() is_SetDisplayMode() is_SetColorMode() is_AllocImageMem() is_SetImageMem() is_SetAllocatedImageMem() © 2013 Thorlabs GmbH...

  • Page 450: Is_Unlockddmem

    Using is_UnlockDDMem(), you can unlock the image memory in the DirectDraw modes. This results in a refresh of the BackBuffer contents on the screen. Input parameters hCam Camera handle Return values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related functions is_LockDDMem() is_LockDDOverlayMem() is_UnlockDDOverlayMem() is_LockSeqBuf() is_UnlockSeqBuf() is_UpdateDisplay() © 2013 Thorlabs GmbH...

  • Page 451: Is_Unlockddoverlaymem

    Input parameters hCam Camera handle Return values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related functions is_LockDDOverlayMem() is_UnlockDDOverlayMem() is_LockDDMem() is_UnlockDDMem() is_LockSeqBuf() is_UnlockSeqBuf() is_UpdateDisplay() © 2013 Thorlabs GmbH...

  • Page 452: Is_Updatedisplay

    There may be cases, however, where a manual update of the screen output is necessary. Input parameters hCam Camera handle Return values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related functions is_SetDisplayMode() is_LockDDOverlayMem() is_UnlockDDOverlayMem() is_LockDDMem() is_UnlockDDMem() © 2013 Thorlabs GmbH...

  • Page 453: Programming Notes

    The uc480.h header file The uc480.h header file contains all the definitions and constants needed for the uc480 API. After the installation of the uc480 drivers you will find this file in the directory: Windows: C:\Program Files\Thorlabs\DCx Cameras\Develop\include Linux: /usr/include Note Note on older functions If it is necessary to continue working with the older functions, it is possible to add the uc480_deprecated.h...

  • Page 454: Programming In C

    We suggest that you keep the function libraries (DLL, AX and OCX files) in the default directory. After the installation, these files reside e.g. under Window (32 bit) in C:\Windows\System32\. Copying these files to other locations may result in version conflicts. © 2013 Thorlabs GmbH...

  • Page 455: Programming With Activex

    (e.g. in console applications). In this case you will need to implement the message loop yourself. This applies to the following uc480 events: IS_SET_EVENT_REMOVED IS_SET_EVENT_REMOVAL IS_SET_EVENT_DEVICE_RECONNECTED IS_SET_EVENT_NEW_DEVICE If no message loop exists, a USB camera will not be automatically detected after reconnecting. © 2013 Thorlabs GmbH...

  • Page 456: Lists

    The board ID is invalid. Valid IDs range from 1 through 255. IS_ALL_DEVICES_BUSY All cameras are in use. IS_TIMED_OUT A timeout occurred. An image capturing process could not be terminated within the allowable period. IS_NULL_POINTER Invalid array © 2013 Thorlabs GmbH...
  • Page 457 The back buffer timer could not be created. IS_BB_OVL_NOT_EN The back buffer overlay was not enabled. IS_ONLY_IN_BB_MODE Only possible in BackBuffer mode. IS_INVALID_COLOR_FORMAT Invalid color format IS_INVALID_WB_BINNING_MODE Mono binning/mono sub-sampling do not support automatic white balance. © 2013 Thorlabs GmbH...
  • Page 458 PC network card. IS_NETWORK_CONFIGURATION_INVALID The configuration of the network card is invalid. IS_ERROR_CPU_IDLE_STATES_CONFIGURATION The configuration of the CPU idle has failed. IS_DEVICE_BUSY The camera is busy ad cannot transfer the requested image. © 2013 Thorlabs GmbH...

  • Page 459: Error Codes Of Avi Functions

    The event could not be initialized. The Windows SetEvent function failed. 4.7.3 Linux: Not Supported Functions The following uc480 API functions are not supported by the Linux driver version 4.20 and older: is_DirectRenderer() is_GetColorDepth() is_GetDC() is_ReleaseDC() is_RenderBitmap() is_SetDisplayMode() is_SetDisplayPos() is_SetHwnd() is_SetOptimalCameraTiming() is_UpdateDisplay() © 2013 Thorlabs GmbH...

  • Page 460: Specifications

    DCx Cameras 5 Specifications This chapter lists the specifications of the available DCx camera models. Model comparison Camera and sensor data Mechanical specifications Electrical specifications Accessories © 2013 Thorlabs GmbH...

  • Page 461: Model Comparison

    Software Software Hardware Color calculation Software Software Software Hardware Hardware: Dig. Subsampling/Binning Bit depth: Internal/ 16/16 transferred LUT: Internal/ transferred 12/12 Max. pixel clock (MHz) at full resolution Max. data rate (MBytes/s) *) with supplied adapter © 2013 Thorlabs GmbH...

  • Page 462: Model Naming Conventions

    Cameras with CCD sensors DCU223x DCU224x Note: The diagrams shown in the sensor specifications section indicate the relative sensitivities of the DCx Cameras in the spectral range. Therefore, the characteristic curves cannot be compared to each other. © 2013 Thorlabs GmbH...

  • Page 463: Dcc1240X / Dcc3240X

    4 to 1024, 2 4 to 1024, 2 AOI position grid horizontal, vertical Pixels 2, 2 2, 2 AOI frame rate, 640 x 480 pixels 52.0 123.0 (VGA) AOI frame rate, 320 x 240 pixels 98.0 229.0 (CIF) © 2013 Thorlabs GmbH...
  • Page 464 The power consumption depends on the sensor model and the pixel clock setting. Not yet confirmed DCC3240N only Only for USB3.0 transmission (DCC3240x), with USB2.0 - bit depth is 8 bit. Please see also the DCC1240x / DCC3240x Application Notes chapter. © 2013 Thorlabs GmbH...
  • Page 465 5 Specifications Relative sensor sensitivity Sensor sensitivity of the DCC1240M (monochrome) / DCC3240x (monochrome and NIR) Sensor sensitivity of the DCC1240C / DCC3240C © 2013 Thorlabs GmbH...

  • Page 466: Dcc1545M

    Frame rate w/ 2x subsampling, 640 x 480 pixels Frame rate w/ 4x subsampling, 320 x 240 pixels Hardware trigger Mode Asynchronous Trigger delay with rising edge µs 22.0 ±0.25 Trigger delay with falling edge µs 40.3 ±0.25 © 2013 Thorlabs GmbH...
  • Page 467 Use of this function increases the frame rate. The power consumption depends on the sensor model and the pixel clock setting. Please see also the DCC1545M Application Notes chapter. Relative sensor sensitivity Sensor sensitivity of the DCC1545M (monochrome) © 2013 Thorlabs GmbH...

  • Page 468: Dcc1645C

    Subsampling Mode Horizontal + Vertical Method H + V: Color subsampling Factor 2x, 4x Frame rate w/ 2x subsampling, 640 x 480 pixels Frame rate w/ 4x subsampling, 320 x 240 pixels Hardware trigger Mode Asynchronous © 2013 Thorlabs GmbH...
  • Page 469 Use of this function increases the frame rate. The power consumption depends on the sensor model and the pixel clock setting. Please see also the DCC1645C Application Notes chapter. Relative sensor sensitivity Sensor sensitivity of the DCC1645C © 2013 Thorlabs GmbH...

  • Page 470: Dcu223X

    Color: AOI position grid horizontal, Pixels 2, 2 vertical AOI frame rate, 800 x 600 pixels (SVGA) AOI frame rate, 640 x 480 pixels (VGA) AOI frame rate, 320 x 240 pixels (CIF) Binning Mode Vertical © 2013 Thorlabs GmbH...
  • Page 471 Requires minimum pixel clock frequency. Use of this function increases the frame rate. The power consumption depends on the sensor model and the pixel clock setting. Please see also the DCU223x Application Notes chapter. Relative sensor sensitivity Sensor sensitivity of the DCU223M (monochrome) Sensor sensitivity of the DCU223C (Color) ©...

  • Page 472: Dcu224X

    Pixels 2, 2 vertical AOI frame rate, 1024 x 768 pixels (XGA) AOI frame rate, 640 x 480 pixels (VGA) AOI frame rate, 320 x 240 pixels (CIF) Binning Mode Vertical Method V: Monochrome binning, additive © 2013 Thorlabs GmbH...
  • Page 473 The power consumption depends on the sensor model and the pixel clock setting. Please see also the DCU224x Application Notes chapter. Relative sensor sensitivity Sensor sensitivity of the DCU224M (monochrome) Sensor sensitivity of the DCU224C (color) © 2013 Thorlabs GmbH...

  • Page 474: Mechanical Specifications

    DCx Cameras 5.4 Mechanical Specifications DCU223x, DCU224x DCC1545M, DCC1645C DCC1240x, DCC3240x General Flange back distance Position accuracy of the sensor Filter glasses Ambient conditions © 2013 Thorlabs GmbH...

  • Page 475: Dcu223X, Dcu224X

    5 Specifications 5.4.1 DCU223x, DCU224x © 2013 Thorlabs GmbH...

  • Page 476: Dcc1240X

    DCx Cameras 5.4.2 DCC1240x © 2013 Thorlabs GmbH...

  • Page 477: Dcc3240X

    5 Specifications 5.4.3 DCC3240x © 2013 Thorlabs GmbH...

  • Page 478: Dcc1545M, Dcc1645C

    DCx Cameras 5.4.4 DCC1545M, DCC1645C © 2013 Thorlabs GmbH...

  • Page 479: Flange Back Distance

    Distance from active sensor area to PCB Thickness of the glass cover of the sensor Filter thickness (optional) Refractive index Maximum sensor height above the PCB This distance describes the equivalent in air (see introduction above) © 2013 Thorlabs GmbH...

  • Page 480: Maximum Immersion Depth For Lenses

    Beside the immersion depth also the back focal length has to be considered, that means the distance between the last lens and the sensor (named "bfl" in the image below). The back focal length can be calculated for C-mount with the following formula: x stands for the maximum immersion depth (see table below). © 2013 Thorlabs GmbH...
  • Page 481 Camera front (sectional view) Note Front Panel of the DCU223x / DCU224x housing Models introduced before 2008 have a different front panel. On these models, the filter glass is held in the C-mount lens connector by two screws. This front panel version is indicated by (V2) in the table below.

  • Page 482: Position Accuracy Of The Sensor

    1 mm 650 nm (old) IRcut filter 1.53 D263 1 mm 650 nm On one side (new) Daylight cut 1.53 RG665 1 mm 695 nm filter Glass 1.53 D263 1 mm 380 nm On both sides © 2013 Thorlabs GmbH...
  • Page 483 HQ filters achieve a higher image brightness and better color rendering compared with the BG filter. uc480 drivers of version V3.24 and higher determine automatically which the IR filter is used in a camera. The corresponding color correction is selected automatically. Infrared cut filter (type BG) BG filter © 2013 Thorlabs GmbH...
  • Page 484 DCx Cameras Infrared cut filter (type HQ) HQ filter Daylight cut filter (type DL) DL cut filter © 2013 Thorlabs GmbH...
  • Page 485 5 Specifications Plain glass filter (type GL) Glass filter Note A different scale is used for the Y-axis of the glass filter curve, to show the curves between 400 nm and 1100 nm better. © 2013 Thorlabs GmbH...

  • Page 486: Mounting The Filter

    The threaded ring is screwed into the adjusting ring from the front with a torque of 0.2 Nm. Threaded ring Notes A special tool is required for adjusting the threaded ring! Some DCx camera models have a different design with a separate filter glass that is secured by two screws. © 2013 Thorlabs GmbH...

  • Page 487: Cleaning The Filter Glasses

    The filter glasses can be cleaned only from outside. If remove the filter glasses, the sensor might become soiled. Thorlabs is not liable for any damage to the sensor resulting from removal of the filter glasses. First, remove dirt particles on the glass using compressed air. Do not use compressed air from compressors or spray cans since it often contains oil droplets or droplets of other liquids.

  • Page 488: Ambient Conditions

    Vibration and shock resistance of the USB DCx Cameras were tested as specified in DIN EN 60068-2-6(1996-05), DIN EN 60068-2-27(1995-03) and DIN EN 60068-2-29(1995-03). The mechanical shock was at 80 g; the vibration testing was performed with sinusoidal vibration at a frequency between 30 Hz-500 Hz and an amplitude of 10 g. © 2013 Thorlabs GmbH...

  • Page 489: Camera Interface

    This section contains information on all camera models sorted by sensor type. DCU223x, DCU224x, DCC1240x DCC3240x EEPROM Specification 5.5.1 DCU223x, DCU224x, DCC1240x In this section the additional digital input / output of these cameras is described in detail: I/O Connector - Pin Assignment Digital Input (Trigger) Circuit Digital Output (Flash) Circuit 5.5.1.1 I/O Connector - Pin Assignment...

  • Page 490: Digital Input (Trigger) Circuit

    For interpreting the trigger signal, either the negative or the falling edge can be used. The digital input is galvanically isolated using an opto coupler to protect the camera and the PC against surges. Only DC voltages may be applied to the digital input. Digital input wiring Wiring of the trigger connector © 2013 Thorlabs GmbH...

  • Page 491: Digital Output (Flash) Circuit

    The following figures show examples of how the digital output is wired. Wiring of the digital output as an open collector output (rev. 1.2) Wiring of the digital output as an open collector output (rev. 2.0) © 2013 Thorlabs GmbH...
  • Page 492 DCx Cameras Wiring of the digital output as an open emitter output (rev. 2.0) © 2013 Thorlabs GmbH...

  • Page 493: Dcc3240X

    Trigger input, opto-decoupled (+) white camera rear view Output supply voltage, 5 V (100 mA) pink For a comprehensive list of all cables and connectors available for DCC3240X cameras, please refer to the DCC3240X Accessories section. © 2013 Thorlabs GmbH...

  • Page 494: Gpio Interface

    GPIO wiring as input The following figures illustrate GPIO wiring examples. GPIO input Min. Max. Signal level "Low" Signal level "High" GPIO wiring as output GPIO output Min. Max. Signal level "Low" Signal level "High" Output current © 2013 Thorlabs GmbH...

  • Page 495: Digital Input (Trigger) Circuit

    For interpreting the trigger signal, either the negative or the falling edge can be used. The digital input is galvanically isolated using an optocoupler to protect the camera and the PC against surges. Only DC voltages may be applied to the digital input. Digital input wiring Wiring of the trigger connector © 2013 Thorlabs GmbH...

  • Page 496: Digital Output (Flash) Circuit

    Digital output wiring The following figures show examples of how the digital output is wired. Wiring of the digital output as an open collector output Wiring of the digital output as an open emitter output © 2013 Thorlabs GmbH...

  • Page 497: Serial Interface

    The following figure shows the wiring of the serial interface with GPIO 1 as camera-side output (TxD) and GPIO 2 as camera-side input (RxD). The GPIO must be configured accordingly (see is_IO() Serial interface connector (UART) © 2013 Thorlabs GmbH...

  • Page 498: Camera Eeprom Specification

    DCx Cameras have an EEPROM memory where the camera manufacturer, type, and serial number are stored. A 64 byte memory space can be used freely by the user. EEPROM Specifications Data retention 10 years Read/write cycles 100,000 Size of user data space 64 bytes © 2013 Thorlabs GmbH...

  • Page 499: Accessories For Dcx Cameras

    USB cables All Thorlabs DCx cameras are shipped with a 1.5m USB2.0, A to Mini B, cable. 5.6.1 Accessories for DCU22xX / DCC1240X For information on the pin assignment of the cables and connectors see chapter...

  • Page 500: Accessories For Dcc1X45X

    GPIO 1, 3.3 V LVCMOS blue Trigger input, opto-decoupled (-) brown Flash output, opto-decoupled (+) yellow GPIO 2, 3.3 V LVCMOS Hirose connector female, Trigger input, opto-decoupled (+) white cable tip view Output supply voltage, 5 V (100 mA) pink © 2013 Thorlabs GmbH...

  • Page 501: Appendix

    To save a camera image with all the included text and drawings, select "Save window" from the Draw/Measure menu. The menu also provides an option for saving only the drawings, so you can load them again later. © 2013 Thorlabs GmbH...

  • Page 502: Pcs With Energy Saving Cpu Technology

    Check your energy saving options in the operating system. Disable energy saving features and set the available features to “full performance” or similarly named options. If you checked the above and still observe low USB performance you might be experiencing the issue with CPU sleep states. © 2013 Thorlabs GmbH...

  • Page 503: Status Led On Usb Dcx Cameras

    6 Appendix 6.2 Status LED on USB DCx Cameras DCU223x, DCU224x and DCC1240x The LED on the rear side of the USB DCx camera indicates whether the DCx camera is powered on – LED lights up red (only USB board rev. 2.0 or higher).

  • Page 504: Color And Memory Formats

    IS_CM_BAYER_RG12 (identical to IS_CM_SENSOR_RAW12) IS_CM_BAYER_RG16 (identical to IS_CM_SENSOR_RAW16) IS_CM_BGR555_PACKED (has been renamed to IS_CM_BGR5_PACKED) Each color format supported by the DCx camera defines a different memory format. The following table shows the byte arrangement in memory: © 2013 Thorlabs GmbH...
  • Page 505 The list above does not contain the IS_CM_RGB8_PLANAR color format. In planar RGB the image is saved as 8 bit RGB. The channels red, green, and blue are stored separately, i.e. first all red information, then all green information and at last all blue information are saved. © 2013 Thorlabs GmbH...

  • Page 506: Uc480 Parameter File (Ini File)

    Activate subsampling mode and Sensor-dependent select factor [Scaler] The internal image scaling is only supported by sensors of the DCC1240x / DCC3240x camera series. Mode Enable/disable scaling 0 = Scaling off 1 = Scaling on Factor Scaling factor © 2013 Thorlabs GmbH...
  • Page 507 0, 1, 2, 4 IS_SET_CM_RGB15 Color format 0, 1, 2, 4 IS_SET_CM_Y8 Color format 0, 1, 2, 4 IS_SET_CM_RGB8 Color format 0, 1, 2, 4 IS_SET_CM_BAYER Color format 0, 1, 2, 4 IS_SET_CM_UYVY Color format 0, 1, 2, 4 © 2013 Thorlabs GmbH...
  • Page 508 EdgeEnhancementFactor Enable edge enhancement 0...2 RopEffect Image geometry change (Rop = 0, 8, 16, 32, 64 raster operation), e.g. mirroring Whitebalance Enable software white balance 0, 1, 2, 4 Whitebalance Red 1.000000 Red factor for software white double value © 2013 Thorlabs GmbH...
  • Page 509 Y start point of reference AOI for -Aoi Height) 0 0...(max. height brightness control Brightness Aoi Width 2560 Width of reference AOI for Sensor-dependent brightness control Brightness Aoi Height Height of reference AOI for 1920 Sensor-dependent © 2013 Thorlabs GmbH...
  • Page 510 Delay of triggered image Sensor-dependent capture in µs Trigger debounce mode Not supported by DCx cameras Trigger debounce delay Not supported by DCx cameras time Trigger burst size Not supported by DCx cameras Flash strobe Activate flash output 0...6 © 2013 Thorlabs GmbH...

  • Page 511: Definition Of Ip Protection Classes

    6.6 History of uc480 Software Versions For new features in the current driver version 4.20see What is New in this Version? New in Version 4.02 Cameras & functions Described in chapter The USB 3 DCC3240x cameras are now supported under Windows © 2013 Thorlabs GmbH...
  • Page 512 New function for saving the camera parameter set in a file or the is_ParameterSet() camera EEPROM and loading from a file or the camera EEPROM respectively. New function for controlling the camera pixel clock. is_PixelClock() New function for reading camera information. is_DeviceInfo() © 2013 Thorlabs GmbH...
  • Page 513 New function for controlling the digital in-/outputs of the cameras is_IO() New header file uc480_deprecated.h with all deprecated function definitions and constants. These are no longer part of the uc480.h file. If neccessary the uc480_deprecated.h can be © 2013 Thorlabs GmbH...
  • Page 514 New function for setting special options on some camera models. is_DeviceFeature() Currently the following special options are available through this function: On UI-124x/UI524x models: Set line scan mode On UI-124x/UI524x models: Toggle between rolling and global shutter mode © 2013 Thorlabs GmbH...
  • Page 515 New function in uc480 Viewer for selection profiles for camera Start Dialog settings Creating Profiles Information in this manual Described in chapter Function is_GetCameraType() moved to the "Obsolete Obsolete Functions Functions" section. It is entirely replaced by is_GetCameraInfo is_GetCameraInfo() © 2013 Thorlabs GmbH...
  • Page 516 Some sensors can output images with a color depth of 10 to 12 bits. This data can now be processed by the DCx software. New color formats Camera properties: Color uc480 driver version 3.3 supports a wide range of new color © 2013 Thorlabs GmbH...
  • Page 517 10 languages that can be switched anytime. New information in the manual Described in chapter Detailed presentation of all DCx operating modes Operating Modes Updated connected load data on every camera model Camera and Sensor Data © 2013 Thorlabs GmbH...

  • Page 518: History Of Uc480 Api Functions

    New functions in software version 3.70 is_ColorTemperature() New functions in software version 3.52/3.60 is_ImageFormat() New functions in software version 3.40 is_DirectRenderer() is_GetImageInfo() is_GetSensorScalerInfo() is_SetSensorScaler() New functions in software version 3.33 is_Direct3D() is_GetTimeout() New functions in software version 3.32 is_GetTimeout() is_SetTimeout() © 2013 Thorlabs GmbH...
  • Page 519 6 Appendix is_SetTriggerCounter() New functions in software version 3.30 is_GetCameraLUT() is_GetCaptureErrorInfo() is_GetColorConverter() is_GetSupportedTestImages() is_GetTestImageValueRange() is_ResetCaptureErrorInfo() is_SetColorConverter() is_SetSensorTestImage() New function in software version 3.20 is_SetOptimalCameraTiming() © 2013 Thorlabs GmbH...

  • Page 520: Thorlabs Worldwide Contacts

    Email: europe@thorlabs.com Email: scandinavia@thorlabs.com France Brazil Thorlabs SAS Thorlabs Vendas de Fotônicos Ltda. 109, rue des Côtes Rua Riachuelo, 171 78600 Maisons-Laffitte São Carlos, SP 13560-110 France Brazil Tel: +33-970 444 844 Tel: +55-16-3413 7062 Fax: +33-811 38 17 48 Fax: +55-16-3413 7064 www.thorlabs.com...

  • Page 521: Certifications And Compliances

    Operation of this equipment in a residential area is likely to cause harmful interference in which case the user will be required to correct the interference at his own expense. Modifications not expressly approved by the manufacturer could void the user's authority to operated the equipment under FCC rules. © 2013 Thorlabs GmbH...

  • Page 522: Thorlabs 'End Of Life' Policy (Weee)

    Waste treatment on your own responsibility If you do not return an “end of life” unit to Thorlabs, you must hand it to a company specialized in waste recovery. Do not dispose of the unit in a litter bin or at a public waste disposal site.

  • Page 523: Warranty

    For warranty repairs or service the unit must be sent back to Thorlabs. The customer will carry the shipping costs to Thorlabs, in case of warranty repairs Thorlabs will carry the shipping costs back to the customer.

  • Page 524: Exclusion Of Liability And Copyright

    User Manual. Should you require further information on this product, or encounter specific problems that are not discussed in sufficient detail in the User Manual, please contact your local Thorlabs dealer or system installer.
  • Page 525 147, 303 linear AVI functions logarithmic errors C-mount/CS-mount AVI recording 84, 359 Color correction playback Color depth Color formats 99, 502 COM port -> Serial interface Contrast adjustment Bad pixel -> hot pixel © 2013 Thorlabs GmbH...
  • Page 526 79, 89, 90 I/O connector transmission errors pin assignment troubleshooting serial interface Event handling trigger Expert mode 76, 77 DCU223x / DCU224x 44, 93, 427 Exposure time electrical data setting I/O connector Pin assignment Fast line scan driver compatibility Fill factor...
  • Page 527 © 2013 Thorlabs GmbH...
  • Page 528 IS_SET_EVENT_TRANSFE is_SetTriggerCounter R_FAILED is_SetTriggerDelay is_SetAllocatedImageMem is_ShowDDOverlay is_SetAOI is_StealVideo is_SetAutoParameter is_StopLiveVideo is_SetBadPixelCorrection is_UnlockDDMem is_SetBadPixelCorrectionTa is_UnlockDDOverlayMem is_UnlockSeqBuf is_SetBayerConversion is_UpdateDisplay is_SetBinning is_WaitEvent is_SetBlCompensation is_WaitForNextImage is_SetCameraID is_WriteEEPROM is_SetColorConverter isavi_AddFrame is_SetColorCorrection isavi_CloseAVI is_SetColorMode isavi_DisableEvent is_SetConvertParam isavi_EnableEvent is_SetDDUpdateTime isavi_ExitAVI is_SetDisplayMode isavi_ExitEvent © 2013 Thorlabs GmbH...
  • Page 529 Multi AOI ROI -> AOI 34, 159 uc480 Viewer Rolling shutter 30, 115 Multi camera systems system requirements Rolling shutter (global start) RS-232 -> Serial interface Network card Scaler Sensor position accuracy Obsolete functions Sensor formats © 2013 Thorlabs GmbH...
  • Page 530 Test image Thread programming Trigger Trigger mode -> Image capture UART uc480 Camera Manager Control Center uc480 Hotpixel Editor uc480 programs uc480 Viewer status bar toolbars uc480.h 451, 452, uc480_Api.dll 451, 452, bandwidth cable connection standard topology © 2013 Thorlabs GmbH...

This manual is also suitable for:

Dcu224xDcc1240xDcc1545mDcc1645c

Table of Contents