Page 1 CCD and CMOS Cameras DCU223x, DCU224x DCC1240x DCC1545M, DCC1645C DCC3240X DCC3260X DCx Camera Functional Description and SDK Manual 2016...
Page 3: Table Of Contents
Contents Foreword 1 General Information 1.1 Safety 1.2 Ordering Codes and Accessories 1.3 Requirements 1.4 DCx Camera Family 1.5 Contents 1.6 What's New in this Version? 2 Camera Basics 2.1 Operating Modes 2.1.1 Freerun Mode 2.1.2 Trigger Mode 2.1.3 Standby 2.2 Image Display Modes 2.3 Sensor 2.3.1...
Page 4 2.9 USB Interface 2.9.1 History and Development 2.9.2 Structure and Topology 2.9.3 USB 2.0 Cabling and Connectors 2.9.4 USB 3.0 Cabling and Connectors 2.9.5 Data Transmission and Bandwidth 3 Operation 3.1 uc480 Quick Start 3.2 Installation and Connection 3.2.1 System Requirements 3.2.2 DCx Driver Compatibility 3.2.3...
Page 5 4.2.4 Setting Camera Parameters 4.2.4.1 Setting and Getting Parameters 4.2.4.2 Automatic Image Control 4.2.4.3 Image Pre-processing 4.2.4.4 Get Camera Status 4.2.4.5 Using the Camera EEPROM 4.2.5 Saving Images and Videos 4.2.5.1 Saving and Loading Single Frames 4.2.5.2 Capturing AVIs 4.2.6 Using Inputs and Outputs 4.2.6.1 Input/Output Control...
Page 6 4.3.24 is_ExitEvent 4.3.25 is_ExitImageQueue 4.3.26 is_Exposure 4.3.26.1 Setting the Exposure Time 4.3.26.2 Exposure Time with Fine Increments 4.3.26.3 Setting the Long Exposure 4.3.26.4 Setting the Dual Exposure 4.3.27 is_ForceTrigger 4.3.28 is_FreeImageMem 4.3.29 is_FreezeVideo 4.3.30 is_Gamma 4.3.31 is_GetActiveImageMem 4.3.32 is_GetActSeqBuf 4.3.33 is_GetAutoInfo 4.3.34 is_GetBusSpeed 4.3.35 is_GetCameraInfo 4.3.36 is_GetCameraList...
Page 7 4.3.62 is_InitEvent 4.3.63 is_InitImageQueue 4.3.64 is_InquireImageMem 4.3.65 is_IO 4.3.66 is_IsVideoFinish 4.3.67 is_LockSeqBuf 4.3.68 is_LUT 4.3.69 is_Measure 4.3.70 is_ParameterSet 4.3.71 is_PixelClock 4.3.72 is_ReadEEPROM 4.3.73 is_RenderBitmap 4.3.74 is_ResetToDefault 4.3.75 is_SetAllocatedImageMem 4.3.76 is_SetAutoParameter 4.3.77 is_SetBinning 4.3.78 is_SetCameraID 4.3.79 is_SetColorConverter 4.3.80 is_SetColorCorrection 4.3.81 is_SetColorMode 4.3.82 is_SetDisplayMode 4.3.83 is_SetDisplayPos 4.3.84 is_SetErrorReport...
Page 8 4.3.104 is_UnlockSeqBuf 4.3.105 is_WaitEvent 4.3.106 is_WaitForNextImage 4.3.107 is_WriteEEPROM 4.4 AVI Function Descriptions 4.4.1 isavi_AddFrame 4.4.2 isavi_CloseAVI 4.4.3 isavi_DisableEvent 4.4.4 isavi_EnableEvent 4.4.5 isavi_ExitAVI 4.4.6 isavi_ExitEvent 4.4.7 isavi_GetAVIFileName 4.4.8 isavi_GetAVIFileNameW 4.4.9 isavi_GetAVISize 4.4.10 isavi_GetnCompressedFrames 4.4.11 isavi_GetnLostFrames 4.4.12 isavi_InitAVI 4.4.13 isavi_InitEvent 4.4.14 isavi_OpenAVI 4.4.15 isavi_OpenAVIW 4.4.16 isavi_ResetFrameCounters 4.4.17 isavi_SetFrameRate...
Page 9 4.7.4 Programming in Delphi 4.7.5 Programming with ActiveX 4.7.6 Thread Programming 4.8 Lists 4.8.1 Complete List of All Return Values 4.8.2 Error Codes of AVI Functions 4.8.3 Linux: Not Supported Functions 5 Specifications 5.1 Model Comparison 5.2 Model Naming Conventions 5.3 Camera and Sensor Data 5.3.1 DCC3260x...
Page 10 6.3 Color and Memory Formats 6.4 uc480 Parameter File (ini file) 6.5 Definition of IP Protection Classes 6.6 History of API functions 6.7 Certifications and Compliances 6.8 Thorlabs 'End of Life' Policy (WEEE) 6.9 Exclusion of Liability and Copyright 6.10 Thorlabs Worldwide Contacts...
Page 11: Foreword
Always read the associated information carefully, before performing the indicated procedure. Attention Paragraphs preceeded by this symbol explain hazards that could damage the instrument and the connected equipment or may cause loss of data. © 2016 Thorlabs Scientific Imaging...
Page 12: General Information
Do not open the cabinet, there are no parts serviceable by the operator inside! Refer servicing to qualified personnel! Only with written consent from Thorlabs Scientific Imaging may changes to single components be made or components not supplied by Thorlabs Scientific Imaging be used.
Page 13 Thorlabs Scientific Imaging is not responsible for any radio television interference caused by modifications of this equipment or the substitution or attachment of connecting cables and equipment other than those specified by Thorlabs Scientific Imaging.
Page 14: Ordering Codes And Accessories
Trigger cable for DCU22xX and DCC1240X cameras (Trigger In only) CAB-DCU-T3 I/O cable for DC3240 CMOS USB 3.0 cameras Thorlabs C Mount Camera Lenses (objectives): See Thorlabs' website 1.3 Requirements For operating the DCx cameras, the following system requirements must be met:...
Page 15: Dcx Camera Family
The DCx cameras are available as monochrome and color versions, DC3240 series has a NIR version as well. The Model Comparison chapter shows the most important features of every series at a glance. USB 3.0 DCC3260x and DCC3240x CMOS Cameras © 2016 Thorlabs Scientific Imaging...
Page 16 Through the use of the widespread USB 2.0 technology, the cameras can easily be interfaced with a vast variety of systems. These cameras are available with a plastic housing with CS- mount lens adapter. © 2016 Thorlabs Scientific Imaging...
Page 17: Contents
Accessories Here you will find a list of accessories for DCx Cameras sorted by model. Appendix Information on Troubleshooting Status LEDs on USB DCx cameras Color and memory formats uc480 parameter file (ini file) © 2016 Thorlabs Scientific Imaging...
Page 18 DCx Camera Functional Description and SDK Manual Definition of IP protection classes © 2016 Thorlabs Scientific Imaging...
Page 19: What's New In This Version
New in Version 4.80.00 Cameras & functions Described in chapter New models in the USB 3 DCC camera family: DCC3260 DCC3260 Older versions See the History of uc480 Software Versions and History of uc480 API functions chapters. © 2016 Thorlabs Scientific Imaging...
Page 20: Camera Basics
The pre-processing time depends on the API functions you are using (e.g. color conversion, edge enhancement). For more information on flash timing see the Digital In-/Output (Trigger/Flash) chapter. Continuous mode (live mode) Images are captured and transferred continuously. You can use the DCxCamera flash outputs. © 2016 Thorlabs Scientific Imaging...
Page 21 The next image exposed by the sensor will be transferred. In this mode, flash is not making sense (only manually). Freerun mode (snap mode) See also: Basics: Shutter methods Basics: Trigger mode Basics: Applying new parameters Programming: Capture modes © 2016 Thorlabs Scientific Imaging...
Page 22: Trigger Mode
PC. Trigger events that occur during image exposure or data transfer are ignored. An internal counter records the number of ignored trigger events and can be read out from the PC. © 2016 Thorlabs Scientific Imaging...
Page 23: Standby
Standby is the default state when the camera is not open in the software. When you open the camera or switch to a different mode (freerun or trigger mode), the camera wakes up from standby mode. Note In standby mode, you can continue to use the camera's digital inputs or outputs. © 2016 Thorlabs Scientific Imaging...
Page 24: Image Display Modes
CPU load may be lower than in Bitmap mode. You can display overlay data and also scale the video image. The Direct3D mode and the overlay functions can be configured using the is_DirectRenderer() API function. © 2016 Thorlabs Scientific Imaging...
Page 25 CPU load Slightly increased by Low. Display performed Low. Display performed copying of data. by graphics card. by graphics card. Overlay functions Not available. A simple Integrated. Complex Integrated. overlay can be overlays can be © 2016 Thorlabs Scientific Imaging...
Page 26 Access to image Direct access possible. Possible using Steal Direct access to memory Image data already Mode. Single images graphics card and image provided in user memory. can be copied to the user memory. memory. © 2016 Thorlabs Scientific Imaging...
Page 27: Sensor
16 mm is specified as a 1-inch sensor. The following illustrations show the most common sensor sizes. The diameter in inch multiplied with 2/3 equals approximately the actual sensitiv area in millimeters. Common sensor sizes (in inch) © 2016 Thorlabs Scientific Imaging...
Page 28: Micro Lenses
The use of micro lenses compensates for this and increases the fill factor to 90 % or more. Micro lenses collect the light that falls onto a photocell, thus increasing the useable sensor area. Using micro lenses to increase the effective fill factor © 2016 Thorlabs Scientific Imaging...
Page 30 Using parallel light on sensors with CRA correction may cause slight color variations. These may occur, for example, if telecentric lenses are used. The following models are equipped with sensors with offset micro lenses: DCC1240x/DCC3240x DCC1645C © 2016 Thorlabs Scientific Imaging...
Page 31: Color Filter (Bayer Filter)
Software conversion with high quality should only be used for sensors whose green pixels have the same sensitivity. This applies to the following sensors: DCU223C / DCU224C DCC1240C, DCC3240C For all other sensors, we recommend using the standard filter mask. © 2016 Thorlabs Scientific Imaging...
Page 32 DCx Camera Functional Description and SDK Manual Bayer conversion using the standard mask See also: Color conversion: is_SetColorConverter() ThorCam: Settings > Camera > Pixel Data Format © 2016 Thorlabs Scientific Imaging...
Page 33: Hot Pixels
In the process, images are taken with a darkened sensor and long exposure times. Pixels with a brightness higher than a specific value are classified as hot pixels. A list of the © 2016 Thorlabs Scientific Imaging...
Page 34 If additional hot pixels occur during use of the camera, you can add them to the camera's internal hot pixel list. To do this, use the API function given below. See also: ThorCam: Hot pixel correction uc480 Hotpixel Editor Programming: is_HotPixel() © 2016 Thorlabs Scientific Imaging...
Page 35: Shutter Methods
Sensors that use the global shutter system are more complex in design than rolling shutter sensors. All CCD sensors as well as some CMOS sensors use the global shutter method. Global shutter sensor in live mode © 2016 Thorlabs Scientific Imaging...
Page 36 Some CMOS senors with global shutter can be operated also with rolling shutter. The operation in the rolling shutter mode is used to reduce the image noise. This function is only supported from the camera models DCC1240x/DCC3240x. © 2016 Thorlabs Scientific Imaging...
Page 37 Some rolling shutter sensors also provide a global start mode, which starts exposure of all rows simultaneously (see illustration). For best results, use a flash for this mode. No light is allowed to fall on the sensor outside the flash period because otherwise the image brightness will be distributed unevenly. © 2016 Thorlabs Scientific Imaging...
Page 38 DCx Camera Functional Description and SDK Manual Rolling shutter sensor in trigger mode with global start function * Optional flash function. The start time and duration are defined by the flash delay and duration parameters (see also Camera settings: I/O). © 2016 Thorlabs Scientific Imaging...
Page 39: Line Scan Mode
The line scan mode is currently only supported by the monochrome DCC1240M and DCC3240M,N models in form of the fast line scan mode. The triggered line scan mode is not supported by any camera model yet. See also: ThorCam: Settings > Shutter Programming: Function: is_DeviceFeature() © 2016 Thorlabs Scientific Imaging...
Page 40: Reading Out Partial Images
AOIs depend on the sensor. The values defining the position and size of an AOI have to be integer multiples of the allowed step widths. For details on the AOI grids of the individual camera models, please see Camera and sensor data © 2016 Thorlabs Scientific Imaging...
Page 41 2 Camera Basics and click a camera model. Please note that, after defining an AOI, the resulting image may be darker if the camera cannot maintain the originally set exposure time due to the increased frame rate. © 2016 Thorlabs Scientific Imaging...
Page 42 AOIs in one image and transfer them simultaneously. The AOIs are positioned side by side or one below the other, and share the same X or Y axis. This feature is not supported in ThorCam at this time. © 2016 Thorlabs Scientific Imaging...
Page 43 AOIs, which need to have the same size but may differ in position, exposure time or gain settings. This feature is not supported in ThorCam at this time. See also: ThorCam: Crop to Region of Interest Programming: is_AOI() © 2016 Thorlabs Scientific Imaging...
Page 44: Subsampling
Depending on the model, DCx Cameras support different subsampling factors. Subsampling of horizontal and vertical pixels can be enabled independently. Camera and sensor datas chapter lists the subsampling methods and factors supported by each camera model. Subsampling on monochrome sensors Subsampling on color sensors © 2016 Thorlabs Scientific Imaging...
Page 45: Binning
Depending on the model, DCx Cameras support different binning factors. Binning of horizontal and vertical pixels can be enabled independently. Camera and sensor data chapter lists the binning methods and factors the individual camera models support. Binning on monochrome sensors Binning on color sensors © 2016 Thorlabs Scientific Imaging...
Page 46: Digitizing Images
A gamma value of 1 generates a linear characteristic again. A curve with the value γ = 2.2 used for computer screens is shown in the figure below. Imaging with gamma characteristic © 2016 Thorlabs Scientific Imaging...
Page 47 0...127 with value 0 and all pixels with gray values 128...255 with value 255. Using LUTs has the advantage that calculations can be done very fast. Typical applications of LUTs are enhancing image contrast, or gamma characteristics. © 2016 Thorlabs Scientific Imaging...
Page 48 DCx Camera Functional Description and SDK Manual LUT characteristic for binarizing an image © 2016 Thorlabs Scientific Imaging...
Page 49 Color formats with a bit depth of more than 8 bits per channel are only supported by USB 3 DCC3240x camera models. Using color formats with higher bit depth increases the bandwidth used by a camera. © 2016 Thorlabs Scientific Imaging...
Page 50 With a contrast adjustment, the values of the histogram are spread in such a way as to create a contrast-rich image. The fewer than 100 brightness values are now distributed across levels 0 to 255; gaps arise in the histogram and are visible as jumps in brightness in the resulting image. © 2016 Thorlabs Scientific Imaging...
Page 51 This type of contrast adjustment can already be done in the camera when an image is digitized in 10 bits and transferred in 8 bit. In this case, optimum utilization of the 8 bit data is also important for image processing. © 2016 Thorlabs Scientific Imaging...
Page 52: Camera Parameters
The exposure time values are rounded down to the nearest valid value, if required. For this reason, the actual exposure time can deviate slightly from the exposure time you have selected. See also: ThorCam: Settings > Camera is_PixelClock() is_SetFrameRate() is_Exposure() © 2016 Thorlabs Scientific Imaging...
Page 53: Gain And Offset
SDK function. Auto exposure shutter (AES) The control of the average brightness is preferably achieved by adjusting the exposure, i.e. you set the highest possible exposure time before gain is controlled. The auto exposure feature always © 2016 Thorlabs Scientific Imaging...
Page 54 It is resumed when the actual value drops below (setpoint - hysteresis value) or exceeds (setpoint + hysteresis value). If the hysteresis value is increased, the control function will stop sooner. This can be useful in some situations. © 2016 Thorlabs Scientific Imaging...
Page 55: Applying New Parameters
I/Os (GPIO). Use of the GPIOs for flash control is possible to a certain degree. External triggering via the GPIO is not supported. See also: Basics: Trigger mode ThorCam: Settings > Input/output Specification: Electrical specifications © 2016 Thorlabs Scientific Imaging...
Page 56: Using Digital Inputs/Outputs
The disadvantage is that the flash signal is active slightly longer than the exposure time. The flash duration with automatic flash is longer for rolling shutter sensors than for global shutter sensors. © 2016 Thorlabs Scientific Imaging...
Page 57 (global flash function). Using , you can query the appropriate values. is_IO() Note The flash output is reset with the start of the next image capture. This also applies if you have set a longer flash duration. © 2016 Thorlabs Scientific Imaging...
Page 58: Flash Timing (Freerun Mode)
It is recommended to synchronize the flash manually in freerun mode. This applies to both rolling and global shutter sensors. In freerun mode, the manual flash synchronization works in the same way as in trigger mode. © 2016 Thorlabs Scientific Imaging...
Page 59: Serial Interface Rs-232 (Dc3240X Only)
To set up and use the serial interface, the "Additional functions" dialog box is provided in the uc480 Camera Manager. For the serial interface specifications, please refer to the DC3240x Serial Interface Wiring (RS-232) chapters. © 2016 Thorlabs Scientific Imaging...
Page 60: Usb Interface
Theoretically, 127 devices can be connected to a host controller. Using external hubs or repeaters, even more devices can be connected, and from a greater distance. Provided that a maximum of 5 hubs/repeaters may be daisy-chained, USB devices can be connected in up to seven levels. © 2016 Thorlabs Scientific Imaging...
Page 61: Usb 2.0 Cabling And Connectors
On the PC side, USB 2.0 cables are equipped with a standard A type plug (four pins) and on the device side either with a standard B plug (four pins) or a mini-B plug (five pins). © 2016 Thorlabs Scientific Imaging...
Page 62: Usb 3.0 Cabling And Connectors
The USB 2.0 standard specifies an overall bandwidth of 480 Mbit/s shared between different transmission modes. DCx Cameras use the USB 2.0 bulk mode for transmitting images. This mode uses error correction to ensure correct delivery of the image data, but does not guarantee a © 2016 Thorlabs Scientific Imaging...
Page 63 USB bus than completely black images. USB 3.0 Compared to USB 2.0, USB 3.0 offers a tenfold increased bandwidth of 5 Gbit/s, i.e. images can be transmitted with a bandwidth of 400 Mbytes/s. © 2016 Thorlabs Scientific Imaging...
Page 64: Operation
See also: ThorCam Software User Manual (Separate Document) Camera basics: Operating modes Customize the key camera properties Select the Settings icon on the menu bar to open the dialog box for modifying the camera properties. © 2016 Thorlabs Scientific Imaging...
Page 65 "File" menu. If you have recorded AVI videos, you can play them through Windows Media Player, ImageJ, or other AVI-compliant viewer with Motion- JPEG decoding capability. See also: ThorCam Software User Manual (Separate Document) © 2016 Thorlabs Scientific Imaging...
Page 66: Installation And Connection
For uc480 color cameras, the color conversion is done by software in the PC. When you use a color camera with a high frame rate, the conversion might lead to a high CPU load. Depending on the PC hardware used you might not be able to reach the camera's maximum frame rate. © 2016 Thorlabs Scientific Imaging...
Page 67: Dcx Driver Compatibility
The model will be immediately recognized whenever you connect the camera to this port again. If you use a different port, the registration will be repeated. Under Windows the camera will show up in the uc480 Camera Manager's camera list. © 2016 Thorlabs Scientific Imaging...
Page 68 Many USB ports on PCI/PCIe cards and the USB ports on the front of the PC often supply lower bandwidth. Attention USB cables with non-standard connectors must be connected to the camera first and then to the PC. Otherwise the camera might not be recognized correctly. © 2016 Thorlabs Scientific Imaging...
Page 69: Application Notes By Camera Model
The internal sensor delay is about 2-3 lines when triggering. The line period depends on the selected pixel clock. The higher the pixel clock, the smaller the line period is. Vertical AOI merge mode For color sensors, the AOI merge mode can only be used with at least 2 lines. © 2016 Thorlabs Scientific Imaging...
Page 70: Dcc1240X / Dcc3240X Application Notes
Use of the gain functions can lead to slight fluctuations of the black level. In global shutter mode the black level can also vary slightly. In global shutter mode the black level can also vary slightly between two image captures. © 2016 Thorlabs Scientific Imaging...
Page 71 On the color sensor the hot pixel correction works with the appropriate color neighbours. In the global shutter mode, increased hot pixels can become visible in the lower image area with © 2016 Thorlabs Scientific Imaging...
Page 72 15 lines at a frame rate set to maximum. In the fast line scan mode color images are not possible as Bayer color sensors needs at least two neighboring lines for color calculating. Therefore, only monochrome models support the line scan mode. © 2016 Thorlabs Scientific Imaging...
Page 73: Dcc1545M Application Notes
Gain values between 59 and 99 may lead to image inhomogeneity. When using very narrow AOIs, the sensor may not be able to calculate the correct black level. Use manual black level offset when problems with the black level occur. © 2016 Thorlabs Scientific Imaging...
Page 74: Dcc1645C Application Notes
Manager: The central tool for managing all connected DCx cameras. ThorCam: A comprehensive viewer for exploring the camera functionality. uc480 Hotpixel Editor: A tool to edit the sensor hot pixel list stored in the camera. © 2016 Thorlabs Scientific Imaging...
Page 75: Uc480 Camera Manager
USB DCx Cameras and provides options for configuring them. On Windows systems the DCx Camera Manager can be accessed as follows: Start > Programs > Thorlabs > Scientific Imaging > DCx Camera Manager Click in the figure to get help on the functions.
Page 76: Camera List
Camera Manager additionally displays Parameters box on the right. There you will find detailed information on the DCx camera selected in the camera list. Click in the figure to get help on the functions. © 2016 Thorlabs Scientific Imaging...
Page 77 If the option is disabled, the data in the tree structure is only updated when a different camera is selected. All other "Control Center" buttons are described in detail in the following sections: General information Camera information Creating a support file Additional functions (COM port) © 2016 Thorlabs Scientific Imaging...
Page 78: General Information
This list shows the location and version of the uc480 interface files that have been installed on your system for third-party software. USB controller and network adapters All USB controllers and network adapters that are available in your system are shown in a tree structure. © 2016 Thorlabs Scientific Imaging...
Page 79: Camera Information
"Save as" dialog box, where you can save the displayed camera information and additional driver information to a file. 3.4.1.6 Additional Functions CPU idle states Windows only: Processor operating states (idle states/C-states) Modern processors have various operating states, so-called C-states, that are characterized by © 2016 Thorlabs Scientific Imaging...
Page 80 Note This feature is only available for DCC3240x cameras. You need administrator privileges to install a virtual COM port. The selected in the uc480 Camera Manager DCC3240x camera has to be marked "Free" and "Available". © 2016 Thorlabs Scientific Imaging...
Page 81 If you want to control more than one DCC3240x camera from a PC, each camera should be assigned a unique port number. If multiple cameras are assigned the same port number, only the port of the first camera that is opened will be used. © 2016 Thorlabs Scientific Imaging...
Page 82 Using these functions, you can send a file in either direction (output on the camera's virtual COM port or output on the PC's COM port). Note Since the sample program has to open the camera, please make sure the selected camera is not used by other applications at the same time. © 2016 Thorlabs Scientific Imaging...
Page 83: Parameters
Indicates which hub and port a USB camera is connected to. In addition, the full path through all hubs to the USB controller on the computer is displayed. o Controller Indicates the USB controller to which the camera is connected. Local driver o Indicates the USB version of the camera driver © 2016 Thorlabs Scientific Imaging...
Page 84: Uc480 Hotpixel Editor
Closes the camera that is marked in the camera list. Badpixel correction Turns the hot pixel correction on/off. Detect Badpixel Opens the dialog for the automatic hot pixel detection. Write Badpixel Writes the list of the hot pixel to the EEPROM. © 2016 Thorlabs Scientific Imaging...
Page 85 Here, the camera settings can be changed for a better hot pixels visualization. By default, exposure time is set to max. and master gain to 50. Note that the frame rate is limited to lower values. © 2016 Thorlabs Scientific Imaging...
Page 86 Note The number of bad pixels, stored to the EEPROM, is limited. If the number of detected bad pixels exceeds the memory capacity, please increase the bad pixel detection threshold and repeat the detection procedure. © 2016 Thorlabs Scientific Imaging...
Page 87: Programming (Sdk)
See also: First steps to uc480 programming How to proceed Function descriptions AVI function descriptions Obsolete functions Programming notes Lists © 2016 Thorlabs Scientific Imaging...
Page 88: First Steps To Uc480 Programming
). To adapt a color is_SetColorCorrection() camera to the ambient light conditions, it is essential to carry out white balancing. This is also done using the function. is_SetAutoParameter() See also: How to proceed: Setting camera parameters © 2016 Thorlabs Scientific Imaging...
Page 89 So, if you want to save specific settings, use the function before closing the camera. The next time you start the is_ParameterSet() application, you can simply load the settings again by using the same function. © 2016 Thorlabs Scientific Imaging...
Page 90: How To Proceed
It is also very useful to have the message boxes for error output enabled during the programming process is_SetErrorReport() Enables/disables dialog messages for error output. With the following functions, you can read out additional information on cameras and software. Returns the event counters and other information. is_CameraStatus() Enables standby mode. © 2016 Thorlabs Scientific Imaging...
Page 91: Opening And Closing The Camera
Returns the pointer to the starting address of the image memory. is_GetImageMemPitch() Returns the line offset used in the image memory. is_InquireImageMem() Returns the properties of an image memory. Note Image memory sequences should be used for frame sequence capture. © 2016 Thorlabs Scientific Imaging...
Page 92 DCx Camera Functional Description and SDK Manual Flowchart: Allocating memory Click in the figure to get help on the functions. © 2016 Thorlabs Scientific Imaging...
Page 93: Image Memory Sequences
Determines the image memory currently used for the sequence. is_SetImageMem() Makes the indicated image memory the active memory. is_LockSeqBuf() Protects the sequence image memory from being overwritten. is_UnlockSeqBuf() Releases the sequence image memory for overwriting. © 2016 Thorlabs Scientific Imaging...
Page 94: Selecting The Display Mode
Outputs the contents of the active image memory to a window. is_RenderBitmap() is_SetDisplayPos() Enables offsetting the image output inside the window. Flowchart: Image display in DIB mode Click in the figure to get help on the functions. © 2016 Thorlabs Scientific Imaging...
Page 95: Capturing Images
In this mode, cameras running in freerun mode (live mode, see above) can be synchronized with an external trigger signal. The cameras still remain in freerun mode. The trigger signal stops and restarts the current image capture process. You can use this mode to synchronize multiple © 2016 Thorlabs Scientific Imaging...
Page 96 The possible frame rate in trigger mode depends on the exposure time. Example: At the maximum exposure time, the frame rate is about half as high as in freerun mode; at the minimum exposure time, the frame rate is about the same. © 2016 Thorlabs Scientific Imaging...
Page 97 Wait parameter. If no image arrives within this timeout period, a timeout error message is issued. Under Windows, a dialog box is displayed if you have enabled error reports (see ). Information on the error cause can be queried using is_SetErrorReport() is_CaptureStatus() © 2016 Thorlabs Scientific Imaging...
Page 98 Returns whether the capture process has been started or not. is_IsVideoFinish() Returns whether the capture process has been terminated or not. is_SetSensorTestImage() Enables test image output from sensor (all cameras). Terminates the capturing process (live video or single frame). is_StopLiveVideo() © 2016 Thorlabs Scientific Imaging...
Page 99 4 Programming (SDK) Flowchart: Single Capture Click in the figure to get help on the functions. Flowchart - Single Capture (1 of 2) © 2016 Thorlabs Scientific Imaging...
Page 100 DCx Camera Functional Description and SDK Manual Flowchart - Single Capture (2 of 2) © 2016 Thorlabs Scientific Imaging...
Page 101 4 Programming (SDK) Flowchart: Sequence Capture Flowchart - Capturing a frame sequence (1 of 2) © 2016 Thorlabs Scientific Imaging...
Page 102 DCx Camera Functional Description and SDK Manual Flowchart - Capturing a frame sequence (2 of 2) © 2016 Thorlabs Scientific Imaging...
Page 103: Event / Message Handling
(e.g. color IS_SET_EVENT_FRAME conversion) is complete and a finished image is available in the user memory. The event is set after one cycle of a storing sequence has been completed (see also IS_SET_EVENT_SEQ is_AddToSequence() © 2016 Thorlabs Scientific Imaging...
Page 104 DCx Camera Functional Description and SDK Manual * Optional function. The start time and duration of the flash signal are defined by the "Flash delay" and "Duration" parameters (see is_IO() © 2016 Thorlabs Scientific Imaging...
Page 105 Initializes the event handler (Windows only) is_EnableAutoExit() Automatically releases the camera resources when the camera is disconnected from the PC. is_WaitEvent() Waits for DCxCamera events (Linux only) Flowchart: Enable events Click in the figure to get help on the functions. © 2016 Thorlabs Scientific Imaging...
Page 106 DCx Camera Functional Description and SDK Manual Flowchart: Enabling Messages © 2016 Thorlabs Scientific Imaging...
Page 107: Setting Camera Parameters
Sets a predefined image size Sets the size and position of an area of interest is_AOI() (AOI) or of a reference AOI for auto imaging functions. Sets the binning modes. is_SetBinning() is_SetRopEffect() Makes real-time geometry changes to an image © 2016 Thorlabs Scientific Imaging...
Page 108: Is_Convert
Selects a color mode. is_Convert() Conversion parameters for raw Bayer conversion. Sets edge enhancement. is_EdgeEnhancement() is_SetSaturation() Sets the image saturation (digital post- processing). Enables test image output from sensor. is_SetSensorTestImage() is_SetTimeout() Sets user-defined timeout values. © 2016 Thorlabs Scientific Imaging...
Page 109 4 Programming (SDK) Flowchart: Changing camera timing Click in the figure to get help on the functions. © 2016 Thorlabs Scientific Imaging...
Page 110: Automatic Image Control
All controls are configured using the SDK function. is_SetAutoParameter() For more information on the automatic image control see Camera basics: Automatic image control. Flowchart: Enable Auto Brightness Click in the figure to get help on the functions. © 2016 Thorlabs Scientific Imaging...
Page 111: Image Pre-Processing
Returns the factory-set information (e.g. revision information for the individual DCxCamera components). Returns the sensor information. is_GetSensorInfo() is_ReadEEPROM() Reads out the writable data area of the EEPROM. is_WriteEEPROM() Writes user data to the EEPROM. © 2016 Thorlabs Scientific Imaging...
Page 112: Saving Images And Videos
Returns the number of frames that have been discarded so far. isavi_GetnLostFrames() isavi_ResetFrameCounters() Resets the counters for discarded and saved frames to 0. Events can be used to get signalled when a frame was added. isavi_DisableEvent() Disables a AVI event. isavi_EnableEvent() Enables a AVI-Event. © 2016 Thorlabs Scientific Imaging...
Page 113 Windows Media Player. To do this, you need to install the uc480 MJPEG codec on your system: Open the uc480 installation directory (default: C:\Program Files\Thorlabs\DCx Cameras \Tools32 or C:\Program Files\Thorlabs\DCx Cameras\Tools64 Right-click the file. uc480Mjpeg.inf uc480Mjpeg_64.inf) Select "Install". The codec is installed automatically.
Page 114 DCx Camera Functional Description and SDK Manual Flowchart: AVI capture Click in the figure to get help on the functions. © 2016 Thorlabs Scientific Imaging...
Page 115: Using Inputs And Outputs
With these commands you can activate additional functions or use GPIOs on some DCx Cameras. is_IO() Sets the additional digital outputs (GPIO). Defines each port as a digital input or output (GPIO). is_IO() Toggles the color of the status LED for DCU22x and is_IO() DCC1240x cameras. © 2016 Thorlabs Scientific Imaging...
Page 116 DCx Camera Functional Description and SDK Manual Flowchart: Digital input Click in the figure to get help on the functions. © 2016 Thorlabs Scientific Imaging...
Page 118: Function Descriptions
C:\Program Files\Thorlabs\DCx directory. The associated source code can be found under Cameras\Samples C:\Program Files \Thorlabs\DCx Cameras\Develop\Source. All sample programs are described in the uc480 Samples Manual. © 2016 Thorlabs Scientific Imaging...
Page 119: Is_Addtosequence
Camera handle Pointer to image memory pcMem Image memory ID Return values IS_INVALID_CAMERA_HANDLE Invalid camera handle General error message IS_NO_SUCCESS IS_SUCCESS Function executed successfully Related functions is_AllocImageMem() is_InitImageQueue() is_SetImageMem() is_SetAllocatedImageMem() Sample programs uc480Sequence (C++) © 2016 Thorlabs Scientific Imaging...
Page 120: Is_Allocimagemem
RAM at a time. Input parameters hCam Camera handle Image width width height Image height Image bit depth (bits per pixel). bitspixel ppcImgMem Returns the pointer to the memory starting address Returns the ID of this memory © 2016 Thorlabs Scientific Imaging...
Page 121 General error message IS_OUT_OF_MEMORY No memory could be allocated. The memory could not be locked. The pointer to the buffer is invalid. IS_SEQUENCE_BUF_ALREADY_ LOCKED IS_SUCCESS Function executed successfully Related functions is_FreeImageMem() is_AddToSequence() is_SetImageMem() is_SetAllocatedImageMem() is_GetColorDepth() is_GetImgMemPitch() © 2016 Thorlabs Scientific Imaging...
Page 122: Is_Aoi
Image capture is not suspended for fast AOI position changes. As a result, when you call the command, a number of images might still be transferred with the old AOI position if they were in the driver buffer at that moment. © 2016 Thorlabs Scientific Imaging...
Page 123 Sets the position and size of the image by using an object of type. Sample 1 for AOI IS_RECT You can define the start position of the AOI in the memory by ORing with the X or Y position. IS_AOI_IMAGE_POS_ABSOLUTE Sample for setting the AOI position © 2016 Thorlabs Scientific Imaging...
Page 124 The axes are passed in an UINT array: Array[0] - Array[3] = X1…X4 Array[4] - Array[8] = Y1…Y4 Sample 1 for multi AOI IS_AOI_MULTI_GET_AOI Returns the set multi AOI mode. The mode that is used has to be ORed with IS_AOI_MULTI_SET_AOI © 2016 Thorlabs Scientific Imaging...
Page 125 X position of the AOI s32X s32Y Y position of the AOI Width of the AOI s32Width s32Height Height of the AOI Contents of the IS_POINT_2D structure s32X X position of the AOI Y position of the AOI s32Y © 2016 Thorlabs Scientific Imaging...
Page 126 1 = a change of exposure time, gain or position of AOI 1 does not affect the parameters of AOI 2, 3 and 4. Double dblScalerFactor Scaling factor (not supported in version 4.80) BYTE byReserved[64] Reserved © 2016 Thorlabs Scientific Imaging...
Page 127 No memory could be allocated. The memory could not be locked. The pointer to the buffer IS_SEQUENCE_BUF_ALREADY_LOCKED is invalid. IS_SUCCESS Function executed successfully IS_TIMED_OUT A timeout occurred. An image capturing process could not be terminated within the allowable period. © 2016 Thorlabs Scientific Imaging...
Page 128 DCx Camera Functional Description and SDK Manual The function cannot be used because the camera is IS_TRIGGER_ACTIVATED waiting for a trigger signal. Related functions is_ImageFormat() is_SetBinning() is_SetSubSampling() © 2016 Thorlabs Scientific Imaging...
Page 129 (nAbsPos == 0) // not set Examples for setting absolute AOI positions in memory x = 100 y = 100 AOI without absolute memory positioning x = 100 | IS_AOI_IMAGE_POS_ABSOLUTE y = 100 © 2016 Thorlabs Scientific Imaging...
Page 130 INT nRet = is_AOI(hCam, IS_AOI_MULTI_DISABLE_AOI | IS_AOI_MULTI_MODE_X_Y_AXES, NULL, NULL); Sample 1 for sequence AOI mode INT nSequenceAOI = 0; (is_AOI(m_hCam, IS_AOI_SEQUENCE_GET_SUPPORTED, (void*)&nSequenceAOI, sizeof(nSequenceAOI)) == IS_SUCCESS) // Sequence AOI 2 is supported ((nSequenceAOI & IS_AOI_SEQUENCE_INDEX_AOI_2) != 0); © 2016 Thorlabs Scientific Imaging...
Page 131 // Enable AOI 1, 2, 3 and 4 nMask = IS_AOI_SEQUENCE_INDEX_AOI_1 | IS_AOI_SEQUENCE_INDEX_AOI_2 | IS_AOI_SEQUENCE_INDEX_AOI_3 | IS_AOI_SEQUENCE_INDEX_AOI_4; nRet = is_AOI(m_hCam, IS_AOI_SEQUENCE_SET_ENABLE, (void*)&nMask, sizeof(nMask)); // Get current AOI mask INT nRet = is_AOI(m_hCam, IS_AOI_SEQUENCE_GET_ENABLE, (void*)&nMask, sizeof(nMask)); © 2016 Thorlabs Scientific Imaging...
Page 132: Is_Autoparameter
0x0002 IS_AWB_COLOR_TEMPERATURE: IS_AWB_CMD_GET_ENABLE Returns if the auto white balance is enabled (Example IS_AUTOPARAMETER_DISABLE: IS_AUTOPARAMETER_ENABLE: IS_AUTOPARAMETER_ENABLE_RUNONCE: IS_AWB_CMD_SET_ENABLE Enables/Disables the auto white balance (Example IS_AUTOPARAMETER_DISABLE: IS_AUTOPARAMETER_ENABLE: IS_AUTOPARAMETER_ENABLE_RUNONCE: IS_AWB_CMD_GET_SUPPORTED_RGB_COLOR_M Returns the supported color spaces for the auto white © 2016 Thorlabs Scientific Imaging...
Page 133 IS_SUCCESS Function executed successfully Related functions is_SetAutoParameter() Example 1 UINT nSupportedTypes = 0; INT nRet = is_AutoParameter(m_hCam, IS_AWB_CMD_GET_SUPPORTED_TYPES, (void*)&nSupportedTypes, sizeof(nSupportedTypes) (nRet == IS_SUCCESS) ((nSupportedTypes & IS_AWB_COLOR_TEMPERATURE) != 0) // AWB type "Color Temperature" is supported © 2016 Thorlabs Scientific Imaging...
Page 134 // Color model SRGB D50 is supported. See uc480.h for color model defines Example 5 UINT nRGBColorModel = 0; INT nRet = is_AutoParameter(m_hCam, IS_AWB_CMD_GET_RGB_COLOR_MODEL, (void*)&nRGBColorModel, sizeof(nRGBColorModel) nRGBColorModel = RGB_COLOR_MODEL_CIE_RGB_E; nRet = is_AutoParameter(m_hCam, IS_AWB_CMD_SET_RGB_COLOR_MODEL, (void*)&nRGBColorModel, sizeof(nRGBColorModel) © 2016 Thorlabs Scientific Imaging...
Page 135: Is_Blacklevel
IS_BLACKLEVEL_CMD_GET_OFFSET_DEFAULT. IS_BLACKLEVEL_CMD_GET_MODE_DEFAULT Returns the default black level mode (Example2) IS_BLACKLEVEL_CMD_GET_MODE Returns the current black level mode (Example2) IS_BLACKLEVEL_CMD_SET_MODE Sets the black level mode (Example The automatic black IS_AUTO_BLACKLEVEL_OFF: level mode is switched off. © 2016 Thorlabs Scientific Imaging...
Page 136 // Get default blacklevel offset INT nRet = is_Blacklevel(hCam, IS_BLACKLEVEL_CMD_GET_OFFSET_DEFAULT, (void*)&nOffset, sizeof(nOffset)); // Get offset range IS_RANGE_S32 nRange; nRet = is_Blacklevel(hCam, IS_BLACKLEVEL_CMD_GET_OFFSET_RANGE, (void*)&nRange, sizeof(nRange)); INT nOffsetMin = nRange.s32Min; INT nOffsetMax = nRange.s32Max; INT nOffsetInc = nRange.s32Inc; © 2016 Thorlabs Scientific Imaging...
Page 137 4 Programming (SDK) // Get current blacklevel offset nRet = is_Blacklevel(hCam, IS_BLACKLEVEL_CMD_GET_OFFSET, (void*)&nOffset, sizeof(nOffset)); // Set new offset nOffset = 100; nRet = is_Blacklevel(hCam, IS_BLACKLEVEL_CMD_SET_OFFSET, (void*)&nOffset, sizeof(nOffset)); © 2016 Thorlabs Scientific Imaging...
Page 138: Is_Camerastatus
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 IS_GET_STATUS Returns the information specified by nInfo. © 2016 Thorlabs Scientific Imaging...
Page 139 The camera model used here does not support this function or setting. IS_OUT_OF_MEMORY No memory could be allocated. Function executed successfully IS_SUCCESS IS_TIMED_OUT A timeout occurred. An image capturing process could not be terminated within the allowable period. Related functions is_GetCameraInfo() is_GetError() is_SetErrorReport() is_SetTriggerCounter() © 2016 Thorlabs Scientific Imaging...
Page 140: Is_Capturestatus
Release locked destination memory Allocate more destination memory Reduce the frame rate so that there is more time to process the filled destination memory The current image could not be processed correctly. IS_CAP_STATUS_API_CONVERSION_FAIL © 2016 Thorlabs Scientific Imaging...
Page 141 Returns the total number of errors occurred since the last reset. BYTE reserved[60] Reserved for an internal function DWORD adwCapStatusCnt_Detail[256] This array returns the current count for each possible error. The possible errors are listed above. Return values © 2016 Thorlabs Scientific Imaging...
Page 142 Related functions is_GetError() is_CameraStatus() is_SetErrorReport() Example 1 uc480_CAPTURE_STATUS_INFO CaptureStatusInfo; INT nRet = is_CaptureStatus(m_hCam, IS_CAPTURE_STATUS_INFO_CMD_GET, (void*)&CaptureStatusInfo, sizeof(CaptureStatusInfo)); (nRet == IS_SUCCESS) UINT nConversionFailed = CaptureStatusInfo.adwCapStatusCnt_Detail[IS_CAP_STATUS_API_CONVERSION_FAILED]); UINT nTotalInfos = CaptureStatusInfo.dwCapStatusCnt_Total; Example 2 INT nRet = is_CaptureStatus(m_hCam, IS_CAPTURE_STATUS_INFO_CMD_RESET, NULL, © 2016 Thorlabs Scientific Imaging...
Page 143: Is_Capturevideo
IS_INVALID_CAMERA_TYPE The camera type defined in the .ini file does not match the current camera model. IS_INVALID_EXPOSURE_TIME This setting is not available for the currently set exposure time. IS_INVALID_CAMERA_HANDLE Invalid camera handle © 2016 Thorlabs Scientific Imaging...
Page 144 A timeout occurred. An image capturing process could not be terminated within the allowable period. The function cannot be used because the camera is waiting for a IS_TRIGGER_ACTIVATED trigger signal. Related functions is_FreezeVideo() is_StopLiveVideo() is_SetExternalTrigger() is_ForceTrigger() is_SetTimeout() is_CaptureStatus() Sample programs SimpleLive (C++) © 2016 Thorlabs Scientific Imaging...
Page 145: Is_Clearsequence
Input parameters hCam Camera handle Return values IS_INVALID_CAMERA_HANDLE Invalid camera handle General error message IS_NO_SUCCESS IS_SEQUENCE_LIST_EMPTY The sequence list is empty and cannot be deleted. IS_SUCCESS Function executed successfully Related functions is_AddToSequence() is_FreeImageMem() is_SetImageMem() © 2016 Thorlabs Scientific Imaging...
Page 146: Is_Colortemperature
Input parameters hCam Camera handle nCommand Setting the color space COLOR_TEMPERATURE_CMD_GET_SUPPORTED_RGB_C Returns the supported color spaces. OLOR_MODELS More details Pointer to a bit mask of type pParam: UINT The bit mask returns the supported modes, © 2016 Thorlabs Scientific Imaging...
Page 147 More details Pointer to variable of type pParam: UINT returning the maximum value. nSizeOfParam: Returns the increment for setting the color COLOR_TEMPERATURE_CMD_GET_TEMPERATURE_INC temperature. More details Pointer to variable of type pParam: UINT returning the increment. © 2016 Thorlabs Scientific Imaging...
Page 148 Pointer to variable of type pParam: UINT returning the default value. nSizeOfParam: pParam Pointer to a function parameter, whose function depends on nCommand. nSizeOfParam Size (in bytes) of the memory area to which refers. pParam © 2016 Thorlabs Scientific Imaging...
Page 149 General error message IS_NO_SUCCESS IS_NOT_SUPPORTED The camera model used here does not support this function or setting. IS_SUCCESS Function executed successfully Related functions is_SetHardwareGain() is_AutoParameter() is_SetAutoParameter() © 2016 Thorlabs Scientific Imaging...
Page 150: Is_Configuration
Windows operating systems. Input parameters Camera handle hCam nCommand IS_CONFIG_CMD_GET_CAPABILITIES Returns the configuration options supported by the system. Additional information Pointer to a bitmask. The status pParam: UINT flags from are returned in CONFIGURATION_CAPS the bitmask. © 2016 Thorlabs Scientific Imaging...
Page 151 IS_CONFIG_OPEN_MP_CMD_SET_ENABLE Additional information Pointer to a variable, pParam: UINT to enable: IS_CONFIG_OPEN_MP_ENABLE to disable: IS_CONFIG_OPEN_MP_DISABLE nSizeOfParam: The settings are lost after the application is Note: closed and must be set again the next time the © 2016 Thorlabs Scientific Imaging...
Page 152 IS_CONFIG_INITIAL_PARAMETERSET_CAP_SU Function parameters to load camera PPORTED parameters during initialization are supported. Contents of the CONFIGURATION_SEL Structure Set/recover processor operating states for IS_CONFIG_CPU_IDLE_STATES_BIT_AC_VALU power supply unit operation IS_CONFIG_CPU_IDLE_STATES_BIT_DC_VALU Set/recover processor operating states for © 2016 Thorlabs Scientific Imaging...
Page 153 The driver could not allocate memory. General error message IS_NO_SUCCESS IS_NOT_SUPPORTED The camera model used here does not support this function or setting. IS_OPERATING_SYSTEM_NOT_SUPPORTED Operating system not supported Function executed successfully IS_SUCCESS Related functions is_ParameterSet() © 2016 Thorlabs Scientific Imaging...
Page 154 (nRet == IS_SUCCESS) (nCpuStates & IS_CONFIG_CPU_IDLE_STATES_BIT_AC_VALUE) // CPU idle states for mains power are deactivated when camera is opened (nCpuStates & IS_CONFIG_CPU_IDLE_STATES_BIT_DC_VALUE) // CPU idle states for battery power are deactivated when camera is opened © 2016 Thorlabs Scientific Imaging...
Page 156 // No parameter set specified else if (nNumber == IS_CONFIG_INITIAL_PARAMETERSET_1) // Parameter set 1 else if (nNumber == IS_CONFIG_INITIAL_PARAMETERSET_2) // Parameter set 2 nNumber = IS_CONFIG_INITIAL_PARAMETERSET_2; is_Configuration(IS_CONFIG_INITIAL_PARAMETERSET_CMD_SET, (void*)&nNumber, sizeof(nNumber)); (nRet == IS_SUCCESS) // Set to parameter set 2 © 2016 Thorlabs Scientific Imaging...
Page 157 IS_CONVERT_CMD_APPLY_PARAMS_AND_CONVERT_B Converts a raw Bayer buffer with the passed conversion parameters UFFER Pointer to a function parameter, whose function pParam depends on nCommand. cbSizeOfParam Size (in bytes) of the memory area to which refers. pParam © 2016 Thorlabs Scientific Imaging...
Page 158 BUFFER_CONVERSION_PARAMS conversionParams; conversionParams.nDestPixelFormat = IS_CM_BGRA8_PACKED; conversionParams.nDestPixelConverter = IS_CONV_MODE_SOFTWARE_3X3; conversionParams.nDestColorCorrectionMode = IS_CCOR_DISABLE; conversionParams.nDestGamma = 100; conversionParams.nDestSaturationU = 100; conversionParams.nDestSaturationV = 100; conversionParams.nDestEdgeEnhancement = 0; conversionParams.pSourceBuffer = pSourceBuffer; conversionParams.pDestBuffer = pDestBuffer; INT nRet = is_Convert(m_hCam, IS_CONVERT_CMD_APPLY_PARAMS_AND_CONVERT_BUFFER, (void*)&conversionParams, sizeof(conversionParams) © 2016 Thorlabs Scientific Imaging...
Page 159: Is_Copyimagemem
An IO request from the uc480 driver failed. IS_IO_REQUEST_FAILED Possibly the versions of the (API) and uc480.dll the driver file ( ) do not match. uc480_usb.sys General error message IS_NO_SUCCESS IS_SUCCESS Function executed successfully Related functions is_AllocImageMem() is_SetAllocatedImageMem() © 2016 Thorlabs Scientific Imaging...
Page 160: Is_Copyimagememlines
An IO request from the uc480 driver failed. Possibly the versions of the (API) and uc480.dll the driver file ( ) do not match. uc480_usb.sys IS_NO_SUCCESS General error message Function executed successfully IS_SUCCESS Related functions is_AllocImageMem() is_SetAllocatedImageMem() © 2016 Thorlabs Scientific Imaging...
Page 161: Is_Devicefeature
The use of the extended pixel clock range is supported. _RANGE IS_DEVICE_FEATURE_CAP_FPN_CORRECTION Fixed pattern noise correction is supported. IS_DEVICE_FEATURE_CAP_IMAGE_EFFECT Image effects are supported. IS_DEVICE_FEATURE_CAP_JPEG_COMPRESSION JPEG compression is supported. IS_DEVICE_FEATURE_CAP_LEVEL_CONTROLLED_TR The use of the level controlled trigger is supported. IGGER © 2016 Thorlabs Scientific Imaging...
Page 162 400 "merged" AOIs. IS_DEVICE_FEATURE_CAP_WIDE_DYNAMIC_RANGE The use of the wide dynamic range is supported. Return values IS_CANT_COMMUNICATE_WITH_DRIVER Communication with the driver failed because no driver has been loaded. IS_CANT_OPEN_DEVICE An attempt to initialize or select the camera © 2016 Thorlabs Scientific Imaging...
Page 163: Configuring The Aoi Merge Mode
INT nLineNumber = 512; nRet = is_DeviceFeature(hCam, IS_DEVICE_FEATURE_CMD_SET_LINESCAN_NUMBER, (void*)&nLineNumber, sizeof(nLineNumber)); nRet = is_DeviceFeature(hCam, IS_DEVICE_FEATURE_CMD_GET_LINESCAN_NUMBER, (void*)&nLineNumber, sizeof(nLineNumber)); 4.3.15.1 Configuring the AOI Merge Mode USB 3.0 USB 3.0 Syntax INT is_DeviceFeature (HIDS hCam, UINT nCommand, void* pParam, UINT cbSizeOfParam) © 2016 Thorlabs Scientific Imaging...
Page 164 If you select functions for setting or returning a value, contains a pointer to a variable of the type. The size of the memory area to which pParam UINT refers is specified in the input parameter. pParam cbSizeOfParam Input parameters hCam Camera handle nCommand © 2016 Thorlabs Scientific Imaging...
Page 165 Returns the default value for the AOI merge position AOI_MERGE_POSITION_DEFAULT IS_DEVICE_FEATURE_CMD_GET_VERTICAL_ Returns the range for the AOI merge position AOI_MERGE_POSITION_RANGE IS_RANGE_S32 IS_DEVICE_FEATURE_CMD_GET_VERTICAL_ Returns the position of the two sensor lines © 2016 Thorlabs Scientific Imaging (default = 0, i.e. the two top lines) AOI_MERGE_POSITION IS_DEVICE_FEATURE_CMD_SET_VERTICAL_...
Page 166 /* Get current value of the vertical AOI merge mode height */ nRet = is_DeviceFeature(hCam, IS_DEVICE_FEATURE_CMD_GET_VERTICAL_AOI_MERGE_HEIGHT, (void*)&nHeight, sizeof(nHeight)); /* Get the number of elements in the vertical AOI merge mode height list */ INT nVerticalAoiMergeModeHeightNumber; nRet = is_DeviceFeature(hCam, IS_DEVICE_FEATURE_CMD_GET_VERTICAL_AOI_MERGE_HEIGHT_NUMBER, (void*)&nVerticalAoiMergeModeHeightNumber, © 2016 Thorlabs Scientific Imaging...
Page 167: Using The Log Mode
If you select functions for setting or returning a value, contains a pointer to a variable of the type. The size of the memory area to which pParam UINT refers is specified in the input parameter. pParam cbSizeOfParam Input parameters Camera handle hCam © 2016 Thorlabs Scientific Imaging...
Page 168 Log mode is supported/Set mode Example 1 /* Read and set default Log mode */ UINT nDefaultLogMode = 0; INT nRet = is_DeviceFeature(hCam, IS_DEVICE_FEATURE_CMD_GET_LOG_MODE_DEFAULT, (void*)&nDefaultLogMode, sizeof(nDefaultLogMode)); (nRet == IS_SUCCESS) { nRet = is_DeviceFeature(hCam, IS_DEVICE_FEATURE_CMD_SET_LOG_MODE, (void*)&nDefaultLogMode, sizeof(nDefaultLogMode)); © 2016 Thorlabs Scientific Imaging...
Page 169 INT nMax = nLogModeManualGainRange.s32Max; INT nInc = nLogModeManualGainRange.s32Inc; Example 6 UINT nLogModeGain = 0; /* Read current Log mode gain */ nRet = is_DeviceFeature(hCam, IS_DEVICE_FEATURE_CMD_GET_LOG_MODE_MANUAL_GAIN, (void*)&nLogModeGain, sizeof(nLogModeGain)); /* Set Log mode gain*/ nRet = is_DeviceFeature(hCam, IS_DEVICE_FEATURE_CMD_SET_LOG_MODE_MANUAL_GAIN, (void*)&nLogModeGain, sizeof(nLogModeGain)); © 2016 Thorlabs Scientific Imaging...
Page 170: Using Level Controlled Trigger
Pointer to a function parameter, whose function depends on nCommand. cbSizeOfParam Size (in bytes) of the memory area to which refers. pParam Status flags from DEVICE_FEATURE_MODE_CAPS IS_DEVICE_FEATURE_CAP_LEVEL_CONTROLLED_TR The use of the level controlled trigger is supported. IGGER © 2016 Thorlabs Scientific Imaging...
Page 171: Switching The Shutter Mode
The size of the memory area to which pParam UINT refers is specified in the input parameter. pParam cbSizeOfParam Input parameters hCam Camera handle nCommand Sets the shutter mode, see IS_DEVICE_FEATURE_CMD_SET_SHUTTER_MODE DEVICE_FEATURE_MODE_CAPS © 2016 Thorlabs Scientific Imaging...
Page 172: Using The Internal Image Memory
Camera handle hCam nCommand IS_DEVICE_FEATURE_CMD_GET_MEMORY_MODE_E Returns if the image memory of the camera is enabled (Example 3). NABLE IS_DEVICE_FEATURE_CMD_SET_MEMORY_MODE_E Enables/disables the image memory of the camera (Example 2): NABLE 1 = IS_MEMORY_MODE_ON 0 = IS_MEMORY_MODE_OFF © 2016 Thorlabs Scientific Imaging...
Page 173 // Query the status of the image memory via camera handle nMemoryMode; nRet = is_DeviceFeature(hCam, IS_DEVICE_FEATURE_CMD_GET_MEMORY_MODE_ENABLE, &nMemoryMode, sizeof(nMemor (nMemoryMode == IS_MEMORY_MODE_ON) … // Query the status of the image memory via device ID nMemoryMode; nRet = is_DeviceFeature(nDevID | IS_USE_DEVICE_ID, IS_DEVICE_FEATURE_CMD_GET_MEMORY_MODE_ENABLE, &nMemo (nMemoryMode == IS_MEMORY_MODE_ON) … © 2016 Thorlabs Scientific Imaging...
Page 174: Using The Line Scan Mode
Sets the scan line used for the line scan mode Returns the scan line used for the line scan IS_DEVICE_FEATURE_CMD_GET_LINESCAN_NUMBER mode pParam Pointer to a function parameter, whose function depends on nCommand. cbSizeOfParam Size (in bytes) of the memory area to which refers. pParam © 2016 Thorlabs Scientific Imaging...
Page 175: Configuring The Timestamp
Sets once the camera timestamp to 0. s32Pin Pin for setting the timestamp: TIMESTAMP_CONFIGURATION_PIN_ Timestamp is not reset. NONE: TIMESTAMP_CONFIGURATION_PIN_ Timestamp is set by TRIGGER: signal on the trigger pin. TIMESTAMP_CONFIGURATION_PIN_ Timestamp is set by GPIO_1: © 2016 Thorlabs Scientific Imaging...
Page 176 = IS_IGNORE_PARAMETER; nRet = is_DeviceFeature(hCam, IS_DEVICE_FEATURE_CMD_SET_TIMESTAMP_CONFIGURATION, (void*)&timestampConfiguration, sizeof(timestampConfiguration)); 4.3.16 is_DeviceInfo USB 3 USB 3 Note This command is supported by DCC3240x USB3 cameras only! Syntax INT is_DeviceInfo (HIDS hCam, UINT nCommand, void* pParam, UINT cbSizeOfParam) © 2016 Thorlabs Scientific Imaging...
Page 177: Is_Deviceinfo
Bit 10...4: temperature (places before the decimal point) Bit 3...0: temperature (places after the decimal point) See the Ambient conditions chapter for permissible temperature range. WORD wLinkSpeed_Mb Transfer rate: IS_USB_HIGH_SPEED = 480 IS_USB_SUPER_SPEED = 4000 © 2016 Thorlabs Scientific Imaging...
Page 178 Example 1 // The camera has the device ID 1 UINT nDeviceId = 1; IS_DEVICE_INFO deviceInfo; memset(&deviceInfo, 0, sizeof(IS_DEVICE_INFO)); INT nRet = is_DeviceInfo((HIDS)(nDeviceId | IS_USE_DEVICE_ID), IS_DEVICE_INFO_CMD_GET_DEVICE_INFO, (void*)&deviceInfo, sizeof(deviceInfo)); (nRet == IS_SUCCESS) WORD wTemperature = deviceInfo.infoDevHeartbeat.wTemperature; © 2016 Thorlabs Scientific Imaging...
Page 179: Is_Directrenderer
The size of the memory area to which pParam UINT refers is specified in the input parameter. pParam nSizeOfParam Input parameters Camera handle hCam nMode Returns either if Direct3D or OpenGL is DR_GET_SUPPORTED © 2016 Thorlabs Scientific Imaging...
Page 180 If you fill part of the overlay with a different color, the camera image will be covered by the overlay in those places. The key color has no effect in semi-transparent mode! © 2016 Thorlabs Scientific Imaging...
Page 181 The position needs to be determined individually, based on the camera type and the graphics card. Example Direct3D only: Returns the minimum and DR_GET_USER_SYNC_POSITION_RANGE © 2016 Thorlabs Scientific Imaging...
Page 182 OpenGL only: Returns a pointer to the overlay. DR_UPDATE_OVERLAY_DATA OpenGL only: Updates the overlay. pParam Pointer to a function parameter, whose function depends on nCommand. nSize Size (in bytes) of the data object or array. © 2016 Thorlabs Scientific Imaging...
Page 183 Related functions is_SetDisplayMode() is_SetColorMode() is_SetImageMem() is_RenderBitmap() Example Supported function UINT nType = IS_SET_DM_DIRECT3D; (is_DirectRenderer(m_pMainView->GetCameraHandle(), DR_GET_SUPPORTED, (void*)&nType, sizeof(nType)) == IS_SUCCESS) // Direct3D is supported nType = IS_SET_DM_OPENGL; (is_DirectRenderer(m_pMainView->GetCameraHandle(), DR_GET_SUPPORTED, (void*)&nType, sizeof(nType)) == IS_SUCCESS) // OpenGL is supported © 2016 Thorlabs Scientific Imaging...
Page 184 DCx Camera Functional Description and SDK Manual Example DC handle //------------------------------------ DC-Handle //------------------------------------ // Get DC handle for Overlay HDC hDC; is_DirectRenderer (hCam, DR_GET_OVERLAY_DC, (void*)&hDC, sizeof (hDC)); // Release DC handle is_DirectRenderer (hCam, DR_RELEASE_OVERLAY_DC, NULL, NULL); © 2016 Thorlabs Scientific Imaging...
Page 185 // Show overlay is_DirectRenderer (hCam, DR_SHOW_OVERLAY, NULL, NULL); // Hide overlay is_DirectRenderer (hCam, DR_HIDE_OVERLAY, NULL, NULL); Example scaling //------------------------------------ Scaling //------------------------------------ // Enable scaling is_DirectRenderer (hCam, DR_ENABLE_SCALING, NULL, NULL); // Disable scaling is_DirectRenderer (hCam, DR_DISABLE_SCALING, NULL, NULL); © 2016 Thorlabs Scientific Imaging...
Page 186 // Get and set color mode for image to be copied INT nColorMode; is_DirectRenderer (hCam, DR_GET_STEAL_FORMAT, (void*)&nColorMode, sizeof (nColorMode)); nColorMode = IS_CM_MONO8; is_DirectRenderer (hCam, DR_SET_STEAL_FORMAT, void*)&nColorMode, sizeof (nColorMode)); // Copy image with function returning immediately INT nwait = IS_DONT_WAIT; is_DirectRenderer(hCam, DR_STEAL_NEXT_FRAME, (void*)&wait, sizeof (wait)); © 2016 Thorlabs Scientific Imaging...
Page 187 (hCam, DR_SET_HWND, (void*)&hWnd, sizeof (hWnd)); Example compatibility //------------------------------------ Compatibility //------------------------------------ // Check graphics card compatibility INT nRet = is_DirectRenderer (hCam, DR_CHECK_COMPATIBILITY, NULL, NULL); (nRet == IS_DR_DEVICE_CAPS_INSUFFICIENT ) // Graphics card does not support Direct3D © 2016 Thorlabs Scientific Imaging...
Page 188 (cr, 1, 0.2, 0.2, 0.6); cairo_arc (cr, 10.0, 135.0, 5.12, 0, 2*3.14); cairo_close_path (cr); cairo_arc (cr, 70.0, 165.0, 5.12, 0, 2*3.14); cairo_fill (cr); cairo_destroy (cr); cairo_surface_destroy (surface); // update overlay is_DirectRenderer(hCam, DR_UPDATE_OVERLAY_DATA, NULL, 0); Sample programs uc480DirectRenderer uc480Steal © 2016 Thorlabs Scientific Imaging...
Page 189 IS_NO_SUCCESS General error message Function executed successfully IS_SUCCESS Related functions is_EnableEvent() Windows only: is_InitEvent() Windows only: is_ExitEvent() Linux only: is_WaitEvent() © 2016 Thorlabs Scientific Imaging...
Page 190: Is_Edgeenhancement
Return values IS_INVALID_PARAMETER One of the submitted parameters is outside the valid range or is not supported for this sensor or is not available in this mode. IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully © 2016 Thorlabs Scientific Imaging...
Page 191 4 Programming (SDK) Related functions is_SetColorMode() is_SetColorConverter() © 2016 Thorlabs Scientific Imaging...
Page 192 Example 2 UINT nDefault; INT nRet = is_EdgeEnhancement(m_hCam, IS_EDGE_ENHANCEMENT_CMD_GET_DEFAULT, (void*)&nDefault, sizeof(nDefault) Example 3 UINT nEdgeEnhancement; INT nRet = is_EdgeEnhancement(m_hCam, IS_EDGE_ENHANCEMENT_CMD_GET, (void*)&nEdgeEnhancement, sizeof(nEdgeEnhancement) Example 4 UINT nEdgeEnhancement = 4; INT nRet = is_EdgeEnhancement(m_hCam, IS_EDGE_ENHANCEMENT_CMD_SET, (void*)&nEdgeEnhancement, sizeof(nEdgeEnhancement) © 2016 Thorlabs Scientific Imaging...
Page 193: Is_Enableautoexit
Enables automatic closing IS_ENABLE_AUTO_EXIT IS_DISABLE_AUTO_EXIT Disables automatic closing Returns the current setting IS_GET_AUTO_EXIT_ENABLED Return values Current setting when used together with IS_GET_AUTO_EXIT_ENABLED Invalid camera handle IS_INVALID_CAMERA_HANDLE IS_NO_SUCCESS General error message Function executed successfully IS_SUCCESS Related functions is_ExitCamera() © 2016 Thorlabs Scientific Imaging...
Page 194: Is_Disableevent
USB 2.0 to USB 3.0 or from USB 3.0 to USB 2.0. A camera initialized with IS_SET_EVENT_DEVICE_RECONNECTED is_InitCamera() disconnected afterwards was reconnected. An image which was captured following the IS_SET_EVENT_EXTTRIG arrival of a trigger has been transferred completely. © 2016 Thorlabs Scientific Imaging...
Page 195 Windows only: is_ExitEvent() Linux only: is_WaitEvent() Example Windows HANDLE hEvent = CreateEvent(NULL, FALSE, FALSE, NULL); is_InitEvent(hCam, hEvent, IS_SET_EVENT_FRAME); is_EnableEvent(hCam, IS_SET_EVENT_FRAME); is_FreezeVideo(hCam, IS_DONT_WAIT); DWORD dwRet = WaitForSingleObject(hEvent, 1000); (dwRet == WAIT_TIMEOUT) /* wait timed out */ © 2016 Thorlabs Scientific Imaging...
Page 196 IS_SET_EVENT_FRAME); is_FreezeVideo(hCam, IS_DONT_WAIT); INT nRet = is_WaitEvent(hCam, IS_SET_EVENT_FRAME, 1000); (nRet == IS_TIMED_OUT) /* wait timed out */ else if (nRet == IS_SUCCESS) /* event signalled */ is_DisableEvent(hCam, IS_SET_EVENT_FRAME); Sample programs SimpleLive (C++) uc480Event (C++) © 2016 Thorlabs Scientific Imaging...
Page 197: Is_Enablemessage
The image must then be post-processed by the driver and is available after the message has occurred. IS_FRAME IS_DEVICE_REMOVED A camera initialized with is_InitCamera() disconnected. IS_DEVICE_RECONNECTED A camera initialized with is_InitCamera() disconnected afterwards was reconnected. © 2016 Thorlabs Scientific Imaging...
Page 198 One of the submitted parameters is outside the IS_INVALID_PARAMETER valid range or is not supported for this sensor or is not available in this mode. IS_NO_SUCCESS General error message Function executed successfully IS_SUCCESS Related functions is_InitEvent() © 2016 Thorlabs Scientific Imaging...
Page 199: Is_Exitcamera
Possibly the versions of the (API) and uc480.dll the driver file ( ) do not match. uc480_usb.sys IS_NO_IMAGE_MEM_ALLOCATED The driver could not allocate memory. IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_InitCamera() is_EnableAutoExit() © 2016 Thorlabs Scientific Imaging...
Page 200 One of the submitted parameters is outside the valid range or is not supported for this sensor or is not available in this mode. IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_EnableEvent() is_InitEvent() Example See also is_ForceTrigger() © 2016 Thorlabs Scientific Imaging...
Page 201: Is_Exitimagequeue
The image memories will be unlocked. The memory sequence itself persists and can be deleted with is_ClearSequence() Input parameters Camera handle hCam Return values IS_INVALID_CAMERA_HANDLE Invalid camera handle General error message IS_NO_SUCCESS IS_SUCCESS Function executed successfully Related functions is_InitImageQueue() is_WaitForNextImage() © 2016 Thorlabs Scientific Imaging...
Page 202 Note on older uc480 exposure time functions The following uc480 API commands are obsolete by the function: is_Exposure() is_GetExposureRange() is_SetExposureTime() See also Obsolete functions Input parameters Camera handle hCam nCommand © 2016 Thorlabs Scientific Imaging...
Page 203 The camera does not contain any calibration data. IS_NOT_CALIBRATED IS_NOT_SUPPORTED The camera model used here does not support this function or setting. Function executed successfully IS_SUCCESS A timeout occurred. An image capturing process could not IS_TIMED_OUT be terminated within the allowable period. © 2016 Thorlabs Scientific Imaging...
Page 204: Setting The Exposure Time
Applying new settings In freerun mode ( ), any modification of the exposure time will only become is_CaptureVideo() effective when image after next is captured. In trigger mode ( ), the is_SetExternalTrigger() © 2016 Thorlabs Scientific Imaging...
Page 205 If you select functions for setting or returning a value, contains a pointer to a variable of the type. The size of the memory area to which pParam UINT refers is specified in the input parameter. pParam cbSizeOfParam Input parameters hCam Camera handle nCommand © 2016 Thorlabs Scientific Imaging...
Page 206 Depending on the sensor the set exposure time may vary slightly from the desired exposure time. nSizeOfParam: If 0 is passed, the exposure time is set to the maximum value of 1/frame rate. © 2016 Thorlabs Scientific Imaging...
Page 207: Exposure Time With Fine Increments
If you select functions for setting or returning a value, contains a pointer to a variable of the type. The size of the memory area to which pParam UINT refers is specified in the input parameter. pParam cbSizeOfParam Input parameters hCam Camera handle nCommand © 2016 Thorlabs Scientific Imaging...
Page 208 INT nRet = is_Exposure(m_hCam, IS_EXPOSURE_CMD_GET_FINE_INCREMENT_RANGE_MIN, (void*)&dblMin, sizeof(dblMin)); INT nRet = is_Exposure(m_hCam, IS_EXPOSURE_CMD_GET_FINE_INCREMENT_RANGE_MAX, (void*)&dblMax, sizeof(dblMax)); INT nRet = is_Exposure(m_hCam, IS_EXPOSURE_CMD_GET_FINE_INCREMENT_RANGE_INC, (void*)&dblInc, sizeof(dblInc)); Example 2 double dblRange[3]; double dblMin, dblMax, dblInc; INT nRet = is_Exposure(m_hCam, IS_EXPOSURE_CMD_GET_FINE_INCREMENT_RANGE, (void*)dblRange, sizeof(dblRange)); (nRet == IS_SUCCESS) © 2016 Thorlabs Scientific Imaging...
Page 209: Setting The Long Exposure
If you select functions for setting or returning a value, contains a pointer to a variable of the type. The size of the memory area to which pParam UINT refers is specified in the input parameter. pParam cbSizeOfParam Input parameters Camera handle hCam nCommand © 2016 Thorlabs Scientific Imaging...
Page 210: Setting The Dual Exposure
Using you can set for the models / and / the dual exposure time. is_Exposure() Dual exposure and AOI If you want to use dual exposure and AOI simultaneously, you must take care that both © 2016 Thorlabs Scientific Imaging...
Page 211: Is_Exposure
The dual exposure cannot be used when Note: the camera is operated with minimum exposure time. Pointer to a function parameter, whose function pParam depends on nCommand. Size (in bytes) of the memory area to which cbSizeOfParam refers. pParam © 2016 Thorlabs Scientific Imaging...
Page 212: Is_Forcetrigger
Enable trigger and wait 1 second for the external trigger. If no trigger signal has arrived, force an exception using is_ForceTrigger(). HANDLE hEvent = CreateEvent(NULL, TRUE, FALSE, ""); ( hEvent != NULL ) is_InitEvent(hCam, m_hEvent, IS_SET_EVENT_FRAME); is_EnableEvent(hCam, IS_SET_EVENT_FRAME); © 2016 Thorlabs Scientific Imaging...
Page 213 4 Programming (SDK) 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); © 2016 Thorlabs Scientific Imaging...
Page 214: Is_Freeimagemem
An IO request from the uc480 driver failed. IS_IO_REQUEST_FAILED Possibly the versions of the (API) and uc480.dll the driver file ( ) do not match. uc480_usb.sys IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully © 2016 Thorlabs Scientific Imaging...
Page 216: Is_Freezevideo
IS_INVALID_EXPOSURE_TIME time. Invalid camera handle IS_INVALID_CAMERA_HANDLE Invalid pointer or invalid memory ID IS_INVALID_MEMORY_POINTER IS_INVALID_PARAMETER One of the submitted parameters is outside the valid range or is not supported for this sensor or is not available © 2016 Thorlabs Scientific Imaging...
Page 217 IS_SET_TRIGGER_SOFTWARE); // Set the flash to a high active pulse for each image in the trigger mode UINT nMode = IO_FLASH_MODE_TRIGGER_HI_ACTIVE; is_IO(m_hCam, IS_IO_CMD_FLASH_SET_MODE, (void*)&nMode, sizeof(nMode)); is_FreezeVideo(hCam, IS_WAIT); Sample programs SimpleAcquire (C++) uc480C# Demo (C#) © 2016 Thorlabs Scientific Imaging...
Page 218: Is_Gamma
100, corresponds to a gamma value of 1.0) Example 2 IS_GAMMA_CMD_GET Returns the current set gamma value Example 3 pParam Pointer to a function parameter, whose function depends on nCommand. cbSizeOfParam Size (in bytes) of the memory area to which refers. pParam © 2016 Thorlabs Scientific Imaging...
Page 219: Is_Getactiveimagemem
If a Direct3D mode is active and image memory was nevertheless allocated, the pointer to the image memory and its ID will be returned. However, in Direct3D mode, the image will not be copied automatically to this image memory. © 2016 Thorlabs Scientific Imaging...
Page 220 An IO request from the uc480 driver failed. Possibly the versions of the (API) and uc480.dll the driver file ( ) do not match. uc480_usb.sys IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_AllocImageMem() is_GetImageMem() is_SetImageMem() is_SetAllocatedImageMem() © 2016 Thorlabs Scientific Imaging...
Page 221: Is_Getactseqbuf
Invalid pointer or invalid memory ID IS_INVALID_PARAMETER One of the submitted parameters is outside the valid range or is not supported for this sensor or is not available in this mode. An IO request from the uc480 driver failed. IS_IO_REQUEST_FAILED © 2016 Thorlabs Scientific Imaging...
Page 222 Possibly the versions of the (API) and uc480.dll the driver file ( ) do not match. uc480_usb.sys General error message IS_NO_SUCCESS IS_SEQUENCE_LIST_EMPTY The sequence list is empty and cannot be deleted. Function executed successfully IS_SUCCESS Related functions is_AddToSequence() is_GetImageMem() © 2016 Thorlabs Scientific Imaging...
Page 223: Is_Getautoinfo
AUTO_BRIGHT_STATUS sBrightCtrlStatus Status of automatic brightness control, see below Status of auto white balance, see below AUTO_WB_STATUS sWBCtrlStatus Returns a bit mask containing all supported DWORD AShutterPhotomCaps photometry settings (fields of view) for auto © 2016 Thorlabs Scientific Imaging...
Page 224 BlueChannel AUTO_WB_CHANNEL_STATUS Contents of the UC480_AUTO_INFO::AUTO_WB_STATUS::AUTO_WB_CHANNEL_STATUS Structure curValue Current average grayscale value (actual value) Current control deviation (error) curError curCtrlStatus Current control status ACS_ADJUSTING Control is active. ACS_FINISHED Control is completed. Control is disabled. ACS_DISABLED © 2016 Thorlabs Scientific Imaging...
Page 225 Gray World algorithm. This algorithm assumes that the average color value in the scene is gray. WB_MODE_INCANDESCENT_LAMP Sensor sets auto white balance to incandescent light Sensor sets auto white balance to fluorescent WB_MODE_FLUORESCENT_DL light (daylight type) © 2016 Thorlabs Scientific Imaging...
Page 226 (API) and uc480.dll the driver file ( ) do not match. uc480_usb.sys IS_NO_SUCCESS General error message The camera model used here does not support IS_NOT_SUPPORTED this function or setting. Function executed successfully IS_SUCCESS Related functions is_SetAutoParameter() © 2016 Thorlabs Scientific Imaging...
Page 227: Is_Getbusspeed
Function executed successfully IS_USB_10 The controller to which the camera is connected does not support USB 2.0. IS_USB_20 The camera is connected to a USB 2.0 controller. IS_USB_30 The camera is connected to a USB 3.0 controller. © 2016 Thorlabs Scientific Imaging...
Page 228: Is_Getcamerainfo
(e.g. V2.10 char Date[12] System date of the final quality check (e.g. 01.08.2011 (DD.MM.YYYY)) unsigned char Select Camera ID unsigned char Type Camera type: DCU223x, DCU224x IS_CAMERA_TYPE_UEYE_USB_SE: and DCC1240x DCC1545M / IS_CAMERA_TYPE_UEYE_USB_LE: DCC1645C DCC3240x IS_CAMERA_TYPE_UEYE_USB3_CP: © 2016 Thorlabs Scientific Imaging...
Page 229 4 Programming (SDK) Reserved char Reserved[8] Return values Invalid camera handle IS_INVALID_CAMERA_HANDLE IS_NO_SUCCESS General error message Function executed successfully IS_SUCCESS Related functions is_CameraStatus() is_GetSensorInfo() © 2016 Thorlabs Scientific Imaging...
Page 230: Is_Getcameralist
Instead, we recommend identifying a camera by a fixed camera ID, the camera type or by the sensor ID. The advantage of the camera ID is that you can set it manually. That means if you exchange a camera, you can set the same camera ID for the new camera. © 2016 Thorlabs Scientific Imaging...
Page 231 = nNumCam; //Retrieve camera info (is_GetCameraList(pucl) == IS_SUCCESS) { iCamera; (iCamera = 0; iCamera < (int)pucl->dwCount; iCamera++) { //Test output of camera info on the screen printf("Camera %i Id: %d", iCamera, pucl->uci[iCamera].dwCameraID); delete [] pucl; © 2016 Thorlabs Scientific Imaging...
Page 232: Is_Getcameralut
Pointer to the array to which the blue channel pBlue values of the LUT are written. Return values IS_INVALID_CAMERA_HANDLE Invalid camera handle General error message IS_NO_SUCCESS IS_NOT_SUPPORTED The camera model used here does not support this function or setting. IS_SUCCESS Function executed successfully © 2016 Thorlabs Scientific Imaging...
Page 233: Is_Getcolorconverter
All converters supported for this color mode. pSupportedConvertModes Possible converters are: IS_CONV_MODE_NONE IS_CONV_MODE_SOFTWARE_3X3 IS_CONV_MODE_SOFTWARE_5X5 IS_CONV_MODE_HARDWARE_3X3 Return values IS_INVALID_COLOR_FORMAT Invalid color format Invalid camera handle IS_INVALID_CAMERA_HANDLE IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_SetColorConverter() is_SetColorMode() © 2016 Thorlabs Scientific Imaging...
Page 234: Is_Getcolordepth
One of the submitted parameters is outside the valid range or is not supported for this sensor or is not available in this mode. General error message IS_NO_SUCCESS IS_SUCCESS Function executed successfully Related functions is_SetColorMode() is_AllocImageMem() © 2016 Thorlabs Scientific Imaging...
Page 235: Is_Getdllversion
= is_GetDLLVersion(); build = version & 0xFFFF; version = version >> 16; minor = version & 0xFF; version = version >> 8; major = version & 0xFF; printf("API version %d.%d.%d \n\n", major, minor, build); © 2016 Thorlabs Scientific Imaging...
Page 236: Is_Geterror
One of the submitted parameters is outside the IS_INVALID_PARAMETER valid range or is not supported for this sensor or is not available in this mode. IS_NO_SUCCESS General error message Function executed successfully IS_SUCCESS Related functions is_CaptureStatus() is_SetErrorReport() is_CameraStatus() © 2016 Thorlabs Scientific Imaging...
Page 237: Is_Getframespersecond
One of the submitted parameters is outside the valid range or is not supported for this sensor or is not available in this mode. General error message IS_NO_SUCCESS IS_SUCCESS Function executed successfully Related functions is_GetFrameTimeRange() is_SetFrameRate() is_PixelClock() is_Exposure() © 2016 Thorlabs Scientific Imaging...
Page 238: Is_Getframetimerange
One of the submitted parameters is outside the valid IS_INVALID_PARAMETER range or is not supported for this sensor or is not available in this mode. IS_NO_SUCCESS General error message Function executed successfully IS_SUCCESS Related functions © 2016 Thorlabs Scientific Imaging...
Page 239 4 Programming (SDK) is_GetFramesPerSecond() is_SetFrameRate() is_PixelClock() is_Exposure() © 2016 Thorlabs Scientific Imaging...
Page 240: Is_Getimagehistogram
An IO request from the uc480 driver failed. Possibly the versions of the (API) and uc480.dll the driver file ( ) do not match. uc480_usb.sys IS_NO_SUCCESS General error message IS_NULL_POINTER Invalid array IS_SUCCESS Function executed successfully Related functions © 2016 Thorlabs Scientific Imaging...
Page 242 //Create pointer for each histogram color DWORD * pBlueHisto = bgrBuffer; DWORD *pGreenHisto = bgrBuffer + 256; DWORD * pRedHisto = bgrBuffer + 512; //Retrieve histogram and release memory is_GetImageHistogram (hCam, nIDSource, IS_CM_RGB8_PACKED, bgrBuffer); is_FreeImageMem (hCam, pcSource, nIDSource); © 2016 Thorlabs Scientific Imaging...
Page 243: Is_Getimageinfo
ID of the image buffer for which information is nImageBufferID requested Pointer to a type structure to pImageInfo UC480IMAGEINFO which the information will be written nImageInfoSize Size of the structure Contents of the UC480IMAGEINFO structure DWORD dwFlags Internal status flags (currently not used) © 2016 Thorlabs Scientific Imaging...
Page 244 DWORD dwReserved3 Reserved Image height DWORD dwImageHeight Image width DWORD dwImageWidth Status flags in UC480IMAGEINFO::dwIoStatus Bit combination State of digital input State of GPIO 1 State of GPIO 2 Contents of the UC480IMAGEINFO::UEYETIME structure © 2016 Thorlabs Scientific Imaging...
Page 245 This may happen when e.g.: more memory is allocated than the UC480IMAGEINFO structure needs nImageBufferID <= 0 pImageInfo == NULL nImageInfoSize <= 0 IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully © 2016 Thorlabs Scientific Imaging...
Page 246: Sample Program
= ImageInfo.u64TimestampDevice; CString Str; // Read out timestamp in system time Str.Format("%02d.%02d.%04d, %02d:%02d:%02d:%03d", ImageInfo.TimestampSystem.wDay, ImageInfo.TimestampSystem.wMonth, ImageInfo.TimestampSystem.wYear, ImageInfo.TimestampSystem.wHour, ImageInfo.TimestampSystem.wMinute, ImageInfo.TimestampSystem.wSecond, ImageInfo.TimestampSystem.wMilliseconds); DWORD dwTotalBuffers = ImageInfo.dwImageBuffers; DWORD dwUsedBuffers = ImageInfo.dwImageBuffersInUse; Sample Program uc480Timestamp (C++) © 2016 Thorlabs Scientific Imaging...
Page 247: Is_Getimagemem
Possibly the versions of the (API) and uc480.dll the driver file ( ) do not match. uc480_usb.sys General error message IS_NO_SUCCESS IS_SUCCESS Function executed successfully Related functions is_GetImageMemPitch() is_AllocImageMem() is_AddToSequence() is_SetImageMem() is_SetAllocatedImageMem() Sample programs uc480PixelPeek (C++) © 2016 Thorlabs Scientific Imaging...
Page 248: Is_Getimagemempitch
An IO request from the uc480 driver failed. Possibly the versions of the (API) and uc480.dll the driver file ( ) do not match. uc480_usb.sys IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_GetImageMem() is_AllocImageMem() is_AddToSequence() © 2016 Thorlabs Scientific Imaging...
Page 250: Is_Getnumberofcameras
Return values IS_INVALID_PARAMETER One of the submitted parameters is outside the valid range or is not supported for this sensor or is not available in this mode. IS_SUCCESS Function executed successfully Related functions is_GetCameraList() is_DeviceInfo() © 2016 Thorlabs Scientific Imaging...
Page 251: Is_Getosversion
Windows 2000 operating system IS_OS_WINXP Windows XP operating system Windows Server 2003 operating system IS_OS_WINSERVER2003 IS_OS_WINVISTA Windows Vista operating system Windows 7 operating system IS_OS_WIN7 IS_OS_LINUX26 Linux 2.6 operating system Unknown operating system IS_OS_UNDETERMINED Related functions is_GetDLLVersion() © 2016 Thorlabs Scientific Imaging...
Page 252: Is_Getsensorinfo
µ m) Reserved Char Reserved[14] Return values IS_INVALID_CAMERA_HANDLE Invalid camera handle IS_INVALID_PARAMETER One of the submitted parameters is outside the valid range or is not supported for this sensor or is not available in this mode. © 2016 Thorlabs Scientific Imaging...
Page 253 4 Programming (SDK) General error message IS_NO_SUCCESS The camera model used here does not support IS_NOT_SUPPORTED this function or setting. Function executed successfully IS_SUCCESS Related functions is_GetCameraInfo() is_CameraStatus() © 2016 Thorlabs Scientific Imaging...
Page 254: Is_Getsensorscalerinfo
General error message IS_NO_SUCCESS IS_NOT_SUPPORTED The camera model used here does not support this function or setting. IS_SUCCESS Function executed successfully Related functions is_SetSensorScaler() © 2016 Thorlabs Scientific Imaging...
Page 255: Is_Getsupportedtestimages
Camera image overlaid with a grid of blue dots Camera image overlaid with a grid of red IS_TEST_IMAGE_HOTPIXEL_GRID dots IS_TEST_IMAGE_VARIABLE_GREY Adjustable grayscale image 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 © 2016 Thorlabs Scientific Imaging...
Page 256 IS_NO_SUCCESS General error message The camera model used here does not support IS_NOT_SUPPORTED this function or setting. Function executed successfully IS_SUCCESS Related functions is_SetSensorTestImage() is_GetTestImageValueRange() © 2016 Thorlabs Scientific Imaging...
Page 257: Is_Gettestimagevaluerange
General error message IS_NO_SUCCESS IS_NOT_SUPPORTED The camera model used here does not support this function or setting. In this case, the TestImageValueMin parameters are equal to 0. TestImageValueMax IS_SUCCESS Function executed successfully Related functions is_GetSupportedTestImages() is_SetSensorTestImage() © 2016 Thorlabs Scientific Imaging...
Page 258: Is_Gettimeout
The camera model used here does not support this IS_NOT_SUPPORTED function or setting. Function executed successfully IS_SUCCESS Related functions is_SetTimeout() is_CaptureVideo() is_FreezeVideo() is_SetExternalTrigger() Example // Return user-defined timeout UINT nTimeout; INT ret = is_GetTimeout(hCam, IS_TRIGGER_TIMEOUT, &nTimeout); © 2016 Thorlabs Scientific Imaging...
Page 259: 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 MByte/s) Related functions is_PixelClock() © 2016 Thorlabs Scientific Imaging...
Page 260: Is_Getvsynccount
Input parameters hCam Camera handle Current VSYNC count pIntr pActIntr Current Frame SYNC count Return values IS_INVALID_CAMERA_HANDLE Invalid camera handle IS_NO_SUCCESS General error message Function executed successfully IS_SUCCESS Related functions is_GetFramesPerSecond() © 2016 Thorlabs Scientific Imaging...
Page 261: Is_Hasvideostarted
Returns the digitizing status: 0 = Image capturing has not started yet. 1 = Image capturing has started. Return values Invalid camera handle IS_INVALID_CAMERA_HANDLE IS_NO_SUCCESS General error message Function executed successfully IS_SUCCESS Related functions is_FreezeVideo() is_IsVideoFinish() © 2016 Thorlabs Scientific Imaging...
Page 262: Is_Hotpixel
This requires the user's hot pixel list to be set IS_HOTPIXEL_SET_SOFTWARE_USER_LIST IS_HOTPIXEL_ENABLE_SENSOR_CORRECTION Enables sensor's own hot pixel correction function (if available). IS_HOTPIXEL_DISABLE_SENSOR_CORRECTION Disables the sensor's own hot pixel correction function. © 2016 Thorlabs Scientific Imaging...
Page 263 Sets the user-defined hot pixel list stored in the IS_HOTPIXEL_SET_CAMERA_USER_LIST camera EEPROM (Example IS_HOTPIXEL_DELETE_CAMERA_USER_LIST Deletes the user-defined hot pixel list from the camera EEPROM. IS_HOTPIXEL_GET_CAMERA_USER_LIST_MAX_NU Returns the maximum number of hot pixels that MBER the user can store in the camera EEPROM. © 2016 Thorlabs Scientific Imaging...
Page 264 = is_HotPixel(hCam, IS_HOTPIXEL_ENABLE_CAMERA_CORRECTION, NULL, NULL); nRet = is_HotPixel(hCam, IS_HOTPIXEL_ENABLE_SOFTWARE_USER_CORRECTION, NULL, NULL); nRet = is_HotPixel(hCam, IS_HOTPIXEL_ENABLE_SENSOR_CORRECTION, NULL, NULL); nRet = is_HotPixel(hCam, IS_HOTPIXEL_DISABLE_SENSOR_CORRECTION, NULL, NULL); Example 2 // Read out current mode INT nMode = 0; © 2016 Thorlabs Scientific Imaging...
Page 265 // The number of the hot pixel has to be specified in pList[0] pList[1] = 100; nRet = is_HotPixel(hCam, IS_HOTPIXEL_SET_SOFTWARE_USER_LIST, (void*)pList, (1 + 2 * nNumber) * sizeof(WORD)); // Delete unneeded list delete [] pList; © 2016 Thorlabs Scientific Imaging...
Page 266 // Additional memory space of one WORD per hot pixel is required for numbering. WORD *pList = WORD[1 + 2 * nNumber]; nRet = is_HotPixel(hCam, IS_HOTPIXEL_GET_MERGED_CAMERA_LIST, (void*)pList, (1 + 2 * nNumber) * sizeof(WORD)); // Delete unneeded list delete [] pList; © 2016 Thorlabs Scientific Imaging...
Page 267: Is_Imagefile
Note The following functions are obsolete by the function: is_ImageFile() is_LoadImage() is_LoadImageMem() is_SaveImage() is_SaveImageMem() is_SaveImageEx() is_SaveImageMemEx() See also: Obsolete functions Input parameters hCam Camera handle nCommand © 2016 Thorlabs Scientific Imaging...
Page 268 Saves an image file (bmp, jpg, png) (Example The function can be used with UNICODE file names. pParam Pointer to a function parameter, whose function depends on nCommand. cbSizeOfParam Size (in bytes) of the memory area to which refers. pParam © 2016 Thorlabs Scientific Imaging...
Page 269 General error message IS_NO_SUCCESS IS_NOT_SUPPORTED The camera model used here does not support this function or setting. IS_SUCCESS Function executed successfully Related functions is_GetImageMem() is_SetImageMem() © 2016 Thorlabs Scientific Imaging...
Page 270 // Save png from special memory with quality 50 (with file open dialog) ImageFileParams.pwchFileName = NULL; ImageFileParams.pnImageID = &nID; // valid ID ImageFileParams.ppcImageMem = &pcMemory; // valid buffer ImageFileParams.nFileType = IS_IMG_PNG; ImageFileParams.nQuality = 50; nRet = is_ImageFile(m_hCam, IS_IMAGE_FILE_CMD_SAVE, (void*)&ImageFileParams, sizeof(ImageFileParams)); © 2016 Thorlabs Scientific Imaging...
Page 271: Is_Imageformat
Pointer to variable of type pParam: UINT returning the number of list entries. nSizeOfParam: IMGFRMT_CMD_SET_FORMAT Sets the desired image format. More details Pointer to variable of type pParam: UINT passing the format ID of the desired image format. nSizeOfParam: © 2016 Thorlabs Scientific Imaging...
Page 272 Scaling factor used (only sensors that support scaling). UINT nReserved[24] Reserved Possible values for CAPTUREMODE CAPTMODE_SINGLE Freerun mode, single frame (freerun snap) CAPTMODE_FREERUN Freerun mode, continuous (freerun live) Software triggered mode, single frame CAPTMODE_TRIGGER_SOFT_SINGLE © 2016 Thorlabs Scientific Imaging...
Page 273 4 Programming (SDK) Software triggered mode, continuous CAPTMODE_TRIGGER_SOFT_CONTINUOUS Hardware triggered mode, single frame CAPTMODE_TRIGGER_HW_SINGLE CAPTMODE_TRIGGER_HW_CONTINUOUS Hardware triggered mode, continuous For further information on the image capture modes, see also in the Basics: Operating modes chapter. © 2016 Thorlabs Scientific Imaging...
Page 274 288x352 (CIF Portrait) 320x240 (QVGA) 240x320 (QVGA Portrait) 1600x1200 (UXGA) 3840x2748 (10M) 1920x1080 (Full HD 16:9, HQ) 2560x1920 (5M) 768x576 (CCIR) 1280x1024 (1.3M SXGA) 2448x2048 (5M) 1024x768 (XGA) 1024x1024 (1M) 800x600 (SVGA) 1360x1024 (1.4M 4:3) © 2016 Thorlabs Scientific Imaging...
Page 275 IS_CANT_ADD_TO_SEQUENCE The image memory is already included in the sequence and cannot be added again. IS_BAD_STRUCTURE_SIZE An internal structure has an incorrect size. IS_CANT_COMMUNICATE_WITH_DRIVER Communication with the driver failed because no driver has been loaded. © 2016 Thorlabs Scientific Imaging...
Page 276 IS_SUCCESS Function executed successfully IS_TIMED_OUT A timeout occurred. An image capturing process could not be terminated within the allowable period. IS_TRIGGER_ACTIVATED The function cannot be used because the camera is waiting for a trigger signal. © 2016 Thorlabs Scientific Imaging...
Page 277 // Allocate image mem for current format, set format nRet = is_AllocImageMem(hCam, width, height, 24, &pMem, &memID); nRet = is_SetImageMem(hCam, pMem, memID); nRet = is_ImageFormat(hCam, IMGFRMT_CMD_SET_FORMAT, &formatInfo.nFormatID, 4); // Capture image nRet = is_FreezeVideo(hCam, IS_WAIT); © 2016 Thorlabs Scientific Imaging...
Page 278: Is_Initcamera
(only GigE uEye SE/RE/CP cameras). To ensure backward compatibility of applications, always call without the is_InitCamera() parameter first. Only if an IS_ALLOW_STARTER_FW_UPLOAD error occurs, call the function with this parameter set (see © 2016 Thorlabs Scientific Imaging...
Page 279 (free run, trigger or standby). IS_INVALID_DEVICE_ID The device ID is invalid. Valid IDs start from 1 for USB cameras. This setting is not available for the currently set IS_INVALID_EXPOSURE_TIME exposure time. IS_INVALID_CAMERA_HANDLE Invalid camera handle © 2016 Thorlabs Scientific Imaging...
Page 280 The function cannot be used because the camera is waiting for a trigger signal. Related functions is_ExitCamera() is_EnableAutoExit() is_GetCameraList() is_SetCameraID() is_GetCameraInfo() Example //Open camera with ID 1 HIDS hCam = 1; INT nRet = is_InitCamera (&hCam, NULL); © 2016 Thorlabs Scientific Imaging...
Page 281 //Upload new starter firmware during initialization hCam = hCam | IS_ALLOW_STARTER_FW_UPLOAD; nRet = is_InitCamera (&hCam, NULL); end progress bar Sample programs uc480MultipleCameraScan (C++) uc480Console (C++) uc480C# Demo (C#) © 2016 Thorlabs Scientific Imaging...
Page 282: Is_Initevent
One of the submitted parameters is outside the valid range or is not supported for this sensor or is not available in this mode. General error message IS_NO_SUCCESS IS_SUCCESS Function executed successfully Related functions is_EnableEvent() is_DisableEvent() is_ExitEvent() © 2016 Thorlabs Scientific Imaging...
Page 283 IS_DONT_WAIT); DWORD dwRet = WaitForSingleObject(hEvent, 1000); (dwRet == WAIT_TIMEOUT) /* wait timed out */ else if (dwRet == WAIT_OBJECT_0) /* event signalled */ is_DisableEvent(hCam, IS_SET_EVENT_FRAME); is_ExitEvent(hCam, IS_SET_EVENT_FRAME); CloseHandle(hEvent); Sample programs SimpleLive (C++) uc480Event (C++) © 2016 Thorlabs Scientific Imaging...
Page 284: Is_Initimagequeue
Function executed successfully Related functions is_ExitImageQueue() is_WaitForNextImage() is_AddToSequence() Example // A previously initialized camera continuously captures images // until a timeout or transfer error occurs. // Note: image memories have to be allocated before this © 2016 Thorlabs Scientific Imaging...
Page 285 4 Programming (SDK) is_InitImageQueue (m_hCam, 0); INT nMemID = 0; char *pBuffer = NULL; while (IS_SUCCESS == is_WaitForNextImage(m_hCam, 1000, &pBuffer, &nMemID)) is_SaveImageMem (m_hCam, "image.bmp", pBuffer, nMemID); is_UnlockSeqBuf (m_hCam, nMemID, pBuffer); is_ExitImageQueue (m_hCam); © 2016 Thorlabs Scientific Imaging...
Page 286: Is_Inquireimagemem
An IO request from the uc480 driver failed. Possibly the versions of the (API) and uc480.dll the driver file ( ) do not match. uc480_usb.sys IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_AllocImageMem() © 2016 Thorlabs Scientific Imaging...
Page 287 4 Programming (SDK) is_SetImageMem() is_SetAllocatedImageMem() is_GetColorDepth() © 2016 Thorlabs Scientific Imaging...
Page 288: Is_Io
If you select functions for setting or returning a value, contains a pointer to a variable of the type. The size of the memory area to which pParam UINT © 2016 Thorlabs Scientific Imaging...
Page 289 Flash Returns the GPIOs which can be used for flash IS_IO_CMD_FLASH_GET_SUPPORTED_GPIOS output (Example IS_IO_CMD_FLASH_GET_MODE Returns the current flash mode, see below (Example IS_IO_CMD_FLASH_SET_MODE Sets the flash mode (Example Disables the digital IO_FLASH_MODE_OFF: output. Enables IO_FLASH_MODE_TRIGGER_LO_ACTIVE: © 2016 Thorlabs Scientific Imaging...
Page 290 Returns the GPIOs which can be used for pulse- width modulation (PWM) (Example IS_IO_CMD_PWM_GET_MODE Returns the current PWM mode (Example IS_IO_CMD_PWM_SET_MODE Sets the current PWM mode (Example Sets the flash output as IS_FLASH_MODE_PWM: output for PWM mode. © 2016 Thorlabs Scientific Imaging...
Page 291 Sets LED to green. IO_LED_STATE_2: Toggles between the LED states (Example IS_IO_CMD_LED_TOGGLE_STATE Pointer to a function parameter, whose function pParam depends on nCommand. Size (in bytes) of the memory area to which cbSizeOfParam refers. pParam © 2016 Thorlabs Scientific Imaging...
Page 292 An IO request from the uc480 driver failed. IS_IO_REQUEST_FAILED Possibly the versions of the (API) and uc480.dll the driver file ( ) do not match. uc480_usb.sys IS_NO_SUCCESS General error message The camera model used here does not support this IS_NOT_SUPPORTED © 2016 Thorlabs Scientific Imaging...
Page 293 4 Programming (SDK) function or setting. Function executed successfully IS_SUCCESS IS_TRIGGER_ACTIVATED The function cannot be used because the camera is waiting for a trigger signal. The function is not possible as trigger is disabled. IS_TRIGGER_NOT_ACTIVATED © 2016 Thorlabs Scientific Imaging...
Page 294 = IO_LED_STATE_1; nRet = is_IO(m_hCam, IS_IO_CMD_LED_SET_STATE, (void*)&nCurrentState, sizeof(nCurrentState)); // Toggle LED state to green nRet = is_IO(m_hCam, IS_IO_CMD_LED_TOGGLE_STATE, NULL, 0); Example 4 INT nRet = IS_SUCCESS; // Read the global flash params IO_FLASH_PARAMS flashParams; © 2016 Thorlabs Scientific Imaging...
Page 295 INT nRet = is_IO(m_hCam, IS_IO_CMD_FLASH_GET_GLOBAL_PARAMS, (void*)&flashParams, sizeof(flashParams)); (nRet == IS_SUCCESS) INT nDelay = flashParams.s32Delay; UINT nDuration = flashParams.u32Duration; // Read the global flash params and set the flash params to these values INT nRet = is_IO(m_hCam, IS_IO_CMD_FLASH_APPLY_GLOBAL_PARAMS, NULL, 0); © 2016 Thorlabs Scientific Imaging...
Page 296 // Get all GPIOs that can be used for the PWM UINT nGPIOs_PWM = 0; INT nRet = is_IO(m_hCam, IS_IO_CMD_PWM_GET_SUPPORTED_GPIOS, (void*)&nGPIOs_PWM, sizeof(nGPIOs_PWM)); Example 7 INT nRet = IS_SUCCESS; // Disable flash UINT nMode = IO_FLASH_MODE_OFF; nRet = is_IO(m_hCam, IS_IO_CMD_FLASH_SET_MODE, (void*)&nMode, sizeof(nMode)); © 2016 Thorlabs Scientific Imaging...
Page 297 // Set the flash to a high active pulse for each image in the trigger mode nMode = IO_FLASH_MODE_TRIGGER_HI_ACTIVE; nRet = is_IO(m_hCam, IS_IO_CMD_FLASH_SET_MODE, (void*)&nMode, sizeof(nMode)); // Get the current flash mode nRet = is_IO(m_hCam, IS_IO_CMD_FLASH_GET_MODE, (void*)&nMode, sizeof(nMode)); © 2016 Thorlabs Scientific Imaging...
Page 298 // Set GPIO1, GPIO2 and the flash pin as PWM output nMode = IO_GPIO_1 | IO_GPIO_2 | IS_FLASH_MODE_PWM; nRet = is_IO(m_hCam, IS_IO_CMD_PWM_SET_MODE, (void*)&nMode, sizeof(nMode)); // Get the current PWM mode nRet = is_IO(m_hCam, IS_IO_CMD_PWM_GET_MODE, (void*)&nMode, sizeof(nMode)); © 2016 Thorlabs Scientific Imaging...
Page 299 // The following code leads to the same setting // Set configuration of GPIO2 (COM-port RX) gpioConfiguration.u32Gpio = IO_GPIO_2; gpioConfiguration.u32Configuration = IS_GPIO_COMPORT_RX; // GPIO1 will be configured as IS_GPIO_COMPORT_TX automatically! nRet = is_IO(hCam, IS_IO_CMD_GPIOS_SET_CONFIGURATION, (void*)&gpioConfiguration, sizeof(gpioConfiguration)); © 2016 Thorlabs Scientific Imaging...
Page 300 // Get the minimum values for the GPIO flash delay and flash duration nRet = is_IO(m_hCam, IS_IO_CMD_FLASH_GET_GPIO_PARAMS_MIN, (void*)&flashParams, sizeof(flashParams)); // Set the minimum values for flash delay and flash duration. Be careful: The normal flash does not work wit nRet = is_IO(m_hCam, IS_IO_CMD_FLASH_SET_GPIO_PARAMS, (void*)&flashParams, sizeof(flashParams)); © 2016 Thorlabs Scientific Imaging...
Page 301: Is_Isvideofinish
One of the submitted parameters is outside the valid range or is not supported for this sensor or is not available in this mode. IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_FreezeVideo() © 2016 Thorlabs Scientific Imaging...
Page 303: Is_Lockseqbuf
One of the submitted parameters is outside the IS_INVALID_PARAMETER valid range or is not supported for this sensor or is not available in this mode. IS_NO_SUCCESS General error message Function executed successfully IS_SUCCESS Related functions is_UnlockSeqBuf() is_AddToSequence() is_SetImageMem() is_SetAllocatedImageMem() © 2016 Thorlabs Scientific Imaging...
Page 304: Is_Lut
0.0 and 1.0 has no effect on the image. For further information on LUTs, please refer to the LUT properties section. Note: The following functions are obsolete by the function: is_LUT() is_GetCameraLUT() is_SetCameraLUT() See also: Obsolete functions Input parameters hCam Camera handle nCommand © 2016 Thorlabs Scientific Imaging...
Page 305 (Example IS_LUT_CMD_GET_PRESET_LUT Returns the predefined LUT (Example linear LUT, no IS_LUT_PRESET_ID_IDENTITY: image modifications inverts the image IS_LUT_PRESET_ID_NEGATIVE: false-color display of IS_LUT_PRESET_ID_GLOW1: the image © 2016 Thorlabs Scientific Imaging false-color display of IS_LUT_PRESET_ID_GLOW2: the image...
Page 306 IS_NO_SUCCESS General error message The camera model used here does not support IS_NOT_SUPPORTED this function or setting. IS_SUCCESS Function executed successfully © 2016 Thorlabs Scientific Imaging...
Page 307: Is_Measure
INT nRet = is_LUT(hCam, IS_LUT_CMD_LOAD_FILE, (void*) pFilename , NULL); /* Save the current set LUT into the "lutFile2.xml" file */ wchar_t* pFilename2 = L"lutFile2.xml"; nRet = is_LUT(hCam, IS_LUT_CMD_SAVE_FILE, (void*) pFilename2 , NULL); 4.3.69 is_Measure USB 2.0 USB 2.0 USB 3.0 USB 3.0 © 2016 Thorlabs Scientific Imaging...
Page 308 Y position s32Y: AOI width s32Width: AOI height s32Height: Content of the MEASURE_SHARPNESS_AOI_PRESETS enumeration Predefined AOI for the harpness measurement IS_MEASURE_SHARPNESS_AOI_PRESET_1 (in each of the four image corner and in the center) Return values © 2016 Thorlabs Scientific Imaging...
Page 309 INT nRet = IS_SUCCESS; /* Create info object */ MEASURE_SHARPNESS_AOI_INFO measureSharpnessInfo; /* Get values of AOI_0 */ measureSharpnessInfo.u32NumberAOI = 0; nRet = is_Measure(m_hCam, IS_MEASURE_CMD_SHARPNESS_AOI_INQUIRE, (void*)&measureSharpnessInfo, sizeof(measureSharpnessInfo)); (nRet == IS_SUCCESS) UINT s32Sharpness = measureSharpnessInfo.u32SharpnessValue; Example 3 © 2016 Thorlabs Scientific Imaging...
Page 310 DCx Camera Functional Description and SDK Manual INT nRet = IS_SUCCESS; /* Set preset */ UINT nPreset = IS_MEASURE_SHARPNESS_AOI_PRESET_1; nRet = is_Measure(m_hCam, IS_MEASURE_CMD_SHARPNESS_AOI_SET_PRESET, (void*)&nPreset, sizeof(nPreset)); © 2016 Thorlabs Scientific Imaging...
Page 311: Is_Parameterset
When loading an ini file, make sure that the image size (AOI) and color depth parameters in the ini file match those in the allocated memory. Otherwise, display errors may occur. Note The following functions are obsolete by the function: is_ParameterSet() is_SaveParameters() is_LoadParameters() See also: Obsolete functions Input parameter hCam Camera handle nCommand © 2016 Thorlabs Scientific Imaging...
Page 312 INT nRet = is_ParameterSet(m_hCam, IS_PARAMETERSET_CMD_LOAD_EEPROM, NULL, NULL); Example 2 // Load parameters from file (open filebox) INT nRet = is_ParameterSet(m_hCam, IS_PARAMETERSET_CMD_LOAD_FILE, NULL, NULL); // Load parameters from specified file nRet = is_ParameterSet(m_hCam, IS_PARAMETERSET_CMD_LOAD_FILE, L"file.ini", NULL); © 2016 Thorlabs Scientific Imaging...
Page 313 // Save parameters to specified file nRet = is_ParameterSet(m_hCam, IS_PARAMETERSET_CMD_SAVE_FILE, L"file.ini", NULL); Example 5 // Get the number of supported parameter sets in the camera EEPROM UINT nNumber; INT nRet = is_ParameterSet(m_hCam, IS_PARAMETERSET_CMD_GET_NUMBER_SUPPORTED, (void*) &nNumber, sizeof(nNumber)); © 2016 Thorlabs Scientific Imaging...
Page 314: Is_Pixelclock
(Example pParam Pointer to a function parameter, whose function depends on nCommand. cbSizeOfParam Size (in bytes) of the memory area to which refers. pParam Return values IS_INVALID_MODE Camera is in standby mode, function not allowed © 2016 Thorlabs Scientific Imaging...
Page 315 INT nRet = is_PixelClock(hCam, IS_PIXELCLOCK_CMD_GET_RANGE, (void*)nRange, sizeof(nRange)); (nRet == IS_SUCCESS) UINT nMin = nRange[0]; UINT nMax = nRange[1]; UINT nInc = nRange[2]; Example 3 UINT nPixelClock; // Get current pixel clock nRet = is_PixelClock(hCam, IS_PIXELCLOCK_CMD_GET, (void*)&nPixelClock, sizeof(nPixelClock)); © 2016 Thorlabs Scientific Imaging...
Page 316 DCx Camera Functional Description and SDK Manual Example 4 UINT nPixelClockDefault; // Get default pixel clock INT nRet = is_PixelClock(hCam, IS_PIXELCLOCK_CMD_GET_DEFAULT, (void*)&nPixelClockDefault, sizeof(nPixelClockDefault)); (nRet == IS_SUCCESS) // Set this pixel clock nRet = is_PixelClock(hCam, IS_PIXELCLOCK_CMD_SET, (void*)&nPixelClockDefault, sizeof(nPixelClockDefault)); © 2016 Thorlabs Scientific Imaging...
Page 317: Is_Readeeprom
) do not match. uc480_usb.sys IS_NO_SUCCESS General error message The camera does not contain any calibration IS_NOT_CALIBRATED data. The camera model used here does not support IS_NOT_SUPPORTED this function or setting. Function executed successfully IS_SUCCESS Related functions is_WriteEEPROM() © 2016 Thorlabs Scientific Imaging...
Page 318 DCx Camera Functional Description and SDK Manual Example char buffer[64]; is_ReadEEPROM( hCam, 0x00, buffer, © 2016 Thorlabs Scientific Imaging...
Page 319: Is_Renderbitmap
Renders the green color component of the planar format in gray shades. IS_RENDER_PLANAR_MONO_BLUE Renders the blue color component of the planar format in gray shades. The following options can be linked by a logical OR using the nMode parameter: © 2016 Thorlabs Scientific Imaging...
Page 320 General error message Function executed successfully IS_SUCCESS Related functions is_AllocImageMem() is_SetColorMode() is_SetDisplayMode() is_DirectRenderer() Example Fit image to window and display it upside down: is_RenderBitmap (hCam, nMemID, hwnd, IS_RENDER_FIT_TO_WINDOW | IS_RENDER_MIRROR_UPDOWN); Sample programs SimpleAcquire (C++) SimpleLive (C++) © 2016 Thorlabs Scientific Imaging...
Page 321: Is_Resettodefault
An IO request from the uc480 driver failed. Possibly the versions of the (API) and uc480.dll the driver file ( ) do not match. uc480_usb.sys General error message IS_NO_SUCCESS IS_NOT_CALIBRATED The camera does not contain any calibration data. © 2016 Thorlabs Scientific Imaging...
Page 322 The memory could not be locked. The pointer to IS_SEQUENCE_BUF_ALREADY_LOCKED the buffer is invalid. IS_SUCCESS Function executed successfully A timeout occurred. An image capturing process IS_TIMED_OUT could not be terminated within the allowable period. Related functions is_ParameterSet() © 2016 Thorlabs Scientific Imaging...
Page 323: Is_Setallocatedimagemem
The image memory is already included in the sequence IS_CANT_ADD_TO_SEQUENCE and cannot be added again. IS_INVALID_CAMERA_HANDLE Invalid camera handle IS_INVALID_MEMORY_POINTER Invalid pointer or invalid memory ID One of the submitted parameters is outside the valid IS_INVALID_PARAMETER © 2016 Thorlabs Scientific Imaging...
Page 324 IS_NO_SUCCESS General error message No memory could be allocated. IS_OUT_OF_MEMORY The memory could not be locked. The pointer to the buffer IS_SEQUENCE_BUF_ALREADY_LOCKED is invalid. IS_SUCCESS Function executed successfully © 2016 Thorlabs Scientific Imaging...
Page 325 = is_FreeImageMem(hCam, pcMem, iMemID); GlobalUnlock(hMem); GlobalFree(hMem); Example Linux char* pcMem = (char*)malloc(uImageSize); iRet = mlock(pcMem, uImageSize); INT nRet = is_SetAllocatedImageMem(hCam, uWidth, uHeight, uBitspixel, pcMem, &iMemID); […] nRet = is_FreeImageMem(hCam, pcMem, iMemID); iRet = munlock(pcMem, uImageSize); free(pcMem); © 2016 Thorlabs Scientific Imaging...
Page 326: Is_Setautoparameter
= 1 enables control, 0 disables control pval1 IS_GET_ENABLE_AUTO_GAIN Returns the current auto gain setting or white level adjustment Control parameters returns the current setting pval1: IS_SET_ENABLE_AUTO_SENSOR_GAIN Enables/disables the internal auto gain control function of the sensor Control parameters © 2016 Thorlabs Scientific Imaging...
Page 327 (see pval1: is_GetAutoInfo() WB_MODE_DISABLE WB_MODE_AUTO WB_MODE_ALL_PULLIN WB_MODE_INCANDESCENT_LAMP WB_MODE_FLUORESCENT_DL WB_MODE_OUTDOOR_CLEAR_SKY WB_MODE_OUTDOOR_CLOUDY IS_GET_ENABLE_AUTO_SENSOR_WHITEBALANCE Returns the sensor's current auto white balance setting Control parameters returns the current setting pval1: Enables/disables the auto frame rate function. IS_SET_ENABLE_AUTO_FRAMERATE © 2016 Thorlabs Scientific Imaging...
Page 328 Returns the upper limit for auto gain control. Control parameters returns the current setting pval1: IS_SET_AUTO_SHUTTER_MAX Sets the upper limit for auto exposure shutter. Control parameters valid exposure value (0 sets the value pval1: continuously to max. exposure) © 2016 Thorlabs Scientific Imaging...
Page 329 Returns the hysteresis value for auto exposure IS_GET_AUTO_HYSTERESIS shutter and auto gain control. Control parameters returns the current setting pval1: IS_GET_AUTO_HYSTERESIS_RANGE Returns the permissible range for the hysteresis value. Control parameters returns the minimum permitted value pval1: © 2016 Thorlabs Scientific Imaging...
Page 330 Sets the offset values for the red and blue IS_SET_AUTO_WB_OFFSET channels. Control parameters defines the red level offset (-50...50) pval1: defines the blue level offset (-50...50) pval2: IS_GET_AUTO_WB_OFFSET Returns the offset values for the red and blue © 2016 Thorlabs Scientific Imaging...
Page 331 Returns the permissible range for the hysteresis value. Control parameters returns the minimum permitted value pval1: returns the maximum permitted value pval2: IS_SET_AUTO_WB_SKIPFRAMES Sets the number of frames to be skipped during automatic control. Control parameters © 2016 Thorlabs Scientific Imaging...
Page 332 Communication with the driver failed because IS_CANT_COMMUNICATE_WITH_DRIVER no driver has been loaded. IS_CANT_OPEN_DEVICE An attempt to initialize or select the camera failed (no camera connected or initialization error). IS_INCOMPATIBLE_SETTING Because of other incompatible settings the function is not possible. © 2016 Thorlabs Scientific Imaging...
Page 333 = is_SetAutoParameter (hCam, IS_SET_ENABLE_AUTO_GAIN, &dEnable, 0); //Set brightness setpoint to 128: double nominal = 128; ret = is_SetAutoParameter (hCam, IS_SET_AUTO_REFERENCE, &nominal, 0); //Return shutter control limit: double maxShutter; ret = is_SetAutoParameter (hCam, IS_GET_AUTO_SHUTTER_MAX, &maxShutter, 0); © 2016 Thorlabs Scientific Imaging...
Page 334: Is_Setbinning
IS_BINNING_4X_VERTICAL Enables vertical binning with factor 4. Enables vertical binning with factor 5. IS_BINNING_5X_VERTICAL Enables vertical binning with factor 6. IS_BINNING_6X_VERTICAL IS_BINNING_8X_VERTICAL Enables vertical binning with factor 8. IS_BINNING_16X_VERTICAL Enables vertical binning with factor 16. © 2016 Thorlabs Scientific Imaging...
Page 335 The texture could not be created. IS_DR_CANNOT_CREATE_TEXTURE The vertex buffer could not be created. IS_DR_CANNOT_CREATE_VERTEX_BUFFER IS_DR_DEVICE_OUT_OF_MEMORY Not enough graphics memory available. IS_DR_LIBRARY_NOT_FOUND The DirectRenderer library could not be found. The image memory has an inappropriate size to IS_INVALID_BUFFER_SIZE © 2016 Thorlabs Scientific Imaging...
Page 336 A timeout occurred. An image capturing process could not be terminated within the allowable period. IS_TRIGGER_ACTIVATED The function cannot be used because the camera is waiting for a trigger signal. Related functions is_SetSubSampling() is_AOI() is_SetImagePos() is_PixelClock() © 2016 Thorlabs Scientific Imaging...
Page 337: Is_Setcameraid
Possibly the versions of the (API) and uc480.dll the driver file ( ) do not match. uc480_usb.sys IS_NO_SUCCESS General error message IS_NOT_CALIBRATED The camera does not contain any calibration data. IS_NOT_SUPPORTED The camera model used here does not support © 2016 Thorlabs Scientific Imaging...
Page 338 DCx Camera Functional Description and SDK Manual this function or setting. Invalid array IS_NULL_POINTER IS_SUCCESS Function executed successfully IS_TIMED_OUT A timeout occurred. An image capturing process could not be terminated within the allowable period. Related functions is_InitCamera() is_GetCameraInfo() is_CameraStatus() © 2016 Thorlabs Scientific Imaging...
Page 339: Is_Setcolorconverter
Software conversion using the standard filter mask, but conversion is done on the graphic board IS_CONV_MODE_OPENCL_5X5 (Not applicable to DCx Cameras) Return values Parameter invalid or not supported IS_INVALID_COLOR_FORMAT ColorMode IS_CANT_COMMUNICATE_WITH_DRIVER Communication with the driver failed because © 2016 Thorlabs Scientific Imaging...
Page 340 No IR filter available IS_NO_IR_FILTER IS_NO_SUCCESS General error message IS_NOT_SUPPORTED The camera model used here does not support this function or setting. IS_OUT_OF_MEMORY No memory could be allocated. IS_SUCCESS Function executed successfully Related functions is_GetColorConverter() is_SetColorMode() is_Convert() © 2016 Thorlabs Scientific Imaging...
Page 341: Is_Setcolorcorrection
Return values When used together with Current setting IS_GET_CCOR_MODE When used together with When used for color cameras and together with this parameter IS_GET_SUPPORTED_CCOR_MODE IS_GET_SUPPORTED_CCOR_MODE, returns the supported values linked by a logical IS_CCOR_ENABLE_NORMAL IS_CCOR_ENABLE_BG40_ENHANCED © 2016 Thorlabs Scientific Imaging...
Page 342 ) do not match. uc480_usb.sys IS_NO_IR_FILTER No IR filter available IS_NO_SUCCESS General error message IS_NOT_SUPPORTED The camera model used here does not support this function or setting. IS_SUCCESS Function executed successfully Related functions is_SetColorConverter() is_SetColorMode() is_SetAutoParameter() © 2016 Thorlabs Scientific Imaging...
Page 343: Is_Setcolormode
Raw sensor data (8), for monochrome and color cameras, LUT/ gamma active IS_CM_RGB12_PACKED RGB36 (12 12 12), for monochrome and color cameras, LUT/ gamma active. RGB30 (10 10 10), for monochrome and color cameras, LUT/ IS_CM_RGB10_PACKED gamma active © 2016 Thorlabs Scientific Imaging...
Page 344 A capturing operation is in progress and must IS_CAPTURE_RUNNING be terminated before you can start another one. IS_INVALID_CAMERA_TYPE The camera type defined in the .ini file does not match the current camera model. IS_INVALID_COLOR_FORMAT Invalid color format © 2016 Thorlabs Scientific Imaging...
Page 345 The following parameters for color formats are obsolete. Only the new parameters should be used: Old parameter New parameter IS_SET_CM_RGB32 IS_CM_BGRA8_PACKED IS_SET_CM_RGB24 IS_CM_BGR8_PACKED IS_SET_CM_RGB16 IS_CM_BGR565_PACKED IS_SET_CM_RGB15 IS_CM_BGR555_PACKED IS_SET_CM_Y8 IS_CM_MONO8 IS_SET_CM_BAYER IS_CM_BAYER_RG8 IS_SET_CM_UYVY IS_CM_UYVY_PACKED IS_SET_CM_UYVY_MONO IS_CM_UYVY_MONO_PACKED IS_SET_CM_UYVY_BAYER IS_CM_UYVY_BAYER_PACKED IS_SET_CM_CBYCRY IS_CM_CBYCRY_PACKED IS_SET_CM_RGBY IS_CM_BGRY8_PACKED IS_SET_CM_RGB30 IS_CM_BGR10V2_PACKED © 2016 Thorlabs Scientific Imaging...
Page 346 DCx Camera Functional Description and SDK Manual Old parameter New parameter IS_SET_CM_Y12 IS_CM_MONO12 IS_SET_CM_BAYER12 IS_CM_BAYER_RG12 IS_SET_CM_Y16 IS_CM_MONO16 IS_SET_CM_BAYER16 IS_CM_BAYER_RG16 IS_CM_BGR10V2_PACKED IS_CM_BGR10_PACKED IS_CM_RGB10V2_PACKED IS_CM_RGB10_PACKED IS_CM_BGR555_PACKED IS_CM_BGR5_PACKED IS_CM_BAYER_RG8 IS_CM_SENSOR_RAW8 IS_CM_BAYER_RG12 IS_CM_SENSOR_RAW12 IS_CM_BAYER_RG16 IS_CM_SENSOR_RAW16 © 2016 Thorlabs Scientific Imaging...
Page 347: Is_Setdisplaymode
Raw Bayer format image display in Direct3D IS_SET_DM_BAYER mode IS_SET_DM_OPENGL Image display in OpenGL mode Monochrome image display in OpenGL mode IS_SET_DM_OPENGL | IS_SET_DM_MONO Raw Bayer format image display in OpenGL IS_SET_DM_OPENGL | IS_SET_DM_BAYER mode Returns the current setting. IS_GET_DISPLAY_MODE © 2016 Thorlabs Scientific Imaging...
Page 348 Possibly the versions of the (API) and uc480.dll the driver file ( ) do not match. uc480_usb.sys No IR filter available IS_NO_IR_FILTER General error message IS_NO_SUCCESS IS_NOT_CALIBRATED The camera does not contain any calibration data. © 2016 Thorlabs Scientific Imaging...
Page 349 The memory could not be locked. The pointer to IS_SEQUENCE_BUF_ALREADY_LOCKED the buffer is invalid. IS_SUCCESS Function executed successfully A timeout occurred. An image capturing process IS_TIMED_OUT could not be terminated within the allowable period. Related functions is_RenderBitmap() is_SetColorMode() is_DirectRenderer() © 2016 Thorlabs Scientific Imaging...
Page 350 DCx Camera Functional Description and SDK Manual Example is_SetDisplayMode (hCam, Mode); //Bitmap mode (images are digitized and stored in system memory): Mode = IS_SET_DM_DIB //Direct3D mode Mode = IS_SET_DM_DIRECT3D © 2016 Thorlabs Scientific Imaging...
Page 351: Is_Setdisplaypos
Offset in x direction, measured from the top left corner of the output window Offset in y direction, measured from the top left corner of the output window Return values Invalid camera handle IS_INVALID_CAMERA_HANDLE IS_NO_SUCCESS General error message Function executed successfully IS_SUCCESS Related functions is_AOI() is_RenderBitmap() is_SetDisplayMode() © 2016 Thorlabs Scientific Imaging...
Page 352: Is_Seterrorreport
Or 0 if no camera has been initialized yet Mode Disables error reporting. IS_DISABLE_ERR_REP IS_ENABLE_ERR_REP Enables error reporting. IS_GET_ERR_REP_MODE Current status of error reporting. Return values When used with Current setting IS_GET_ERR_REP_MODE IS_SUCCESS Function executed successfully Related functions is_GetError() is_CaptureStatus() is_CameraStatus() © 2016 Thorlabs Scientific Imaging...
Page 353: Is_Setexternaltrigger
Software trigger Call of is_FreezeVideo() (single frame mode) Call of is_CaptureVideo() (continuous mode) IS_GET_EXTERNALTRIGGER Returns the trigger mode setting IS_GET_TRIGGER_STATUS Returns the current signal level at the trigger input IS_GET_SUPPORTED_TRIGGER_MO Returns the supported trigger modes © 2016 Thorlabs Scientific Imaging...
Page 354 // Set the flash to a high active pulse for each image in the trigger mode UINT nMode = IO_FLASH_MODE_TRIGGER_HI_ACTIVE; is_IO(m_hCam, IS_IO_CMD_FLASH_SET_MODE, (void*)&nMode, sizeof(nMode)); is_FreezeVideo(hCam, IS_WAIT); Sample programs uc480 Simple Trigger (C++) uc480 IO (C++) © 2016 Thorlabs Scientific Imaging...
Page 355: Is_Setframerate
IS_GET_FRAMERATE Returns the set frame rate in the newFPS parameter. To query the frame rate actually reached by the camera, use is_GetFramesPerSecond() IS_GET_DEFAULT_FRAMERATE Returns the default frame rate. Returns the frame rate actually set. newFPS © 2016 Thorlabs Scientific Imaging...
Page 356 General error message IS_NO_SUCCESS IS_SUCCESS Function executed successfully Related functions is_GetFramesPerSecond() is_GetFrameTimeRange() is_PixelClock() is_SetOptimalCameraTiming() is_Exposure() is_SetAutoParameter() is_AOI() is_SetSubSampling() is_SetBinning() is_CaptureVideo() © 2016 Thorlabs Scientific Imaging...
Page 357: Is_Setgainboost
IS_SET_GAINBOOST_ON IS_GET_SUPPORTED_GAINBOOST supported, otherwise it returns IS_SET_GAINBOOST_OFF. IS_INVALID_CAMERA_HANDLE Invalid camera handle Camera is in standby mode, function not allowed IS_INVALID_MODE IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_SetHardwareGain() is_SetHWGainFactor() is_SetAutoParameter() © 2016 Thorlabs Scientific Imaging...
Page 358: Is_Setgamma
Possibly the versions of the (API) and uc480.dll the driver file ( ) do not match. uc480_usb.sys General error message IS_NO_SUCCESS IS_NOT_SUPPORTED The camera model used here does not support this function or setting. IS_SUCCESS Function executed successfully © 2016 Thorlabs Scientific Imaging...
Page 359 4 Programming (SDK) See also: Basics: Characteristics and LUT Basics: Color filter (Bayer filter) Programming: is_SetColorConverter() © 2016 Thorlabs Scientific Imaging...
Page 360: Is_Sethardwaregain
Returns the blue channel gain factor. IS_GET_DEFAULT_MASTER Returns the default master gain factor. Returns the default red channel gain factor. IS_GET_DEFAULT_RED Returns the default green channel gain factor. IS_GET_DEFAULT_GREEN IS_GET_DEFAULT_BLUE Returns the default blue channel gain factor. © 2016 Thorlabs Scientific Imaging...
Page 361 The camera model used here does not support this function or setting. IS_NULL_POINTER Invalid array Function executed successfully IS_SUCCESS IS_TIMED_OUT A timeout occurred. An image capturing process could not be terminated within the allowable period. Related functions is_SetHWGainFactor() © 2016 Thorlabs Scientific Imaging...
Page 362 DCx Camera Functional Description and SDK Manual is_GetSensorInfo() is_SetGainBoost() is_SetAutoParameter() © 2016 Thorlabs Scientific Imaging...
Page 363: Is_Sethwgainfactor
Gain value (100 = gain factor 1, i. e. no effect) For converting a gain value from the function, you can set the is_SetHardwareGain() nMode parameter to one of the values. In this case, the value range for IS_INQUIRE_x_FACTOR nFactor © 2016 Thorlabs Scientific Imaging...
Page 364 (hCam, IS_SET_MASTER_GAIN_FACTOR, 357); //ret has the value 363 for the UI-1460-C //Query the maximum gain factor for the red channel: ret = is_SetHWGainFactor (hCam, IS_INQUIRE_RED_GAIN_FACTOR, 100); //ret has the value 725 for the UI-1460-C © 2016 Thorlabs Scientific Imaging...
Page 365: Is_Setimagemem
Pointer to the starting position in the memory. ID of this memory. Return values Invalid camera handle IS_INVALID_CAMERA_HANDLE IS_NO_SUCCESS General error message IS_SUCCESS Function executed successfully Related functions is_AllocImageMem() is_FreeImageMem() is_AddToSequence() is_SetAllocatedImageMem() is_GetColorDepth() is_GetImageMem() is_GetImageMemPitch() © 2016 Thorlabs Scientific Imaging...
Page 366: Is_Setoptimalcameratiming
Returns the maximum pixel clock frequency (in MHz). pMaxFrameRate Returns the maximum frame rate (in fps). Return values IS_AUTO_EXPOSURE_RUNNING This setting cannot be changed while automatic exposure time control is enabled. © 2016 Thorlabs Scientific Imaging...
Page 367 The camera model used here does not support this IS_NOT_SUPPORTED function or setting. IS_TRIGGER_ACTIVATED The function cannot be used because the camera is waiting for a trigger signal. Related functions is_PixelClock() is_SetFrameRate() is_SetAutoParameter() is_CaptureVideo() © 2016 Thorlabs Scientific Imaging...
Page 368: Is_Setropeffect
IS_IO_REQUEST_FAILED An IO request from the uc480 driver failed. Possibly the versions of the (API) and uc480.dll the driver file ( ) do not match. uc480_usb.sys © 2016 Thorlabs Scientific Imaging...
Page 369 The camera model used here does not support IS_NOT_SUPPORTED this function or setting. IS_NULL_POINTER Invalid array IS_SUCCESS Function executed successfully A timeout occurred. An image capturing process IS_TIMED_OUT could not be terminated within the allowable period. Related functions is_SetBinning() is_SetSubSampling() is_AOI() © 2016 Thorlabs Scientific Imaging...
Page 370: Is_Setsaturation
One of the submitted parameters is outside the IS_INVALID_PARAMETER valid range or is not supported for this sensor or is not available in this mode. IS_NO_SUCCESS General error message Function executed successfully IS_SUCCESS Related functions is_SetColorMode() is_SetColorCorrection() is_SetColorConverter() © 2016 Thorlabs Scientific Imaging...
Page 371: Is_Setsensorscaler
) do not match. uc480_usb.sys IS_NO_SUCCESS General error message The camera does not contain any calibration data. IS_NOT_CALIBRATED The camera model used here does not support this IS_NOT_SUPPORTED function or setting. IS_NULL_POINTER Invalid array Function executed successfully IS_SUCCESS © 2016 Thorlabs Scientific Imaging...
Page 372 DCx Camera Functional Description and SDK Manual A timeout occurred. An image capturing process could not IS_TIMED_OUT be terminated within the allowable period. Related functions is_GetSensorScalerInfo() © 2016 Thorlabs Scientific Imaging...
Page 373 INT nRet; double dblNewFactor; // Query information on image scaling nRet = is_GetSensorScalerInfo (hCam, &Info, sizeof(Info)); // Enable scaling with anti aliasing dblNewFactor = Info.dblMinFactor + Info.dblFactorIncrement; nRet = is_SetSensorScaler (hCam, IS_ENABLE_SENSOR_SCALER | IS_ENABLE_ANTI_ALIASING, dblNewFactor); © 2016 Thorlabs Scientific Imaging...
Page 374: Is_Setsensortestimage
Possibly the versions of the (API) and uc480.dll the driver file ( ) do not match. uc480_usb.sys IS_NO_ACTIVE_IMG_MEM No active image memory available. You must set the memory to active using the function or create a is_SetImageMem() © 2016 Thorlabs Scientific Imaging...
Page 375 A timeout occurred. An image capturing process IS_TIMED_OUT could not be terminated within the allowable period. The function cannot be used because the IS_TRIGGER_ACTIVATED camera is waiting for a trigger signal. Related functions is_GetSupportedTestImages() is_GetTestImageValueRange() © 2016 Thorlabs Scientific Imaging...
Page 376: Is_Setsubsampling
Enables vertical sub-sampling with factor 8. IS_SUBSAMPLING_8X_VERTICAL IS_SUBSAMPLING_16X_VERTICAL Enables vertical sub-sampling with factor 16. IS_SUBSAMPLING_2X_HORIZONTAL Enables horizontal sub-sampling with factor 2. IS_SUBSAMPLING_3X_HORIZONTAL Enables horizontal sub-sampling with factor 3. Enables horizontal sub-sampling with factor 4. IS_SUBSAMPLING_4X_HORIZONTAL © 2016 Thorlabs Scientific Imaging...
Page 377 The image surface or overlay surface could not be created. The texture could not be created. IS_DR_CANNOT_CREATE_TEXTURE IS_DR_CANNOT_CREATE_VERTEX_BUFFER The vertex buffer could not be created. IS_DR_DEVICE_OUT_OF_MEMORY Not enough graphics memory available. IS_DR_LIBRARY_NOT_FOUND The DirectRenderer library could not be found. © 2016 Thorlabs Scientific Imaging...
Page 378 IS_SUCCESS A timeout occurred. An image capturing IS_TIMED_OUT process could not be terminated within the allowable period. IS_TRIGGER_ACTIVATED The function cannot be used because the camera is waiting for a trigger signal. Related functions is_SetBinning() © 2016 Thorlabs Scientific Imaging...
Page 380: Is_Settimeout
(API) and the driver file uc480.dll ) do not match. uc480_usb.sys IS_NO_SUCCESS General error message IS_NOT_SUPPORTED The camera model used here does not support this function or setting. IS_SUCCESS Function executed successfully Related functions is_GetTimeout() is_CaptureVideo() is_FreezeVideo() is_SetExternalTrigger() © 2016 Thorlabs Scientific Imaging...
Page 381 4 Programming (SDK) Example // Set user-defined timeout to 120 seconds is_SetTimeout(hCam, IS_TRIGGER_TIMEOUT, 12000); © 2016 Thorlabs Scientific Imaging...
Page 382: Is_Settriggercounter
An IO request from the uc480 driver failed. Possibly the versions of the (API) and uc480.dll the driver file ( ) do not match. uc480_usb.sys IS_NO_SUCCESS General error message Function executed successfully IS_SUCCESS Related functions is_SetExternalTrigger() is_CameraStatus() © 2016 Thorlabs Scientific Imaging...
Page 383: Is_Settriggerdelay
An IO request from the uc480 driver failed. Possibly the versions of the (API) and uc480.dll the driver file ( ) do not match. uc480_usb.sys IS_NO_SUCCESS General error message Function executed successfully IS_SUCCESS Related functions is_IO() is_SetExternalTrigger() © 2016 Thorlabs Scientific Imaging...
Page 384: Is_Stoplivevideo
General error message IS_NO_SUCCESS IS_SUCCESS Function executed successfully A timeout occurred. An image capturing process IS_TIMED_OUT could not be terminated within the allowable period. Related functions is_FreezeVideo() is_CaptureVideo() is_SetDisplayMode() © 2016 Thorlabs Scientific Imaging...
Page 385: Is_Trigger
Note on trigger delay in burst trigger mode If you set a trigger delay with the function, the delay will only is_SetTriggerDelay() apply to the first image after each trigger signal. Input parameters hCam Camera handle nCommand © 2016 Thorlabs Scientific Imaging...
Page 386 General error message IS_NO_SUCCESS The camera model used here does not support IS_NOT_SUPPORTED this function or setting. Function executed successfully IS_SUCCESS © 2016 Thorlabs Scientific Imaging...
Page 387: Is_Triggerdebounce
µs. The camera will not trigger the image capture on the rising edge until the digital signal has remained at the high level for longer than 50 µs without interruption. If this is not the case, the signal © 2016 Thorlabs Scientific Imaging...
Page 388 ( DELAY_TIME This function is currently only supported by the GigE uEye camera series. Input parameters Camera handle hCam nCommand © 2016 Thorlabs Scientific Imaging...
Page 389 Returns the maximum value for the delay (in µs). TRIGGER_DEBOUNCE_CMD_GET_DELAY_TIME_MAX More details Pointer to variable of type pParam: UINT returning the maximum value. nSizeOfParam: TRIGGER_DEBOUNCE_CMD_GET_DELAY_TIME_INC Returns the increment for setting the delay. © 2016 Thorlabs Scientific Imaging More details Pointer to variable of type pParam: UINT...
Page 390 IS_NO_SUCCESS General error message IS_NOT_SUPPORTED The camera model used here does not support this function or setting. IS_SUCCESS Function executed successfully Related functions is_SetExternalTrigger() is_SetTriggerDelay() Example INT value = TRIGGER_DEBOUNCE_MODE_AUTOMATIC; is_TriggerDebounce(hCam, TRIGGER_DEBOUNCE_CMD_SET_MODE, (void*)&value, sizeof(value)); © 2016 Thorlabs Scientific Imaging...
Page 391: Is_Unlockseqbuf
One of the submitted parameters is outside the valid range or is not supported for this sensor or is not available in this mode. General error message IS_NO_SUCCESS IS_SUCCESS Function executed successfully Related functions is_LockSeqBuf() is_WaitForNextImage() © 2016 Thorlabs Scientific Imaging...
Page 392: Is_Waitevent
//Start image capture and wait 1000 ms for event to occur is_FreezeVideo(hCam, IS_DONT_WAIT); INT nRet = is_WaitEvent(hCam, IS_SET_EVENT_FRAME, 1000); (nRet == IS_TIMED_OUT) /* wait timed out */ else if (nRet == IS_SUCCESS) /* event signalled */ is_DisableEvent(hCam, IS_SET_EVENT_FRAME); © 2016 Thorlabs Scientific Imaging...
Page 393: Is_Waitfornextimage
An IO request from the uc480 driver failed. IS_IO_REQUEST_FAILED Possibly the versions of the (API) and uc480.dll the driver file ( ) do not match. uc480_usb.sys © 2016 Thorlabs Scientific Imaging...
Page 394 Related functions is_InitImageQueue() is_ExitImageQueue() is_UnlockSeqBuf() See also: How to proceed: Image memory sequences How to proceed: Allocating image memory Transfer error: uc480 Viewer Image infos Transfer error: is_GetImageInfo() © 2016 Thorlabs Scientific Imaging...
Page 395: Is_Writeeeprom
The camera model used here does not support IS_NOT_SUPPORTED this function or setting. IS_NULL_POINTER Invalid array IS_SUCCESS Function executed successfully A timeout occurred. An image capturing process IS_TIMED_OUT could not be terminated within the allowable period. © 2016 Thorlabs Scientific Imaging...
Page 396 DCx Camera Functional Description and SDK Manual Related functions is_ReadEEPROM() © 2016 Thorlabs Scientific Imaging...
Page 397: Avi Function Descriptions
IS_AVI_ERR_COMPRESS The last image compression failed. The current image could not be processed since IS_AVI_ERR_COMPRESSION_RUN compression is still in progress. The file has no valid AVI format. IS_AVI_ERR_INVALID_FILE Related functions isavi_InitAVI() © 2016 Thorlabs Scientific Imaging...
Page 398: Isavi_Closeavi
Name of the event to be disabled. which IS_AVI_SET_EVENT_FRAME_SAVED A new frame was saved to the AVI file. Return values Function executed successfully. IS_AVI_NO_ERR IS_AVI_ERR_INVALID_ID The indicated AVI instance could not be found. © 2016 Thorlabs Scientific Imaging...
Page 399: Isavi_Enableevent
The indicated AVI instance could not be found. Either the AVI ID is invalid or the instance has already been deleted using isavi_ExitAVI() One of the submitted parameters is outside the IS_AVI_ERR_PARAMETER valid range. Related functions isavi_DisableEvent() © 2016 Thorlabs Scientific Imaging...
Page 400: Isavi_Exitavi
The indicated AVI instance could not be found. IS_AVI_ERR_INVALID_ID Either the AVI ID is invalid or the instance has already been deleted using isavi_ExitAVI() IS_AVI_ERR_INVALID_FILE The file has no valid AVI format. Related functions isavi_InitAVI() isavi_OpenAVI() isavi_CloseAVI() © 2016 Thorlabs Scientific Imaging...
Page 401: Isavi_Exitevent
The indicated AVI instance could not be found. IS_AVI_ERR_INVALID_ID Either the AVI ID is invalid or the instance has already been deleted using isavi_ExitAVI() IS_AVI_ERR_PARAMETER One of the submitted parameters is outside the valid range. Related functions isavi_InitEvent() isavi_EnableEvent() isavi_DisableEvent() © 2016 Thorlabs Scientific Imaging...
Page 402: Isavi_Getavifilename
NULL Return values Function executed successfully. IS_AVI_NO_ERR IS_AVI_ERR_INVALID_ID The indicated AVI instance could not be found. Either the AVI ID is invalid or the instance has already been deleted using isavi_ExitAVI() Related functions isavi_GetAVISize() isavi_OpenAVI() © 2016 Thorlabs Scientific Imaging...
Page 403: Isavi_Getavifilenamew
NULL Return values IS_AVI_NO_ERR Function executed successfully. IS_AVI_ERR_INVALID_ID The indicated AVI instance could not be found. Either the AVI ID is invalid or the instance has already been deleted using isavi_ExitAVI() Related functions isavi_GetAVISize() isavi_OpenAVIW() © 2016 Thorlabs Scientific Imaging...
Page 404: Isavi_Getavisize
The size in kBytes Return values Function executed successfully. IS_AVI_NO_ERR IS_AVI_ERR_INVALID_ID The indicated AVI instance could not be found. Either the AVI ID is invalid or the instance has already been deleted using isavi_ExitAVI() Related functions isavi_GetAVIFileName() © 2016 Thorlabs Scientific Imaging...
Page 405: Isavi_Getncompressedframes
Return values IS_AVI_NO_ERR Function executed successfully. The indicated AVI instance could not be found. IS_AVI_ERR_INVALID_ID Either the AVI ID is invalid or the instance has already been deleted using isavi_ExitAVI() Related functions isavi_GetnLostFrames() isavi_ResetFrameCounters() © 2016 Thorlabs Scientific Imaging...
Page 406: Isavi_Getnlostframes
The number of frames Return values Function executed successfully. IS_AVI_NO_ERR IS_AVI_ERR_INVALID_ID The indicated AVI instance could not be found. Either the AVI ID is invalid or the instance has already been deleted using isavi_ExitAVI() Related functions isavi_GetnCompressedFrames() isavi_ResetFrameCounters() © 2016 Thorlabs Scientific Imaging...
Page 407: Isavi_Initavi
IS_AVI_ERR_PARAMETER valid range. The maximum number of instances allowed in IS_AVI_ERR_NO_CODEC_AVAIL this system has been reached. It is not possible to create another instance. IS_AVI_ERR_INVALID_UEYE No DCx camera was found. Related functions isavi_ExitAVI() isavi_OpenAVI() isavi_CloseAVI() © 2016 Thorlabs Scientific Imaging...
Page 408: Isavi_Initevent
"" ( 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 ); © 2016 Thorlabs Scientific Imaging...
Page 409: Isavi_Openavi
AVI file is still open. IS_AVI_ERR_INVALID_FILE The file has no valid AVI format. IS_AVI_ERR_NEW_FAILED No memory could be allocated for the AVI file. IS_AVI_ERR_CREATESTREAM No AVI stream could be created. Related functions isavi_GetAVIFileName() isavi_CloseAVI() isavi_InitAVI() isavi_ExitAVI() © 2016 Thorlabs Scientific Imaging...
Page 410: Isavi_Openaviw
AVI file is still open. The file has no valid AVI format. IS_AVI_ERR_INVALID_FILE IS_AVI_ERR_NEW_FAILED No memory could be allocated for the AVI file. No AVI stream could be created. IS_AVI_ERR_CREATESTREAM Related functions isavi_GetAVIFileNameW() isavi_CloseAVI() isavi_InitAVI() isavi_ExitAVI() © 2016 Thorlabs Scientific Imaging...
Page 411: Isavi_Resetframecounters
Return values IS_AVI_NO_ERR Function executed successfully. The indicated AVI instance could not be found. IS_AVI_ERR_INVALID_ID Either the AVI ID is invalid or the instance has already been deleted using isavi_ExitAVI() Related functions isavi_GetnCompressedFrames() isavi_GetnLostFrames() © 2016 Thorlabs Scientific Imaging...
Page 412: Isavi_Setframerate
Either the AVI ID is invalid or the instance has already been deleted using isavi_ExitAVI() IS_AVI_ERR_WRITE_INFO The AVI file could not be modified. The file has no valid AVI format. IS_AVI_ERR_INVALID_FILE Related functions isavi_SetImageQuality() isavi_SetImageSize() © 2016 Thorlabs Scientific Imaging...
Page 413: Isavi_Setimagequality
Either 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 IS_AVI_ERR_INVALID_FILE The file has no valid AVI format. Related functions isavi_SetFrameRate() isavi_SetImageSize() © 2016 Thorlabs Scientific Imaging...
Page 414: Isavi_Setimagesize
The file has no valid AVI format. Another capturing operation is in progress or an IS_AVI_ERR_CAPTURE_RUNNING AVI file is still open. IS_AVI_ERR_ALLOC_MEMORY No memory could be allocated. IS_AVI_ERR_INVALID_CM The submitted color mode is not supported for AVI capturing. © 2016 Thorlabs Scientific Imaging...
Page 415 4 Programming (SDK) 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() © 2016 Thorlabs Scientific Imaging...
Page 416: Isavi_Startavi
The indicated AVI instance could not be found. Either the AVI ID is invalid or the instance has already been deleted using isavi_ExitAVI() The file has no valid AVI format. IS_AVI_ERR_INVALID_FILE IS_AVI_ERR_PLAY_RUNNING A playback is already running. Related functions isavi_StopAVI() isavi_InitEvent() isavi_ExitAVI() © 2016 Thorlabs Scientific Imaging...
Page 417: Isavi_Stopavi
The indicated AVI instance could not be found. Either the AVI ID is invalid or the instance has already been deleted using isavi_ExitAVI() The file has no valid AVI format. IS_AVI_ERR_INVALID_FILE IS_AVI_ERR_PLAY_NOT_RUNNING No playback is running. Related functions isavi_StartAVI() isavi_InitEvent() isavi_ExitAVI() © 2016 Thorlabs Scientific Imaging...
Page 418: Raw Function Descriptions
IS_AVI_ERR_NOT_SUPPORTED The file was opened in "read-only" mode (see israw_InitFile() Related functions israw_GetFrame() 4.5.2 israw_CloseFile USB 2.0 USB 3.0 GigE Syntax INT israw_CloseFile(UINT unFileID) Description closes a RAW file which was opened using israw_CloseFile() israw_OpenFile() © 2016 Thorlabs Scientific Imaging...
Page 419: Israw_Exitfile
Return values No error, function executed successfully. IS_AVI_NO_ERR IS_AVI_ERR_EXCEPTION An error has occurred. IS_AVI_ERR_GENERIC Generic error Related functions israw_InitFile() 4.5.4 israw_GetFrame USB 2.0 USB 3.0 GigE Syntax INT israw_GetFrame(UINT unFileID, char* pData, UINT64* punTimestampDevice) © 2016 Thorlabs Scientific Imaging...
Page 420: Israw_Getimageinfo
Input parameters unFileID Instance ID set by the function israw_InitFile() punWidth Image width punHeight Image height punBitsPerPixel Bit depth (bits per pixel) Return values IS_AVI_NO_ERR No error, function executed successfully. IS_AVI_ERR_EXCEPTION An error has occurred. © 2016 Thorlabs Scientific Imaging...
Page 421: Israw_Getsize
The indicated instance could not be found. Either the ID is invalid or the instance has already been deleted using israw_ExitFile() Related functions israw_OpenFile() 4.5.7 israw_InitFile USB 2.0 USB 3.0 GigE Syntax INT israw_InitFile(UINT* punFileID, INT nAccessMode) © 2016 Thorlabs Scientific Imaging...
Page 422: Israw_Openfile
No error, function executed successfully. IS_AVI_ERR_EXCEPTION An error has occurred. IS_AVI_ERR_FILE_NOT_OPEN The file is not open. IS_AVI_ERR_GENERIC Generic error IS_AVI_ERR_INVALID_ID The indicated instance could not be found. Either the ID is invalid or the instance has © 2016 Thorlabs Scientific Imaging...
Page 423: Israw_Seekframe
The file was opened in "read-only" mode (see israw_InitFile() IS_AVI_ERR_SEEK_FAILED The image could not be found. Related functions israw_GetFrame() 4.5.10 israw_SetImageInfo USB 2.0 USB 3.0 GigE Syntax INT israw_SetImageInfo(UINT unFileID, UINT unWidth, UINT unHeight, UINT unBitsPerPixel) © 2016 Thorlabs Scientific Imaging...
Page 424: Obsolete Functions
History of API functions. Obsolete function Recommended alternative No longer New function documented valid from since version version 4.50 4.00 is_ConvertImage() is_Convert() is_DisableDDOverlay() 4.50 3.40 is_DirectRenderer() is_EnableDDOverlay() 4.50 is_GetCameraLUT is_LUT() 4.50 4.40 4.50 2.00 is_GetCameraType() is_GetCameraInfo() © 2016 Thorlabs Scientific Imaging...
Page 425 (see below). is_SaveBadPixelCorrectionTabl 4.50 3.80 is_HotPixel() is_SaveImage() 4.50 is_SaveImageEx() 4.50 is_ImageFile() 4.00 is_SaveImageMem() 4.50 is_SaveImageMemEx() 4.50 is_SaveParameters() is_ParameterSet() 4.50 4.00 is_SetAOI() is_AOI() 4.50 3.80 is_SetAutoCfgIpSetup() is_IpConfig() 4.50 3.82 4.50 is_SetBadPixelCorrection() 3.80 is_HotPixel() 4.50 is_SetBadPixelCorrectionTable © 2016 Thorlabs Scientific Imaging...
Page 426 3.30 supported any longer (see is_TransferMemorySequence() below). is_UnlockDDMem() 4.50 3.40 4.50 is_UnlockDDOverlayMem() is_DirectRenderer() 4.50 is_UpdateDisplay() functions have is_SetWhiteBalance() is_SetWhiteBalanceMultipliers() been completely replaced by the function and are no longer is_SetAutoParameter() supported by the uc480 API. © 2016 Thorlabs Scientific Imaging...
Page 427: Programming Notes
Most of the uc480 sample programs were created in Microsoft Visual Studio using the C++ programming language. Hint We suggest that you keep the function libraries (DLL, AX and OCX files) in the default directory. After the installation, these files reside e.g. under Window (32 bit) in C:\Windows\System32\. © 2016 Thorlabs Scientific Imaging...
Page 428: Programming In C
We suggest that you keep the function libraries (DLL, AX and OCX files) in the default directory. After the installation, these files reside e.g. under Window (32 bit) in C:\Windows\System32\. Copying these files to other locations may result in version conflicts. © 2016 Thorlabs Scientific Imaging...
Page 429: Programming In Vb.net
In general, the uc480 API is thread-safe. This means that the uc480 API can be accessed by multiple threads simultaneously. Simultaneous attempts to call the same function are recognized and prevented by the driver. Note Multi-threading © 2016 Thorlabs Scientific Imaging...
Page 430 In this case you will need to implement the message loop yourself. This applies to the following uc480 events: IS_SET_EVENT_REMOVED IS_SET_EVENT_REMOVAL IS_SET_EVENT_DEVICE_RECONNECTED IS_SET_EVENT_NEW_DEVICE If no message loop exists, a USB camera will not be automatically detected after reconnecting. © 2016 Thorlabs Scientific Imaging...
Page 431: Lists
IS_NO_ACTIVE_IMG_MEM No active image memory available. You must set the memory to active using the function or create a is_SetImageMem() sequence using the is_AddToSequence() function. The sequence list is empty and cannot be IS_SEQUENCE_LIST_EMPTY deleted. © 2016 Thorlabs Scientific Imaging...
Page 432 The camera model used here does not support this function or setting. IS_TRIGGER_NOT_ACTIVATED The function is not possible as trigger is disabled. The dialog was canceled without a selection IS_OPERATION_ABORTED so that no file could be saved. © 2016 Thorlabs Scientific Imaging...
Page 433 IS_NO_IR_FILTER No IR filter available IS_STARTER_FW_UPLOAD_NEEDED The camera's starter firmware is not compatible with the driver and needs to be updated. The DirectRenderer library could not be IS_DR_LIBRARY_NOT_FOUND found. IS_DR_DEVICE_OUT_OF_MEMORY Not enough graphics memory available. © 2016 Thorlabs Scientific Imaging...
Page 434 PC network card. IS_NETWORK_CONFIGURATION_INVALID The configuration of the network card is invalid. The configuration of the CPU idle has failed. IS_ERROR_CPU_IDLE_STATES_CONFIGURATION IS_DEVICE_BUSY The camera is busy ad cannot transfer the requested image. © 2016 Thorlabs Scientific Imaging...
Page 435: Error Codes Of Avi Functions
The event could not be initialized. The Windows function failed. SetEvent 4.8.3 Linux: Not Supported Functions The following uc480 API functions are not supported by the Linux driver version 4.80 and older: is_DirectRenderer() is_GetColorDepth() is_GetDC() is_ReleaseDC() © 2016 Thorlabs Scientific Imaging...
Page 436 DCx Camera Functional Description and SDK Manual is_RenderBitmap() is_SetDisplayMode() is_SetDisplayPos() is_SetHwnd() is_SetOptimalCameraTiming() is_UpdateDisplay() © 2016 Thorlabs Scientific Imaging...
Page 437: Specifications
5 Specifications 5 Specifications This chapter lists the specifications of the available DCx camera models. Model comparison Camera and sensor data Mechanical specifications Electrical specifications Accessories © 2016 Thorlabs Scientific Imaging...
Page 438: Model Comparison
1/1/0 1/1/2 1/1/2 RS-232 + (GPIO) + (GPIO) C bus Hot pixel correction Software Software Software Hardware Hardware Color calculation Software Software Software Hardware Hardware Hardware: Dig. Subsampling/ Binning Bit depth: Internal/ 16/16 12/12 transferred © 2016 Thorlabs Scientific Imaging...
Page 439 5 Specifications DCC1545M DCU223x DC1240x DC3240x DC3260x DCC1645C DCU224x LUT: Internal/ 12/12 12/12 transferred Max. pixel clock (MHz) at full resolution Max. data rate (MBytes/s) *) with supplied adapter © 2016 Thorlabs Scientific Imaging...
Page 440: Model Naming Conventions
Cameras with CCD sensors DCU223x DCU224x Note: The diagrams shown in the sensor specifications section indicate the sensitivities of the relative DCx Cameras in the spectral range. Therefore, the characteristic curves cannot be compared to each other. © 2016 Thorlabs Scientific Imaging...
Page 441: Dcc3260X
AOI image width / step width pixels 96 – 1936 / 8 AOI image height / step pixels 2 – 1216 / 2 width AOI position grid / horizontal, pixels 8 / 2 vertical Binning Mode © 2016 Thorlabs Scientific Imaging...
Page 442: Dcc1240X / Dcc3240X
Shutter system Electronic global and rolling shutter Characteristic Linear Readout mode Progressive scan Resolution class SXGA Resolution 1280 x 1024 pixels (1.3 Megapixel) Aspect ratio Bit depth 10 bits * Optical sensor class 1/1.8 inch © 2016 Thorlabs Scientific Imaging...
Page 443 AOI frame rate, 640 x 480 52.0 123.0 pixels (VGA) AOI frame rate, 320 x 240 98.0 229.0 pixels (CIF) Binning Mode Horizontal + Vertical Method H + V combined, mono/color binning, H: additive. V: averaging © 2016 Thorlabs Scientific Imaging...
Page 444 The power consumption depends on the sensor model and the pixel clock setting. Not yet confirmed DCC3240N only Only for USB3.0 transmission (DCC3240x), with USB2.0 - bit depth is 8 bit. Please see also the DCC1240x / DCC3240x Application Notes chapter. © 2016 Thorlabs Scientific Imaging...
Page 445 Sensor sensitivity of the DCC1240M (monochrome) / DCC3240x (monochrome and NIR) Sensor sensitivity of the DCC1240C / DCC3240C Note The colored part of above diagrams just indicates the IR wavelength range in order to tell it from the visible. © 2016 Thorlabs Scientific Imaging...
Page 446: Dcc1545M
Pixels 4, 2 vertical AOI frame rate, 640 x 480 pixels (VGA) Binning Mode none Subsampling Mode Horizontal + Vertical Method H + V: Color subsampling Factor 2x, 4x, 8x Frame rate w/ 2x subsampling, © 2016 Thorlabs Scientific Imaging...
Page 447 Please see also the DCC1545M Application Notes chapter. Relative sensor sensitivity Sensor sensitivity of the DCC1545M (monochrome) Note The colored part of above diagram just indicates the IR wavelength range in order to tell it from the visible. © 2016 Thorlabs Scientific Imaging...
Page 448: Dcc1645C
4 to 1024, 2 AOI position grid horizontal, vertical Pixels 4, 2 AOI frame rate, 1280 x 720 pixels (HD 720) AOI frame rate, 800 x 600 pixels (SVGA) Binning Mode none Subsampling Mode Horizontal + Vertical © 2016 Thorlabs Scientific Imaging...
Page 449 Please see also the DCC1645C Application Notes chapter. Relative sensor sensitivity Sensor sensitivity of the DCC1645C Note The colored part of above diagram just indicates the IR wavelength range in order to tell it from the visible. © 2016 Thorlabs Scientific Imaging...
Page 450: Dcu223X
16 to 1024, 4 Mono: AOI image height, step Pixels 120 to 768, 1 width Color: AOI image height, step Pixels 120 to 768, 2 width Mono: AOI position grid Pixels 1, 1 horizontal, vertical © 2016 Thorlabs Scientific Imaging...
Page 451 Requires minimum pixel clock frequency. Use of this function increases the frame rate. The power consumption depends on the sensor model and the pixel clock setting. Please see also the DCU223x Application Notes chapter. Relative sensor sensitivity © 2016 Thorlabs Scientific Imaging...
Page 452 DCx Camera Functional Description and SDK Manual Sensor sensitivity of the DCU223M (monochrome) Sensor sensitivity of the DCU223C (Color) Note The colored part of above diagrams just indicates the IR wavelength range in order to tell it from the visible. © 2016 Thorlabs Scientific Imaging...
Page 453: Dcu224X
Mono: AOI image height, step Pixels 120 to 1024, 1 width Color: AOI image height, step Pixels 120 to 1024, 2 width Mono: AOI position grid horizontal, Pixels 1, 1 vertical Color: AOI position grid horizontal, Pixels 2, 2 © 2016 Thorlabs Scientific Imaging...
Page 454 Requires minimum pixel clock frequency. Use of this function increases the frame rate. The power consumption depends on the sensor model and the pixel clock setting. Please see also the DCU224x Application Notes chapter. Relative sensor sensitivity © 2016 Thorlabs Scientific Imaging...
Page 455 5 Specifications Sensor sensitivity of the DCU224M (monochrome) Sensor sensitivity of the DCU224C (color) Note The colored part of above diagrams just indicates the IR wavelength range in order to tell it from the visible. © 2016 Thorlabs Scientific Imaging...
Page 456: Mechanical Specifications
DCx Camera Functional Description and SDK Manual 5.4 Mechanical Specifications DCU223x, DCU224x DCC1545M, DCC1645C DCC1240x, DCC3240x General Flange back distance Position accuracy of the sensor Filter glasses Ambient conditions © 2016 Thorlabs Scientific Imaging...
Page 460: Dcc1545M, Dcc1645C
DCx Camera Functional Description and SDK Manual 5.4.4 DCC1545M, DCC1645C © 2016 Thorlabs Scientific Imaging...
Page 461: Flange Back Distance
Distance from active sensor area to PCB Thickness of the glass cover of the sensor Filter thickness (optional) Refractive index Maximum sensor height above the PCB This distance describes the equivalent in air (see introduction above) © 2016 Thorlabs Scientific Imaging...
Page 462 PCB to PCB model glass area with filter sensor filter [mm] [mm] glass [mm] [mm] area glass[mm] Designation DCC1545M 0.525 1.270 13.23 15.95 17.50 2.480 DCC1645C 0.550 1.400 13.10 16.08 17.63 2.500 © 2016 Thorlabs Scientific Imaging...
Page 463: Maximum Immersion Depth For Lenses
(mm) at lens Thread (mm) Camera Type depth (Ø A, B, C CMOS CMOS in mm) 24.0 DCU223X DCU224X 20.0 C-mount 5 mm DCC1240 14.1 11.1 10.6 DCU223X C-mount 5 mm 24.0 (V2) © 2016 Thorlabs Scientific Imaging...
Page 464: Position Accuracy Of The Sensor
Flange back distance ±0.05 Note C-mount lenses can also be subject to inaccuracies of the flange back distance. The tolerance usually is ±0.05 mm. In some cases, however, the inaccuracies of camera and lens might add up, © 2016 Thorlabs Scientific Imaging...
Page 465: Filter Glasses
1 mm 650 nm (old) IRcut filter On one 1.53 D263 1 mm 650 nm (new) side Daylight cut 1.53 RG665 1 mm 695 nm filter Glass On both 1.53 D263 1 mm 380 nm sides © 2016 Thorlabs Scientific Imaging...
Page 466 The corresponding color correction is selected automatically. Infrared cut filter (type BG) BG filter Note The colored part of above diagram just indicates the IR wavelength range in order to tell it from the visible. © 2016 Thorlabs Scientific Imaging...
Page 467 Infrared cut filter (type HQ) HQ filter Daylight cut filter (type DL) DL cut filter Note The colored part of above diagrams just indicates the IR wavelength range in order to tell it from the visible. © 2016 Thorlabs Scientific Imaging...
Page 468 The colored part of above diagram just indicates the IR wavelength range in order to tell it from the visible. A different scale is used for the Y-axis of the glass filter curve, to show the curves between 400 nm and 1100 nm better. © 2016 Thorlabs Scientific Imaging...
Page 469: Mounting The Filter
0.2 Nm. Threaded ring Notes A special tool is required for adjusting the threaded ring! Some DCx camera models have a different design with a separate filter glass that is secured by two screws. © 2016 Thorlabs Scientific Imaging...
Page 470: Cleaning The Filter Glasses
Instructions for cleaning DCx camera filter glasses The filter glasses can be cleaned only from outside. If remove the filter glasses, the sensor might become soiled. Thorlabs is not liable for any damage to the sensor resulting from removal of the filter glasses.
Page 472: Ambient Conditions
60068-2-6(1996-05), DIN EN 60068-2-27(1995-03) and DIN EN 60068-2-29(1995-03). The mechanical shock was at 80 g; the vibration testing was performed with sinusoidal vibration at a frequency between 30 Hz-500 Hz and an amplitude of 10 g. © 2016 Thorlabs Scientific Imaging...
Page 473: Camera Interface
Micro D-Sub socket male, camera rear view Digital input (-) USB data (+) USB data (-) Pin assignment of the CAB-DCU-Tx cable for USB 2.0, trigger and flash Description Cable color Digital output (-) green DCU22xX / DCC1240X © 2016 Thorlabs Scientific Imaging...
Page 474 Digital output (+) yellow Digital input (-) brown For a comprehensive list of all cables and connectors available for DCU22xX / DCC1240X cameras, please refer to the DCU22xX / DCC1240X Accessories section. © 2016 Thorlabs Scientific Imaging...
Page 475: Digital Input (Trigger) Circuit
For interpreting the trigger signal, either the negative or the falling galvanically isolated using an opto coupler to protect the camera and the PC against surges. Only DC voltages may be applied to the digital input. Digital input wiring Wiring of the trigger connector © 2016 Thorlabs Scientific Imaging...
Page 476: Digital Output (Flash) Circuit
(software setting: Flash high active, see also the Camera Properties: Input/Output section). Digital output wiring The following figures show examples of how the digital output is wired. Wiring of the digital output as an open collector output (rev. 1.2) © 2016 Thorlabs Scientific Imaging...
Page 477 5 Specifications Wiring of the digital output as an open collector output (rev. 2.0) Wiring of the digital output as an open emitter output (rev. 2.0) © 2016 Thorlabs Scientific Imaging...
Page 478: Dcc3240X
Trigger input, opto-decoupled (+) white camera rear view Output supply voltage, 5 V (100 mA) pink For a comprehensive list of all cables and connectors available for DCC3240X cameras, please refer to the DCC3240X Accessories section. © 2016 Thorlabs Scientific Imaging...
Page 479: Gpio Interface
GPIO wiring as input The following figures illustrate GPIO wiring examples. GPIO input Min. Max. Signal level "Low" Signal level "High" GPIO wiring as output GPIO output Min. Max. Signal level "Low" © 2016 Thorlabs Scientific Imaging...
Page 480 DCx Camera Functional Description and SDK Manual Signal level "High" Output current © 2016 Thorlabs Scientific Imaging...
Page 481: Digital Input (Trigger) Circuit
For interpreting the trigger signal, either the negative or the falling edge can be used. The digital input is galvanically isolated using an optocoupler to protect the camera and the PC against surges. Only DC voltages may be applied to the digital input. Digital input wiring Wiring of the trigger connector © 2016 Thorlabs Scientific Imaging...
Page 482: Digital Output (Flash) Circuit
Digital output wiring The following figures show examples of how the digital output is wired. Wiring of the digital output as an open collector output Wiring of the digital output as an open emitter output © 2016 Thorlabs Scientific Imaging...
Page 483: Rs-232 Serial Interface
The following figure shows the wiring of the serial interface with GPIO 1 as camera-side output (TxD) and GPIO 2 as camera-side input (RxD). The GPIO must be configured accordingly (see is_IO() Serial interface connector (UART) © 2016 Thorlabs Scientific Imaging...
Page 484: Camera Eeprom Specification
DCx Cameras have an EEPROM memory where the camera manufacturer, type, and serial number are stored. A 64 byte memory space can be used freely by the user. EEPROM Specifications Data retention 10 years Read/write cycles 100,000 Size of user data space 64 bytes © 2016 Thorlabs Scientific Imaging...
Page 485: Accessories For Dcx Cameras
USB cables All Thorlabs DCx cameras are shipped with a 1.5m USB2.0, A to Mini B, cable. 5.6.1 Accessories for DCU22xX / DCC1240X For information on the pin assignment of the cables and connectors see chapter Pin Assignment I/O Connector.
Page 486: Accessories For Dcc1X45X
Trigger input, opto-decoupled (-) brown Flash output, opto-decoupled (+) yellow GPIO 2, 3.3 V LVCMOS Hirose connector female, Trigger input, opto-decoupled (+) white cable tip view Output supply voltage, 5 V (100 mA) pink © 2016 Thorlabs Scientific Imaging...
Page 487: Appendix
D-sub connector have been bent. A fault has occurred in the camera hardware. Please contact the Thorlabs. flashes: USB DCx camera operation The camera can be opened in the software, but captures images sporadically or not at all.
Page 488: Pcs With Energy Saving Cpu Technology
USB data transfer. You can check the USB performance with the “Optimum” pixel clock settings checkbox in uc480 Demo software. A good USB system should be able to reach a pixel clock © 2016 Thorlabs Scientific Imaging...
Page 489: Status Led On Usb Dcx Cameras
Have the driver and the camera been installed properly in the uc480 Camera Manager on the host PC? Does the host PC meet all system requirements? Revision 1.2 (green Status LED) Revision 2.0 (red/green LED) © 2016 Thorlabs Scientific Imaging...
Page 490 DCx Camera Functional Description and SDK Manual DCC3240x The LED on the DCC3240x flashes 2x green if the camera is connected to a USB 2.0 port. If the camera is connected to a USB 3.0 port the LED flashes 3x green. © 2016 Thorlabs Scientific Imaging...
Page 491: Color And Memory Formats
IS_CM_BAYER_RG12 (identical to IS_CM_SENSOR_RAW12) IS_CM_BAYER_RG16 (identical to IS_CM_SENSOR_RAW16) IS_CM_BGR555_PACKED (has been renamed to IS_CM_BGR5_PACKED) Each color format supported by the DCx camera defines a different memory format. The following table shows the byte arrangement in memory: © 2016 Thorlabs Scientific Imaging...
Page 492 The first pixel in the first line with the index (0,0) is always a red pixel at color cameras. The list above does not contain the color format. In planar RGB the image is IS_CM_RGB8_PLANAR © 2016 Thorlabs Scientific Imaging...
Page 493 6 Appendix saved as 8 bit RGB. The channels red, green, and blue are stored separately, i.e. first all red information, then all green information and at last all blue information are saved. © 2016 Thorlabs Scientific Imaging...
Page 494: Uc480 Parameter File (Ini File)
Start X absolute Activate absolute AOI 0, 1 positioning in the memory (see is_AOI() Activate absolute AOI 0, 1 Start Y absolute positioning in the memory (see is_AOI() Width Width of the AOI Sensor-dependent 2460 © 2016 Thorlabs Scientific Imaging...
Page 495 Log mode value Only in combination with Manual value manual Log mode Manual gain Log mode gain [Timing] Timing parameter settings Current pixel clock of the Sensor-dependent Pixelclock camera Framerate Current frame rate Depends on 15.104458 Pixelclock © 2016 Thorlabs Scientific Imaging...
Page 496 Software correction of 0...255 Brightness image brightness Software correction of 0...511 Contrast image contrast Gamma Software correction of the 0.01...10.0 1.000000 gamma value Sensor-based hardware 0, 1 Hardware Gamma correction of the gamma © 2016 Thorlabs Scientific Imaging...
Page 497 Set the color correction 0.0...1.0 Color_correction_factor 1.000000 factor Color_correction_satU Saturation-U (see also 0…200 100 = Saturation 1.0 is_SetSaturation() 200 = Saturation 2.0 Saturation-V (see also 0…200 Color_correction_satV 100 = Saturation 1.0 is_SetSaturation() 200 = Saturation 2.0 © 2016 Thorlabs Scientific Imaging...
Page 498 Brightness Aoi Height 1920 brightness control Brightness Hysteresis Hysteresis value for auto 0…10 exposure and gain (see IS_SET_AUTO_HYSTERESIS Number of images that will 0…1000 Brightness Skip Frames be not analyzed for the control (see IS_SET_AUTO_SKIPFRAMES © 2016 Thorlabs Scientific Imaging...
Page 499 Sets the digital inputs/outputs Trigger mode Trigger mode Trigger timeout Timeout value for triggered image capture in 10 ms steps Delay of triggered image Sensor-dependent Trigger delay capture in µs Trigger debounce mode Not supported by DCx © 2016 Thorlabs Scientific Imaging...
Page 500 [Transfer] Not supported by DCx cameras ImageDelay_us PacketInterval_us This information is provided in Camera and sensor data chapter. For the parameters, please refer to the uc480.h header file provided in the \Develop\include © 2016 Thorlabs Scientific Imaging...
Page 501: Definition Of Ip Protection Classes
New functions in software version 4.20 is_ImageBuffer() is_Measure() New functions in software version 4.01 is_Blacklevel() New functions in software version 4.00 is_AutoParameter() is_Convert() is_DeviceInfo() is_EdgeEnhancement() is_ImageFile() is_ParameterSet() is_PixelClock() is_Stream() New functions in software version 3.90 is_BootBoost() © 2016 Thorlabs Scientific Imaging...
Page 502 New functions in software version 3.40 is_DirectRenderer() is_GetImageInfo() is_GetDuration() is_GetSensorScalerInfo() is_SetSensorScaler() New functions in software version 3.33 is_Direct3D() is_GetTimeout() New functions in software version 3.32 is_GetTimeout() is_SetTimeout() is_SetTriggerCounter() New functions in software version 3.30 is_GetCameraLUT() is_GetCaptureErrorInfo() is_GetColorConverter() © 2016 Thorlabs Scientific Imaging...
Page 503: Certifications And Compliances
This equipment generates, uses, and can radiate radio frequency energy and, if not installed and used in accordance with the instruction manual, may cause harmful interference to radio communications. Operation of this equipment in a residential © 2016 Thorlabs Scientific Imaging...
Page 504 Modifications not expressly approved by the manufacturer could void the user's authority to operated the equipment under FCC rules. Certificates of Conformity available upon request. © 2016 Thorlabs Scientific Imaging...
Page 505: Thorlabs 'End Of Life' Policy (Weee)
Waste treatment on your own responsibility If you do not return an “end of life” unit to Thorlabs Scientific Imaging, 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 506: Exclusion Of Liability And Copyright
User Manual, please contact your nearest Thorlabs office. 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 Scientific Imaging.
Page 507: Thorlabs Worldwide Contacts
Email: europe@thorlabs.com Email: scandinavia@thorlabs.com France Brazil Thorlabs SAS Thorlabs Vendas de Fotônicos Ltda. 109, rue des Côtes Rua Riachuelo, 171 78600 Maisons-Laffitte São Carlos, SP 13560-110 France Brazil Tel: +33-970 444 844 Tel: +55-16-3413 7062 Fax: +33-811 38 17 48 Fax: +55-16-3413 7064 www.thorlabs.com...
Page 508 CPU idle state Bayer filter CRA correction Bayer conversion Binning 38, 43 47, 341 Bit depth DCC3240x Black level correction digital input Blinking codes digital output Boot boost electrical data Burst trigger mode flsh GPIO I/O connector © 2016 Thorlabs Scientific Imaging...
Page 509 Hot pixel correction 31, 260 overlay display Hotpixel Display overlay Driver version edit EEPROM of the camera 77, 482 Image capture -> Capture Errors Image display -> Display error messages Image format transmission errors troubleshooting © 2016 Thorlabs Scientific Imaging...
Page 510 IS_SET_EVENT_TRANSFE R_FAILED is_FreezeVideo is_SetAllocatedImageMem is_Gamma © 2016 Thorlabs Scientific Imaging...
Page 511 Lookup table (LUT) isavi_AddFrame isavi_CloseAVI isavi_DisableEvent Memory board isavi_EnableEvent Memory formats isavi_ExitAVI Micro lenses isavi_ExitEvent Multi AOI 38, 120 isavi_GetAVIFileName Multi camera systems isavi_GetAVIFileNameW system requirements isavi_GetAVISize isavi_GetnCompressedFram Network card isavi_GetnLostFrames isavi_InitAVI isavi_InitEvent Obsolete functions isavi_OpenAVI © 2016 Thorlabs Scientific Imaging...
Page 512 Return values RGB gain bandwidth ROI -> AOI 38, 120 cable Rolling shutter connection Rolling shutter (global start) RS-232 -> Serial interface standard topology USB 3.0 cable Sensor conncetion position accuracy Sensor formats Serial interface © 2016 Thorlabs Scientific Imaging...

This manual is also suitable for:

Dcc1545m Dcc3240 series Dcc3260 series Dcc1645c Dcu224 series Dcc1240 series

THORLABS DCU223 SERIES Description And Sdk Manual

Foreword

1 General Information

2 Camera Basics

3 Operation

4 Programming (SDK)

5 Specifications

6 Appendix

Quick Links

Related Manuals for THORLABS DCU223 SERIES

Summary of Contents for THORLABS DCU223 SERIES