THORLABS DCU22 Series User Manual
  1. Manuals
  2. Brands
  3. THORLABS Manuals
  4. Digital Camera
  5. DCU22 Series
  6. User manual

THORLABS DCU22 Series User Manual

High-resolution usb2.0 cmos and ccd cameras
Hide thumbs
1
2
3
4
5
Table Of Contents
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
Table of Contents

Advertisement

Quick Links

Download this manual
Getting started
Getting started...
DCU22x Series and DCC1x45 Series
USB 2.0 Camera
Thank you for buying a DCx Series camera. On this "Getting started" flyer you can see
how easy it is to install a DCx Series camera. The CD should start automatically. If not,
please start the "Autorun.exe" file on the CD. After the installation start "camera info" or
the "camera viewer" in the samples folder to check the connection.
Find detailed information about the camera and the SDK on the CD
For troubleshooting please contact our Support Team at:
DCx Camera System requirements:
CPU speed
min. 600 MHz
Memory (RAM)
min. 256 MB
USB host controller
USB 2.0 high speed (480 Mbps); full powered (500mA)
Graphics card
min. onboard graphics chip
Operating system
Windows 2000 (Service Pack 4)
Windows XP 32 bit (Service Pack 2)
Windows Vista 32 bit
...with your new DCx Series Camera
Getting started:
1) Install Software first
Setup will start automatically or run autorun.exe on the CD
2) Attach camera
Driver will install automatically
US:
PO Box 366, 435 Route 206N, Newton, NJ 07860, Tel: +1 (973) 579-7227, Fax: +1 (973) 3600,
Europe:
Hans-Böckler-Str. 6, 85221 Dachau, Germany, Tel: +49 8131 59560, Fax +49 8131 595699
Web:
http://www.thorlabs.com
14/05/09
europe@thorlabs.com
Mail:
europe@thorlabs.com
1

Advertisement

Table of Contents
loading

Related Manuals for THORLABS DCU22 Series

Summary of Contents for THORLABS DCU22 Series

  • Page 1 “camera viewer” in the samples folder to check the connection. Find detailed information about the camera and the SDK on the CD For troubleshooting please contact our Support Team at: europe@thorlabs.com DCx Camera System requirements: CPU speed min. 600 MHz Memory (RAM) min.
  • Page 2 Sub-D 9p male (camera rear view) Micro Sub-D connector PO Box 366, 435 Route 206N, Newton, NJ 07860, Tel: +1 (973) 579-7227, Fax: +1 (973) 3600, Europe: Hans-Böckler-Str. 6, 85221 Dachau, Germany, Tel: +49 8131 59560, Fax +49 8131 595699 Web: http://www.thorlabs.com Mail: europe@thorlabs.com 14/05/09...
  • Page 3 For additional information please refer to the documentation on CD. PO Box 366, 435 Route 206N, Newton, NJ 07860, Tel: +1 (973) 579-7227, Fax: +1 (973) 3600, Europe: Hans-Böckler-Str. 6, 85221 Dachau, Germany, Tel: +49 8131 59560, Fax +49 8131 595699 Web: http://www.thorlabs.com Mail: europe@thorlabs.com 14/05/09...
  • Page 4 User Manual Software Development Kit Thorlabs Instrumentation High-Resolution USB2.0 CMOS and CCD Cameras DCU2xxx DCC1x45x 2010...
  • Page 5 3.5.2 Version: 22.09.2010 Date: © 2010 Thorlabs © 2010 Thorlabs...

  • Page 6: Table Of Contents

    ........................... 32 Part VI Camera viewer (uc480Viewer) 1 Menus ........................... 35 2 Toolbars ........................... 41 3 Status Bar ........................... 44 4 Camera Options and Settings ........................... 46 Cam era ................................ 46 Im age ................................ 49 Size ................................ 51 © 2010 Thorlabs...
  • Page 7 Using Inputs and Outputs ................................ 114 Input / Output Control ..............................114 3 Function Descriptions ........................... 117 is_AddToSequence ................................ 118 is_AllocIm ageMem ................................ 119 is_Cam eraStatus ................................ 121 is_CaptureVideo ................................ 124 is_ClearSequence ................................ 126 is_ConvertIm age ................................ 127 © 2010 Thorlabs...
  • Page 8 ................................ 195 is_InquireIm ageMem ................................ 197 is_IsVideoFinish ................................ 198 is_LoadBadPixelCorrectionTable ................................ 199 is_LoadIm age ................................ 200 is_LoadIm ageMem ................................ 201 is_LoadParam eters ................................ 202 is_LockSeqBuf ................................ 203 is_ReadEEPROM ................................ 204 is_RenderBitm ap ................................ 205 is_ResetCaptureErrorInfo ................................ 207 © 2010 Thorlabs...
  • Page 9 ................................ 287 is_SetTriggerCounter ................................ 288 is_SetTriggerDelay ................................ 289 is_StopLiveVideo ................................ 290 is_UnlockSeqBuf ................................ 291 is_WaitEvent ................................ 292 is_WriteEEPROM ................................ 293 4 AVI Function Descriptions ........................... 294 isavi_AddFram e ................................ 295 isavi_CloseAVI ................................ 296 isavi_DisableEvent ................................ 297 © 2010 Thorlabs...
  • Page 10 Com plete List of All Return Values ................................ 343 Linux Functions ................................ 346 7 Appendix ........................... 350 Color and Mem ory Form ats ................................ 350 DCx cam era Param eter File (INI File) ................................ 351 Part VIII Maintenance and Service © 2010 Thorlabs...
  • Page 11 ............................393 Maximum Immersion Depth for Lenses ............................393 Cam era dim ensions ................................ 395 I/O Interface ................................ 398 Trigger Input Wiring (Trigger) ..............................398 Digital Output Wiring (Flash) ..............................398 Pin assignment Sub-D connector ..............................401 © 2010 Thorlabs...
  • Page 12 ..............................404 DCU223x ..............................406 DCC1545M ..............................408 DCC1645C ..............................410 2 Thorlabs 'End of Life' Policy (WEEE) ........................... 412 Waste Treatm ent on your ow n Responsibility ................................ 412 Ecological Background ................................ 412 3 List of Acronyms ........................... 413 4 Copyright ...........................

  • Page 14: Foreword

    This manual contains "WARNINGS" and "ATTENTION" label in this form, to indicate danger for persons or possible damage of equipment. Please read these advises carefully! NOTE This manual also contains "NOTES" and "HINTS" written in this form. © 2010 Thorlabs...

  • Page 16: Part I Introduction

    Introduction DCx camera Part...

  • Page 17: Safety Information

    WINDOWS are trademarks or registered trademarks of the Microsoft Corporation. All other products or company names which are mentioned in this manual are used solely for the purpose of identification and/or description and can be the trademark or registered trademark of the respective owners. © 2010 Thorlabs...
  • Page 18 General Information DCx camera Part...

  • Page 19: Part Ii General Information

    MVL50L 50 mm, f/2.8, Lockable, Camera Imaging Lens* MVL75L 75 mm, f/3.9, Lockable, Camera Imaging Lens* *C-m ount, adapter ring to CS-m ount included w ith DCC1x45x Cam eras Please visit our homepage http://www.thorlabs.com for further information. © 2010 Thorlabs...

  • Page 20: System Requirements

    OHCI/UHCI Not supported NOTE We strongly recommend using PCs with USB2.0 on board. PCI or PCMCIA USB2.0 adapters may have a lower performance. Make sure that the USB2.0 interface is ‘full powered’ and can provide 500 mA. © 2010 Thorlabs...
  • Page 22 Getting Started DCx camera Part...

  • Page 23: Part Iii Getting Started

    4. Start the included and automatically installed "uc480 Viewer" program 5. Connect to the camera by clicking the top left "Initialize" button You can use the Automatic option (auto contrast /auto white balance) for an uncomplicated setting of you camera parameters © 2010 Thorlabs...
  • Page 24 Installation DCx camera Part...

  • Page 25: Part Iv Installation

    Alternatively, the following screen may appear - then please choose the highlighted option as below: After the CD has been detected from Windows, the following installation window appears. Should the window not appear automatically, please go to the setup directory in the root of the CD and run autorun.exe. © 2010 Thorlabs...
  • Page 26 Please follow the instructions on the screen. Driver installation welcome screen Figure 2 During the installation a list with direct show driver list will pop up, see below, stating a "wrong count of cameras". This message needs to be confirmed with OK. © 2010 Thorlabs...

  • Page 27: Connection Of The Dcx Camera

    The USB 2.0 hubs being used must be full powered hubs that are able to provide 500mA per USB port. Low powered hubs, in comparison, only supply 100mA per port which is not sufficient for DCU cameras. Connection the DCx cameras to a PC Figure 4 © 2010 Thorlabs...

  • Page 28: Hardware-Installation

    After the DCx driver was installed and is operational the Windows device manager contains in the column Universal Serial Bus Controller the entry "Thorlabs DCU ccd xxxx " or "Thorlabs DCC cmos xxxx" depending on your model. No question or exclamation marks should stand before the driver. In case you connected a DCU camera the LED on the back of the camera shows green.

  • Page 29: The Status Led

    The DCU driver has been loaded and the camera is ready for operation: LED shines green The status LED can also help you in case of trouble shooting by providing error codes, see section trouble shooting The Status LED (rev. 2.0) The Status LED (rev. 1.2) Figure 7 Figure 6 © 2010 Thorlabs...
  • Page 30 uc480 Camera Manager DCx camera Part...

  • Page 31: Part V Uc480 Camera Manager

    Manager. This setting is saved and remains effective even after you close and reopen the program. For proper display of Asian languages, the Windows support for East Asian languages has to be installed on your system (in Control Panel Regional and Language Options). © 2010 Thorlabs...
  • Page 32 If an error has occurred in a camera, a black exclamation mark on a yellow background is shown next the camera. The status box then indicates the cause of the error and suggests remedies. © 2010 Thorlabs...

  • Page 33: Camera List

    1 to 1000. After deactivating a DCx camera (switching it off or disconnecting it from the network), the device ID is no longer valid and can be assigned again by the system. Model Model name of the camera SerNo. Serial number of the camera. © 2010 Thorlabs...

  • Page 34: Control Center

    Parameters Box on the right. There you will find detailed information on the DCx camera selected in the camera list The "ETH network service" button is not available for Thorlabs DCx USB cameras. uC480 Camera Manager in Expert Mode...

  • Page 35: General Information

    Direct3D Dlls This list shows the location and version of the Direct3D drivers. USB controller and network adapters All USB controllers and network adapters that are available in your system are shown in a tree structure. © 2010 Thorlabs...

  • Page 36: Camera Information

    Programmable Read Only Memory) to which you can write text of your choice. The Camera information dialog box displays two additional boxes that are for your information only and cannot be edited: Manufacturer (Thorlabs GmbH) Date of QC (date of final camera quality test) © 2010 Thorlabs...

  • Page 37: Creating A Support File

    A DCx camera support file is a binary file with the extension .bin. The file contains camera and driver details that are required for diagnostics by the Thorlabs Support team. No personal computer data or user data is stored in this file.
  • Page 38 Camera viewer (uc480Viewer) DCx camera Part...

  • Page 39: Part Vi Camera Viewer (Uc480Viewer)

    DCx camera Camera viewer (uc480Viewer) Camera viewer (uc480Viewer) is the application program provided by Thorlabs for testing the DCU camera in your own computer environment. Apart from the controlling of the camera, images can be recorded as AVI file and saved as BMP file.

  • Page 40: Menus

    Choice between German and English Customize allows to - restore parameters - restore window position and size - show capture error window - show debug window Exit Exit uc480 Viewer program Camera viewer (uc480Viewer) Menu File Table 3: © 2010 Thorlabs...
  • Page 41 Log window Logs of failed transfers Information on Capture errors, camera image buffers and Image Info resent packets Toolbars Allow select / unselect toolbars of the uc480 Viewer Camera viewer (uc480Viewer) – Menu File Table 4: © 2010 Thorlabs...
  • Page 42 Output an acoustic signal if a transmission error Transfer failed occurs. Error report Errors are displayed in a message box. Clear Counters Reset of the counters (see Status Bar Camera viewer (uc480Viewer) – Menu uc480 Table 5: © 2010 Thorlabs...
  • Page 43 Measure Set measure unit Adjust scaling. Show measures Show/hide measures New mesure New mesure Delete measures Delete all measures Text Select font Select font Show texts Show/hide text New text Write new text Delete text Delete text © 2010 Thorlabs...
  • Page 44 Load drawing elements from a *.bin file and insert to actual display Save drawings Save present drawing elements to a *.bin file Delete all Delete all drawings, text and measurements Camera viewer (uc480Viewer) – Menu Draw/Measure Table 6: © 2010 Thorlabs...
  • Page 45 DCx camera Menu Help Info ab out Camera viewer (uc480Viewer) Figure 15 © 2010 Thorlabs...

  • Page 46: Toolbars

    Horizontal line view - show the color values of a pixel line Vertical line view - show the color values of a pixel row Open zoom window (see Zoom window Open „Pixel peek“ window (see Pixel peek window Camera viewer (uc480Viewer) uc480 Toolb ar Table 7 : © 2010 Thorlabs...
  • Page 47 Camera viewer (uc480Viewer) - Display Toolb ar Table 8 : Capture Toolbar Live video on/off Snapshot Capture single frame using trigger mode continuous Trigger mode on/off; trigger recording Camera viewer (uc480Viewer) - Capture Toolb ar Table 9 : © 2010 Thorlabs...
  • Page 48 Camera viewer (uc480Viewer) - Auto feature Toolb ar Table 10 : Draw/Measure Toolbar Draw freehand Draw lines Draw circles Draw rectangles Add measures Write text Clear all Show / Hide Timestamp Camera viewer (uc480Viewer) - Draw/Measure Toolb ar Table 11 : © 2010 Thorlabs...

  • Page 49: Status Bar

    Camera viewer (uc480Viewer) – Status b ar Table 12: Select camera from choice Figure 17 If only one camera is connected the Camera viewer (uc480Viewer) starts without the dialog shown above. With several cameras at the USB system the camera is selectable. © 2010 Thorlabs...
  • Page 50 Camera viewer (uc480Viewer) Select second camera in new application Figure 18 To operate with several cameras at the same time, start the Camera viewer (uc480Viewer) several times. Used cameras are marked as Available: "No". © 2010 Thorlabs...

  • Page 51: Camera Options And Settings

    The average bandwidth is calculated from the following data: Image size, image format, frame rate, and interface-related protocol overhead. Sensor (max. bandwidth) Maximum data volume in Mpixels/sec created by the sensor. NOTE With USB cameras, the upper limit depends on the USB chipset on the mainboard/ © 2010 Thorlabs...
  • Page 52 Hold or Max check box deselects the Auto check box. Long-term If you select this check box, you can set an exposure time of up to 10 minutes on many DCx CCD cameras. This function is only available in trigger mode. © 2010 Thorlabs...
  • Page 53 DCx camera Default Click this button to reset all parameters to the model-specific defaults. © 2010 Thorlabs...

  • Page 54: Image

    0 (default). At high incident brightness, it might be necessary to adjust the black level. High gain can shift the black level. Only "additive offset" (increase of black level) is possible. © 2010 Thorlabs...
  • Page 55 Gamma correction with the value 1.6. Dark image areas are raised. Software gamma should be used only for visualization. For image processing Software gamma must be deactivated to get a linear illustration. Hardware gamma Gamma correction by the hardware. Not available for DCU / DCC cameras. © 2010 Thorlabs...

  • Page 56: Size

    Set the top position of the window. Using the option Center will centre the AOI vertical. It applies to consider, that the sum of left position and width can never exceed the maximum width, and the sum of top position and height can never exceed the maximum height. Horizontal / Vertical format © 2010 Thorlabs...
  • Page 57 / subsampling only, which may lead to image artefacts. Mirror left/right (up/down) This option flips the image horizontally (vertically). With the CCD models this is done by software, CMOS cameras have an according sensor chip feature. Default All values are reset to the default settings. © 2010 Thorlabs...

  • Page 58: Format

    The conversion is performed in the camera. A filter mask of 3x3 pixels is used for the conversion. This radio button is not available for the DCx cameras. When you select hardware de-Bayering, you can also perform the Gamma and Hotpixel correction functions directly in the camera. © 2010 Thorlabs...
  • Page 59 Output of an image converted according to YUV (8 bits per pixel for Cb, Y, Cr and Y) NOTE We recommend 32-bit RGB mode for TrueColor applications. Y8 mode is usually used for monochrome applications.The General: Color Formats and Memory © 2010 Thorlabs...
  • Page 60 CPU. The mode also allows scaling the images in real time. NOTE The display modes Direct3D is only supported by graphics cards with DirectX functionality. Default Click this button to reset all parameters to the model-specific defaults. © 2010 Thorlabs...

  • Page 61: Color

    (Auto button). You can also select the correction matrix manually. Slider "Factor" This function corrects the color values of a pixel. The colors are rendered more accurately after the color crosstalk of the individual Bayer pattern filters has been eliminated by the color correction. © 2010 Thorlabs...
  • Page 62 Camera viewer (uc480Viewer) The color correction factor is steplessly adjustable between 0 (no correction) and 1 (full correction). Activating the sensor color correction may increase CPU load. Default All values are reset to the default settings. © 2010 Thorlabs...

  • Page 63: Hardware Lut

    This tab provides settings for the hardware Look Up Table (LUT) curve for future cameras. Each LUT contains modification values for the image brightness and contrast parameters. This feature is not supported by the DCx camera series. Properties - Hardware Look up tab le (LUT) Figure 24: © 2010 Thorlabs...

  • Page 64: Trigger

    The camera is running in software trigger mode without a signal applied. The images are captured continuously. Falling edge The camera captures an image on the falling edge of the signal applied to the trigger input. Rising edge © 2010 Thorlabs...
  • Page 65 This is due to the sequential transmission. First the exposure takes place, then the transfer. A new exposure can only be performed after the transmission is completed. Therefore, the freerun mode is faster. High trigger rates are achieved only with short exposure times and a high pixel clock setting. © 2010 Thorlabs...

  • Page 66: Input/Output

    The digital output is disabled. Constant high The digital output is set to High regardless of the exposure. Constant low The digital output is set to Low regardless of the exposure. Flash high active (only in trigger mode) © 2010 Thorlabs...
  • Page 67 Sets the switching time of the digital output. The digital output is actuated for the time set in Duration. The value 0 means that the signal is active over the entire exposure time (default). General Purpose Inputs Outputs 1/2/3 (this option is not supported by the Thorlabs DCU camera models ) Default Click this button to reset all parameters to the model-specific defaults.

  • Page 68: Aes/Agc

    Auto Frame Rate (AFR) adjusts the frame rate to allow longer exposure times (see also Pixel Clock, Frame Rate and Exposure Time ). Selecting this check box might decrease the frame rate substantially. This function is only available when AES is active. Image contrast © 2010 Thorlabs...
  • Page 69 Use sensor auto features If your sensor offers automatic image brightness adjustment, you can select this check box to enable the feature. Thorlabs DCx cameras do not support this feature. Brightness reference Default average grayscale value (brightness) of the image.

  • Page 70: Awb

    Adjustment of the control speed. The higher the automatic controller speed is adjusted, the faster the regulation reacts. In freerun mode every fourth picture is evaluated for controlling using the histogram, in trigger mode each picture. Hysteresis Sets the hysteresis range for control stabilization (see also Automatic Image Control: Hysteresis © 2010 Thorlabs...
  • Page 71 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 (see Toolbar Default All values are reset to the default settings. © 2010 Thorlabs...

  • Page 72: Miscellaneous

    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 The test images are created by the sensor. © 2010 Thorlabs...
  • Page 73 USB bus. Due to the transmission process, completely white camera images require a somewhat more bandwidth on the USB bus than completely black images. Default Click this button to reset all parameters to the model-specific defaults. © 2010 Thorlabs...

  • Page 74: Scaler

    Camera viewer (uc480Viewer) 6.4.12 Scaler This feature enables image scaling of the sensor. So far not supported by Thorlabs DCx cameras. Properties - Scaler Figure 31: © 2010 Thorlabs...

  • Page 75: Automatic Image Control

    Automatically Disabling the Control Function You can disable the control functionality automatically once the target value has been reached. Alternatively, you can keep the control feature enabled so that it responds to deviations from the target value. © 2010 Thorlabs...
  • Page 76 (setpoint + hysteresis value). If the hysteresis value is increased, the achieved target value is maintained for a longer time in case of lighting changes. This makes the automatic control more sluggish, but can be useful in some situations. © 2010 Thorlabs...

  • Page 77: Record Dialog

    RGB24 format, regardless of the input data format. 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 AVI recording is only possible in the Device Independent Bitmap (DIB) display mode © 2010 Thorlabs...
  • Page 78 Click this button to create a new AVI file for recording, and to close the file again when you are done. If you select an existing AVI file, the file contents will be overwritten during recording. Record/Stop Starts/stops AVI recording. Exit Closes the Record dialog box. A recording in progress is stopped. © 2010 Thorlabs...

  • Page 79: Histogram

    In operating mode mono the average grey value is displayed. Outlined With the option Outlined the display of the color values can be switched between area and line diagram. Logarithmic With the activation of this option the representation takes place with a logarithmic scaling. © 2010 Thorlabs...

  • Page 80: Zoom Window

    Alternatively the picture position can be set over the context menu. If the option pixel peek at the upper edge of window is activated, the color values at the cursor position are displayed (see Pixel peek window © 2010 Thorlabs...

  • Page 81: Horizontal/Vertical Line View

    Pixel are bordered yellow. In monochrome mode the Y-value is shown. Generally the used range of values is 0 - 255. If the option pixel peek at the upper edge of window is deactivated, the zoom window is displayed ( © 2010 Thorlabs...

  • Page 82: Waterfall Window

    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. View menu – Waterfall window Figure 37: © 2010 Thorlabs...

  • Page 83: Log Window

    With the button Clear Window the current messages are deleted. Save The button Save to file opens the Save as dialogue from Windows and thus makes the storing of the messages shown in the log window possible. © 2010 Thorlabs...

  • Page 84: Image Infos

    Camera viewer (uc480Viewer) 6.13 Image infos Select View menu Image infos on the main menu to display the Capture Errors dialog box. View menu - Image Information Figure 39: NOTE Please see the trouble shooting section, if errors occur © 2010 Thorlabs...
  • Page 85 Operate fewer cameras simultaneously on a USB Check the quality of the USB cabling and components The selected timeout value is too low for Reduce the exposure time image capture Increase the timeout © 2010 Thorlabs...
  • Page 86 Camera viewer (uc480Viewer) Camera image buffers Not applicable to USB cameras. Resent packets Not applicable to USB cameras. © 2010 Thorlabs...
  • Page 88 SDK (Software development Kit) DCx camera Part...

  • Page 89: Part Vii Sdk (Software Development Kit)

    If you are using a color camera, you should activate color correction in order to achieve rich vibrant colors for on-screen display ( ). To adapt a color camera to the is_SetColorCorrection() ambient light conditions, it is essential to carry out white balancing. This is also done using the © 2010 Thorlabs...
  • Page 90 You will find comprehensive lists of the API functions, sorted by task, in the How To Proceed chapter.The DCx camera SimpleLive and DCx camera SimpleAcquire C++ programming samples included in the SDK illustrate the steps described above. © 2010 Thorlabs...

  • Page 91: How To Proceed

    Creating an image memory sequence is required when capturing live images. Query Information 7.2.1.1 It is recommended to query the following important information before opening one or more DCx camera cameras. Determines the number of cameras connected to the system. is_GetNumberOfCameras() © 2010 Thorlabs...

  • Page 92: Open And Close The Camera

    Releases an allocated image memory. is_FreeImageMem() An image memory has to be activated before each image capture: Makes an image memory active. is_SetImageMem() To query image memory information and access the data in the image memories, you can use these functions: © 2010 Thorlabs...
  • Page 93 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. Flowchart: Allocating memory Flowchart - Allocating memory using system functions Figure 41 © 2010 Thorlabs...

  • Page 94: Image Memory Sequences

    For example, the system automatically cycles through the specified sequence of image memories and can generate an event when it reaches the end of a sequence cycle. Before you can use a memory sequence, you have to allocate the relevant image memories (see Allocating an Image Memory © 2010 Thorlabs...

  • Page 95: Display Mode Selection

    When Bitmap mode (DIB) is active, image display has to be called explicitly for each image. Outputs the contents of the active image memory to a window. is_RenderBitmap() Enables offsetting the image output inside the window. is_SetDisplayPos() © 2010 Thorlabs...

  • Page 96: Image Capture

    Using events or messages , the DCx camera driver can provide information to an application, e. g. about the completion of image capture. You will need events and messages, for example, when you are using image memory sequences © 2010 Thorlabs...

  • Page 97: Capture Modes

    The cameras still remain in freerun mode. The trigger signal stops and restarts the current image capture process. You can use this mode to synchronise multiple cameras that you are operating in the fast live mode. Not all camera models support this mode (see is_SetExternalTrigger() © 2010 Thorlabs...
  • Page 98 Freerun Freely selectable (e.g. HI_LO_SYNC) sync. is_CaptureVideo() is_SetExternalTrigger Freely selectable (OFF) is_FreezeVideo() is_SetExternalTrigger Single Depending on exposure time and Software (SOFTWARE) frame trigger delay is_FreezeVideo() is_SetExternalTrigger Hardwar Depending on exposure time and (e.g. HI_LO) trigger delay is_FreezeVideo() © 2010 Thorlabs...
  • Page 99 API internally by API IS_WAIT Freerun/SW When 1st image Calculated Calculated trigger in memory internally by API internally by API Time t Freerun/SW When 1st image Time t Calculated trigger in memory internally by API © 2010 Thorlabs...
  • Page 100 Returns whether the capture process has been started or not. is_HasVideoStarted() Returns whether the capture process has been terminated or is_IsVideoFinish() not. Enables test image output from sensor (all cameras). is_SetSensorTestImage() Terminates the capturing process (live video or single frame). is_StopLiveVideo() © 2010 Thorlabs...
  • Page 101 DCx camera Flowchart: Single Capture Flowchart - Capturing a single frame (1 of 2) Figure 44 © 2010 Thorlabs...
  • Page 102 SDK (Software development Kit) Flowchart - Capturing a single frame (2 of 2) Figure 45 © 2010 Thorlabs...
  • Page 103 DCx camera Flowchart: Sequence Capture Flowchart - Capturing a frame sequence (1 of 2) Figure 46 © 2010 Thorlabs...
  • Page 104 SDK (Software development Kit) Flowchart - Capturing a frame sequence (2 of 2) Figure 47 © 2010 Thorlabs...

  • Page 105: Event / Message Handling

    (see also is_AddToSequence() Events in live mode Figure 49 Optional function. The start time and duration of the flash signal are defined by the Flash delay and is_SetFlashDelay() Duration parameters (see © 2010 Thorlabs...
  • Page 106 Enables a single event object. is_EnableEvent() Turns the Windows messages on / off. is_EnableMessage() Closes the event handler. is_ExitEvent() Initialises the event handler. is_InitEvent() Automatically releases the camera resources when the camera is is_EnableAutoExit() disconnected from the PC. © 2010 Thorlabs...
  • Page 107 DCx camera Flowchart: Enable Events Flowchart - Enab ling event handling Figure 50 Flowchart: Enabling Messages © 2010 Thorlabs...
  • Page 108 SDK (Software development Kit) Flowchart - Enab ling message handling Figure 51 Flowchart: Event / Message Handling © 2010 Thorlabs...
  • Page 109 DCx camera Flowchart - Handling events / messages Figure 52 © 2010 Thorlabs...

  • Page 110: Saving Images And Videos

    Saves the current image as a JPEG of BMP file. is_SaveImageEx() Saves the contents of the image memory as a BMP file. is_SaveImageMem() Saves the contents of the image memory as a JPEG of BMP file. is_SaveImageMemEx() © 2010 Thorlabs...

  • Page 111: Capturing Avis

    Events can be used to get signalled when a frame was added. Disables a DCx camera AVI event. isavi_DisableEvent() Enables a DCx camera AVI-Event. isavi_EnableEvent() Turns off DCx camera AVI event handling. isavi_ExitEvent() Turns on DCx camera AVI event handling. isavi_InitEvent() © 2010 Thorlabs...
  • Page 112 AVI files you have captured using the uc480_tools.dll can also be played back in external applications, such as Windows Media Player. The required codec (MJPG) is included within Windows, XP and newer, and is available for Linux as well. © 2010 Thorlabs...
  • Page 113 DCx camera Flowchart: AVI Capture Flowchart - Capturing AVI using DCx cameras Figure 53 © 2010 Thorlabs...

  • Page 114: Setting Camera Parameters

    Sets the sensor hardware gain factor. is_SetHWGainFactor() Sets the pixel clock frequency. is_SetPixelClock() Resets the camera parameters to its default values. is_ResetToDefault() This set of functions lets you influence the image geometry for image capture, e.g. the area of interest: © 2010 Thorlabs...
  • Page 115 Sets color correction. is_SetColorCorrection() Selects a color mode. is_SetColorMode() Conversion parameters for raw Bayer conversion. is_SetConvertParam() Sets edge enhancement. is_SetEdgeEnhancement() Sets the image saturation (digital post-processing). is_SetSaturation() Enables test image output from sensor. is_SetSensorTestImage() Sets user-defined timeout values. is_SetTimeout() © 2010 Thorlabs...
  • Page 116 SDK (Software development Kit) Flowchart: Changing camera timing Flowchart - Changing camera timing Figure 54 © 2010 Thorlabs...

  • Page 117: Automatic Image Control

    All controls are configured using the is_SetAutoParameter() SDK function. For more information on the automatic image control see Camera Viewer: Automatic Image Control Flowchart: Enable Auto Brightness Flowchart - Enab ling automatic image b rightness control Figure 55 © 2010 Thorlabs...

  • Page 118: Image Pre-Processing

    Sets the algorithm for Bayer conversion is_SetBayerConversion() Sets the algorithm for Bayer conversion in the camera (not is_SetColorConverter() available for Thorlabs DCx cameras) Using Look-Up-Table (LUT) functions, you can e. g. adjust brightness or contrast after the acquisition. Read out current hardware LUT...

  • Page 119: Using Inputs And Outputs

    With these commands you can activate additional functions or use GPIOs on some DCU camera cameras. is_SetIO() Sets the additional digital outputs (GPIO). is_SetIOMask() Defines each port as a digital input or output (GPIO). is_SetLED() Toggles the colour of the status LED for the USB DCU camera camera series. © 2010 Thorlabs...
  • Page 120 SDK (Software development Kit) Flowchart: Digital input Flowchart - Digital input Figure 56 © 2010 Thorlabs...
  • Page 121 DCx camera Flowchart: Digital output Flowchart - Digital output Figure 57 © 2010 Thorlabs...

  • Page 122: Function Descriptions

    Some descriptions include references to DCx camera SDK sample programs. When you install the DCx camera software, the demo applications are copied to the C:\Programs\Thorlabs\DCx camera\Samples directory. The associated source code can be found under C:\Programs\Thorlabs\DCx camera\Develop\Source. All sample programs are described in the DCx camera Samples Manuals © 2010 Thorlabs...

  • Page 123: Is_Addtosequence

    Image memories that are used for ring buffering must all have been allocated with the same colour depth (bits per pixel). Input Parameters Camera handle hCam Pointer to image memory pcMem Image memory ID Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_AllocImageMem() is_SetImageMem() is_SetAllocatedImageMem() © 2010 Thorlabs...

  • Page 124: Is_Allocimagemem

    RAM that have not been used for some time out to the slower hard disk. This can slow down image capture if more image memory has been allocated than can be provided by the RAM at a time. © 2010 Thorlabs...
  • Page 125 Returns the pointer to the memory starting address ppcImgMem Returns the ID of this memory Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_FreeImageMem() is_AddToSequence() is_SetImageMem() is_SetAllocatedImageMem() is_GetColorDepth() is_GetImgMemPitch() © 2010 Thorlabs...

  • Page 126: Is_Camerastatus

    SDK (Software development Kit) 7.3.3 is_CameraStatus USB 2.0 USB 2.0 Syntax ULONG is_CameraStatus (HIDS hCam, INT nInfo, ULONG ulValue) Description Using , you can query and partly set various status information and settings. is_CameraStatus() © 2010 Thorlabs...
  • Page 127 The camera changes to freerun mode FALSE Queries whether the camera supports standby mode (read-only). IS_STANDBY_SUPPORTED Return values: The camera supports standby mode TRUE The camera does not support standby mode FALSE ulValue Returns the information specified by IS_GET_STATUS nInfo © 2010 Thorlabs...
  • Page 128 IS_NO_SUCCESS Returns information Only if ulValue = IS_GET_STATUS specified by nInfo When used with Returns the last image capture error. For a list of all possible error events, see IS_LAST_CAPTURE_ERROR is_GetCaptureErrorInfo() Related Functions is_GetCameraInfo() is_GetError() is_SetErrorReport() is_SetTriggerCounter() © 2010 Thorlabs...

  • Page 129: Is_Capturevideo

    Time t Returns if live capture is enabled. IS_GET_LIVE Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS When used with if live capture is enabled TRUE IS_GET_LIVE Related Functions is_FreezeVideo() is_StopLiveVideo() is_SetExternalTrigger() is_ForceTrigger() is_SetTimeout() is_GetCaptureErrorInfo() © 2010 Thorlabs...
  • Page 130 SDK (Software development Kit) Sample Programs SimpleLive - "uc480live.exe" (C++) CSharpDemo - "uc480_csharp_demo.exe" © 2010 Thorlabs...

  • Page 131: Is_Clearsequence

    , there is no more active image is_AddToSequence() is_ClearSequence() memory. To make an image memory the active memory, call is_SetImageMem() Input Parameters Camera handle hCam Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_AddToSequence() is_FreeImageMem() is_SetImageMem() © 2010 Thorlabs...

  • Page 132: Is_Convertimage

    NULL memory is allocated internally. Memory ID of the output image nIDDest Reserved. must be passed here. reserved NULL Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_SetConvertParam() is_SetColorMode() is_SetBayerConversion() © 2010 Thorlabs...

  • Page 133: Is_Copyimagemem

    Pointer to the image memory pcSource ID of this image memory Pointer to the destination memory to copy the image to pcDest Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_AllocImageMem() is_SetAllocatedImageMem() © 2010 Thorlabs...

  • Page 134: Is_Copyimagememlines

    ID of this image memory Number of lines to be copied nLines Pointer to the destination memory to copy the image to pcDest Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_AllocImageMem() is_SetAllocatedImageMem() © 2010 Thorlabs...

  • Page 135: Is_Directrenderer

    Releases the device context (DC) handle. DR_RELEASE_OVERLAY_DC Using DR_RELEASE_OVERLAY_DC, you can release the DC handle and update the overlay data. - Code sample Returns the width and height of the maximum overlay area supported by the graphics card. DR_GET_MAX_OVERLAY_SIZE © 2010 Thorlabs...
  • Page 136 With all other colors, the camera image will be visible with the overlay superimposed. The key color has no effect in semi-transparent mode! - Code sample Disables the semi-transparent display of the overlay area. DR_DISABLE _SEMI_TRANSPARENT_OVERLAY - Code sample © 2010 Thorlabs...
  • Page 137 - Code sample Returns whether the graphics card supports the DCx camera Direct3D functions. DR_CHECK_COMPATIBILITY - Code sample -type pointer to a data object or an array of objects (depending on the mode selected using pParam void nMode © 2010 Thorlabs...
  • Page 138 Direct3D functions Related Functions is_SetDisplayMode() is_SetColorMode() is_SetImageMem() is_RenderBitmap() Code Samples //------------------------------------ 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); © 2010 Thorlabs...
  • Page 139 UINT OverlayKeyColor[3]; is_DirectRenderer (hCam, DR_GET_OVERLAY_KEY_COLOR, (void*)OverlayKeyColor, sizeof(OverlayKeyColor)); INT nRed = OverlayKeyColor[0]; INT nGreen = OverlayKeyColor[1]; INT nBlue = OverlayKeyColor[2]; // Set new key color OverlayKeyColor[0] = GetRValue(m_rgbKeyColor); OverlayKeyColor[1] = GetGValue(m_rgbKeyColor); OverlayKeyColor[2] = GetBValue(m_rgbKeyColor); is_DirectRenderer (hCam, DR_SET_OVERLAY_KEY_COLOR, (void*)OverlayKeyColor, sizeof(OverlayKeyColor)); © 2010 Thorlabs...
  • Page 140 // Enable scaling is_DirectRenderer (hCam, DR_ENABLE_SCALING, NULL, NULL); // Disable scaling is_DirectRenderer (hCam, DR_DISABLE_SCALING, NULL, NULL); //------------------------------------ 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); © 2010 Thorlabs...
  • Page 141 (SyncPosition)); // Disable synchronization is_DirectRenderer (hCam, DR_SET_VSYNC_OFF, NULL, NULL); //------------------------------------ BMP file //------------------------------------ // Load overlay from BMP file is_DirectRenderer (hCam, DR_LOAD_OVERLAY_FROM_FILE, (void*)”c:\test.bmp”, NULL); //------------------------------------ Delete overlay //------------------------------------ // Delete overlay area is_DirectRenderer (hCam, DR_CLEAR_OVERLAY, NULL, NULL); © 2010 Thorlabs...
  • Page 142 // Set new window handle for image display is_DirectRenderer (hCam, DR_SET_HWND, (void*)&hWnd, sizeof (hWnd)); //------------------------------------ Compatibility //------------------------------------ // Check graphics card compatibility is_DirectRenderer INT nRet = (hCam, DR_CHECK_COMPATIBILITY, NULL, NULL); (nRet == IS_DR_DEVICE_CAPS_INSUFFICIENT ) // Graphics card does not support Direct3D © 2010 Thorlabs...

  • Page 143: Is_Disableevent

    You can re-enable the desired event using is_EnableEvent() See also is_InitEvent() Input Parameters Camera handle hCam ID of the event to be disabled. See also which is_InitEvent() Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_EnableEvent() is_ExitEvent() is_InitEvent() © 2010 Thorlabs...

  • Page 144: Is_Enableautoexit

    Camera handle hCam nMode Enables automatic closing. IS_ENABLE_AUTO_EXIT Disables automatic closing. IS_DISABLE_AUTO_EXIT Returns the current setting. IS_GET_AUTO_EXIT_ENABLED Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Current setting when used together with IS_GET_AUTO_EXIT_ENABLED Related Functions is_ExitCamera() © 2010 Thorlabs...

  • Page 145: Is_Enableevent

    Following the release, the event messages for the created event object are enabled. Input Parameters Camera handle hCam ID of the event to be released. See also which is_InitEvent() Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_InitEvent() is_ExitEvent() is_DisableEvent() is_WaitEvent() © 2010 Thorlabs...

  • Page 146: Is_Enablemessage

    IS_SET_AUTO_WB_ONCE Automatic brightness control is completed (only if this control was IS_AUTOBRIGHTNESS_FINISHED started using the function). IS_SET_AUTO_BRIGHTNESS_ONCE Application window for receiving the message hWnd disables the message designated by the parameter. NULL which © 2010 Thorlabs...
  • Page 147 DCx camera Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_InitEvent() © 2010 Thorlabs...

  • Page 148: Is_Exitcam Era

    We recommend that you call the following functions only from a single thread in order to avoid unpredictable behaviour of the application. is_InitCamera() is_SetDisplayMode() is_ExitCamera() See also Programming: Thread Programming Input Parameters Camera handle hCam Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_InitCamera() is_EnableAutoExit() © 2010 Thorlabs...

  • Page 149: Is_Exitevent

    Input Parameters Camera handle hCam ID of the event to be deleted. See also which is_InitEvent() Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_InitEvent() is_EnableEvent() is_WaitEvent() Example See also is_ForceTrigger() © 2010 Thorlabs...

  • Page 150: Is_Forcetrigger

    Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_FreezeVideo() is_CaptureVideo() is_SetExternalTrigger() Code Sample Enable trigger and wait 1 second for the external trigger. If no trigger signal has arrived, force an exception using is_ForceTrigger() © 2010 Thorlabs...
  • Page 151 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); © 2010 Thorlabs...

  • Page 152: Is_Freeimagemem

    Input Parameters Camera handle hCam Points to the starting address of the memory (e.g. set in the pcImgMem function) is_AllocImageMem() ID of this memory Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_AllocImageMem() © 2010 Thorlabs...

  • Page 153: Is_Freezevideo

    Timeout value for image capture (see also the How To Proceed: Timeout IS_WAIT Values for Image Capture section) Time t Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_HasVideoStarted() is_IsVideoFinish() is_SetExternalTrigger() is_ForceTrigger() is_CaptureVideo() is_SetTimeout() is_GetCaptureErrorInfo() © 2010 Thorlabs...
  • Page 154 SDK (Software development Kit) Example Enable trigger mode, set high-active flash mode and capture an image: is_SetExternalTrigger (hCam, IS_SET_TRIGGER_SOFTWARE); is_SetFlashStrobe (hCam, IS_SET_FLASH_HI_ACTIVE); is_FreezeVideo (hCam, IS_WAIT); Sample Programs SimpleAcquire (C++) - "uc480aquire.exe" CSharpDemo - "uc480_csharp_demo.exe" © 2010 Thorlabs...

  • Page 155: Is_Getactiveimagemem

    Returns the pointer to the starting address of the active image memory. ppcMem Returns the ID of the active image memory. pnID Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_AllocImageMem() is_GetImageMem() is_SetImageMem() is_SetAllocatedImageMem() © 2010 Thorlabs...

  • Page 156: Is_Getactseqbuf

    Contains the starting address of the image memory currently used for image ppcMem capturing. Contains the starting address of the image memory last used for image ppcMemLast capturing. Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_AddToSequence() is_GetImageMem() © 2010 Thorlabs...

  • Page 157: Is_Getautoinfo

    Auto Frame Rate available AC_FRAMERATE Sensor based Auto Frame Rate available AC_SENSOR_FRAMERATE Auto Gain available AC_GAIN Sensor based Auto Gain available AC_SENSOR_GAIN Auto White Balance available AC_WHITEBAL AUTO_BRIGHT_STATUS sBrightCtrlStatus AUTO_BRIGHT_STATUS AUTO_WB_STATUS sWBCtrlStatus AUTO_WB_STATUS reserved Reserved space for extensions DWORD © 2010 Thorlabs...
  • Page 158 Current average greyscale value (actual value) curValue Current control deviation (error) curError Current control status curCtrlStatus Control is active. ACS_ADJUSTING Control is completed. ACS_FINISHED Control is disabled. ACS_DISABLED Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_SetAutoParameter() © 2010 Thorlabs...

  • Page 159: Is_Getbusspeed

    Return Values IS_SUCCESS Only if is passed: No USB 2.0 controller present IS_NO_SUCCESS hCam=0 The controller to which the camera is connected does not support USB IS_USB_10 2.0. The camera is connected to a USB 2.0 controller. IS_USB_20 © 2010 Thorlabs...

  • Page 160: Is_Getcamerainfo

    Camera type unsigned char Type USB DCU camera IS_CAMERA_TYPE_UC480_USB_SE USB DCC camera IS_CAMERA_TYPE_UC480_USB_LE Reserved char Reserved[8] Input Parameters Camera handle hCam Pointer to a data structure pInfo CAMINFO Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS © 2010 Thorlabs...
  • Page 161 DCx camera Related Functions is_GetCameraType() is_CameraStatus() © 2010 Thorlabs...

  • Page 162: Is_Getcameralist

    The information from this data structure should not be used to find a specific camera (e.g. in order to control this specific camera). Instead, we recommend identifying a camera by a fixed camera ID or by the sensor ID. © 2010 Thorlabs...
  • Page 163 + nNumCam sizeof (UC480_CAMERA_IN FO)]; pucl->dwCount = 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); © 2010 Thorlabs...

  • Page 164: Is_Getcameratype

    SDK (Software development Kit) 7.3.25 is_GetCameraType USB 2.0 USB 2.0 Syntax INT is_GetCameraType (HIDS hCam) Description returns the camera type. is_GetCameraType() Input Parameters Camera handle hCam Return Values USB DCU camera IS_CAMERA_TYPE_UC480_USB_SE USB DCC camera IS_CAMERA_TYPE_UC480_USB_LE Related Functions is_GetCameraInfo() © 2010 Thorlabs...

  • Page 165: Is_Getcaptureerrorinfo

    BYTE reserved[60] This array returns the current count for each possible error. The DWORD adwCapErrCnt _Detail[CapErr] possible errors are listed below. To query the counter of a specific error type, pass its definition in the parameter. CapErr © 2010 Thorlabs...
  • Page 166 USB bus for transferring the image Operate fewer cameras simultaneously on a USB bus Check the quality of the USB cabling and components The selected timeout value is too Reduce the exposure time low for image capture Increase the timeout © 2010 Thorlabs...
  • Page 167 DCx camera Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_ResetCaptureErrorInfo() is_GetError() is_CameraStatus() is_SetErrorReport() © 2010 Thorlabs...

  • Page 168: Is_Getcolorconverter

    Default converter for this colour mode pDefaultConvertMode All converters supported for this colour mode pSupportedConvertModes Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS parameter is invalid or not supported. IS_INVALID_COLOR_FORMAT ColorMode Related Functions is_SetColorConverter() is_SetColorMode() © 2010 Thorlabs...

  • Page 169: Is_Getcolordepth

    For a list of all available colour formats and the associated input parameters, see the Appendix: Color and Memory Formats section. Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_SetColorMode() is_AllocImageMem() © 2010 Thorlabs...

  • Page 170: Is_Getdllversion

    Returns the version of the uc480.dll. Input Parameters <none> Return Values The return value contains the version number which is coded as follows: Bits 31-24: Major version Bits 23-16: Minor version Bits 15-0: Build version Related Functions is_GetOsVersion() © 2010 Thorlabs...

  • Page 171: Is_Geterror

    Input Parameters Camera handle hCam Pointer to the variable containing the error code PErr Pointer to the string containing the error text PpcErr Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_GetCaptureErrorInfo() is_SetErrorReport() is_CameraStatus() © 2010 Thorlabs...

  • Page 172: Is_Getexposurerange

    Returns the minimum available exposure time. Returns the maximum available exposure time. Returns the increment you can use to change the image exposure time. intervall Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_SetExposureTime() is_GetPixelClockRange() is_GetFrameTimeRange() is_GetFramesPerSecond() is_SetFrameRate() © 2010 Thorlabs...

  • Page 173: Is_Getframespersecond

    Input Parameters Camera handle hCam Returns the current frame rate. dblFPS Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_GetFrameTimeRange() is_SetFrameRate() is_GetPixelClockRange() is_GetExposureRange() is_GetExposureTime() © 2010 Thorlabs...

  • Page 174: Is_Getframetimerange

    Returns the minimum available frame duration. Returns the maximum available frame duration. Returns the increment you can use to change the frame duration. intervall Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_GetFramesPerSecond() is_SetFrameRate() is_GetPixelClockRange() is_GetExposureRange() © 2010 Thorlabs...
  • Page 175 DCx camera is_GetExposureTime() © 2010 Thorlabs...

  • Page 176: Is_Getglobalflashdelays

    Pointer to the variable that returns the flash delay in µs. pulDelay Pointer to the variable that returns the flash duration in µs. pulDuration Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_SetFlashStrobe() is_SetFlashDelay() is_SetTriggerDelay() © 2010 Thorlabs...

  • Page 177: Is_Getimagehistogram

    3*256 values for colour formats and in raw Bayer mode. In monochrome mode, the array must be able to accommodate 1*256 values. Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Invalid Array IS_NULL_POINTER Unsupported colour format IS_INVALID_COLOR_FORMAT Unknown parameter IS_INVALID_PARAMETER ColorMode © 2010 Thorlabs...
  • Page 178 //Create pointer for each histogram colour DWORD * pBlueHisto = bgrBuffer; DWORD *pGreenHisto = bgrBuffer + DWORD * pRedHisto = bgrBuffer + //Retrieve histogram and release memory is_GetImageHistogram (hCam, nIDSource, IS_SET_CM_RGB , bgrBuffer); is_FreeImageMem (hCam, pcSource, nIDSource); © 2010 Thorlabs...

  • Page 179: Is_Getimageinfo

    Input Parameters Camera handle hCam ID of the image buffer for which information is requested nImageBufferID Pointer to a _ type structure to which the information will be pImageInfo UC480IMAGEINFO written Size of the structure nImageInfoSize © 2010 Thorlabs...
  • Page 180 Internal timestamp of image capture unsigned long long u64TimestampDevice Structure with timestamp information in PC UC480TIME TimestampSystem system time format, see below UC480TIME With Thorlabs DCx cameras, DWORD dwIoStatus dwIoStatus empty. See below. dwIOStatus Internal image number unsigned long long...
  • Page 181 (ImageInfo)); == IS_SUCCESS) nRet unsigned long long u64TimestampDevice; u64TimestampDevice = 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; © 2010 Thorlabs...

  • Page 182: Is_Getimagemem

    Input Parameters Camera handle hCam Pointer to the starting address of the image memory pMem Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_GetImageMemPitch() is_AllocImageMem() is_AddToSequence() is_SetImageMem() is_SetAllocatedImageMem() © 2010 Thorlabs...

  • Page 183: Is_Getimagemempitch

    = 4 - rest(line / 4) line Input Parameters Camera handle hCam Pointer to the variable containing the line increment pPitch Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_GetImageMem() is_AllocImageMem() is_AddToSequence() is_SetImageMem() is_SetAllocatedImageMem() © 2010 Thorlabs...

  • Page 184: Is_Getnumberofcameras

    INT is_GetNumberOfCameras (INT* pnNumCams) Description returns the number of DCx camera cameras connected to the PC. is_GetNumberOfCameras() Input Parameters Returns the number of connected cameras. pNumCams Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_GetCameraList() is_GetEthDeviceInfo() © 2010 Thorlabs...

  • Page 185: Is_Getosversion

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

  • Page 186: Is_Getpixelclockrange

    Individual Technical Data chapter. Input Parameters Camera handle hCam Returns the lower limit value. pnMin Returns the upper limit value. pnMax Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_SetPixelClock() is_GetFramesPerSecond() is_GetFrameTimeRange() is_GetExposureRange() is_GetExposureTime() © 2010 Thorlabs...

  • Page 187: Is_Getsensorinfo

    Indicates whether the sensor provides analogue green BOOL bGGain channel gain. Indicates whether the sensor provides analogue blue BOOL bBGain channel gain. Indicates whether the sensor has a global shutter. BOOL bGlobShutter = global shutter TRUE = rolling shutter FALSE Reserved Char Reserved[16] © 2010 Thorlabs...
  • Page 188 SDK (Software development Kit) Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_GetCameraInfo() is_CameraStatus() © 2010 Thorlabs...

  • Page 189: Is_Getsupportedtestimages

    DCx camera 7.3.43 is_GetSupportedTestImages USB 2.0 USB 2.0 Syntax INT is_GetSupportedTestImages (HIDS hCam, INT* SupportedTestImages) Description returns all test images supported by the camera. You can enable is_GetSupportedTestImages() the sensor test image feature using is_SetSensorTestImage() © 2010 Thorlabs...
  • Page 190 Camera image overlaid with a grid of blue dots IS_TEST_IMAGE_HOTPIXEL_GRID Camera image overlaid with a grid of red dots Adjustable greyscale image IS_TEST_IMAGE_VARIABLE_GREY Image with adjustable red content IS_TEST_IMAGE_VARIABLE_RED_PART Image with adjustable green content IS_TEST_IMAGE_VARIABLE_GREEN_PART IS_TEST_IMAGE_VARIABLE_BLUE_PART Image with adjustable blue content © 2010 Thorlabs...
  • Page 191 DCx camera Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS The test image function is not supported by the camera. IS_NOT_SUPPORTED Related Functions is_SetSensorTestImage() is_GetTestImageValueRange() © 2010 Thorlabs...

  • Page 192: Is_Gettestimagevaluerange

    Maximum value TestImageValueMax Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS The test image function is not supported by the camera. In this IS_NOT_SUPPORTED case, TestImageValueMin TestImageValueMax parameters are equal to 0. Related Functions is_GetSupportedTestImages() is_SetSensorTestImage() © 2010 Thorlabs...

  • Page 193: Is_Gettimeout

    General error message IS_NO_SUCCESS The value for is invalid IS_NOT_SUPPORTED nMode pointer is IS_INVALID_PARAMETER pTimeout NULL Related Functions is_SetTimeout() is_CaptureVideo() is_FreezeVideo() is_SetExternalTrigger() Code Sample // Return user-defined timeout UINT nTimeout; is_GetTimeout INT ret = (hCam, IS_TRIGGER_TIMEOUT, &nTimeout); © 2010 Thorlabs...

  • Page 194: Is_Getusedbandwidth

    (bits per pixel). The actual data load on the bus can slightly deviate from this value. Input Parameters Camera handle hCam Return Values value The total current bus bandwidth (in Mbit/s) Related Functions is_SetPixelClock() © 2010 Thorlabs...

  • Page 195: Is_Getvsynccount

    It will be incremented by 1 each time the sensor is_GetVsyncCount() VSYNC starts capturing an image. Input Parameters Camera handle hCam Current count pIntr VSYNC Current count pActIntr Frame SYNC Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_GetFramesPerSecond() © 2010 Thorlabs...

  • Page 196: Is_Hasvideostarted

    IS_DONT_WAIT parameter. Input Parameters Camera handle hCam Returns the digitising status: = Image capturing has not started yet. = Image capturing has started. Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_FreezeVideo() is_IsVideoFinish() © 2010 Thorlabs...

  • Page 197: Is_Initcamera

    To initialize or select the next available camera without specifying a camera ID, phf has to be preset with 0. We recommend that you call the following functions exclusively from a single thread in order to avoid unpredictable behavior of the application. is_InitCamera() is_SetDisplayMode() is_ExitCamera() See also General: Thread Programming © 2010 Thorlabs...
  • Page 198 General error message IS_NO_SUCCESS The camera's starter firmware is not compatible with the driver IS_STARTER_FW_UPLOAD_NEEDED and needs to be updated. Related Functions is_ExitCamera() is_EnableAutoExit() is_GetCameraList() is_SetCameraID() is_GetCameraInfo() (not for Thorlabs DCx cameras) is_GetDuration() (not for Thorlabs DCx cameras) is_SetStarterFirmware() © 2010 Thorlabs...
  • Page 199 //Calculate time needed for updating the starter firmware INT nTime; is_GetDuration (hCam, IS_SE_STARTER_FW_UPLOAD, &nTime); ... e.g. have progress bar displayed in separate thread //Upload new starter firmware during initialization is_InitCamera nRet = (&hCam | IS_ALLOW_STARTER_FW_UPLOAD, NULL); ... end progress bar Sample Programs CSharpDemo (C#) © 2010 Thorlabs...

  • Page 200: Is_Initevent

    This is independent of the device handle ( is ignored). hCam A camera was removed. IS_SET_EVENT_REMOVAL This is independent of the device handle ( is ignored). hCam The automatic white balance control is completed. IS_SET_EVENT_WB_FINISHED Not available under Linux. © 2010 Thorlabs...
  • Page 201 (hEvent != NULL) //Enable frame event, start image capture and wait for event: is_InitEvent(hCam, hEvent, IS_SET_EVENT_FRAME); is_EnableEvent(hCam, IS_SET_EVENT_FRAME); is_FreezeVideo(hCam, IS_DONT_WAIT); (WaitForSingleObject(hEvent, 1000) == WAIT_OBJECT_0) // Image was captured successfully is_DisableEvent(hCam, IS_SET_EVENT_FRAME); is_ExitEvent(hCam, IS_SET_EVENT_FRAME); Sample Programs SimpleLive (C++) © 2010 Thorlabs...

  • Page 202: Is_Inquireimagemem

    Returns the bit width used to define the image memory (can be 0). pnBits Returns the line increment of the image memory (can be 0). pnPitch Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_AllocImageMem() is_SetImageMem() is_SetAllocatedImageMem() is_GetColorDepth() © 2010 Thorlabs...

  • Page 203: Is_Isvideofinish

    = Digitising of the image is not completed yet. IS_VIDEO_NOT_FINISH = Digitising of the image is completed. IS_VIDEO_FINISH = Transfer error or conversion problem (e.g. destination IS_TRANSFER_FAILED memory is invalid) Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_FreezeVideo() is_HasVideoStarted() © 2010 Thorlabs...

  • Page 204: Is_Loadbadpixelcorrectiontable

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

  • Page 205: Is_Loadimage

    The size of the image to be loaded exceeds the active IS_FILE_READ_INVALID_BMP_SIZE image memory size. The file to be loaded is not a valid bitmap file. IS_FILE_READ_INVALID_BMP_ID The file could not be opened. IS_FILE_READ_OPEN_ERROR Related Functions Is_LoadImageMem() is_GetImageMem() is_SetImageMem() is_SaveImage() is_SaveImageEx() is_SaveImageMem() is_SaveImageMemEx() © 2010 Thorlabs...

  • Page 206: Is_Loadimagemem

    Pointer to a variable containing the memory ID Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Bitmap format of the image to be loaded is invalid. IS_FILE_READ_INVALID_BMP_ID File cannot be opened. IS_FILE_READ_OPEN_ERROR Related Functions Is_LoadImage() is_GetImageMem() is_SetImageMem() is_SaveImage() is_SaveImageEx() is_SaveImageMem() is_SaveImageMemEx() © 2010 Thorlabs...

  • Page 207: Is_Loadparameters

    You can load the parameter sets stored in the camera EEPROM using specific filenames: pFilename Parameter set 1 "\\cam\\set1" "/cam/set1" Parameter set 2 "\\cam\\set2" "/cam/set2" Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS This is the ini file of a different camera type IS_INVALID_CAMERA_TYPE Related Functions is_SaveParameters() © 2010 Thorlabs...

  • Page 208: Is_Lockseqbuf

    Starting address of the image memory to be locked pcMem indicates the location in the sequence list, not the memory ID assigned using nNum is_AllocImageMem() Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_UnlockSeqBuf() is_AddToSequence() is_SetImageMem() is_SetAllocatedImageMem() © 2010 Thorlabs...

  • Page 209: Is_Readeeprom

    Pointer to the buffer for the data to read (min. size = pcString Count Number of characters to read Count Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_WriteEEPROM() Code Sample char buffer[64]; is_ReadEEPROM ( hCam, 0x00, buffer, © 2010 Thorlabs...

  • Page 210: Is_Renderbitmap

    The following options can be linked by a logical OR using the parameter: nMode Mirrors the displayed image along the horizontal axis. IS_RENDER_MIRROR_UPDOWN Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_AllocImageMem() is_SetColorMode() is_SetDisplayMode() is_DirectRenderer() © 2010 Thorlabs...
  • Page 211 DCx camera Code Sample 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 uc480Acquire (C++) © 2010 Thorlabs...

  • Page 212: Is_Resetcaptureerrorinfo

    You can retrieve this list using the function. is_GetCaptureErrorInfo() Input Parameters Camera handle hCam Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_GetCaptureErrorInfo() is_GetError() is_CameraStatus() © 2010 Thorlabs...

  • Page 213: Is_Resettodefault

    By default, the camera uses full resolution, a medium speed and colour level gain values adapted to daylight exposure. All optional features are disabled. Input Parameters Camera handle hCam Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_LoadParameters() is_SaveParameters() © 2010 Thorlabs...

  • Page 214: Is_Savebadpixelcorrectiontable

    File stored. You can either pass an absolute or a relative path. is passed, the "Save as" dialogue will be displayed. NULL Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_LoadBadPixelCorrectionTable() is_SetBadPixelCorrection() is_SetBadPixelCorrectionTable() © 2010 Thorlabs...

  • Page 215: Is_Saveimage

    Pointer to a string containing the BMP filename You can either pass an absolute File or a relative path. is passed, the "Save as" dialogue will be displayed. NULL Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_SaveImageEx() is_SaveImageMem() is_SaveImageMemEx() is_LoadImage() Is_LoadImageMem() is_GetImageMem() is_SetImageMem() © 2010 Thorlabs...

  • Page 216: Is_Saveimageex

    , the system uses the default quality (75). Param=0 If you use does not take effect. IS_IMG_BMP Param Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Invalid file format or invalid JPEG quality value IS_INVALID_PARAMETER © 2010 Thorlabs...
  • Page 217 DCx camera Related Functions is_SaveImage() is_SaveImageMem() is_SaveImageMemEx() is_LoadImage() Is_LoadImageMem() is_GetImageMem() is_SetImageMem() © 2010 Thorlabs...

  • Page 218: Is_Saveimagemem

    You can link by a logical OR to save the image USE_ACTUAL_IMAGE_SIZE with the currently set image size. Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_SaveImage() is_SaveImageEx() is_SaveImageMemEx() is_LoadImage() Is_LoadImageMem() is_GetImageMem() is_SetImageMem() © 2010 Thorlabs...

  • Page 219: Is_Saveimagememex

    , the system uses the default quality (75). Param=0 If you use does not take effect. IS_IMG_BMP Param Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Invalid file format or invalid JPEG quality value IS_INVALID_PARAMETER © 2010 Thorlabs...
  • Page 220 SDK (Software development Kit) Related Functions is_SaveImage() is_SaveImageEx() is_SaveImageMem() is_LoadImage() Is_LoadImageMem() is_GetImageMem() is_SetImageMem() © 2010 Thorlabs...

  • Page 221: Is_Saveparameters

    You can save two parameter sets in the non-volatile EEPROM of the camera using specific filenames: pFileName Parameter set 1 "\\cam\\set1" "/cam/set1" Parameter set 2 "\\cam\\set2" "/cam/set2" Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_LoadParameters() is_CameraStatus() © 2010 Thorlabs...

  • Page 222: Is_Setallocatedimagemem

    Image height height Image colour depth (bits per pixel) bitspixel Pointer to the starting address of the allocated memory pcImgMem Returns the ID of this memory. Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS © 2010 Thorlabs...
  • Page 223 DCx camera Related Functions is_AllocImageMem() is_FreeImageMem() is_AddToSequence() is_SetImageMem() is_GetColorDepth() is_GetImgMemPitch() © 2010 Thorlabs...

  • Page 224: Is_Setaoi

    If you want the image to be copied to the same offset within the memory, you can link the new position with a logical OR to the parameters. IS_SET_IMAGEPOS_X_ABS IS_SET_IMAGEPOS_Y_ABS © 2010 Thorlabs...
  • Page 225 Returns the current setting when used together with parameters. IS_GET_... Pointer to the height of the AOI pHeight Returns the current setting when used together with parameters. IS_GET_... Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_SetImagePos() is_SetBinning() is_SetSubSampling() is_SetAutoParameter() © 2010 Thorlabs...

  • Page 226: Is_Setautoparameter

    The sensor's internal auto functions are not supported by the sensor of DCC/DCU cameras. Automatic control by the sensor and the software is not possible simultaneously. To use the sensor's control functionality, disable software control, and vice versa. © 2010 Thorlabs...
  • Page 227 = 1 enables, 0 disables control pval1 Returns the current auto frame rate setting. IS_GET_ENABLE_AUTO_FRAMERATE returns the current value pval1 Enables / disables the sensor's internal auto frame rate IS_SET_ENABLE_AUTO_SENSOR_FRAMERATE function. * = 1 enables, 0 disables control pval1 © 2010 Thorlabs...
  • Page 228 SDK (Software development Kit) Returns the current setting of the sensor's internal auto IS_GET_ENABLE_AUTO_SENSOR_FRAMERATE frame rate function * returns the current value pval1 Adjust auto gain/auto exposure © 2010 Thorlabs...
  • Page 229 Enables / disables automatic disabling of auto gain / IS_SET_AUTO_BRIGHTNESS_ONCE auto exposure ** = 1 enables, 0 disables control pval1 Returns the automatic disable status of auto gain / IS_GET_AUTO_BRIGHTNESS_ONCE auto exposure ** returns the current value pval1 © 2010 Thorlabs...
  • Page 230 IS_SET_AUTO_WB_ONCE = 1 enables, 0 disables control pval1 Returns the automatic disable status of auto white balance IS_GET_AUTO_WB_ONCE returns the current value pval1 Pre-defined values for auto gain/auto exposure For parameters must be passed. pval1 pval NULL © 2010 Thorlabs...
  • Page 231 Code Samples //Enable auto gain: double dEnable = is_SetAutoParameter ret = (hCam ,IS_SET_ENABLE_AUTO_GAIN, &dEnable, //Set brightness setpoint value to 128: double nominal = is_SetAutoParameter ret = (hCam,IS_SET_AUTO_REFERENCE, &nominal, //Return shutter control limit: © 2010 Thorlabs...
  • Page 232 SDK (Software development Kit) double maxShutter; is_SetAutoParameter ret = (hCam, IS_GET_AUTO_SHUTTER_MAX, &maxShutter, © 2010 Thorlabs...

  • Page 233: Is_Setbadpixelcorrection

    IS_GET_BPC_THRESHOLD Currently not used threshold Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Current mode when used in connection with IS_GET_BPC_MODE Current threshold value when used in connection with IS_GET_BPC_THRESHOLD Related Functions is_LoadBadPixelCorrectionTable() is_SaveBadPixelCorrectionTable() is_SetBadPixelCorrectionTable() © 2010 Thorlabs...

  • Page 234: Is_Setbadpixelcorrectiontable

    Pointer to the starting address of the hot pixel table pList Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Number of coordinates in the list when used together with IS_GET_LIST_SIZE Related Functions is_LoadBadPixelCorrectionTable() is_SaveBadPixelCorrectionTable() is_SetBadPixelCorrection() © 2010 Thorlabs...
  • Page 235 // Number of coordinates in the list is_SetBadPixelCorrectionTable DWORD nCount = (hCam, IS_GET_LIST_SIZE, NULL); // Allocate memory for the entire list pList = WORD[ *nCount ]; // Read out list is_SetBadPixelCorrectionTable (hCam, IS_GET_BADPIXEL_LIST, pList); // Release the list again delete [] pList; © 2010 Thorlabs...

  • Page 236: Is_Setbinning

    Changes to the image geometry or pixel clock affect the value ranges of the frame rate and exposure time. After executing is_SetBinning , calling the following functions is recommended in order to keep the defined camera settings: is_SetFrameRate() is_SetExposureTime() If you are using the DCx camera's flash function: is_SetFlashStrobe() © 2010 Thorlabs...
  • Page 237 Current setting when used together with IS_GET_BINNING IS_GET_BINNING_FACTOR_VERTICAL IS_GET_BINNING_FACTOR_HORIZONTAL When used with Returns IS_BINNING_COLOR if the camera uses colour-proof subsampling; IS_GET_BINNING_TYPE otherwise, IS_BINNING_MONO is returned. When used with Returns the supported subsampling modes linked by logical ORs. IS_GET_SUPPORTED_BINNING Related Functions is_SetSubSampling() is_SetAOI() © 2010 Thorlabs...
  • Page 238 SDK (Software development Kit) is_SetImagePos() is_SetPixelClock() © 2010 Thorlabs...

  • Page 239: Is_Setblcompensation

    By default, the sensor adjusts the black level value for each pixel automatically. If the environment is very bright, it can be necessary to adjust the black level manually. <%FIGURE_TEXT%> <%IMAGE++%>: Schw arzw ert-Korrektur Offset <%FIGURE_TEXT%> <%IMAGE++%>: Black level correction - Auto © 2010 Thorlabs...
  • Page 240 Reserved. 0 must be passed. reserved Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Supported modes when used together with IS_GET_BL_SUPPORTED_MODE Current mode when used together with IS_GET_BL_COMPENSATION Current offset when used together with IS_GET_BL_OFFSET © 2010 Thorlabs...

  • Page 241: Is_Setcameraid

    1. The camera ID can also be changed in the Camera Manager. Input Parameters Camera handle hCam New camera ID 1...254 Returns the current ID. IS_GET_CAMERA_ID Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Current ID when used together with IS_GET_CAMERA_ID Related Functions is_InitCamera() is_GetCameraInfo() is_CameraStatus() © 2010 Thorlabs...

  • Page 242: Is_Setcolorconverter

    , you can select the type of Bayer conversion for colour cameras. is_SetColorConverter Software conversion is done on the PC, while hardware conversion (not supported by Thorlabs DCx cameras) is done in the camera. The use of a larger filter mask results in a higher image quality, but increases the computational load.
  • Page 243 DCx camera Related Functions is_GetColorConverter() is_SetColorMode() is_ConvertImage() © 2010 Thorlabs...

  • Page 244: Is_Setcolorcorrection

    General error message IS_NO_SUCCESS Current setting when used together with IS_GET_CCOR_MODE When used together with When used for colour cameras and together with , this parameter returns IS_GET_SUPPORTED_CCOR_MODE IS_GET_SUPPORTED_CCOR_MODE the supported values linked by a logical OR: IS_CCOR_ENABLE_NORMAL © 2010 Thorlabs...
  • Page 245 When used together with When used for colour cameras and together with IS_GET_DEFAULT_CCOR_MODE IS_GET_DEFAULT_CCOR_MODE this parameter returns the default colour correction mode: IS_CCOR_ENABLE_NORMAL IS_CCOR_ENABLE_HQ_ENHANCED When used for monochrome cameras, the system returns 0. Related Functions is_SetColorConverter() is_SetColorMode() is_SetAutoParameter() © 2010 Thorlabs...

  • Page 246: Is_Setcolormode

    Otherwise, the images will be displayed with altered colours or are not clearly visible. For the RGB16 and RGB15 data formats, the MSBs of the internal 8-bit R, G and B colours are used. © 2010 Thorlabs...
  • Page 247 UYVY (8 8 8 8) IS_CM_UYVY_BAYER_PACKED CbYCrY (8 8 8 8) IS_CM_CBYCRY_PACKED Returns the current setting. IS_GET_COLOR_MODE Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Current setting when used together with IS_GET_COLOR_MODE Related Functions is_SetDisplayMode() © 2010 Thorlabs...
  • Page 248 SDK (Software development Kit) is_SetColorConverter() is_SetColorCorrection() is_GetColorDepth() is_AllocImageMem() © 2010 Thorlabs...

  • Page 249: Is_Setconvertparam

    Gamma Pointer to an array containing the red, green and blue gain WhiteBalanceMultipliers values Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Invalid parameter IS_INVALID_COLOR_FORMAT ColorMode Other invalid parameter. IS_INVALID_PARAMETER Related Functions is_ConvertImage() is_SetColorMode() is_SetColorConverter() © 2010 Thorlabs...
  • Page 250 = (hCam, TRUE, IS_SET_BAYER_CV_BETTER, IS_SET_CM_RGB , Gamma, rgbGains); // Convert image (nRet == IS_SUCCESS) pcDest = NULL; is_ConvertImage (hCam, pcSource, nIDSource, &pcDest, &nIDDest, // Release allocated image memory is_FreeImageMem (hCam, pcSource, nIDSource); is_FreeImageMem (hCam, pcDest, nIDDest); © 2010 Thorlabs...

  • Page 251: 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: Mode Image display in DirectDraw BackBuffer mode IS_SET_DM_DIRECTDRAW | IS_SET_DM_BACKBUFFER Image display in DirectDraw Overlay Surface mode IS_SET_DM_DIRECTDRAW | IS_SET_DM_ALLOW_OVERLAY Real-time scaling in Overlay Surface mode IS_SET_DM_ALLOW_SCALING © 2010 Thorlabs...
  • Page 252 General error message IS_NO_SUCCESS Current setting when used together with IS_GET_DISPLAY_MODE Related Functions is_RenderBitmap() is_SetColorMode() is_DirectRenderer() Code Sample is_SetDisplayMode (hCam, Mode); //Bitmap mode (images are digitised and stored in system memory): Mode = IS_SET_DM_DIB //Direct3D mode Mode = IS_SET_DM_DIRECT3D © 2010 Thorlabs...

  • Page 253: Is_Setdisplaypos

    . This does not alter the image memory contents. is_RenderBitmap() Input Parameters Camera handle hCam Offset in x direction Offset in y direction Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_SetImagePos() is_SetAOI() is_RenderBitmap() is_SetDisplayMode() © 2010 Thorlabs...

  • Page 254: Is_Setedgeenhancem Ent

    IS_EDGE_EN_DISABLE Enables strong edge enhancement. IS_EDGE_EN_STRONG Enables weaker edge enhancement. IS_EDGE_EN_WEAK Returns the current setting. IS_GET_EDGE_ENHANCEMENT Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Current setting when used together with IS_GET_EDGE_ENHANCEMENT Related Functions is_SetColorMode() is_SetColorConverter() © 2010 Thorlabs...

  • Page 255: Is_Seterrorreport

    Camera handle or 0 if no camera has been initialised yet hCam Mode Disables error reporting. IS_DISABLE_ERR_REP Enables error reporting. IS_ENABLE_ERR_REP Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Current setting when used together with IS_GET_ERR_REP_MODE Related Functions is_GetError() is_GetCaptureErrorInfo() is_CameraStatus() © 2010 Thorlabs...

  • Page 256: Is_Setexposuretime

    , the exposure time is 1/frame rate. EXP=0.0 Returns the current exposure time in the IS_GET_EXPOSURE_TIME newEXP parameter. Returns the default exposure time. IS_GET_DEFAULT_EXPOSURE Enables the auto exposure function. IS_SET_ENABLE_AUTO_SHUTTER Returns the exposure time actually set. newEXP © 2010 Thorlabs...
  • Page 257 DCx camera Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_GetExposureRange() is_SetFrameRate() is_SetPixelClock() is_SetOptimalCameraTiming() is_SetAutoParameter() is_SetHardwareGain() © 2010 Thorlabs...

  • Page 258: Is_Setexternaltrigger

    (continuous mode) Returns the trigger mode setting IS_GET_EXTERNALTRIGGER Returns the current signal level at the trigger input IS_GET_TRIGGER_STATUS Returns the supported trigger modes IS_GET_SUPPORTED_TRIGGER_MODE The freerun synchronisation mode is currently not supported by the DCx camera series. © 2010 Thorlabs...
  • Page 259 Returns the supported modes linked by logical ORs IS_GET_SUPPORTED_TRIGGER_MODE Related Functions is_CaptureVideo() is_FreezeVideo() is_ForceTrigger() is_SetTriggerCounter() is_SetTriggerDelay() is_SetFlashStrobe() Code Sample //Enable trigger mode and set high-active flash mode. is_SetExternalTrigger (hCam, IS_SET_TRIGGER_SOFTWARE); is_SetFlashStrobe (hCam, IS_SET_FLASH_HI_ACTIVE, 0); is_FreezeVideo (hCam, IS_WAIT); © 2010 Thorlabs...

  • Page 260: Is_Setflashdelay

    If 0 is passed, the flash output will be active until the end of the exposure time. Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Current setting when used together with IS_GET_FLASH_DELAY IS_GET_FLASH_DURATION Related Functions is_SetFlashStrobe() is_GetGlobalFlashDelays() is_SetExternalTrigger() © 2010 Thorlabs...
  • Page 261 DCx camera is_SetTriggerDelay() © 2010 Thorlabs...

  • Page 262: Is_Setflashstrobe

    IS_SET_FLASH_LOW Returns the current mode. IS_GET_FLASHSTROBE_MODE Enable additionally the flash functions for GPIO port 1 IS_SET_FLASH_IO_1 Enable additionally the flash functions for GPIO port 1 IS_SET_FLASH_IO_2 Returns the supported flash-enabled I/O ports IS_GET_SUPPORTED_FLASH_IO Currently not used. nLine © 2010 Thorlabs...
  • Page 263 //Enable trigger mode and set high-active flash mode. is_SetExternalTrigger (hCam, IS_SET_TRIGGER_SOFTWARE); is_SetFlashStrobe (hCam, IS_SET_FLASH_HI_ACTIVE, 0); is_FreezeVideo (hCam, IS_WAIT); // Enable additional flash output on GPIO 2 is_SetFlashStrobe (hCam, IS_SET_FLASH_HI_ACTIVE | IS_SET_FLASH_IO_2, 0); // Flash function only on normal digital output is_SetFlashStrobe (hCam, IS_SET_FLASH_HI_ACTIVE, 0); © 2010 Thorlabs...

  • Page 264: Is_Setframerate

    Desired frame rate in frames per second (fps) Only returns the current frame rate in the IS_GET_FRAMERATE newFPS parameter. Returns the default frame rate. IS_GET_DEFAULT_FRAMERATE Returns the frame rate actually set. newFPS Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS © 2010 Thorlabs...
  • Page 265 DCx camera Related Functions is_GetFramesPerSecond() is_GetFrameTimeRange() is_SetPixelClock() is_SetOptimalCameraTiming() is_SetExposureTime() is_SetAutoParameter() is_SetAOI() is_SetSubSampling() is_SetBinning() is_CaptureVideo() © 2010 Thorlabs...

  • Page 266: Is_Setgainboost

    Current setting when used together with Returns 0 if the camera does not support a gain boost feature. IS_GET_GAINBOOST Current setting when used together with Returns if the function is IS_SET_GAINBOOST_ON supported, otherwise it returns IS_GET_SUPPORTED_GAINBOOST IS_SET_GAINBOOST_OFF Related Functions is_SetHardwareGain() is_SetHWGainFactor() is_SetAutoParameter() © 2010 Thorlabs...

  • Page 267: Is_Setgamma

    (Range: 1…1000. Default = 100, corresponds to a gamma value of 1.0) Returns the current setting. IS_GET_GAMMA Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Current setting when used together with IS_GET_GAMMA Related Functions is_SetHardwareGamma() © 2010 Thorlabs...

  • Page 268: Is_Setglobalshutter

    Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Current setting when used together with IS_GET_GLOBAL_SHUTTER When used together with Returns if this function is IS_SET_GLOBAL_SHUTTER_ON supported. Otherwise, returns IS_GET_SUPPORTED_GLOBAL_SHUTT IS_SET_GLOBAL_SHUTTER_OFF Related Functions is_GetGlobalFlashDelays() is_SetExternalTrigger() is_SetFlashStrobe() © 2010 Thorlabs...

  • Page 269: Is_Sethardwaregain

    The default setting values for the red, green and blue channel gain factors depend on the colour correction matrix that has been set. If you select a different colour correction matrix, the returned default values might change (see also is_SetColorCorrection() © 2010 Thorlabs...
  • Page 270 The blue channel gain factor will not be changed. IS_IGNORE_PARAMETER Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Current setting When used together with IS_GET_MASTER_GAIN IS_GET_RED_GAIN IS_GET_GREEN_GAIN IS_GET_BLUE_GAIN Camera is in standby mode, function not allowed. IS_INVALID_MODE Related Functions is_SetHWGainFactor() is_GetSensorInfo() © 2010 Thorlabs...
  • Page 271 DCx camera is_SetGainBoost() is_SetAutoParameter() © 2010 Thorlabs...

  • Page 272: Is_Sethwgainfactor

    Converts the index value for the red channel gain IS_INQUIRE_RED_GAIN_FACTOR factor. Converts the index value for the green channel gain IS_INQUIRE_GREEN_GAIN_FACTOR factor. Converts the index value for the blue channel gain IS_INQUIRE_BLUE_GAIN_FACTOR factor. Gain value (100 = gain factor 1, i. e. no effect) nFactor © 2010 Thorlabs...
  • Page 273 Defined setting when used together with IS_SET_MASTER_GAIN_FACTOR IS_SET_RED_GAIN_FACTOR IS_SET_GREEN_GAIN_FACTOR IS_SET_BLUE_GAIN_FACTOR. Default setting when used together with IS_GET_DEFAULT_MASTER_GAIN_FACTOR IS_GET_DEFAULT_RED_GAIN_FACTOR IS_GET_DEFAULT_GREEN_GAIN_FACTOR IS_GET_DEFAULT_BLUE_GAIN_FACTOR. When used together with Converted gain index IS_INQUIRE_MASTER_GAIN_FACTOR IS_INQUIRE_RED_GAIN_FACTOR IS_INQUIRE_GREEN_GAIN_FACTOR IS_INQUIRE_BLUE_GAIN_FACTOR. Related Functions is_SetHardwareGain() is_SetHardwareGamma() is_SetGainBoost() is_SetAutoParameter() is_GetSensorInfo() © 2010 Thorlabs...
  • Page 274 INT ret = (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: is_SetHWGainFactor ret = (hCam, IS_INQUIRE_RED_GAIN_FACTOR, 100); //ret has the value 725 for the UI-1460-C © 2010 Thorlabs...

  • Page 275: Is_Setimagemem

    Input Parameters Camera handle hCam Pointer to the starting position in the memory. pcImgMem ID of this memory. Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_AllocImageMem() is_FreeImageMem() is_AddToSequence() is_SetAllocatedImageMem() is_GetColorDepth() is_GetImageMem() is_GetImageMemPitch() © 2010 Thorlabs...

  • Page 276: Is_Setimagepos

    The cut window is copied to the start position in the memory. If you want the image to be copied to the same offset within the memory, you can link the new position with a logical OR to the parameters. IS_SET_IMAGE_POS_X_ABS IS_SET_IMAGE_POS_Y_ABS © 2010 Thorlabs...
  • Page 277 Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Parameters are invalid ( , y < 0) IS_INVALID_PARAMETER Current setting when used together with parameters IS_GET_IMAGE_POS Camera is in standby mode, function not allowed. IS_INVALID_MODE Related Functions is_SetAOI() © 2010 Thorlabs...
  • Page 278 SDK (Software development Kit) Example Figure <%IMAGE++%>: Exam ples for is_SetIm agePos © 2010 Thorlabs...

  • Page 279: Is_Setled

    Input Parameters Camera handle hCam nValue Switches LED to red. IS_SET_LED_OFF Switches LED to green. IS_SET_LED_ON Toggles between red and green. IS_SET_LED_TOGGLE Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_SetIO() is_SetFlashStrobe() is_SetExternalTrigger() © 2010 Thorlabs...

  • Page 280: Is_Setoptimalcameratiming

    Returns the maximum frame rate (in fps). pMaxFrameRate Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Automatic exposure is active. IS_AUTO_EXPOSURE_RUNNING input parameter is not correct. IS_INVALID_PARAMETER Timeout The camera is operating in trigger mode. IS_TRIGGER_ACTIVATED © 2010 Thorlabs...
  • Page 281 DCx camera Related Functions is_SetPixelClock() is_SetFrameRate() is_SetAutoParameter() is_CaptureVideo() © 2010 Thorlabs...

  • Page 282: Is_Setpixelclock

    Current setting when used together with IS_GET_PIXEL_CLOCK Camera is in standby mode, function not allowed. IS_INVALID_MODE The value for is outside the pixel clock range IS_INVALID_PARAMETER Clock supported by the camera. Related Functions is_SetOptimalCameraTiming() is_SetFrameRate() is_SetExposureTime() is_SetAutoParameter() is_SetBinning() © 2010 Thorlabs...
  • Page 283 DCx camera is_SetSubSampling() is_SetAOI() © 2010 Thorlabs...

  • Page 284: Is_Setropeffect

    Reserved. 0 must be passed. reserved Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Current setting when used together with IS_SET_ROP_EFFECT Camera is in standby mode, function not allowed. IS_INVALID_MODE Related Functions is_SetBinning() is_SetSubSampling() is_SetAOI() is_SetImagePos() © 2010 Thorlabs...

  • Page 285: Is_Setsaturation

    Returns the current value for the V saturation. IS_GET_SATURATION_V Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Current setting when used together with IS_GET_SATURATION_U IS_GET_SATURATION_V Invalid value for the parameter. IS_INVALID_PARAMETER ChromU ChromV Related Functions is_SetColorMode() is_SetColorCorrection() is_SetHardwareGamma() is_SetColorConverter() © 2010 Thorlabs...

  • Page 286: Is_Setsensorscaler

    This allows to reduce the is_SetSensorScaler() image resolution by adjustable factors. Thus, the amount of data from high resolution sensors can be reduced. Internal image scaling is not supported by Thorlabs DCx cameras. Input Parameters Camera handle hCam...
  • Page 287 DCx camera // Enable scaling with anti aliasing dblNewFactor = Info.dblMinFactor + Info.dblFactorIncrement; is_SetSensorScaler nRet = (hCam, IS_ENABLE_SENSOR_SCALER | IS_ENABLE_ANTI_ALIASING, dblNewFactor); © 2010 Thorlabs...

  • Page 288: Is_Setsensortestimage

    Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS parameter is not within the allowed value IS_INVALID_PARAMETER Param range. The test image function is not supported by the camera. IS_NOT_SUPPORTED Related Functions is_GetSupportedTestImages() is_GetTestImageValueRange() © 2010 Thorlabs...

  • Page 289: Is_Setsubsampling

    Changes to the image geometry or pixel clock affect the value ranges of the frame rate and exposure time. After executing is_SetBinning , calling the following functions is recommended in order to keep the defined camera settings: is_SetFrameRate() is_SetExposureTime() If you are using the DCU camera's flash function: is_SetFlashStrobe() © 2010 Thorlabs...
  • Page 290 General error message IS_NO_SUCCESS Current setting when used together with Returns if the camera IS_SUBSAMPLING_COLOR uses colour-proof sub-sampling, else IS_GET_SUBSAMPLING IS_SUBSAMPLING_MONO When used with Returns the supported sub-sampling modes linked by logical ORs IS_GET_SUPPORTED_SUBSAMPLING Related Functions is_SetBinning() © 2010 Thorlabs...
  • Page 291 DCx camera is_SetAOI() is_SetImagePos() is_SetPixelClock() © 2010 Thorlabs...

  • Page 292: Is_Settimeout

    For 1...3, the value 4 is used. Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS The value for is invalid IS_NOT_SUPPORTED nMode Related Functions is_GetTimeout() is_CaptureVideo() is_FreezeVideo() is_SetExternalTrigger() Code Sample // Set user-defined timeout to 120 seconds is_SetTimeout (hCam, IS_TRIGGER_TIMEOUT, 12000); © 2010 Thorlabs...

  • Page 293: Is_Settriggercounter

    Input Parameters Camera handle hCam nValue Returns the current hardware trigger count IS_GET_TRIGGER_COUNTER Other values Resets the hardware trigger counter Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_SetExternalTrigger() is_CameraStatus() © 2010 Thorlabs...

  • Page 294: Is_Settriggerdelay

    Returns the maximum adjustable value. IS_GET_MAX_TRIGGER_DELAY Returns the resolution of the adjustable delay time. IS_GET_TRIGGER_DELAY_GRANULARITY Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Current setting when used together with IS_GET_TRIGGER_DELAY Related Functions is_SetFlashDelay() is_SetFlashStrobe() is_GetGlobalFlashDelays() is_SetExternalTrigger() © 2010 Thorlabs...

  • Page 295: Is_Stoplivevideo

    The function waits until the image save is complete. IS_WAIT The function returns immediately. Digitising the image is IS_DONT_WAIT completed in the background. Digitising is stopped immediately. IS_FORCE_VIDEO_STOP Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_FreezeVideo() is_CaptureVideo() is_SetDisplayMode() © 2010 Thorlabs...

  • Page 296: Is_Unlockseqbuf

    ID nNum assigned with is_AllocImageMem() Starting address of the image memory pcMem Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_LockSeqBuf() © 2010 Thorlabs...

  • Page 297: Is_Waitevent

    Related Functions is_InitEvent() is_EnableEvent() is_DisableEvent() is_ExitEvent() Code Sample //Activate and initialise FRAME event is_EnableEvent (hCam, IS_SET_EVENT_FRAME); is_InitEvent (hCam, IS_SET_EVENT_FRAME); //Start image capture and wait 1000 ms for event to occur is_FreezeVideo (hCam, IS_DONT_WAIT); is_WaitEvent (hCam, IS_SET_EVENT_FRAME, 1000); © 2010 Thorlabs...

  • Page 298: Is_Writeeeprom

    Pointer to the string containing the data to be written pcString Number of characters to be written (1...64) Count Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Camera is in standby mode, function not allowed. IS_INVALID_MODE Related Functions is_ReadEEPROM() © 2010 Thorlabs...

  • Page 299: Avi Function Descriptions

    The functions of the uc480_tools.dll enable you to save images captured with the DCx camera as sequences to an AVI file. The How To Proceed: Capturing AVIs chapter shows the command sequence for capturing an AVI video. © 2010 Thorlabs...

  • Page 300: Isavi_Addframe

    The indicated AVI instance could not be found. Either the AVI ID IS_AVI_ERR_INVALID_ID is invalid or the instance has already been deleted using isavi_ExitAVI() The current image could not be processed since compression is IS_AVI_ERR_COMPRESSION_RUN still in progress. The AVI file is not open. IS_AVI_ERR_INVALID_FILE Related Functions isavi_InitAVI() © 2010 Thorlabs...

  • Page 301: Isavi_Closeavi

    Instance ID set by the function. nAviID isavi_InitAVI() Return Values Function executed successfully IS_AVI_NO_ERR The indicated AVI instance could not be found. Either the AVI ID is IS_AVI_ERR_INVALID_ID invalid instance already been deleted using isavi_ExitAVI() Related Functions isavi_OpenAVI() isavi_InitAVI() isavi_ExitAVI() © 2010 Thorlabs...

  • Page 302: Isavi_Disableevent

    The indicated AVI instance could not be found. Either the IS_AVI_ERR_INVALID_ID AVI ID is invalid or the instance has already been deleted using isavi_ExitAVI() An invalid event was specified for the parameter. IS_AVI_ERR_PARAMETER which Related Functions isavi_EnableEvent() © 2010 Thorlabs...

  • Page 303: Isavi_Enableevent

    The indicated AVI instance could not be found. Either the IS_AVI_ERR_INVALID_ID AVI ID is invalid or the instance has already been deleted using isavi_ExitAVI() An invalid event was specified for the parameter. IS_AVI_ERR_PARAMETER which Related Functions isavi_DisableEvent() © 2010 Thorlabs...

  • Page 304: Isavi_Exitavi

    The indicated AVI instance could not be found. Either the IS_AVI_ERR_INVALID_ID AVI ID is invalid or the instance has already been deleted using isavi_ExitAVI() The AVI file could not be closed. IS_AVI_ERR_INVALID_FILE Related Functions isavi_InitAVI() isavi_OpenAVI() isavi_CloseAVI() © 2010 Thorlabs...

  • Page 305: Isavi_Exitevent

    The indicated AVI instance could not be found. Either the IS_AVI_ERR_INVALID_ID AVI ID is invalid or the instance has already been deleted using isavi_ExitAVI() An invalid event was specified for the parameter. IS_AVI_ERR_PARAMETER which Related Functions isavi_InitEvent() isavi_EnableEvent() isavi_DisableEvent() © 2010 Thorlabs...

  • Page 306: Isavi_Getavifilename

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

  • Page 307: Isavi_Getavisize

    The size in kBytes size Return Values Function executed successfully IS_AVI_NO_ERR The designated AVI instance could not be found. Either the AVI ID is IS_AVI_ERR_INVALID_ID invalid or the instance was already deleted using isavi_ExitAVI() Related Functions isavi_GetAVIFileName() © 2010 Thorlabs...

  • Page 308: Isavi_Getncompressedframes

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

  • Page 309: Isavi_Getnlostframes

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

  • Page 310: Isavi_Initavi

    IS_AVI_ERR_PARAMETER pnAviID Null The maximum number of instances allowed in this system has IS_AVI_ERR_NO_CODEC_AVAIL been reached. It is not possible to create another instance. No DCx camera camera was found. IS_AVI_ERR_INVALID_UC480 Related Functions isavi_ExitAVI() isavi_OpenAVI() isavi_CloseAVI() © 2010 Thorlabs...

  • Page 311: Isavi_Initevent

    AVI ID is invalid or the instance has already been deleted using isavi_ExitAVI() The event could not be initialised. The Windows IS_AVI_ERR_EVENT_FAILED SetEvent function failed. An invalid event was specified for the parameter. IS_AVI_ERR_PARAMETER which Related Functions isavi_ExitEvent() isavi_EnableEvent() isavi_DisableEvent() © 2010 Thorlabs...
  • Page 312 ( 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 ); © 2010 Thorlabs...

  • Page 313: Isavi_Openavi

    No memory could be allocated for the AVI file. IS_AVI_ERR_NEW_FAILED The AVI file could not be opened. Please check if the IS_AVI_ERR_AVIFILEOPEN file is corrupted or was opened in another application. No AVI stream could be created. IS_AVI_ERR_CREATESTREAM Related Functions isavi_CloseAVI() isavi_InitAVI() isavi_ExitAVI() © 2010 Thorlabs...

  • Page 314: Isavi_Resetframecounters

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

  • Page 315: Isavi_Setframerate

    The indicated AVI instance could not be found. Either the IS_AVI_ERR_INVALID_ID AVI ID is invalid or the instance has already been deleted using isavi_ExitAVI() The AVI file could not be modified. IS_AVI_ERR_WRITE_INFO The AVI file is not open. IS_AVI_ERR_INVALID_FILE Related Functions isavi_SetImageQuality() isavi_SetImageSize() © 2010 Thorlabs...

  • Page 316: Isavi_Setimagequality

    The indicated AVI instance could not be found. Either IS_AVI_ERR_INVALID_ID the AVI ID is invalid or the instance has already been deleted using isavi_ExitAVI() parameter is outside the range of 1...100. IS_AVI_ERR_INVALID_VALUE The AVI file is not open. IS_AVI_ERR_INVALID_FILE Related Functions isavi_SetFrameRate() isavi_SetImageSize() © 2010 Thorlabs...

  • Page 317: Isavi_Setimagesize

    X position (offset) of the area of interest. PosX Y position (offset) of the area of interest. PosY Line increment. The total widths of the areas clipped to the LineOffset right and to the left of the area of interest make up this value. © 2010 Thorlabs...
  • Page 318 Another capturing operation is in progress or an AVI file is IS_AVI_ERR_CAPTURE_RUNNING still open. No memory could be allocated. IS_AVI_ERR_ALLOC_MEMORY The submitted colour mode is not supported for AVI IS_AVI_ERR_INVALID_CM capturing. The submitted size is invalid. IS_AVI_ERR_INVALID_SIZE The submitted position is invalid. IS_AVI_ERR_INVALID_POSITION Related Functions isavi_SetFrameRate() isavi_SetImageQuality() © 2010 Thorlabs...

  • Page 319: Isavi_Startavi

    IS_AVI_NO_ERR The indicated AVI instance could not be found. Either the IS_AVI_ERR_INVALID_ID AVI ID is invalid or the instance has already been deleted using isavi_ExitAVI() The AVI file is not open. IS_AVI_ERR_INVALID_FILE Related Functions isavi_StopAVI() isavi_InitEvent() isavi_ExitAVI() © 2010 Thorlabs...

  • Page 320: Isavi_Stopavi

    IS_AVI_NO_ERR The indicated AVI instance could not be found. Either the IS_AVI_ERR_INVALID_ID AVI ID is invalid or the instance has already been deleted using isavi_ExitAVI() The AVI file is not open. IS_AVI_ERR_INVALID_FILE Related Functions isavi_StartAVI() isavi_InitEvent() isavi_ExitAVI() © 2010 Thorlabs...

  • Page 321: Obsolete Functions

    (see below is_ReleaseDC() is_DirectRenderer() The DCx camera memory board is not 3.30 is_ResetMemory() supported any longer (see below ) is_SetBayerConversion() is_SetColorConverter() is_SetGamma() 3.40 is_SetBrightness() is_SetHardwareGamma() is_SetBlCompensation() is_SetExposureTime() 3.40 is_SetContrast() is_SetHardwareGain() is_SetDDUpdateTime() is_DirectRenderer() is_SetHwnd() is_DirectRenderer() © 2010 Thorlabs...
  • Page 322 The DCx camera memory board is not 3.30 is_TransferImage() supported any longer (see below ). is_TransferMemorySequence() is_UnlockDDMem() is_DirectRenderer() is_UnlockDDOverlayMem() is_DirectRenderer() is_UpdateDisplay() is_DirectRenderer() functions have been is_SetWhiteBalance() is_SetWhiteBalanceMultipliers() completely replaced by the is_SetAutoParameter() function and are no longer supported by the DCx camera API. © 2010 Thorlabs...

  • Page 323: Is_Disableddoverlay

    This results in discarding of the overlay data. Input Parameters Camera handle hCam Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_DisableDDOverlay() is_EnableDDOverlay() is_HideDDOverlay() is_SetDisplayMode() is_ShowDDOverlay() is_GetDDOvlSurface() © 2010 Thorlabs...

  • Page 324: Is_Enableddoverlay

    The overlay uses black as the so-called key colour, so that overlay graphics may not contain any black colour. Input Parameters Camera handle hCam Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_SetDisplayMode() is_DisableDDOverlay() is_ShowDDOverlay() is_HideDDOverlay() is_GetDDOvlSurface() © 2010 Thorlabs...

  • Page 325: Is_Getdc

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

  • Page 326: Is_Getddovlsurface

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

  • Page 327: 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 Camera handle hCam Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_ShowDDOverlay() is_DisableDDOverlay() is_EnableDDOverlay() is_GetDDOvlSurface() is_SetDisplayMode() © 2010 Thorlabs...

  • Page 328: Is_Lockddmem

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

  • Page 329: Is_Lockddoverlaymem

    Pointer to the variable that holds the address pointer ppMem Pointer to the variable that holds the pitch value pPitch Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions Is_UnlockDDOverlayMem() is_LockDDMem() is_UnlockDDMem() is_LockSeqBuf() is_UnlockSeqBuf() © 2010 Thorlabs...

  • Page 330: Is_Preparestealvideo

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

  • Page 331: Is_Releasedc

    Input Parameters Camera handle hCam Device context handle returned by is_GetDC() Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_GetDC() is_ShowDDOverlay() is_DisableDDOverlay() is_EnableDDOverlay() is_GetDDOvlSurface() is_SetDisplayMode() © 2010 Thorlabs...

  • Page 332: Is_Setbayerconversion

    Best quality and edge acuity, higher computational load IS_SET_BAYER_CV_BEST Returns the current setting. IS_GET_BAYER_CV_MODE Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Current setting when used together with IS_GET_BAYER_CV_MODE Related Functions is_SetColorConverter() is_SetColorMode() is_SetColorCorrection() © 2010 Thorlabs...

  • Page 333: Is_Setddupdatetime

    DirectDraw is_SetDDUpdateTime() BackBuffer mode. Input Parameters Camera handle hCam Time in milliseconds. Valid range: 20...2000 ms Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_SetDisplayMode() is_UpdateDisplay() © 2010 Thorlabs...

  • Page 334: Is_Sethwnd

    Input Parameters Camera handle hCam Window handle hwnd Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Related Functions is_SetDisplayMode() © 2010 Thorlabs...

  • Page 335: Is_Setimageaoi

    Y position of the upper left corner. width Image width height Image height Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Camera is in standby mode, function not allowed. IS_INVALID_MODE Related Functions is_SetAOI() is_SetImagePos() is_SetImageSize() is_SetBinning() is_SetSubSampling() © 2010 Thorlabs...

  • Page 336: Is_Setimagesize

    Changes to the image geometry or pixel clock affect the value ranges of the frame rate and exposure time. After executing is_SetBinning , calling the following functions is recommended in order to keep the defined camera settings: is_SetFrameRate() is_SetExposureTime() If you are using the DCx camera's flash function: is_SetFlashStrobe() © 2010 Thorlabs...
  • Page 337 Sets the image height 1...yMax Return settings Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Current setting when used together with parameters IS_GET_IMAGE_SIZE Camera is in standby mode, function not allowed. IS_INVALID_MODE Related Functions is_SetAOI() is_SetImagePos() © 2010 Thorlabs...

  • Page 338: Is_Setkeycolor

    Green content of the key colour (0...255). Blue content of the key colour (0...255). Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Colour value when used together with IS_GET_KC_RGB IS_GET_KC_RED IS_GET_KC_GREEN IS_GET_KC_BLUE Recommended Alternative is_DirectRenderer() Related Functions is_SetDisplayMode() is_ShowDDOverlay() © 2010 Thorlabs...
  • Page 339 DCx camera is_HideDDOverlay() is_DisableDDOverlay() is_EnableDDOverlay() is_GetDDOvlSurface() is_SetColorMode() © 2010 Thorlabs...

  • Page 340: Is_Showddoverlay

    With some graphics cards, overlay display may reduce the frame rate. Input Parameters Camera handle hCam Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Recommended Alternative is_DirectRenderer() Related Functions is_HideDDOverlay() is_DisableDDOverlay() is_EnableDDOverlay() is_GetDDOvlSurface() is_SetDisplayMode() © 2010 Thorlabs...

  • Page 341: Is_Stealvideo

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

  • Page 342: Is_Unlockddmem

    BackBuffer contents on the screen. Input Parameters Camera handle hCam Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Recommended Alternative is_DirectRenderer() Related Functions is_LockDDMem() is_LockDDOverlayMem() is_UnlockDDOverlayMem() is_LockSeqBuf() is_UnlockSeqBuf() is_UpdateDisplay() © 2010 Thorlabs...

  • Page 343: Is_Unlockddoverlaymem

    This results in an overlay buffer refresh on the screen, provided that the overlay display was enabled using is_ShowDDOverlay() Input Parameters Camera handle hCam Return Values Function executed successfully IS_SUCCESS General error message IS_NO_SUCCESS Recommended Alternative is_DirectRenderer() Related Functions is_LockDDOverlayMem() is_UnlockDDOverlayMem() is_LockDDMem() is_UnlockDDMem() is_LockSeqBuf() is_UnlockSeqBuf() is_UpdateDisplay() © 2010 Thorlabs...

  • Page 344: Is_Updatedisplay

    All parameters that are set using these functions remain valid for as long as the handle is valid, that is, until you close the corresponding camera or exit the program. The next time you open the camera, it is initialized with the defaults again. © 2010 Thorlabs...

  • Page 345: Programming In C / C

    The uc480.h header file contains all the definitions and constants needed for the DCx camera API. You will find this file in the directory C:\Program Files\Thorlabs\DCx camera\Develop\include after installation of the DCx camera drivers. 7.6.1.1 Programming in C / C++ For programming with the DCx camera API, we suggest that you use the C / C++ programming language.

  • Page 346: Programming In Vb.net

    SDK (Software development Kit) others\uc480_csharp_demo\ - all others\uc480_csharp_demo\) Function library (DLL): uc480.dll (C:\Program Files\Thorlabs\DCx camera\Driver) In order to access the DCx camera AVI functions in C#, make sure to include the following files in your project: Header file: uc480_tools.cs (C:\Program Files\Thorlabs\DCx camera\Develop\include) Function library (DLL): uc480_tools.dll (C:\Windows\System32\ )

  • Page 347: Programming With Activex

    Simultaneous attempts to call the same function are recognised and prevented by the driver. We recommend that you call the following functions only from a single thread in order to avoid unpredictable behaviour of the application. is_InitCamera() is_SetDisplayMode() is_ExitCamera() © 2010 Thorlabs...

  • Page 348: Complete List Of All Return Values

    The sequence list is empty and cannot be deleted. IS_SEQUENCE_LIST_EMPTY The image memory is already included in the IS_CANT_ADD_TO_SEQUENCE sequence and cannot be added again. The memory could not be locked. The pointer to IS_SEQUENCE_BUF_ALREADY_LOCKED the buffer is invalid. © 2010 Thorlabs...
  • Page 349 An internal structure has an incorrect size. IS_BAD_STRUCTURE_SIZE The image memory has an inappropriate size to IS_INVALID_BUFFER_SIZE store the image in the desired format. This setting is not available for the currently set IS_INVALID_PIXEL_CLOCK pixel clock frequency. © 2010 Thorlabs...
  • Page 350 Parameter set is not present. IS_PARAMETER_SET_NOT_PRESENT The camera type defined in the .ini file does not IS_INVALID_CAMERA_TYPE match the current camera model. The camera's starter firmware is not compatible IS_STARTER_FW_UPLOAD_NEEDED with the driver and needs to be updated (see is_InitCamera() © 2010 Thorlabs...

  • Page 351: Linux Functions

    Linux Functions is_AddToSequence() is_AllocImageMem() is_CameraStatus() is_CaptureVideo() is_ClearSequence() is_ConvertImage() is_CopyImageMem() is_CopyImageMemLines() is_DisableEvent() is_EnableAutoExit() is_EnableEvent() is_EnableHdr() is_ExitCamera() is_ExitEvent() is_ForceTrigger() is_FreeImageMem() is_FreezeVideo() is_GetActiveImageMem() is_GetActSeqBuf() is_GetAutoInfo() is_GetBusSpeed() is_GetCameraInfo() is_GetCameraList() is_GetCameraLUT() is_GetCameraType() is_GetCaptureErrorInfo() is_GetColorConverter() is_GetComportNumber() is_GetDLLVersion() is_GetError() is_GetEthDeviceInfo() is_GetExposureRange() is_GetFramesPerSecond() is_GetFrameTimeRange() is_GetGlobalFlashDelays() © 2010 Thorlabs...
  • Page 352 © 2010 Thorlabs...
  • Page 353 DCx camera is_SetAOI() is_SetAutoCfgIpSetup() is_SetAutoParameter() is_SetBadPixelCorrection() is_SetBadPixelCorrectionTable() is_SetBayerConversion() is_SetBinning() is_SetBlCompensation() is_SetCameraID() is_SetCameraLUT() is_SetColorConverter() is_SetColorCorrection() is_SetColorMode() is_SetConvertParam() is_SetEdgeEnhancement() is_SetErrorReport() is_SetExposureTime() is_SetExternalTrigger() is_SetFlashDelay() is_SetFlashStrobe() is_SetFrameRate() is_SetGainBoost() is_SetGamma() is_SetGlobalShutter() is_SetHardwareGain() is_SetHardwareGamma() is_SetHdrKneepoints() is_SetHWGainFactor() is_SetImageAOI() is_SetImageMem() is_SetImagePos() is_SetImageSize() is_SetIO() is_SetIOMask() is_SetLED() is_SetOptimalCameraTiming() © 2010 Thorlabs...
  • Page 354 Isavi_AddFrame() Isavi_CloseAVI() Isavi_DisableEvent() Isavi_EnableEvent() Isavi_ExitAVI() Isavi_ExitEvent() Isavi_GetAVIFileName() Isavi_GetAVISize() Isavi_GetnCompressedFrames() Isavi_GetnLostFrames() Isavi_InitAVI() Isavi_InitEvent() Isavi_OpenAVI() Isavi_ResetFrameCounters() Isavi_SetFrameRate() Isavi_SetImageQuality() Isavi_SetImageSize() Isavi_StartAVI() Isavi_StopAVI() *) Function ist obsolete, see chapter Obsolete Functions © 2010 Thorlabs...

  • Page 355: Appendix

    An asterisk (*) identifies formats which are filled starting with the most significant bit (MSB) but which may have less than the indicated number of payload bits, depending on the camera model. For the RGB16 and RGB15 data formats, the MSBs of the internal 8-bit R, G and B colours are used. © 2010 Thorlabs...

  • Page 356: Dcx Camera Parameter File (Ini File)

    Activate absolute AOI 0, 1 Start Y absolute positioning in the memory (see is_SetImagePos() Sensor- Width of the AOI dependent Width 2460 Sensor- Height of the AOI dependent Height 1820 Activate binning mode and Sensor- select factor dependent Binning © 2010 Thorlabs...
  • Page 357 0, 1, 2, 4, (8 IS_SET_CM_RGB30 Colour format 0, 1, 2, 4, (8 IS_SET_CM_Y12 Colour format 0, 1, 2, 4, (8 IS_SET_CM_BAYER12 Colour format 0, 1, 2, 4, (8 IS_SET_CM_Y16 Colour format 0, 1, 2, 4, (8 IS_SET_CM_BAYER16 © 2010 Thorlabs...
  • Page 358 0...100 Blue Activate gain boost 0 , 1 GainBoost Parameters for image pre-processing in the driver [Processing] Enable edge enhancement 0...2 EdgeEnhancement Image geometry change (Rop = raster operation), e.g. mirroring 0, 8, 16, 32, 64 RopEffect © 2010 Thorlabs...
  • Page 359 Brightness Aoi Width 2560 brightness control dependent Height of reference AOI for Sensor- Brightness Aoi Height 1920 brightness control dependent Enable white balance control 0, 1 Auto WB control Red offset for white balance 0...100 Auto WB offsetR control © 2010 Thorlabs...
  • Page 360 For the parameters, please refer to the uc480.h header file provided in the \Develop\include folder of the DCx Camera installation directory (see also Programming Notes Not for DCx cameras. ) Function is obsolete, see chapter Obsolete Functions © 2010 Thorlabs...

  • Page 362: Part Viii Maintenance And Service

    Maintenance and Service DCx camera Part VIII...

  • Page 363: General Remarks

    If any disturbances in function occur please first refer to Troubleshooting If you don’t find the error source by means of the trouble shooting list please first contact the Thorlabs-Hotline (europe@thorlabs.com) before sending the DCx camera for checkup and repair to Thorlabs (refer to section Addresses 8.1.1...

  • Page 364: General Care

    To avoid damage to the DCx camera, do not expose it to spray, liquids or solvents 8.1.3 Cleaning If necessary the unit and the display can be cleaned with a cloth dampened with water. You can use a mild 75% Isopropyl Alcohol solution for more efficient cleaning. © 2010 Thorlabs...

  • Page 365: Trouble Shooting

    UC480 viewer program. This method can also be used to connect to several cameras via LabView. How can I enable the long term exposure of 10min for the DCU camera series? Choose the external trigger mode in the camera viewer program, or under uc480/Trigger mode: © 2010 Thorlabs...
  • Page 366 CD. Error codes of the DCU status LED an error is present in this case the green LED flashes: - 2x flash: unknown sensor, please contact Thorlabs dealer - 3x flash: Using USB1.1 interface © 2010 Thorlabs...
  • Page 367 Connection of a USB2.0 interface is necessary for the operation of a DCU camera. If the LED does not light up green, please check Wiring. The installation of the DCU driver in the device manager of the host PC (List of the “Thorlabs DCx” drivers in the device manager).

  • Page 368: Tools

    From start menu of the CD ROM you can find two tools helping you to check capabilities of your USB controllers and connectivity of a camera. CheckUSB.exe allow s to display properties of your USB controller interface: © 2010 Thorlabs...
  • Page 369 DCx camera uc480Hardw areCheck.exe displays all connected DCx cam eras, m odel and serial num bers and their com patibility: © 2010 Thorlabs...
  • Page 370 Maintenance and Service © 2010 Thorlabs...
  • Page 372 Camera Basics DCx camera Part...

  • Page 373: Part Ix Camera Basics

    64 bytes which can freely be used by the use. Sensor board. This board includes The sensor. An EEPROM where the type of camera is stored. Timing board The timing board digitises the output signals of the sensor. Block diagram of the DCU camera Figure 61 © 2010 Thorlabs...

  • Page 374: Freerun

    In the trigger mode two capture modes are available: Single Trigger After a trigger signal occurs exactly one image is captured and transferred Continuous Trigger Images have to be requested and triggered separately Continuous trigger mode Figure 63 © 2010 Thorlabs...

  • Page 375: Take-Over Of New Parameters

    An excessive pixel clock can cause transmission errors or delays. If the data is read from the sensor at a higher speed (high pixel clock), you will also need a faster transmission over the data connection. Thus, by controlling the pixel clock, you can © 2010 Thorlabs...

  • Page 376: Image Display Modes

    This produces a non-destructive overlay. The display is controlled by the graphics card chip and therefore hardly requires any CPU time. This mode is not supported by all graphics cards, and often, it can only be used in conjunction with the YUV color mode. © 2010 Thorlabs...

  • Page 377: Gain And Offset

    PC. With a smaller image area higher camera frame rates can be achieved. After specifying an AOI a new value for the exposure time can be set. © 2010 Thorlabs...

  • Page 378: Binning

    Color subsampling, as done by most of the color sensors, skips pixels according to the Bayer pattern (see illustration). Few color- and all monochrome sensors ignore the bayer pattern, the color information is lost (mono binning). © 2010 Thorlabs...
  • Page 379 DCx camera DCU cameras provide subsampling of two or four pixels. Subsampling of horizontal or vertical pixels can be used independently. Color sub sampling (2x) Figure 68 Monochrome sub sampling (2x) Figure 69 © 2010 Thorlabs...

  • Page 380: Digital Input/Output

    PC. The status of the digital input can be queried by software. So, the input can be used for multiple purposes. Trigger input time flow Figure 70 © 2010 Thorlabs...

  • Page 381: Digital Output (Flash/Strobe)

    The size of each single sensor cell (pixel) depends on the size of the active sensor area and resolution. Fewer pixels at a certain sensor size, or a larger sensor area at a certain resolution, will lead to a greater photosensitivity of the sensor. © 2010 Thorlabs...

  • Page 382: Color Filter (Bayer Filter)

    30-50%. The use of micro lenses raises the fill factor to up to 70 %. The micro lenses collect the light on a photocell and increase the usable sensor area. Use of micro lenses Figure 74 © 2010 Thorlabs...

  • Page 383: Shutter Methods

    Glob al shutter sensor in live mode Figure 75 Glob al shutter sensor in trigger mode Figure 76 *) Optional flash function. The start time and duration are defined by the Flash delay and Duration parameters (see also Camera Settings:I/O © 2010 Thorlabs...
  • Page 384 Figure 77 Rolling shutter sensor in live mode with glob al flash window Figure 78 Optional flash function. The start time and duration are defined by the Flash delay and Duration parameters (see also Camera Settings: I/O © 2010 Thorlabs...
  • Page 385 Rolling shutter sensor in trigger mode with Glob al Start function Figure 79 Optional flash function. The start time and duration are defined by the Flash delay and Duration parameters (see also Camera Settings: I/O © 2010 Thorlabs...

  • Page 386: Interface Basics

    Standard-B (four pins) or Mini-B plug (five pins with ground). In addition the DCU cameras offer a nine pin Sub-D connector for DCU camera cables. The additional four pins carry the camera’s digital input/output signals. © 2010 Thorlabs...

  • Page 387: Structure And Topology

    USB devices can be connected in up to seven levels. Up to 5 hubs can be connected in series which allows 6 levels of USB-devices. USB topology Figure 85 © 2010 Thorlabs...

  • Page 388: Data Transmission And Bandwidth

    The overall bandwidth can be increased by the use of USB2.0 expansion cards. These cards are available for PCI and PCIe bus and provide an own host controller chip. To achieve maximum USB bandwidth it is important to use high-performance mainboards and chipsets. © 2010 Thorlabs...

  • Page 390: Part X Appendices

    Appendices DCx camera Part...

  • Page 391: Technical Data

    Color format M – Monochrome C – Color NOTE The diagrams represented in the specifications show relative sensitivities of the DCU cameras in the spectral region. Therefore is a comparison of the characteristics among themselves not possible. © 2010 Thorlabs...

  • Page 392: Common Data

    Vibration and shock resistance of the 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 © 2010 Thorlabs...

  • Page 393: Ip Protection Classes

    The housings of the DCx models comply with IP 30. These standards are defined as follows: First digit 3 Protection against the ingression of small particles (diameter > 2.5 mm) Second digit 0 No special protection against liquids © 2010 Thorlabs...

  • Page 394: Flange Back Distance

    Parameters for calculating the flange b ack distance for DCx cameras Table 17: Sensor Sensor Refractive Distance x (no filter glass) x (with filter glass height index (n Glass ) sensor [mm] glass) [mm] [mm] [mm] [mm] © 2010 Thorlabs...
  • Page 395 Distances and dimensions for calculating the flange b ack distance Table 18: USB DCx Sensor glass Distance Sensor height sensor d [mm] e [mm] h [mm] CMOS 154xLE 0.55 1.27 +/- 0.085 2.21 +/- 0.27 164xLE 0.55 1.45 +/- 0.125 2.35 +/- 0.15 © 2010 Thorlabs...

  • Page 396: 10.1.1.3.2 Adjusting The Flange Back Distance

    Adjusting ring - top view Figure 89 Schematic illustration of adjusting ring To change the position of the adjusting ring, please proceed exactly in the following order: 1. Loosen the locking screw (see figure below). 2. Adjust the CS-mount ring. © 2010 Thorlabs...
  • Page 397 DCx camera Figure 90 Securing the adjusting ring © 2010 Thorlabs...

  • Page 398: 10.1.1.3.3 Positioning Accuracy Of The Sensor Chip

    Diameter at lens end and max immersion depth Table 20 : Thread Diameter Max. immersion Camera Type depth at lens end depth (mm) © 2010 Thorlabs...
  • Page 399 14.6 * 12.6 ring May vary depending on the inside diameter of the extension ring used NOTE The data given in the table include the following tolerances as a safety clearance for the diameter of 0.2 mm © 2010 Thorlabs...

  • Page 400: Camera Dimensions

    Appendices 10.1.2 Camera dimensions DCC camera Figure 92 DCC camera isometric view Lens mount Enclosure protection class Weight CS-/S-mount 32 g (with housing) IP30 (with housing) SM1 mount Exploded view of the DCC camera Figure 93 © 2010 Thorlabs...
  • Page 401 DCx camera Dimensions Side view (with interface) DCC Figure 94 Rear view DCC models Figure 95 models Bottom view DCC modesl Figure 96 © 2010 Thorlabs...
  • Page 402 Appendices DCU cameras Front view DCU Rear view DCU Figure 97 Figure 98 Side view DCU Top view DCU Figure 99 Figure 100 Bottom view DCU Figure 101 © 2010 Thorlabs...

  • Page 403: I/O Interface

    The strobe signal is active, when the collector emitter switch is closed. Opto couplers solely can switch DC voltages. Do never switch AC voltages. In the following table the maximum charges for the output are specified. © 2010 Thorlabs...
  • Page 404 In the following drawing examples of the connection of the digital output are to be found. Rev. 1.2 Flash Strob e output as Open Collector (OC) Figure 103 Rev. 1.2 Flash Strob e output as Open Emitter (OE) Figure 104 Rev. 2.0 Flash Strob e output as Open Collector (OC) Figure 105 © 2010 Thorlabs...
  • Page 405 DCx camera Rev. 2.0 Flash Strob e output as Open Emitter (OE) Figure 106 © 2010 Thorlabs...

  • Page 406: Pin Assignment Sub-D Connector

    Flash Strobe Output + Pin assignment of the Figure 107 micro D-Sub socket Trigger Input - USB D+ USB D- 10.1.4 EEPROM EEPROM Specification Table 23: User EEPROM Size 64 Byte Data Retention 10 Years 100,0 Read/write cycles cycles © 2010 Thorlabs...

  • Page 407: Individual Technical Data

    DCx cameras in the spectral range. Therefore, the characteristic curves cannot be compared to each other. Filters 10.1.5.1 Thorlabs color cameras are supplied with a IR filter, while monochrome cameras have a protection glass. DCU223M / DCU224M Plain glass filter, removable...
  • Page 408 Appendices Filter curve GL Figure 108: Filter curve BG-40 Figure 109: Filter curve HQ Figure 110: © 2010 Thorlabs...

  • Page 409: Dcu224X

    Absolute image height, step width, monochrome 120 – 1024 Pixel, 1 Absolute image height, step width, color model 120 – 1024 Pixel, 2 Position raster horizontal, monochrome Position raster horizontal, color model Position raster vertical, monochrome Position raster vertical, color model Gain Monochrome model Master © 2010 Thorlabs...
  • Page 410 10 – 20 MHz. A long exposure time increases the number of hotpixel. High temperatures increase the black level of individual pixels. With Gain 0 and Pixel clock above 27 MHz under some circumstances the camera can’t reach the white level. © 2010 Thorlabs...

  • Page 411: Dcu223X

    Absolute image height, step width, color model 120 – 768 Pixel, 2 Position raster horizontal, monochrome Position raster horizontal, color model Position raster vertical, monochrome Position raster vertical, color model Gain Monochrome model Master Color model Master, RGB © 2010 Thorlabs...
  • Page 412 Application references for the DCU 223x Optimal pixel clock 15 MHz. Recommended pixel clock range 10 – 20 MHz. A long exposure time increases the number of hotpixel. High temperatures increase the black level of individual pixels © 2010 Thorlabs...

  • Page 413: Dcc1545M

    Pixels 4 - 1024, 2 AOI position grid horizontal, vertical Pixels 4, 2 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 © 2010 Thorlabs...
  • Page 414 Requires maximum pixel clock frequency. Requires minimum pixel clock frequency. Use of this function increases the frame rate. The connected load depends on the sensor model and the pixel clock setting. Monochrome Sensor sensitivity of the DCC1545M Figure 113: © 2010 Thorlabs...

  • Page 415: Dcc1645C

    Pixels 4 - 1024, 2 AOI position grid horizontal, vertical Pixels 4, 2 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 © 2010 Thorlabs...
  • Page 416 Color Sensor sensitivity of the DCC1645C, sensitivities in the shaded area (>650nm) are Figure 114: related to the response without any filter, actual values (with IR-filter) are b elow 5% For filter curves, see Technical Data: Filters © 2010 Thorlabs...

  • Page 417: 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 418: List Of Acronyms

    User Manual, please contact your local Thorlabs dealer or system installer. All rights reserved. This manual may not be reproduced, transmitted or translated to another language, either as a whole or in parts, without the prior written permission of Thorlabs GmbH. Status: 2010 ©...

  • Page 419: Addresses

    Phone: +1 973 579 7227 Fax: +1 973 300 3600 Email: sales@thorlabs.com Internet: http://www.thorlabs.com Japan: Thorlabs Japan, Inc. Higashi Ikebukuro Q Building 1st floor 2-23-2 Toshima-ku, Tokyo 170-0013 Japan Phone: +81 3 5979 8889 Fax: +81 3 5979 7285 Email: sales@thorlabs.jp...

This manual is also suitable for:

Dcc1 45 seriesDcc1545mDcc1645cDcu223mDcu223cDcu224m ... Show all

Table of Contents