THORLABS DCC1 45 Series, User Manual

Page 1: ...e CD After the installation start camera info or the camera viewer in the samples folder to check the connection Find detailed information about the camera and the SDK on the CD For troubleshooting please contact our Support Team at europe thorlabs com DCx Camera System requirements CPU speed min 600 MHz Memory RAM min 256 MB USB host controller USB 2 0 high speed 480 Mbps full powered 500mA Graph...

Page 2: ...bs com 14 05 09 3 Start camera camera viewer from START button or from desktop icon Camera viewer will show the first pictures Check for DCU cameras red driver not loaded green driver loaded and camera ready Cables Standard USB A to USB Mini B Optional DCU camera Micro Sub D connector with shielded USB 2 0 to USB A including breakout cables for trigger and strobe Sub D 9p male camera rear view 1 5...

Page 3: ... Böckler Str 6 85221 Dachau Germany Tel 49 8131 59560 Fax 49 8131 595699 Web http www thorlabs com Mail europe thorlabs com 14 05 09 34 0 mm 32 0 18 0 mm 16 0 DCU Camera front view DCU Camera rear view DCC Camera side view DCC Camera rear view For additional information please refer to the documentation on CD ...

Page 4: ...2010 User Manual Software Development Kit DCU2xxx DCC1x45x Thorlabs Instrumentation High Resolution USB2 0 CMOS and CCD Cameras ...

Page 5: ...Version Date 3 5 2 22 09 2010 2010 Thorlabs 2010 Thorlabs ...

Page 6: ... Started 18 18 1 Unpacking 18 2 Preparation Part IV Installation 20 20 1 Software Installation 22 2 Connection of the DCx camera 23 3 Hardware Installation 24 4 The status LED Part V uc480 Camera Manager 26 28 1 Camera List 29 2 Control Center 30 3 General Information 31 4 Camera Information 32 5 Creating a Support File 32 6 Additional Functions COM Port Part VI Camera viewer uc480Viewer 34 35 1 M...

Page 7: ...formation 87 Open and Close the Camera 87 Allocating Image Memory 89 Image Memory Sequences 90 Display Mode Selection 91 Image Capture 92 Capture Modes 100 Event Message Handling 105 Saving Images and Videos 105 Saving and Loading Single Frames 106 Capturing AVIs 109 Setting Camera Parameters 109 Setting and Getting Parameters 112 Automatic Image Control 113 Image Pre processing 113 Get Camera Sta...

Page 8: ...6 is_GetError 167 is_GetExposureRange 168 is_GetFramesPerSecond 169 is_GetFrameTimeRange 171 is_GetGlobalFlashDelays 172 is_GetImageHistogram 174 is_GetImageInfo 177 is_GetImageMem 178 is_GetImageMemPitch 179 is_GetNumberOfCameras 180 is_GetOsVersion 181 is_GetPixelClockRange 182 is_GetSensorInfo 184 is_GetSupportedTestImages 187 is_GetTestImageValueRange 188 is_GetTimeout 189 is_GetUsedBandwidth ...

Page 9: ...SetEdgeEnhancement 250 is_SetErrorReport 251 is_SetExposureTime 253 is_SetExternalTrigger 255 is_SetFlashDelay 257 is_SetFlashStrobe 259 is_SetFrameRate 261 is_SetGainBoost 262 is_SetGamma 263 is_SetGlobalShutter 264 is_SetHardwareGain 267 is_SetHWGainFactor 270 is_SetImageMem 271 is_SetImagePos 274 is_SetLED 275 is_SetOptimalCameraTiming 277 is_SetPixelClock 279 is_SetRopEffect 280 is_SetSaturati...

Page 10: ...verlay 323 is_LockDDMem 324 is_LockDDOverlayMem 325 is_PrepareStealVideo 326 is_ReleaseDC 327 is_SetBayerConversion 328 is_SetDDUpdateTime 329 is_SetHwnd 330 is_SetImageAOI 331 is_SetImageSize 333 is_SetKeyColor 335 is_ShowDDOverlay 336 is_StealVideo 337 is_UnlockDDMem 338 is_UnlockDDOverlayMem 339 is_UpdateDisplay 339 6 Lists and Programming Notes 339 Programming 340 Programming in C C 340 Progra...

Page 11: ...376 Digital output flash strobe 376 9 Sensor formats 377 10 Color filter Bayer filter 377 11 Fill factor 378 12 Shutter Methods 381 13 Interface Basics 381 History and development 381 Cable and connection 382 Structure and topology 383 Data transmission and bandwidth Part X Appendices 386 386 1 Technical Data 387 Common Data 387 Ambient specification 388 IP Protection Classes 389 Flange Back Dista...

Page 12: ...Technical Data 402 Filters 404 DCU224x 406 DCU223x 408 DCC1545M 410 DCC1645C 412 2 Thorlabs End of Life Policy WEEE 412 Waste Treatment on your own Responsibility 412 Ecological Background 413 3 List of Acronyms 413 4 Copyright 414 5 Addresses ...

Page 13: ......

Page 14: ...al partners are looking forward to hearing from you Thorlabs GmbH This part of the instruction manual contains every specific information on how to handle and use the DCx camera A general description is followed by explanations of how to operate the unit via USB Attention This manual contains WARNINGS and ATTENTION label in this form to indicate danger for persons or possible damage of equipment P...

Page 15: ......

Page 16: ...Introduction DCx camera Part I ...

Page 17: ...oper use of this product Failure to do so will render the warranty void Do not subject this product to direct sunlight moisture or shock The environmental conditions specified in chapter Specifications are required 1 3 Trademarks IBM PC is a registered trademark of International Business Machines Corporation MICROSOFT and WINDOWS are trademarks or registered trademarks of the Microsoft Corporation...

Page 18: ...General Information DCx camera Part II ...

Page 19: ...2 and 64 bit and LINUX All information about programming can be found in the Software Development Kit section of this manual Please read the file WhatsNew txt which is on the installation CD Here you can find additional information which is possibly not contained in the printed edition of the manual We would like to wish you every success with the product 2 2 Ordering Codes and Accessories Orderin...

Page 20: ... bit Service Pack 3 Windows Vista 32 bit Service Pack 1 Linux Kernel 2 6 x NOTE Please make sure that SP4 for WIN 2000 is installed SP2 for WIN XP is installed the USB 2 0 Port is full powered 500mA and USB2 0 certified cables are used 2 4 Supported Operating Systems Table 2 Supported Operating Systems and Interfaces OS Service Packs Required Patches Windows 2000 SP4 Windows XP SP1 KB822603 Window...

Page 21: ......

Page 22: ...Getting Started DCx camera Part III ...

Page 23: ...ta 7 32 and 64 bit as well as the SDK and the Camera viewer uc480Viewer Quick reference guide Getting Started Standard USB 2 0 cable 1x CS to C mount Adapter Ring DCC1x45x only 2x SM1 Adapter Ring internal external external external thread 3 2 Preparation To get your camera up and running the following points are necessary 1 Install the USB camera driver from the supplied Support CD 2 Remove the d...

Page 24: ...Installation DCx camera Part IV ...

Page 25: ...tallation procedure In order to proceed please make sure you have administrator s privileges The software setup is automatically launched when the DCx CD is inserted into the CD drive Alternatively the following screen may appear then please choose the highlighted option as below After the CD has been detected from Windows the following installation window appears Should the window not appear auto...

Page 26: ...package is installed A seperate driver installation window will appear as shown below Please follow the instructions on the screen Figure 2 Driver installation welcome screen During the installation a list with direct show driver list will pop up see below stating a wrong count of cameras This message needs to be confirmed with OK ...

Page 27: ...our PC s USB 2 0 port Connect the camera using the USB 2 0 cable Window s plug and play manager recognizes the new hardware A wide range of various hubs and repeaters are available that can be purchased from the computer trade Experience with USB2 0 PCI plug in boards has shown that their performance is poorer than with interfaces integrated direct into the mainboard The USB 2 0 hubs being used mu...

Page 28: ...tains in the column Universal Serial Bus Controller the entry Thorlabs DCU ccd xxxx or Thorlabs DCC cmos xxxx depending on your model No question or exclamation marks should stand before the driver In case you connected a DCU camera the LED on the back of the camera shows green Figure 5 List of the Thorlabs DCU driver in the device manager ...

Page 29: ...er supplied LED lites up red only USB Board Rev 2 0 or higher The DCU driver has been loaded and the camera is ready for operation LED shines green The status LED can also help you in case of trouble shooting by providing error codes see section trouble shooting Figure 6 The Status LED rev 1 2 Figure 7 The Status LED rev 2 0 360 ...

Page 30: ...uc480 Camera Manager DCx camera Part V ...

Page 31: ...er Program icon on the desktop or Quick Launch toolbar Start Control Panel uC480 Camera Manager Figure 8 uC480 Camera Manager Camera list The camera list displays information on the connected uc480 cameras Control center In the control center you can access the configuration and display detailed information on the connected DCx cameras In the drop down box you can choose the language for the uc480...

Page 32: ...anager window indicates the current status of the selected camera If it is available the status message is shown in black Otherwise the status message is shown in red If an error has occurred in a camera a black exclamation mark on a yellow background is shown next the camera The status box then indicates the cause of the error and suggests remedies ...

Page 33: ... with an exclamation mark are not in use but are currently unavailable for various reasons such as The camera is not compatible with the driver Please contact Tech Support The driver has not properly detected initialized the camera Please disconnect the camera from the PC and then reconnect it The camera is currently being removed from the Manager The camera reports that it is Not operational Type...

Page 34: ...ra list The ETH network service button is not available for Thorlabs DCx USB cameras Figure 10 uC480 Camera Manager in Expert Mode Automatic parameter refresh If you select the Automatic Parameter refresh check box the data shown in the tree structure is updated periodically If the option is disabled the data in the tree structure is only updated when a different camera is selected All other Contr...

Page 35: ...er General Information uc480 drivers and 3rd party drivers This list shows the location and version of the uc480 driver files and interface files for third party software installed on your system Direct3D Dlls This list shows the location and version of the Direct3D drivers USB controller and network adapters All USB controllers and network adapters that are available in your system are shown in a...

Page 36: ...from 1 to 254 The default value for the camera ID is 1 The same ID can be assigned to multiple cameras You do not have to assign sequential ID numbers to all connected cameras If software accesses cameras through the uc480 DirectShow interface the camera IDs must be in a range from 1 to 8 If software accesses cameras through the uc480 DirectShow interface the camera IDs must be assigned consecutiv...

Page 37: ...or diagnostics by the Thorlabs Support team No personal computer data or user data is stored in this file The button opens the Save as dialog box where you can save the displayed camera information and additional driver information to a file Figure 13 uC480 Camera Manager Support File Dialog 5 6 Additional Functions COM Port The Additional functions is not available for DCx USB Camera ...

Page 38: ...Camera viewer uc480Viewer DCx camera Part VI ...

Page 39: ...king reliability in all modes and in all computer environments This program is free of charge and may not be compared with other available products Camera viewer uc480Viewer is delivered completely in source code and serves the demonstration of the Thorlabs driver library Support regarding Camera viewer uc480Viewer is unfortunately not possible Figure 14 Camera viewer uc480Viewer program Microsoft...

Page 40: ...ialog for avi recording Load parameters Load parameters out of an ini File Save parameters Save parameters in an ini File Language Choice between German and English Customize allows to restore parameters restore window position and size show capture error window show debug window Exit Exit uc480 Viewer program Table 3 Camera viewer uc480Viewer Menu File ...

Page 41: ... also uc480 Toolbar Line View Histogram Zoom Window Pixel peek window waterfall window Options for uc480 display see uc480 Toolbar Log window Logs of failed transfers Image Info Information on Capture errors camera image buffers and resent packets Toolbars Allow select unselect toolbars of the uc480 Viewer Table 4 Camera viewer uc480Viewer Menu File 42 41 41 ...

Page 42: ...ea of Interest Clear AES AGC AOI Clear current Auto Contrast Area of Interest Auto White Balance Activate the automatic color alignment Set new AWB AOI Define an new AWB Area of Interest Clear AWB AOI Clear current AWB Area of Interest Set new AOI After calling up an area to be used as AOI can be selected with the mouse Clear AOI Clear current AOI and display full image User allocate image Demo fo...

Page 43: ...nd Draw new freehand Delete freehand Delete freehand Line Show lines Show hide lines New lines Draw new lines Delete lines Rectangle Draw rectangles Show rectangles Show hide rectangles New rectangles Draw new rectangles Delete rectangles Delete rectangles Measure Set measure unit Adjust scaling Show measures Show hide measures New mesure New mesure Delete measures Delete all measures Text Select ...

Page 44: ...Show hide time stamp Save image drawings Open Save as dialogue The image is stored with all drawings text and measurements Load drawings Load drawing elements from a bin file and insert to actual display Save drawings Save present drawing elements to a bin file Delete all Delete all drawings text and measurements Table 6 Camera viewer uc480Viewer Menu Draw Measure ...

Page 45: ...40 DCx camera 2010 Thorlabs Menu Help Figure 15 Info about Camera viewer uc480Viewer ...

Page 46: ...ard in DIB mode only 0 Camera Properties see detailed description Set Area Of Interest Delete Area Of Interest Histogram on off see Histogram Horizontal line view show the color values of a pixel line Vertical line view show the color values of a pixel row Open zoom window see Zoom window Open Pixel peek window see Pixel peek window Table 7 Camera viewer uc480Viewer uc480 Toolbar 46 74 75 76 ...

Page 47: ...ale display to half size Scale display to quarter size Scale display to double size Limit the max display frame rate to 30 fps Table 8 Camera viewer uc480Viewer Display Toolbar Capture Toolbar Live video on off Snapshot Capture single frame using trigger mode Trigger mode on off continuous trigger recording Table 9 Camera viewer uc480Viewer Capture Toolbar ...

Page 48: ...ntrast function Auto White Balance Activate the automatic white alignment Specify the active area for the auto white balance function Delete the active area for the white balance function Table 10 Camera viewer uc480Viewer Auto feature Toolbar Draw Measure Toolbar Draw freehand Draw lines Draw circles Draw rectangles Add measures Write text Clear all Show Hide Timestamp Table 11 Camera viewer uc48...

Page 49: ...s Displayed displayed images Miss unprocessed hardware trigger only in trigger mode Failed Transfer error Reconnects The counter increments each time the open camera is removed and reconnected in ongoing operation 4 Status of the data transfer 5 Current frame rate of the camera Table 12 Camera viewer uc480Viewer Status bar Figure 17 Select camera from choice If only one camera is connected the Cam...

Page 50: ...r uc480Viewer 2010 Thorlabs Figure 18 Select second camera in new application To operate with several cameras at the same time start the Camera viewer uc480Viewer several times Used cameras are marked as Available No ...

Page 51: ...o Pixel Clock Frame Rate and Exposure Time Figure 19 Camera viewer uc480Viewer Camera Camera peak bandwidth Maximum required bandwidth in MB sec peak load This value is displayed in red if the available USB bandwidth is exceeded Camera average bandwidth Required average bandwidth in MB sec The average bandwidth is calculated from the following data Image size image format frame rate and interface ...

Page 52: ... frame rate will remain constant if the pixel clock changes If the frame rate cannot be maintained it is set to the nearest possible value Max The camera is operated at the maximum frame rate that is possible at the current pixel clock setting Auto Select this check box to activate the Auto Frame Rate function This function is only available when Auto Exposure Shutter is enabled Exposure time Sets...

Page 53: ...48 DCx camera 2010 Thorlabs Default Click this button to reset all parameters to the model specific defaults ...

Page 54: ... Auto Auto can be activated only for cameras with master gain After activating Auto the sliding control and the input field for master gain are updated cyclically Changing the gain values sliding controls or input deactivates the Auto functionality Gain boost Additional analog hardware gain of the camera depending on the model it s value is between 1 5x and 2x Black level Offset 0 255 Offset for t...

Page 55: ... RGB gain controllers are selectable only with the color models Edge enhancement Edges can be emphasized with Edge enhancement In connection with the color sensors this function can be used to counteract edge softening caused by Bayer Mosaic conversion Activating the Edge enhancement function results in increased processing during image capture Gamma Software gamma 1 6 Gamma correction with the va...

Page 56: ...nally the image is administered in the AOI resolution and not in the full resolution of sensor This function saves memory and computing time when building the image Width Set the window width Height Set the window height Left Set the left position of the window Using the option Center will centre the AOI horizontal Top Set the top position of the window Using the option Center will centre the AOI ...

Page 57: ...ccount in horizontal direction This procedure reduces image width accordingly and increases frame rate Subsampling does not change sensitivity Binning and subsampling availability depends on the camera type and is shown in the software after a camera is recognized Some color models can offer only a monochrome binning and or subsampling In this case the color information is lost Vice versa some mon...

Page 58: ...nd their representation in the memory Debayering method With this setting you select the conversion algorithm o Software Normal The conversion is performed by software in the PC A filter mask of 3x3 pixels is used for the conversion o Software High The conversion is performed by software in the PC A filter mask of 5x5 pixels is used for the conversion o Hardware Normal The conversion is performed ...

Page 59: ...6 Output of a grayscale image to which the LUT gamma curve has been applied 12 bits per pixel starting from most significant bit MSB o RGB15 5 5 5 Output of an image converted according to RGB 15 5 bits per pixel for R G and B o RGB16 5 6 5 Output of an image converted according to RGB 16 5 bits per pixel for R and G 6 bits per pixel for B o RGB24 8 8 8 Output of an image converted according to RG...

Page 60: ...pported by all graphics hardware and is recommended for applications that will be used on different PCs Direct3D Desktop color In this mode the images are written directly to an invisible area of the graphics card mixed with optional overlay image data and displayed by the card without load on the CPU The mode also allows scaling the images in real time NOTE The display modes Direct3D is only supp...

Page 61: ...and Y For the use in other color formats than YUV U and V are converted using a driver matrix Combine Selecting this check box synchronizes the two Saturation U and Saturation V sliders IR color filter correction matrix When using color cameras with IR filter glass you need to set the appropriate color correction matrix to ensure correct color rendering The driver detects the IR filter type and se...

Page 62: ...r 2010 Thorlabs The color correction factor is steplessly adjustable between 0 no correction and 1 full correction Activating the sensor color correction may increase CPU load Default All values are reset to the default settings ...

Page 63: ...des settings for the hardware Look Up Table LUT curve for future cameras Each LUT contains modification values for the image brightness and contrast parameters This feature is not supported by the DCx camera series Figure 24 Properties Hardware Look up table LUT ...

Page 64: ...is polled and displayed Trigger delay Select this check box to set a delay between the arrival of a software or hardware trigger signal and the start of exposure Mode With these radio buttons you choose which trigger mode you want to activate in the camera Software The camera is running in software trigger mode without a signal applied The images are captured continuously Falling edge The camera c...

Page 65: ...utter sensor are exposed simultaneously Activating Global Start only makes sense when using a flash This function is currently not supported Default Click this button to reset all parameters to the model specific defaults NOTE Please note that the frame rate in trigger mode is always lower than in freerun mode This is due to the sequential transmission First the exposure takes place then the trans...

Page 66: ...ctivate it again whenever you change the pixel clock setting or horizontal image geometry This is necessary to newly synchronize the internal timing settings of the flash output with the start of sensor exposure Flash output With these radio buttons you choose which digital output function you want to activate on the camera Off The digital output is disabled Constant high The digital output is set...

Page 67: ...or the digital output After an exposure has started actuating the digital output is delayed by the time set in Flash delay For some models and depending on the operating mode delays of up to 200 µs must be set in order to exactly hit the beginning of the exposure time of the pixels You can look up the exact value for each camera under Sensor delay to exposure start in the Technical Data chapter Du...

Page 68: ...posure times may cause motion blur Auto Gain Control AGC automatically adjusts image brightness based on the hardware gain control setting of the camera sensor You can activate this function in addition to AES if ambient light conditions are poor High gain settings may cause artifacts Auto Frame Rate AFR adjusts the frame rate to allow longer exposure times see also Pixel Clock Frame Rate and Expo...

Page 69: ... value for automatic exposure time control is linked to the camera settings If the maximum possible exposure time value has changed e g through changes in the timing parameters then this value is applied as the maximum Auto Exposure value Set values that are less than the maximum value are not affected Gain limit Sets the maximum gain limit On reaching the lower limit gain 0 the exposure time adju...

Page 70: ...he mean green value for the red and or blue channel These options allow deviating color controlling Gain min Gain min is the lower limit for the controlling and allows thereby a minimum amplification is kept for cameras without master gain Gain max Upper limit for the controlling Speed Adjustment of the control speed The higher the automatic controller speed is adjusted the faster the regulation r...

Page 71: ... active see also Automatic Image Control Control Speed Histogram area The histogram area specifies which area of the image will be used for calculating the average grayscale value of the image You can set the size of the histogram area by using the tools on the toolbar see Toolbar Default All values are reset to the default settings 71 71 42 ...

Page 72: ...h is due to the different sensor systems The hot pixels are detected during DCx camera testing and written to a coordinate list in the camera If hotpixel correction is enabled the correction function eliminates these pixels before debayering Mark hotpixel If you select this check box the hot pixel positions stored in the camera are graphically represented in the image Hotpixel correction Select th...

Page 73: ...tting has an influence on the test image For USB cameras you can use a white test image to check the camera s maximum load on the USB bus Due to the transmission process completely white camera images require a somewhat more bandwidth on the USB bus than completely black images Default Click this button to reset all parameters to the model specific defaults ...

Page 74: ...69 Camera viewer uc480Viewer 2010 Thorlabs 6 4 12 Scaler This feature enables image scaling of the sensor So far not supported by Thorlabs DCx cameras Figure 31 Properties Scaler ...

Page 75: ...ontrol range A lower frame rate allows for longer exposure times but then the live image display may exhibit jitter The objective of the automatic frame rate control is to set the frame rate to an optimum value This way in all situations the automatic exposure control can use the required control range at the highest possible frame rate Auto White Balance AWB Depending on the lighting source light...

Page 76: ...ames With the Skip Frames parameter you can select how many frames should be skipped in freerun mode default 4 This parameter strongly influences the control speed Choosing small values can destabilize the automatic control Hysteresis The automatic control feature uses a hysteresis function for stabilization When the actual value is in the range of setpoint hysteresis value up to setpoint hysteres...

Page 77: ...m the DCx are placed in a buffer Then the images are compressed and added to the AVI file which is stored on the hard disk These operations are not performed in the same thread as the capturing process If you capture more images while a compression or write operation is in progress the new images will be discarded Supported color formats The supported input color formats are RGB32 RGB24 Y8 and raw...

Page 78: ...lc Framerate If you select this check box the frame rate of the AVI file is determined automatically during recording It can also be set manually The frame rate value is stored in the AVI file and evaluated by the movie player The usual value is 25 or 30 frames per second The recording speed of the video depends on the selected color format the image size and the compression level of the AVI file ...

Page 79: ...lue can the display of the respective color channels be switched on and or off With Avg the average value of the individual color value is displayed In operating mode mono the average grey value is displayed Outlined With the option Outlined the display of the color values can be switched between area and line diagram Logarithmic With the activation of this option the representation takes place wi...

Page 80: ...n the range of 0 25 to 20 00 The size of the display detail depends on the selected size of the zoom window This can be changed with the usual Windows functions For the selection of the picture position the control key and the right mouse button must be pressed Alternatively the picture position can be set over the context menu If the option pixel peek at the upper edge of window is activated the ...

Page 81: ...menu Line view 6 10 Pixel peek window Figure 36 View Menu Pixel peek window With the option Pixel peek window the color values at the current cursor position and the neighbouring pixels are displayed For this the control key and the right mouse button must be pressed In the example shown above the cursor stands at the position x 272 y 495 The color values of this Pixel are bordered yellow In monoc...

Page 82: ...ndow With each new frame all lines in the Waterfall window are moved one pixel down and the new line is added at the top This results in an image that flows from top to bottom and is useful for observing short term image changes To set the cursor position you want to monitor in the Waterfall window place the cursor at that position in the image hold the Ctrl key and right click Alternatively you c...

Page 83: ...the logging takes place with this level Auto Scroll With activated option Auto Scroll the display is automatically scrolled upward with the arrival of new events so that the new events can be read Log Transfer Failed With Log Transfer Failed the logging of transfer failures is oppressed Clear Window With the button Clear Window the current messages are deleted Save The button Save to file opens th...

Page 84: ...wer 2010 Thorlabs 6 13 Image infos Select View menu Image infos on the main menu to display the Capture Errors dialog box Figure 39 View menu Image Information NOTE Please see the trouble shooting section if errors occur 36 360 ...

Page 85: ...ssible cause Remedy 1 Not enough destination memory allocated or all destination buffers locked by the application Reduce the frame rate so that there is more time to process the filled destination memory 2 Internal error during internal processing of the image 3 All destination buffers locked by the application Reduce the frame rate so that there is more time to process the filled destination mem...

Page 86: ...81 Camera viewer uc480Viewer 2010 Thorlabs Camera image buffers Not applicable to USB cameras Resent packets Not applicable to USB cameras ...

Page 87: ......

Page 88: ...SDK Software development Kit DCx camera Part VII ...

Page 89: ...pture To show the image on screen call the is_RenderBitmap function after each completed image capture From the events or messages you can see when an image is available for display Under Linux The display functions of the DCx camera API are not available under Linux You need to allocate and activate the relevant image memory as described above The application then displays the image data via the ...

Page 90: ...camera and the allocated memory are automatically released All previously set camera parameters will be lost however So if you want to save specific settings use the is_SaveParameters function before closing the camera The next time you start the application you can simply load the settings again by using is_LoadParameters NOTE You will find comprehensive lists of the API functions sorted by task ...

Page 91: ...pen one or more DCx camera cameras we recommend querying some key information Opening and closing a camera Allocating an image memory This is necessary if you want to access image memory contents or if you are not using Direct3D for image display Creating an image memory sequence is required when capturing live images 7 2 1 1 Query Information It is recommended to query the following important inf...

Page 92: ...dware initialisation is_ExitCamera Closes the camera and releases the created image memory When multiple cameras are used on one system you should assign every camera a unique camera ID is_SetCameraID Sets a new camera ID 7 2 1 3 Allocating Image Memory When you are programming an application that requires direct access to the image data in stored in memory or uses Bitmap mode DIB for display use ...

Page 93: ... the active image memory is_GetImageMem 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 Flowchart Allocating memory Figure 41 Flowchart Allocating memory using system functions 128 129...

Page 94: ...provide appropriate image memory sequences The DCx camera driver offers a set of easy to use features for this purpose For example the system automatically cycles through the specified sequence of image memories and can generate an event when it reaches the end of a sequence cycle Before you can use a memory sequence you have to allocate the relevant image memories see Allocating an Image Memory 1...

Page 95: ...vides different modes for displaying the captured images on Windows systems We recommend using the Bitmap mode or the Direct3D functions depending on your specific application For further information on the different display modes see Basics Image Display Modes Select the desired mode The display mode has to be set before you start image capture is_SetDisplayMode Selection of the display mode When...

Page 96: ...e of single frames snap and frame sequences live in trigger mode and untriggered freerun mode Select the image capture mode that best meets your application requirements Using events or messages the DCx camera driver can provide information to an application e g about the completion of image capture You will need events and messages for example when you are using image memory sequences 92 100 89 ...

Page 97: ...s digital input hardware trigger For the specifications of the electrical trigger signals see the Technical Data I O Interface Trigger Input Wiring chapter The trigger mode is selected using is_SetExternalTrigger Software trigger mode When this mode is enabled calling is_FreezeVideo immediately triggers the capture of an image and then transfers the image to the PC If is_CaptureVideo is called the...

Page 98: ...Continu ous Off is_SetExternalTrigger OFF is_CaptureVideo X Freely selectable Software is_SetExternalTrigger SOFTWARE is_CaptureVideo X X Depending on exposure time and trigger delay Hardwar e is_SetExternalTrigger e g HI_LO is_CaptureVideo X X Depending on exposure time and trigger delay Freerun sync is_SetExternalTrigger e g HI_LO_SYNC is_CaptureVideo X Freely selectable Single frame Off is_SetE...

Page 99: ...Parameter Wait Image capture mode Function returns Timeout for 1st image Timeout for subsequent images1 IS_DONT_WAIT HW trigger Immediately API default or user defined value 3 API default or user defined value 3 IS_WAIT HW trigger When 1st image in memory API default or user defined value 3 API default or user defined value 3 Time t HW trigger When 1st image in memory Time t API default or user de...

Page 100: ...t using the is_SetTimeout function Function List is_CaptureVideo Captures a live video is_FreezeVideo Captures an image and writes it to the active image memory is_ForceTrigger Simulates a trigger signal in hardware trigger mode is_HasVideoStarted Returns whether the capture process has been started or not is_IsVideoFinish Returns whether the capture process has been terminated or not is_SetSensor...

Page 101: ...96 DCx camera 2010 Thorlabs Flowchart Single Capture Figure 44 Flowchart Capturing a single frame 1 of 2 ...

Page 102: ...97 SDK Software development Kit 2010 Thorlabs Figure 45 Flowchart Capturing a single frame 2 of 2 ...

Page 103: ...98 DCx camera 2010 Thorlabs Flowchart Sequence Capture Figure 46 Flowchart Capturing a frame sequence 1 of 2 ...

Page 104: ...99 SDK Software development Kit 2010 Thorlabs Figure 47 Flowchart Capturing a frame sequence 2 of 2 ...

Page 105: ...nce The sensor exposure and readout times and the transmission times depend on the camera settings The pre processing time depends on the API functions you are using e g colour conversion edge enhancement Figure 48 Events in hardware trigger mode Events in Live Mode Image Sequence The following figure shows the time sequence when triggering the IS_FRAME and IS_SEQUENCE events The camera is set to ...

Page 106: ...t is_EnableEvent Enables a single event object is_EnableMessage Turns the Windows messages on off is_ExitEvent Closes the event handler is_InitEvent Initialises the event handler is_EnableAutoExit Automatically releases the camera resources when the camera is disconnected from the PC 138 140 141 144 195 139 ...

Page 107: ...102 DCx camera 2010 Thorlabs Flowchart Enable Events Figure 50 Flowchart Enabling event handling Flowchart Enabling Messages ...

Page 108: ...103 SDK Software development Kit 2010 Thorlabs Figure 51 Flowchart Enabling message handling Flowchart Event Message Handling ...

Page 109: ...104 DCx camera 2010 Thorlabs Figure 52 Flowchart Handling events messages ...

Page 110: ... BMP or JPG file and load saved image data into an image memory is_LoadImage Loads an image from a bitmap file into the current image memory is_LoadImageMem Loads an image from a bitmap file into a new image memory is_SaveImage Saves the current image as a BMP file is_SaveImageEx Saves the current image as a JPEG of BMP file is_SaveImageMem Saves the contents of the image memory as a BMP file is_S...

Page 111: ...es are placed in a buffer Then the images are compressed and added to the AVI file which is stored on the hard disk These operations are not performed in the same thread as the capturing process If you capture more images while a compression or write operation is in progress the new images will be discarded isavi_StartAVI Starts AVI recording isavi_AddFrame Adds a compressed image to the AVI file ...

Page 112: ...fining a freely selectable area of interest AOI Capture Speed The possible speed of capture depends on the selected colour format the image size and the compression level of the AVI file as well as the PC performance Playback in External Applications AVI files you have captured using the uc480_tools dll can also be played back in external applications such as Windows Media Player The required code...

Page 113: ...108 DCx camera 2010 Thorlabs Flowchart AVI Capture Figure 53 Flowchart Capturing AVI using DCx cameras ...

Page 114: ...eRange Returns the adjustable exposure range is_GetFramesPerSecond Returns the current frame rate in live mode is_GetFrameTimeRange Returns the adjustable frame rate range is_GetPixelClockRange Returns the adjustable pixel clock range is_SetAutoParameter Enables disables automatic imaging functions is_SetBlCompensation Turns black level correction on off is_SetExposureTime Sets the exposure time i...

Page 115: ...ionTable Loads a user defined hot pixel list from a file is_SaveBadPixelCorrectionTable Saves the current user defined hot pixel list is_SetBadPixelCorrection Turns hot pixel correction on off is_SetBadPixelCorrectionTable Enables a user defined hot pixel list is_SetColorConverter Selects Bayer conversion mode is_SetColorCorrection Sets color correction is_SetColorMode Selects a color mode is_SetC...

Page 116: ...111 SDK Software development Kit 2010 Thorlabs Flowchart Changing camera timing Figure 54 Flowchart Changing camera timing ...

Page 117: ...just the image capture parameters to the lighting situation All controls are configured using the is_SetAutoParameter SDK function For more information on the automatic image control see Camera Viewer Automatic Image Control Flowchart Enable Auto Brightness Figure 55 Flowchart Enabling automatic image brightness control 221 70 ...

Page 118: ...event counters and other information Enables standby mode is_GetAutoInfo Returns status information on the auto features is_GetCameraList Returns information on all connected cameras is_GetCameraType Returns the camera type is_GetCaptureErrorInfo Displays information on errors that have occurred is_GetError Displays errors that have occurred is_GetUsedbandwidth Returns the bus bandwidth in Mbit s ...

Page 119: ...he digital output for flash control or a static output level is_SetFlashDelay Sets the delay and power on time of the flash output is_SetTriggerDelay Sets the trigger signal delay time is_GetGlobalFlashDelays Determines the delay and power on times of the flash output to obtain a global shutter effect when using rolling shutter sensors is_ForceTrigger Simulates a trigger signal in hardware trigger...

Page 120: ...115 SDK Software development Kit 2010 Thorlabs Flowchart Digital input Figure 56 Flowchart Digital input ...

Page 121: ...116 DCx camera 2010 Thorlabs Flowchart Digital output Figure 57 Flowchart Digital output ...

Page 122: ...es to related functions Input Parameters Description of the function parameters including their value ranges Return Value Description and value range of the return value If a function returns the IS_NO_SUCCESS 1 value you can get information on the error from the is_GetError function Related Functions List with similar or related SDK functions Code Sample For some functions C programming samples a...

Page 123: ...Mem Using the is_SetAllocatedImageMem function you can set a memory that has been allocated before as image memory Image memories that are used for ring buffering must all have been allocated with the same colour depth bits per pixel Input Parameters hCam Camera handle pcMem Pointer to image memory nID Image memory ID Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General er...

Page 124: ...ncrement you can use the is_GetImgMemPitch function The starting address of the memory area is returned in ppcImgMem pid returns an ID for the allocated memory A newly allocated memory is not directly active i e digitised images will not be stored immediately in this new memory It must first be made active using is_SetImageMem The returned pointer must be write protected and may not be altered bec...

Page 125: ...emory but can be distinguished by the bitspixel parameter ppcImgMem Returns the pointer to the memory starting address pid Returns the ID of this memory Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESSGeneral error message Related Functions is_FreeImageMem is_AddToSequence is_SetImageMem is_SetAllocatedImageMem is_GetColorDepth is_GetImgMemPitch 147 118 270 217 164 178 ...

Page 126: ...ment Kit 2010 Thorlabs 7 3 3 is_CameraStatus USB 2 0 USB 2 0 Syntax ULONG is_CameraStatus HIDS hCam INT nInfo ULONG ulValue Description Using is_CameraStatus you can query and partly set various status information and settings ...

Page 127: ... a list of all possible error events see is_GetCaptureErrorInfo IS_PARAMETER_SET_1 Indicates whether parameter set 1 including camera settings is present on the camera read only See also is_SaveParameters Return values TRUE Parameter set 1 present FALSE Parameter set 1 not present IS_PARAMETER_SET_2 Indicates whether parameter set 2 including camera settings is present on the camera read only See ...

Page 128: ...or message Returns the information specified by nInfo Only if ulValue IS_GET_STATUS When used with IS_LAST_CAPTURE_ERROR Returns the last image capture error For a list of all possible error events see is_GetCaptureErrorInfo Related Functions is_GetCameraInfo is_GetError is_SetErrorReport is_SetTriggerCounter 160 155 166 250 288 ...

Page 129: ...is_LockSeqBuf will be skipped If the last available sequence memory has been filled the sequence event or message will be triggered Capturing always starts with the first element of the sequence For further information on the image capture modes of the DCx camera camera see the How To Proceed Image Capture section Input Parameters hCam Camera handle Wait IS_DONT_WAIT Timeout value for image captur...

Page 130: ...125 SDK Software development Kit 2010 Thorlabs Sample Programs SimpleLive uc480live exe C CSharpDemo uc480_csharp_demo exe ...

Page 131: ... that were added using is_AddToSequence After a call of is_ClearSequence there is no more active image memory To make an image memory the active memory call is_SetImageMem Input Parameters hCam Camera handle Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related Functions is_AddToSequence is_FreeImageMem is_SetImageMem 118 270 118 147 270 ...

Page 132: ...vertParam to define the conversion settings Input Parameters hCam Camera handle pcSource Pointer to the input image nIDSource Memory ID of the input image ppcDest Pointer to the output image In case a NULL value is passed a new memory is allocated internally nIDDest Memory ID of the output image reserved Reserved NULL must be passed here Return Values IS_SUCCESS Function executed successfully IS_N...

Page 133: ... starting address pcDest points The allocated memory must be large enough to accommodate the entire image in its current format bits per pixel Input Parameters hCam Camera handle pcSource Pointer to the image memory nID ID of this image memory pcDest Pointer to the destination memory to copy the image to Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Re...

Page 134: ...nts The function only copies the number of lines indicated by nLines The allocated memory must be large enough to accommodate the entire image in its current format bits per pixel Input Parameters hCam Camera handle pcSource Pointer to the image memory nID ID of this image memory nLines Number of lines to be copied pcDest Pointer to the destination memory to copy the image to Return Values IS_SUCC...

Page 135: ... you are using high resolution cameras the maximum texture size supported by the graphics card should be at least 4096 x 4096 pixels You can check the maximum texture size by reading out the D3D_GET_MAX_OVERLAY_SIZE parameter The Direct3D mode automatically uses the Windows Desktop color depth setting for the display Please also read the notes on graphics cards which are provided in the System Req...

Page 136: ...p of the current camera image Code sample DR_HIDE_OVERLAY Disables overlay display Code sample DR_ENABLE_SCALING Enables real time scaling of the image to the size of the display window The overlay is scaled together with the camera image Code sample DR_ENABLE_IMAGE_SCALING Enables real time scaling of the image to the size of the display window The overlay is not scaled Sample see DR_ENABLE_SCALI...

Page 137: ...erlay area If the bitmap image is larger than the overlay area the bitmap image is clipped Code sample DR_CLEAR_OVERLAY Deletes the data of the overlay area by filling it with black color Code sample DR_STEAL_NEXT_FRAME Copies the next image to the active user memory Steal function Using the pParam parameter you specify when the function should return IS_WAIT The function waits until the image sav...

Page 138: ...COMPATIBILITY IS_DR_DEVICE_CAPS_INSUFFICIENT The graphics hardware does not fully support the DCx camera Direct3D functions Related Functions is_SetDisplayMode is_SetColorMode is_SetImageMem is_RenderBitmap Code Samples DC Handle Get DC handle for Overlay HDC hDC is_DirectRenderer hCam DR_GET_OVERLAY_DC void hDC sizeof hDC Release DC handle is_DirectRenderer hCam DR_RELEASE_OVERLAY_DC NULL NULL 24...

Page 139: ... UINT Position 2 Position 0 20 Position 1 0 is_DirectRenderer hCam DR_SET_OVERLAY_POSITION void Position sizeof Position Key color Get current key color UINT OverlayKeyColor 3 is_DirectRenderer hCam DR_GET_OVERLAY_KEY_COLOR void OverlayKeyColor sizeof OverlayKeyColor INT nRed OverlayKeyColor 0 INT nGreen OverlayKeyColor 1 INT nBlue OverlayKeyColor 2 Set new key color OverlayKeyColor 0 GetRValue m_...

Page 140: ...Y NULL NULL Scaling Enable scaling is_DirectRenderer hCam DR_ENABLE_SCALING NULL NULL Disable scaling is_DirectRenderer hCam DR_DISABLE_SCALING NULL NULL Transparency Enable semi transparent overlay is_DirectRenderer hCam DR_ENABLE_SEMI_TRANSPARENT_OVERLAY NULL NULL Disable semi transparent overlay is_DirectRenderer hCam DR_DISABLE_SEMI_TRANSPARENT_OVERLAY NULL NULL ...

Page 141: ...ITION_RANGE void UserSync sizeof UserSync INT Min UserSync 0 INT Max UserSync 1 INT SyncPosition 400 is_DirectRenderer hCam DR_SET_USER_SYNC void SyncPosition sizeof SyncPosition Disable synchronization is_DirectRenderer hCam DR_SET_VSYNC_OFF NULL NULL BMP file Load overlay from BMP file is_DirectRenderer hCam DR_LOAD_OVERLAY_FROM_FILE void c test bmp NULL Delete overlay Delete overlay area is_Dir...

Page 142: ...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 Handle to window Set new window handle for image display is_DirectRenderer hCam DR_SET_HWND void hWnd sizeof hWnd Compatibility Check graphics card compatibility INT nRet is_DirectRenderer hCam DR_CHECK_COMPATIBILITY NULL NULL if nRet I...

Page 143: ... but will no longer trigger an event signal Disabled events are no longer signaled to the application You can re enable the desired event using is_EnableEvent See also is_InitEvent Input Parameters hCam Camera handle which ID of the event to be disabled See also is_InitEvent Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related Functions is_EnableEvent...

Page 144: ... closing of the handle the entire memory allocated by the driver will be released Input Parameters hCam Camera handle nMode IS_ENABLE_AUTO_EXIT Enables automatic closing IS_DISABLE_AUTO_EXIT Disables automatic closing IS_GET_AUTO_EXIT_ENABLED Returns the current setting Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Current setting when used together wi...

Page 145: ...d with is_InitEvent Following the release the event messages for the created event object are enabled Input Parameters hCam Camera handle which ID of the event to be released See also is_InitEvent Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related Functions is_InitEvent is_ExitEvent is_DisableEvent is_WaitEvent 195 195 195 144 138 292 ...

Page 146: ...he arrival of a trigger has been transferred completely This is the earliest possible moment for a new capturing process The image must then be post processed by the driver and is available after the IS_FRAME message has occurred IS_DEVICE_REMOVED A camera initialised with is_InitCamera was disconnected IS_DEVICE_RECONNECTED A camera initialised with is_InitCamera and disconnected afterwards was r...

Page 147: ...142 DCx camera 2010 Thorlabs Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related Functions is_InitEvent 195 ...

Page 148: ...mageMem function which has not been released yet is automatically released We recommend that you call the following functions only from a single thread in order to avoid unpredictable behaviour of the application is_InitCamera is_SetDisplayMode is_ExitCamera See also Programming Thread Programming Input Parameters hCam Camera handle Return Values IS_SUCCESS Function executed successfully IS_NO_SUC...

Page 149: ...as been deleted you can no longer enable it by calling the is_EnableEvent function Input Parameters hCam Camera handle which ID of the event to be deleted See also is_InitEvent Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related Functions is_InitEvent is_EnableEvent is_WaitEvent Example See also is_ForceTrigger 140 195 195 140 292 145 ...

Page 150: ...ogress This function can only be used if the triggered capturing process was started using the IS_DONE_WAIT parameter Input Parameters hCam Camera handle Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related Functions is_FreezeVideo is_CaptureVideo is_SetExternalTrigger Code Sample Enable trigger and wait 1 second for the external trigger If no trigger...

Page 151: ..._FRAME is_EnableEvent hCam IS_SET_EVENT_FRAME is_SetExternalTrigger hCam IS_SET_TRIGGER_HI_LO is_FreezeVideo hCam IS_DONT_WAIT if 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 ...

Page 152: ... function you need to call is_FreeImageMem as well Otherwise there may be errors when the driver keeps trying to access this memory This does however not release the memory So you need to make sure that the memory will be released again Input Parameters hCam Camera handle pcImgMem Points to the starting address of the memory e g set in the is_AllocImageMem function id ID of this memory Return Valu...

Page 153: ...e started by a trigger if you previously enabled the trigger mode using is_SetExternalTrigger A hardware triggered image acquisition can be cancelled using is_StopLiveVideo if exposure has not started yet For further information on the image capture modes of the DCx camera camera see the How To Proceed Image Capture section Input Parameters hCam Camera handle Wait IS_DONT_WAIT Timeout value for im...

Page 154: ...rigger mode set high active flash mode and capture an image is_SetExternalTrigger hCam IS_SET_TRIGGER_SOFTWARE is_SetFlashStrobe hCam IS_SET_FLASH_HI_ACTIVE is_FreezeVideo hCam IS_WAIT Sample Programs SimpleAcquire C uc480aquire exe CSharpDemo uc480_csharp_demo exe ...

Page 155: ...ss 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 Input Parameters hCam Camera handle ppcMem Returns the pointer to the starting address of the active image memory pnID Returns the ID of the active image memory Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General...

Page 156: ...on but the running number from the order in which memory was allocated by the is_AddToSequence function Input Parameters hCam Camera handle pnNum Contains the number of the image memory currently used for image capturing If image capturing is already in progress when is_GetActSeqBuf is called pnNum will return the value 0 until the sequence arrives at the first image memory again ppcMem Contains t...

Page 157: ... the auto control features has been enabled using is_SetAutoParameter Input Parameters hCam Camera handle pinfo _UC480_AUTO_INFO structure see below Contents of the DCx camera_AUTO_INFO Structure INT AutoAbility Supported auto control features AC_SHUTTER Auto Shutter available AC_SENSOR_SHUTTER Sensor based Auto Shutter available AC_FRAMERATE Auto Frame Rate available AC_SENSOR_FRAMERATE Sensor ba...

Page 158: ...NNEL Value of the red channel AC_WB_GREEN_CHANNEL Value of the green channel AC_WB_BLUE_CHANNEL Value of the blue channel AUTO_WB_CHANNEL_STATUS RedChannel See AUTO_WB_CHANNEL_STATUS AUTO_WB_CHANNEL_STATUS GreenChannel See AUTO_WB_CHANNEL_STATUS AUTO_WB_CHANNEL_STATUS BlueChannel See AUTO_WB_CHANNEL_STATUS Contents of the DCx camera_AUTO_INFO AUTO_WB_STATUS AUTO_WB_CHANNEL_STATUS Structure INT cur...

Page 159: ...ost controller When the value 0 is passed for hCam the function checks whether a USB 2 0 controller is present in the system Input Parameters hCam Camera handle Return Values IS_SUCCESS IS_NO_SUCCESS Only if hCam 0 is passed No USB 2 0 controller present 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 ...

Page 160: ...sor ID see is_GetCameraList Contents of the CAMINFO Structure char SerNo 12 Serial number of the camera char ID 20 Manufacturer of the camera e g Thorlabs GmbH char Version 10 For USB cameras this value indicates the USB board hardware version e g V2 10 char Date 12 System date of the final quality check e g 01 08 2008 DD MM YYYY unsigned char Select Camera ID unsigned char Type Camera type IS_CAM...

Page 161: ...156 DCx camera 2010 Thorlabs Related Functions is_GetCameraType is_CameraStatus 159 121 ...

Page 162: ..._INFO uci 1 Placeholder for 1 n _UC480_CAMERA_INFO structures Contents of the _UC480_CAMERA_LIST _UC480_CAMERA_INFO Structure DWORD dwCameraID Customisable camera ID This ID is stored in the camera and is persistent DWORD dwDeviceID Internal device ID This ID ist generated by the driver depending on order of connection and camera type The device ID is not persistent DWORD dwSensorID Sensor ID DWOR...

Page 163: ...Functions is_GetNumberOfCameras Code Sample At least one camera must be available INT nNumCam if is_GetNumberOfCameras nNumCam IS_SUCCESS if nNumCam 1 Create new list with suitable size UC480_CAMERA_LIST pucl pucl UC480_CAMERA_LIST new char sizeof DWORD nNumCam sizeof UC480_CAMERA_IN FO pucl dwCount nNumCam Retrieve camera info if is_GetCameraList pucl IS_SUCCESS int iCamera for iCamera 0 iCamera ...

Page 164: ...2 0 USB 2 0 Syntax INT is_GetCameraType HIDS hCam Description is_GetCameraType returns the camera type Input Parameters hCam Camera handle Return Values IS_CAMERA_TYPE_UC480_USB_SE USB DCU camera IS_CAMERA_TYPE_UC480_USB_LE USB DCC camera Related Functions is_GetCameraInfo 155 ...

Page 165: ...dle CaptureErrorInfo Structure of the _UC480_CAPTURE_ERROR_INFO type that is filled by the DCx camera driver This structure then contains the error list SizeCaptureErrorInfo Indicates the size of the CaptureErrorInfo structure Contents of the _UC480_CAPTURE_ERROR_INFO Structure DWORD dwCapErrCnt_Total Returns the total number of errors occurred since the last reset BYTE reserved 60 Reserved for an...

Page 166: ...ocked destination memory Allocate more destination memory Reduce the frame rate so that there is more time to process the filled destination memory 2 Internal error during internal processing of the image 3 All destination buffers locked by the application Release locked destination memory Allocate more destination memory Reduce the frame rate so that there is more time to process the filled desti...

Page 167: ...ra 2010 Thorlabs Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related Functions is_ResetCaptureErrorInfo is_GetError is_CameraStatus is_SetErrorReport 207 166 121 250 ...

Page 168: ...ory Formats section Input Parameters hCam Camera handle ColorMode Colour mode for which the converter is to be returned For a list of all available colour formats and the associated input parameters see the Appendix Colour and Memory Formats section pCurrentConvertMode Currently selected converter for this colour mode pDefaultConvertMode Default converter for this colour mode pSupportedConvertMode...

Page 169: ..._SetColorMode function You need to pass the bit depth when allocating an image memory Input Parameters hCam Camera handle PnCol Returns the bit depth of the colour setting pnColMode Returns the DCx camera colour mode that corresponds to pnCol For a list of all available colour formats and the associated input parameters see the Appendix Color and Memory Formats section Return Values IS_SUCCESS Fun...

Page 170: ...tax INT is_GetDLLVersion Description Returns the version of the uc480 dll Input Parameters none Return Values The return value contains the version number which is coded as follows Bits 31 24 Major version Bits 23 16 Minor version Bits 15 0 Build version Related Functions is_GetOsVersion 180 ...

Page 171: ...is function after an error has occurred that returned IS_NO_SUCCESS Each error message will be overwritten when a new error occurs Input Parameters hCam Camera handle PErr Pointer to the variable containing the error code PpcErr Pointer to the string containing the error text Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related Functions is_GetCapture...

Page 172: ... values are comprised between min and max and can be set in increments defined by the intervall parameter Input Parameters hCam Camera handle min Returns the minimum available exposure time max Returns the maximum available exposure time intervall Returns the increment you can use to change the image exposure time Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error ...

Page 173: ... is_GetFramesPerSecond function returns the number of frames actually captured per second Input Parameters hCam Camera handle dblFPS Returns the current frame rate Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related Functions is_GetFrameTimeRange is_SetFrameRate is_GetPixelClockRange is_GetExposureRange is_GetExposureTime 124 169 259 181 167 167 ...

Page 174: ...ions will affect the frame duration is_SetPixelClock is_SetOptimalCameraTiming is_SetAOI if the image size is changed is_SetSubSampling is_SetBinning Changes made to the window size the frame rate or the read out timing pixel clock frequency also affect the defined frame duration For this reason you need to call is_GetFrameTimeRange again after such changes Input Parameters hCam Camera handle min ...

Page 175: ...170 DCx camera 2010 Thorlabs is_GetExposureTime 167 ...

Page 176: ...n before is_GetGlobalFlashDelays Otherwise incorrect values will be returned for Delay and Duration Global shutter cameras In freerun mode the exposure of global shutter cameras is delayed if the exposure time is not set to the maximum value is_GetGlobalFlashDelays determines the required delay in order to synchronise exposure and flash operation In triggered mode the return values for delay and f...

Page 177: ... ID ColorMode Colour mode of the image with the nID memory ID For a list of all available colour formats and the associated input parameters see the Appendix Colour and Memory Formats section pHistoMem Pointer to a DWORD array The array must be allocated in such a way that it can accommodate 3 256 values for colour formats and in raw Bayer mode In monochrome mode the array must be able to accommod...

Page 178: ...nY j for int i 0 i nX 3 i 3 pcSource i j nPitch 0 Blue pixels pcSource i j nPitch 1 i 3 Green pixels pcSource i j nPitch 2 255 Red pixels Create memory for RGB histogram DWORD bgrBuffer 256 3 Create pointer for each histogram colour DWORD pBlueHisto bgrBuffer DWORD pGreenHisto bgrBuffer 256 DWORD pRedHisto bgrBuffer 512 Retrieve histogram and release memory is_GetImageHistogram hCam nIDSource IS_S...

Page 179: ...iving the IS_FRAME event Using the function with USB DCx camera cameras The u64TimestampDevice timestamp returns the time when image data transfer to the PC was completed The _UC480TIME structure returns the timestamp with a resolution of 1 ms synchronized with the PC system time Image buffers that are part of a sequence need to be locked using is_LockSeqBuf This is important to ensure correct ass...

Page 180: ...n the camera Status Flags in _UC480IMAGEINFO dwIoStatus 0x00 00 Both GPIOs return 0 0x01 01 First GPIO returns 1 second GPIO returns 0 0x02 10 First GPIO returns 0 second GPIO returns 1 0x03 11 Both GPIOs return 1 Contents of the _UC480IMAGEINFO UC480TIME Structure WORD wYear Timestamp year WORD wMonth Timestamp month WORD wDay Timestamp day WORD wHour Timestamp hour WORD wMinute Timestamp minute ...

Page 181: ... long u64TimestampDevice u64TimestampDevice ImageInfo u64TimestampDevice CString Str Read out timestamp in system time Str Format 02d 02d 04d 02d 02d 02d 03d ImageInfo TimestampSystem wDay ImageInfo TimestampSystem wMonth ImageInfo TimestampSystem wYear ImageInfo TimestampSystem wHour ImageInfo TimestampSystem wMinute ImageInfo TimestampSystem wSecond ImageInfo TimestampSystem wMilliseconds DWORD ...

Page 182: ... you use ring buffering is_GetImageMem returns the starting address of the image memory last used for image capturing Input Parameters hCam Camera handle pMem Pointer to the starting address of the image memory Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related Functions is_GetImageMemPitch is_AllocImageMem is_AddToSequence is_SetImageMem is_SetAllo...

Page 183: ...eMem The line increment is always a number that can be divided by 4 The line increment is calculated as line width bitspixel 1 8 lineinc line adjust adjust 0 if line can be divided by 4 without remainder adjust 4 rest line 4 if line cannot be divided by 4 without remainder Input Parameters hCam Camera handle pPitch Pointer to the variable containing the line increment Return Values IS_SUCCESS Func...

Page 184: ... INT pnNumCams Description is_GetNumberOfCameras returns the number of DCx camera cameras connected to the PC Input Parameters pNumCams Returns the number of connected cameras Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related Functions is_GetCameraList is_GetEthDeviceInfo 157 ...

Page 185: ... Parameters none Return Values IS_OS_WIN2000 Windows 2000 operating system IS_OS_WINXP Windows XP operating system IS_OS_WINSERVER2003 Windows Server 2003 operating system IS_OS_WINVISTA Windows Vista operating system IS_OS_WIN7 Windows 7 operating system IS_OS_LINUX26 Linux 2 6 operating system IS_OS_UNDETERMINED Unknown operating system Related Functions is_GetDLLVersion 165 ...

Page 186: ...odel and operating mode For detailed information on the pixel clock range of a specific camera model please refer to the Individual Technical Data chapter Input Parameters hCam Camera handle pnMin Returns the lower limit value pnMax Returns the upper limit value Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related Functions is_SetPixelClock is_GetFram...

Page 187: ...O Structure WORD SensorID Returns the sensor type e g IS_SENSOR_UI224X_C Char strSensorName 32 Returns the camera model e g UI224xLE C Char nColorMode Returns the sensor colour mode IS_COLORMODE_BAYER IS_COLORMODE_MONOCHROME DWORD nMaxWidth Returns the maximum image width DWORD nMaxHeight Returns the maximum image height BOOL bMasterGain Indicates whether the sensor provides analogue master gain B...

Page 188: ...183 SDK Software development Kit 2010 Thorlabs Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related Functions is_GetCameraInfo is_CameraStatus 155 121 ...

Page 189: ...Images USB 2 0 USB 2 0 Syntax INT is_GetSupportedTestImages HIDS hCam INT SupportedTestImages Description is_GetSupportedTestImages returns all test images supported by the camera You can enable the sensor test image feature using is_SetSensorTestImage 283 ...

Page 190: ...TEST_IMAGE_COLOR_BARS1 Colour bars IS_TEST_IMAGE_COLOR_BARS2 Colour bars IS_TEST_IMAGE_GREY_AND_COLOR_BARS Grey and colour bars IS_TEST_IMAGE_MOVING_GREY_AND_COLOR_ BARS Grey and colour bars animated IS_TEST_IMAGE_ANIMATED_LINE Line animated IS_TEST_IMAGE_ALTERNATE_PATTERN Alternating pattern raw Bayer mode only IS_TEST_IMAGE_MONOCHROME_HORIZONTAL_ BARS Monochrome bars horizontal IS_TEST_IMAGE_MON...

Page 191: ...urn Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message IS_NOT_SUPPORTED The test image function is not supported by the camera Related Functions is_SetSensorTestImage is_GetTestImageValueRange 283 187 ...

Page 192: ... enable the sensor test image feature using is_SetSensorTestImage Input Parameters hCam Camera handle TestImage Test image for which the value range is queried TestImageValueMin Minimum value TestImageValueMax Maximum value Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message IS_NOT_SUPPORTED The test image function is not supported by the camera In this case...

Page 193: ...ned IS_TRIGGER_TIMEOUT Returns the timeout value in ms for triggered image capture pTimeout Pointer to the variable that holds the timeout value Returns 0 if the default value of the DCx camera API is used Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message IS_NOT_SUPPORTED The value for nMode is invalid IS_INVALID_PARAMETER The pTimeout pointer is NULL Rela...

Page 194: ...it s currently used by all initialised or selected cameras This is an approximate value which is calculated based on the pixel clock that has been set and the data format bits per pixel The actual data load on the bus can slightly deviate from this value Input Parameters hCam Camera handle Return Values INT value The total current bus bandwidth in Mbit s Related Functions is_SetPixelClock 277 ...

Page 195: ...GetVsyncCount reads out the VSYNC counter It will be incremented by 1 each time the sensor starts capturing an image Input Parameters hCam Camera handle pIntr Current VSYNC count pActIntr Current Frame SYNC count Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related Functions is_GetFramesPerSecond 168 ...

Page 196: ...ing process has started This function is helpful when the is_FreezeVideo function was called with the IS_DONT_WAIT parameter Input Parameters hCam Camera handle pbo Returns the digitising status 0 Image capturing has not started yet 1 Image capturing has started Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related Functions is_FreezeVideo is_IsVideoFi...

Page 197: ... Image Display Note on multi camera environments When using multiple cameras in parallel operation on a single system you should assign a unique camera ID to each camera To initialize or select a camera with is_InitCamera the phf handle must previously have been set to the desired camera ID To initialize or select the next available camera without specifying a camera ID phf has to be preset with 0...

Page 198: ...ter firmware is updated automatically Not for Thorlabs DCx cameras To ensure backward compatibility of applications always call is_InitCamera without the IS_ALLOW_STARTER_FW_UPLOAD parameter first Only if an error occurs call the function with this parameter set see Code Sample below hWnd Pointer to the window where the Direct3D image will be displayed If hWnd NULL DIB mode will be used for image ...

Page 199: ...needed if nRet IS_STARTER_FW_UPLOAD_NEEDED Calculate time needed for updating the starter firmware INT nTime is_GetDuration hCam IS_SE_STARTER_FW_UPLOAD nTime e g have progress bar displayed in separate thread Upload new starter firmware during initialization nRet is_InitCamera hCam IS_ALLOW_STARTER_FW_UPLOAD NULL end progress bar Sample Programs CSharpDemo C ...

Page 200: ...R_FAILED During the transfer data was lost IS_SET_EVENT_EXTTRIG An image which was captured following the arrival of a trigger has been transferred completely This is the earliest possible moment for a new capturing process The image must then be post processed by the driver and will be available after the IS_FRAME processing event IS_SET_EVENT_REMOVE A camera initialised with is_InitCamera was di...

Page 201: ...t CreateEvent NULL TRUE FALSE if hEvent NULL Enable frame event start image capture and wait for event is_InitEvent hCam hEvent IS_SET_EVENT_FRAME is_EnableEvent hCam IS_SET_EVENT_FRAME is_FreezeVideo hCam IS_DONT_WAIT if WaitForSingleObject hEvent 1000 WAIT_OBJECT_0 Image was captured successfully is_DisableEvent hCam IS_SET_EVENT_FRAME is_ExitEvent hCam IS_SET_EVENT_FRAME Sample Programs SimpleL...

Page 202: ...ry as allocated by is_AllocImageMem NID ID of the image memory as allocated by is_AllocImageMem pnX Returns the width used to define the image memory can be 0 pnY Returns the height used to define the image memory can be 0 pnBits Returns the bit width used to define the image memory can be 0 pnPitch Returns the line increment of the image memory can be 0 Return Values IS_SUCCESS Function executed ...

Page 203: ...m Camera handle pbo By setting pbo IS_TRANSFER_FAILED before calling the function pbo contains the following digitising status IS_VIDEO_NOT_FINISH Digitising of the image is not completed yet IS_VIDEO_FINISH Digitising of the image is completed By setting pbo IS_TRANSFER_FAILED before calling the function pbo contains the following digitising status IS_VIDEO_NOT_FINISH Digitising of the image is n...

Page 204: ...sing the is_SaveBadPixelCorrectionTable function Input Parameters hCam Camera handle File Pointer to a string which contains the name of the file where the coordinates are stored You can either pass an absolute or a relative path If NULL is passed the Open File dialogue opens Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related Functions is_SaveBadPix...

Page 205: ...ass an absolute or a relative path If NULL is passed the Open File dialogue opens Return Values IS_SUCCESS The image was loaded without errors IS_FILE_READ_INVALID_BMP_SIZE The size of the image to be loaded exceeds the active image memory size IS_FILE_READ_INVALID_BMP_ID The file to be loaded is not a valid bitmap file IS_FILE_READ_OPEN_ERROR The file could not be opened Related Functions Is_Load...

Page 206: ... again Input Parameters hCam Camera handle File Filename You can either pass an absolute or a relative path If NULL is passed the Open File dialogue opens ppcImgMem Pointer to a variable containing the starting address pid Pointer to a variable containing the memory ID Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message IS_FILE_READ_INVALID_BMP_ID Bitmap for...

Page 207: ...h parameters in the ini file match those in the allocated memory Otherwise display errors may occur Input Parameters hCam Camera handle pFilename Pointer to a filename You can either pass an absolute or a relative path For the internal camera parameter sets these would be cam set1 or cam set1 or cam set2 or cam set2 respectively If NULL is passed the Open File dialogue is displayed You can load th...

Page 208: ...till guaranteed You can lock any number of image memories at the same time Using the is_UnlockSeqBuf function you can re enable write access to the image memory Input Parameters hCam Camera handle nNum Number of the image memory to be locked 1 max or IS_IGNORE_PARAMETER The image memory will be identified by its starting address only pcMem Starting address of the image memory to be locked nNum ind...

Page 209: ...rmation the EEPROM of the DCx camera can hold 64 bytes of user data Input Parameters hCam Camera handle Adr Starting address for data reads Value range 0 63 pcString Pointer to the buffer for the data to read min size Count Count Number of characters to read Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related Functions is_WriteEEPROM Code Sample char...

Page 210: ...ap DIB mode the color format UYVY is not supported Input Parameters hCam Camera handle nMemID ID of the image memory whose contents is to be displayed hwnd Output window handle nMode IS_RENDER_NORMAL The image is rendered normally It will be displayed in 1 1 scale as stored in the image memory IS_RENDER_FIT_TO_WINDOW The image size is adjusted to fit the output window IS_RENDER_DOWNSCALE_1_2 Displ...

Page 211: ...206 DCx camera 2010 Thorlabs Code Sample Fit image to window and display it upside down is_RenderBitmap hCam nMemID hwnd IS_RENDER_FIT_TO_WINDOW IS_RENDER_MIRROR_UPDOWN Sample Programs uc480Acquire C ...

Page 212: ...reErrorInfo deletes the list of errors that occurred while images were being captured You can retrieve this list using the is_GetCaptureErrorInfo function Input Parameters hCam Camera handle Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related Functions is_GetCaptureErrorInfo is_GetError is_CameraStatus 160 160 166 121 ...

Page 213: ...ific defaults as specified by the driver By default the camera uses full resolution a medium speed and colour level gain values adapted to daylight exposure All optional features are disabled Input Parameters hCam Camera handle Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related Functions is_LoadParameters is_SaveParameters 202 216 ...

Page 214: ... specified file Input Parameters hCam Camera handle File Pointer to a string which contains the name of the file where the coordinates are stored You can either pass an absolute or a relative path If NULL is passed the Save as dialogue will be displayed Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related Functions is_LoadBadPixelCorrectionTable is_Se...

Page 215: ...or that was set for the current colour mode in Direct3D mode In Direct3D mode overlay data is not saved Input Parameters hCam Camera handle File Pointer to a string containing the BMP filename You can either pass an absolute or a relative path If NULL is passed the Save as dialogue will be displayed Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related...

Page 216: ...t saved Input Parameters hCam Camera handle File Pointer to a string containing the BMP filename You can either pass an absolute or a relative path If NULL is passed the Save as dialogue will be displayed fileFormat Specifies the output format of the file IS_IMG_BMP Bitmap format IS_IMG_JPG JPEG format Param When you use IS_IMG_JPG to specify the file format you can set the quality by specifying a...

Page 217: ...212 DCx camera 2010 Thorlabs Related Functions is_SaveImage is_SaveImageMem is_SaveImageMemEx is_LoadImage Is_LoadImageMem is_GetImageMem is_SetImageMem 210 213 214 200 201 177 270 ...

Page 218: ...with a colour depth of 8 or 24 bits In Direct3D mode overlay data is not saved Input Parameters hCam Camera handle File Pointer to a string containing the BMP filename You can either pass an absolute or a relative path If NULL is passed the Save as dialogue will be displayed pcMem Pointer to the image memory nID Image memory ID You can link USE_ACTUAL_IMAGE_SIZE and nID by a logical OR to save the...

Page 219: ...e overlay data is not saved Input Parameters hCam Camera handle File Pointer to a string containing the BMP filename You can either pass an absolute or a relative path If NULL is passed the Save as dialogue will be displayed pcMem Pointer to the image memory nID Image memory ID fileFormat Specifies the output format of the file IS_IMG_BMP Bitmap format IS_IMG_JPG JPEG format Param When you use IS_...

Page 220: ...215 SDK Software development Kit 2010 Thorlabs Related Functions is_SaveImage is_SaveImageEx is_SaveImageMem is_LoadImage Is_LoadImageMem is_GetImageMem is_SetImageMem 210 211 213 200 201 177 270 ...

Page 221: ...i file Input Parameters hCam Camera handle pFileName Pointer to a filename You can either pass an absolute or a relative path For internal parameter sets these are cam set1 or cam set1 or cam set2 or cam set2 respectively If NULL is passed the Save as dialogue will be displayed You can save two parameter sets in the non volatile EEPROM of the camera using specific filenames pFileName cam set1 or c...

Page 222: ...The address of this memory will be passed to the DCx camera driver For this you can use the is_SetAllocatedImageMem function In addition you need to specify the image size just as you do when calling is_AllocImageMem The returned memory ID is required by other functions for memory access The memory area must be removed from the driver management again using the is_FreeImageMem function Please note...

Page 223: ...218 DCx camera 2010 Thorlabs Related Functions is_AllocImageMem is_FreeImageMem is_AddToSequence is_SetImageMem is_GetColorDepth is_GetImgMemPitch 119 147 118 270 164 178 ...

Page 224: ...g or sub sampling the auto AOIs will always be reset to the image AOI value i e to maximum size This means that it might be necessary to set the AOIs for the auto features again manually Changes to the image geometry or pixel clock affect the value ranges of the frame rate and exposure time After executing is_SetAOI calling the following functions is recommended in order to keep the defined camera...

Page 225: ... 0 XPosMax IS_SET_IMAGEPOS_X_ABS Applies the absolute position to the memory as well pYPos Pointer to the vertical position of the AOI Returns the current setting when used together with the IS_GET_ parameters 0 YPosMax IS_SET_IMAGEPOS_Y_ABS Applies the absolute position to the memory as well pWidth Pointer to the width of the AOI Returns the current setting when used together with the IS_GET_ par...

Page 226: ...ntrol chapter Control is only active as long as the camera is capturing images A manual change of the exposure time and gain settings disables the auto functions When the auto shutter function is enabled you cannot modify the pixel clock frequency The auto frame rate function is only available when the auto shutter control is on Auto frame rate and auto gain cannot be used simultaneously The auto ...

Page 227: ...ER Enables disables the auto exposure function pval1 1 enables 0 disables control IS_GET_ENABLE_AUTO_SHUTTER Returns the current auto exposure setting pval1 returns the current value IS_SET_ENABLE_AUTO_SENSOR _SHUTTER Enables disables the sensor s internal auto exposure function pval1 1 enables 0 disables control IS_GET_ENABLE_AUTO_SENSOR_SHUTTER Returns the current setting of the sensor s interna...

Page 228: ...tware development Kit 2010 Thorlabs IS_GET_ENABLE_AUTO_SENSOR_FRAMERATE Returns the current setting of the sensor s internal auto frame rate function pval1 returns the current value Adjust auto gain auto exposure ...

Page 229: ... speed value for auto gain auto exposure pval1 returns the current value IS_SET_AUTO_HYSTERESIS Sets the hysteresis for auto gain auto exposure pval1 defines the hysteresis value default 2 IS_GET_AUTO_HYSTERESIS Returns the hysteresis for auto gain auto exposure pval1 returns the current value IS_GET_AUTO_HYSTERESIS_RANGE Returns range for the hysteresis value pval1 returns the minimum value pval2...

Page 230: ...S_SET_AUTO_WB_HYSTERESIS Sets the hysteresis for auto white balance pval1 defines the hysteresis value default 2 IS_GET_AUTO_WB_HYSTERESIS Returns the hysteresis for auto white balance pval1 returns the current value IS_GET_AUTO_WB_HYSTERESIS_RANGE Returns range for the hysteresis value pval1 returns the minimum value pval2 returns the maximum value IS_SET_AUTO_WB_SKIPFRAMES Sets the number of fra...

Page 231: ... balance offset IS_DEFAULT_AUTO_WB_SPEED Default value for auto white balance speed IS_MIN_AUTO_WB_SPEED Minimum value for auto white balance speed IS_MAX_AUTO_WB_SPEED Maximum value for auto white balance speed Not supported by all sensors see info box above Not available when the sensor s internal controls are activated Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS Genera...

Page 232: ...227 SDK Software development Kit 2010 Thorlabs double maxShutter int ret is_SetAutoParameter hCam IS_GET_AUTO_SHUTTER_MAX maxShutter 0 ...

Page 233: ...e correction based on the hot pixel list stored in the EEPROM IS_BPC_ENABLE_USER Enables software correction based on user defined values First the is_SetBadPixelCorrectionTable function must be called IS_GET_BPC_MODE Returns the current mode IS_GET_BPC_THRESHOLD Returns the current threshold value threshold Currently not used Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS G...

Page 234: ...n Y A table with 3 hot pixels must be structured as follows 3 X1 Y1 X2 Y2 X3 Y3 Input Parameters hCam Camera handle nMode IS_SET_BADPIXEL_LIST Sets a new user defined list The pList parameter points to a list which has the format described above IS_GET_LIST_SIZE Returns the number of pixel coordinates included in the user defined list IS_GET_BADPIXEL_LIST Copies the user defined list to the pList ...

Page 235: ... coordinates in the list DWORD nCount is_SetBadPixelCorrectionTable hCam IS_GET_LIST_SIZE NULL Allocate memory for the entire list pList new WORD 1 2 nCount Read out list is_SetBadPixelCorrectionTable hCam IS_GET_BADPIXEL_LIST pList Release the list again delete pList ...

Page 236: ...al binning parameters by a logical OR The adjustable binning factors of each sensor are listed in the Specifications Sensors chapter Some sensors allow a higher pixel clock setting if binning or subsampling has been activated If you set a higher pixel clock and then reduce the binning subsampling factors again the driver will automatically select the highest possible pixel clock for the new settin...

Page 237: ...he current setting IS_GET_BINNING_FACTOR _VERTICAL Returns the vertical binning factor IS_GET_BINNING_FACTOR _HORIZONTAL Returns the horizontal binning factor IS_GET_SUPPORTED_BINNING Returns the supported binning modes IS_GET_BINNING_TYPE Indicates whether the camera uses colour proof binning IS_BINNING_COLOR or not IS_BINNING_MONO Return Values IS_SUCCESS Function executed successfully IS_NO_SUC...

Page 238: ...233 SDK Software development Kit 2010 Thorlabs is_SetImagePos is_SetPixelClock 271 277 ...

Page 239: ...tion enables the black level correction function which might improve the image quality under certain circumstances By default the sensor adjusts the black level value for each pixel automatically If the environment is very bright it can be necessary to adjust the black level manually FIGURE_TEXT IMAGE Black level correction Auto FIGURE_TEXT IMAGE Schwarzwert Korrektur nur Offset ...

Page 240: ...the default value for offset IS_GET_BL_SUPPORTED_MODE Returns the supported modes Possible values IS_BL_COMPENSATION_ENABLE The sensor supports automatic black level correction IS_BL_COMPENSATION_OFFSET For the sensor used it is also possible to set the offset manual IS_IGNORE_PARAMETER The nEnable parameter is ignored offset Contains the offset value used for compensation Valid values are between...

Page 241: ... camera ID is stored in the non volatile memory of the camera The factory default camera ID is 1 The camera ID can also be changed in the Camera Manager Input Parameters hCam Camera handle nID 1 254 New camera ID IS_GET_CAMERA_ID Returns the current ID Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Current ID when used together with IS_GET_CAMERA_ID Rel...

Page 242: ...iveVideo or set the camera to trigger mode see also is_SetExternalTrigger Input Parameters hCam Camera handle ColorMode Colour mode for which the converter is to be set For a list of all available colour formats and the associated input parameters see the Appendix Colour and Memory Formats section ConvertMode Conversion mode selection IS_CONV_MODE_SOFTWARE_3x3 Software conversion using the standar...

Page 243: ...238 DCx camera 2010 Thorlabs Related Functions is_GetColorConverter is_SetColorMode is_ConvertImage 163 241 127 ...

Page 244: ...meter replaces IS_CCOR_ENABLE IS_CCOR_ENABLE_BG40_ENHANCED Enables colour correction for cameras with optical IR filter glasses of the BG40 type IS_CCOR_ENABLE_HQ_ENHANCED Enables colour correction for cameras with optical IR filter glasses of the HQ type IS_CCOR_DISABLE Disables colour correction IS_GET_CCOR_MODE Returns the current setting IS_GET_SUPPORTED_CCOR_MODE Returns all supported colour ...

Page 245: ...ther with IS_GET_DEFAULT_CCOR_MODE When used for colour cameras and together with IS_GET_DEFAULT_CCOR_MODE this parameter returns the default colour correction mode IS_CCOR_ENABLE_NORMAL IS_CCOR_ENABLE_HQ_ENHANCED When used for monochrome cameras the system returns 0 Related Functions is_SetColorConverter is_SetColorMode is_SetAutoParameter 237 241 221 ...

Page 246: ...phics card For this purpose the allocated image memory must be large enough to accommodate the data with the selected colour mode When images are transferred directly to the graphics card memory make sure that the display settings match the colour mode settings Otherwise the images will be displayed with altered colours or are not clearly visible For the RGB16 and RGB15 data formats the MSBs of th...

Page 247: ...RGB32 8 8 8 IS_CM_RGBY8_PACKED RGBY 8 8 8 8 IS_CM_RGB8_PACKED RGB24 8 8 8 IS_CM_BGR10V2_PACKED BGR30 10 10 10 IS_CM_BGRA8_PACKED BGR32 8 8 8 IS_CM_BGR8_PACKED BGR24 8 8 8 IS_CM_BGRY8_PACKED BGRY 8 8 8 IS_CM_BGR565_PACKED BGR16 5 6 5 IS_CM_BGR555_PACKED BGR15 5 5 5 IS_CM_UYVY_PACKED UYVY 8 8 8 8 IS_CM_UYVY_MONO_PACKED UYVY 8 8 8 8 IS_CM_UYVY_BAYER_PACKED UYVY 8 8 8 8 IS_CM_CBYCRY_PACKED CbYCrY 8 8 ...

Page 248: ...243 SDK Software development Kit 2010 Thorlabs is_SetColorConverter is_SetColorCorrection is_GetColorDepth is_AllocImageMem 237 239 164 119 ...

Page 249: ...nversion mode IS_SET_BAYER_CV_BETTER Better quality IS_SET_BAYER_CV_BEST Optimum quality higher CPU load ColorMode Sets the colour mode for the output image For a list of all available colour formats and the associated input parameters see the Appendix Colour and Memory Formats section Gamma Gamma value multiplied by 100 Range 1 1000 WhiteBalanceMultipliers Pointer to an array containing the red g...

Page 250: ...i Define conversion parameters example INT Gamma 120 double rgbGains 3 rgbGains 0 1 0 Red channel gain rgbGains 1 3 0 Green channel gain rgbGains 2 1 0 Blue channel gain char pcDest Pointer to the newly allocated image memory INT nIDDest ID of the newly allocated image memory Set conversion parameters nRet is_SetConvertParam hCam TRUE IS_SET_BAYER_CV_BETTER IS_SET_CM_RGB24 Gamma rgbGains Convert i...

Page 251: ...pplication is_InitCamera is_SetDisplayMode is_ExitCamera See also Programming Thread Programming Input Parameters hCam Camera handle Mode IS_SET_DM_DIB Captures an image in system memory RAM Using is_RenderBitmap you can define the image display default IS_SET_DM_DIRECT3D Image display in Direct3D mode IS_SET_DM_DIRECT3D IS_SET_DM_MONO Monochrome image display in Direct3D mode IS_GET_DISPLAY_MODE ...

Page 252: ...General error message Current setting when used together with IS_GET_DISPLAY_MODE Related Functions is_RenderBitmap is_SetColorMode is_DirectRenderer Code Sample is_SetDisplayMode hCam Mode Bitmap mode images are digitised and stored in system memory Mode IS_SET_DM_DIB Direct3D mode Mode IS_SET_DM_DIRECT3D 205 241 130 ...

Page 253: ...interest when rendering images using is_RenderBitmap This does not alter the image memory contents Input Parameters hCam Camera handle x Offset in x direction y Offset in y direction Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related Functions is_SetImagePos is_SetAOI is_RenderBitmap is_SetDisplayMode 205 271 219 205 246 ...

Page 254: ...e filter you can optimise edge representation This function causes a higher CPU load Input Parameters hCam Camera handle nEnable IS_EDGE_EN_DISABLE Disables the edge filter IS_EDGE_EN_STRONG Enables strong edge enhancement IS_EDGE_EN_WEAK Enables weaker edge enhancement IS_GET_EDGE_ENHANCEMENT Returns the current setting Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General...

Page 255: ...s using the is_GetError function is_SetErrorReport can be called before calling is_InitCamera You only need to enable the is_SetErrorReport function once for all cameras in the application Input Parameters hCam Camera handle or 0 if no camera has been initialised yet Mode IS_DISABLE_ERR_REP Disables error reporting IS_ENABLE_ERR_REP Enables error reporting Return Values IS_SUCCESS Function execute...

Page 256: ...etimes allow an extended value range for the exposure time setting We recommend to query the value range every time and set the exposure time explicitly The use of the following functions will affect the exposure time is_SetPixelClock is_SetOptimalCameraTiming is_SetFrameRate if the new image duration is shorter that the exposure time is_SetAOI if the image size is changed is_SetSubSampling is_Set...

Page 257: ...ues IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related Functions is_GetExposureRange is_SetFrameRate is_SetPixelClock is_SetOptimalCameraTiming is_SetAutoParameter is_SetHardwareGain 167 259 277 275 221 264 ...

Page 258: ...level at the trigger input This option causes the camera to change to freerun mode For further information on the image capture modes of the DCx camera camera see the How To Proceed Image Capture section Input Parameters hCam Camera handle nTriggerMode Trigger mode Trigger event IS_SET_TRIGGER_OFF Off IS_SET_TRIGGER_HI_LO Hardware trigger Falling signal edge IS_SET_TRIGGER_LO_HI Hardware trigger R...

Page 259: ...l at the trigger input When used with IS_GET_SUPPORTED_TRIGGER_MODE Returns the supported modes linked by logical ORs Related Functions is_CaptureVideo is_FreezeVideo is_ForceTrigger is_SetTriggerCounter is_SetTriggerDelay is_SetFlashStrobe Code Sample Enable trigger mode and set high active flash mode is_SetExternalTrigger hCam IS_SET_TRIGGER_SOFTWARE is_SetFlashStrobe hCam IS_SET_FLASH_HI_ACTIVE...

Page 260: ...LASH_DELAY Returns the currently set delay time IS_GET_FLASH_DURATION Returns the currently set flash duration IS_GET_MIN_FLASH_DELAY Returns the minimum value for the delay IS_GET_MIN_FLASH_DURATION Returns the minimum value for the flash duration IS_GET_MAX_FLASH_DELAY Returns the maximum value for the delay IS_GET_MAX_FLASH_DURATION Returns the maximum value for the flash duration IS_GET_FLASH_...

Page 261: ...256 DCx camera 2010 Thorlabs is_SetTriggerDelay 289 ...

Page 262: ...ever you change the pixel clock setting or horizontal image geometry This is necessary to newly synchronise the internal timing settings of the flash output with the start of sensor exposure Input Parameters hCam Camera handle nMode IS_SET_FLASH_OFF Disables the strobe output IS_SET_FLASH_LO_ACTIVE Sets the strobe output to low active trigger mode only IS_SET_FLASH_HI_ACTIVE Sets the strobe output...

Page 263: ...s_SetFlashDelay is_SetTriggerDelay is_GetGlobalFlashDelays is_SetExternalTrigger is_CaptureVideo Code Sample Enable trigger mode and set high active flash mode is_SetExternalTrigger hCam IS_SET_TRIGGER_SOFTWARE is_SetFlashStrobe hCam IS_SET_FLASH_HI_ACTIVE 0 is_FreezeVideo hCam IS_WAIT Enable additional flash output on GPIO 2 is_SetFlashStrobe hCam IS_SET_FLASH_HI_ACTIVE IS_SET_FLASH_IO_2 0 Flash ...

Page 264: ...OptimalCameraTiming is_SetAOI if the image size is changed is_SetSubSampling is_SetBinning Changes made to the window size or the read out timing pixel clock frequency also affect the defined frame rate For this reason you need to call is_SetFrameRate again after such changes Newer driver versions sometimes allow an extended value range for the frame rate setting We recommend to query the value ra...

Page 265: ...ed Functions is_GetFramesPerSecond is_GetFrameTimeRange is_SetPixelClock is_SetOptimalCameraTiming is_SetExposureTime is_SetAutoParameter is_SetAOI is_SetSubSampling is_SetBinning is_CaptureVideo 168 169 277 275 251 221 219 284 231 124 ...

Page 266: ... IS_SET_GAINBOOST_OFF Disables the gain boost function IS_GET_SUPPORTED_GAINBOOST Indicates whether the camera supports a gain boost feature or not Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Current setting when used together with IS_GET_GAINBOOST Returns 0 if the camera does not support a gain boost feature Current setting when used together with I...

Page 267: ...aracteristic LUT Valid values are in the range between 0 01 and 10 Input Parameters hCam Camera handle nGamma Gamma value to be set multiplied by 100 Range 1 1000 Default 100 corresponds to a gamma value of 1 0 IS_GET_GAMMA Returns the current setting Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Current setting when used together with IS_GET_GAMMA Rel...

Page 268: ...nt mode or IS_NOT_SUPPORTED if the camera does not support this function IS_SET_GLOBAL_SHUTTER_ON Enables Global Start shutter mode IS_SET_GLOBAL_SHUTTER_OFF Disables Global Start shutter mode IS_GET_SUPPORTED_GLOBAL_SHUTTERIndicates whether the connected camera supports the Global Start shutter or not Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Curr...

Page 269: ...se the is_GetSensorInfo function to query the available gain controls Depending on the time when the gain settings are changed these changes might only become effective when the next image is captured Enabling hardware gain increases not only the image brightness but also the image noise We recommend to use gain values below 50 for normal operation The default setting values for the red green and ...

Page 270: ...gain factor IS_SET_ENABLE_AUTO_GAIN Enables the auto gain functionality see also is_SetAutoParameter You can disable the auto gain functionality by setting a value for nMaster nRed Sets the red channel gain factor 0 100 IS_IGNORE_PARAMETER The channel gain factor will not be changed nGreen Sets the green channel gain factor 0 100 IS_IGNORE_PARAMETER The green channel gain factor will not be change...

Page 271: ...266 DCx camera 2010 Thorlabs is_SetGainBoost is_SetAutoParameter 261 221 ...

Page 272: ...tor IS_GET_GREEN_GAIN_FACTOR Returns the green channel gain factor IS_GET_BLUE_GAIN_FACTOR Returns the blue channel gain factor IS_SET_MASTER_GAIN_FACTOR Sets the master gain factor IS_SET_RED_GAIN_FACTOR Sets the red channel gain factor IS_SET_GREEN_GAIN_FACTOR Sets the green channel gain factor IS_SET_BLUE_GAIN_FACTOR Sets the blue channel gain factor IS_GET_DEFAULT_MASTER_GAIN_FACTOR Returns th...

Page 273: ...unction executed successfully IS_NO_SUCCESS General error message Current setting when used together with IS_GET_MASTER_GAIN_FACTOR IS_GET_RED_GAIN_FACTOR IS_GET_GREEN_GAIN_FACTOR IS_GET_BLUE_GAIN_FACTOR Defined setting when used together with IS_SET_MASTER_GAIN_FACTOR IS_SET_RED_GAIN_FACTOR IS_SET_GREEN_GAIN_FACTOR IS_SET_BLUE_GAIN_FACTOR Default setting when used together with IS_GET_DEFAULT_MAS...

Page 274: ... gain factor to 3 57 INT ret is_SetHWGainFactor hCam IS_SET_MASTER_GAIN_FACTOR 357 ret has the value 363 for the UI 1460 C Query the maximum gain factor for the red channel ret is_SetHWGainFactor hCam IS_INQUIRE_RED_GAIN_FACTOR 100 ret has the value 725 for the UI 1460 C ...

Page 275: ...pointer will result in an error message You may pass the same pointer multiple times In the Direct3D modes there is no need to set an image memory If you want the application to be compatible with the FALCON SDK make sure to call is_SetImageSize after is_SetImageMem Input Parameters hCam Camera handle pcImgMem Pointer to the starting position in the memory id ID of this memory Return Values IS_SUC...

Page 276: ...ges to the image geometry or pixel clock affect the value ranges of the frame rate and exposure time After executing is_SetBinning calling the following functions is recommended in order to keep the defined camera settings is_SetFrameRate is_SetExposureTime If you are using the DCx camera s flash function is_SetFlashStrobe Input Parameters The x and y parameters represent an offset with respect to...

Page 277: ...S_GET_IMAGE_POS_Y_MIN Returns the minimum value for the vertical AOI position IS_GET_IMAGE_POS_Y_MAX Returns the maximum value for the vertical AOI position IS_GET_IMAGE_POS_Y_INC Returns the increment for the vertical AOI position IS_GET_IMAGE_POS_Y_ABS Returns the absolute vertical position in the memory y 0 yMax Sets the vertical position 0 yMax IS_SET_IMAGE_POS_Y_ABS Applies the absolute posit...

Page 278: ...273 SDK Software development Kit 2010 Thorlabs Example Figure IMAGE Examples for is_SetImagePos ...

Page 279: ...era housing The is_SetLED function is only supported by DCU cameras Input Parameters hCam Camera handle nValue IS_SET_LED_OFF Switches LED to red IS_SET_LED_ON Switches LED to green IS_SET_LED_TOGGLE Toggles between red and green Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related Functions is_SetIO is_SetFlashStrobe is_SetExternalTrigger 257 253 ...

Page 280: ...ational load caused by additional colour conversions etc Otherwise it will not able to return the optimum values Input Parameters hCam Camera handle Mode IS_BEST_PCLK_RUN_ONCE The function makes one attempt to determine the optimum pixel clock and returns immediately Timeout 4000 20000 Sets the period in milliseconds during which no transfer error may occur The adjustable range is between 4 and 20...

Page 281: ...276 DCx camera 2010 Thorlabs Related Functions is_SetPixelClock is_SetFrameRate is_SetAutoParameter is_CaptureVideo 277 259 221 124 ...

Page 282: ...l clock affect the value ranges of the frame rate and exposure time After executing is_SetPixelClock calling the following functions is recommended in order to keep the defined camera settings is_SetFrameRate is_SetExposureTime If you are using the DCx camera s flash function is_SetFlashStrobe Input Parameters hCam Camera handle Clock Pixel clock frequency to be set in MHz IS_GET_PIXEL_CLOCK Curre...

Page 283: ...278 DCx camera 2010 Thorlabs is_SetSubSampling is_SetAOI 284 219 ...

Page 284: ...P_MIRROR_LEFTRIGHT Mirrors the image along the vertical axis Depending on the sensor this operation is performed in the camera or in the PC software IS_GET_ROP_EFFECT Returns the current settings param Turns the Rop effect on off 0 Turn off 1 Turn on reserved Reserved 0 must be passed Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Current setting when u...

Page 285: ...V are converted using a driver matrix Input Parameters hCam Camera handle ChromU U saturation value multiplied by 100 Range IS_MIN_SATURATION IS_MAX_SATURATION IS_GET_SATURATION_U Returns the current value for the U saturation ChromV V saturation value multiplied by 100 Range IS_MIN_SATURATION IS_MAX_SATURATION IS_GET_SATURATION_V Returns the current value for the V saturation Return Values IS_SUC...

Page 286: ...ameters hCam Camera handle nMode Function mode IS_ENABLE_SENSOR_SCALER Enable image scaling IS_ENABLE_SENSOR_SCALER IS_ENABLE_ANTI_ALIASING Enable image scaling with smoothed edges anti alising effect dblFactor Scaling factor Return Values IS_SUCCESS Function executed successfully IS_INVALID_PARAMETER General error message IS_NOT_SUPPORTED The test image function is not supported by the camera IS_...

Page 287: ... DCx camera 2010 Thorlabs Enable scaling with anti aliasing dblNewFactor Info dblMinFactor Info dblFactorIncrement nRet is_SetSensorScaler hCam IS_ENABLE_SENSOR_SCALER IS_ENABLE_ANTI_ALIASING dblNewFactor ...

Page 288: ...des additional options If the test image does not support additional parameters Param will be ignored Input Parameters hCam Camera handle TestImage The test image to be set See also is_GetSupportedTestImages Param Additional parameter for used to modify the test image Not available for all test images Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message IS_IN...

Page 289: ... In case of fine image structures this can result in slight artifacts The adjustable sub sampling factors of each sensor are listed in Specifications Sensors chapter Some sensors allow a higher pixel clock setting if binning or subsampling has been activated If you set a higher pixel clock and then reduce the binning subsampling factors again the driver will automatically select the highest possib...

Page 290: ...r 4 IS_SUBSAMPLING_5X_HORIZONTAL Enables horizontal sub sampling with factor 5 IS_SUBSAMPLING_6X_HORIZONTAL Enables horizontal sub sampling with factor 6 IS_SUBSAMPLING_8X_HORIZONTAL Enables horizontal sub sampling with factor 8 IS_SUBSAMPLING_16X_HORIZONTAL Enables horizontal sub sampling with factor 16 IS_GET_SUBSAMPLING Returns the current setting IS_GET_SUBSAMPLING_FACTOR_VERTICAL Returns the ...

Page 291: ...286 DCx camera 2010 Thorlabs is_SetAOI is_SetImagePos is_SetPixelClock 219 271 277 ...

Page 292: ...ecified camera at runtime of the program Input Parameters hCam Camera handle nMode Selects the timeout value to be set IS_TRIGGER_TIMEOUT Sets the timeout value for triggered image capture Timeout Timeout value in 10 ms Value range 0 4 429496729 corresponds to 40 ms to approx 1193 hours 0 use default value of the DCx camera API For 1 3 the value 4 is used Return Values IS_SUCCESS Function executed...

Page 293: ... can read out the camera s internal counter for incoming hardware triggers Input Parameters hCam Camera handle nValue IS_GET_TRIGGER_COUNTER Returns the current hardware trigger count Other values Resets the hardware trigger counter Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related Functions is_SetExternalTrigger is_CameraStatus 253 121 ...

Page 294: ...tions Sensors chapter Input Parameters hCam Camera handle nTriggerDelay Time by which the image capture is delayed in µs IS_GET_TRIGGER_DELAY Returns the currently set delay time IS_GET_MIN_TRIGGER_DELAY Returns the minimum adjustable value IS_GET_MAX_TRIGGER_DELAY Returns the maximum adjustable value IS_GET_TRIGGER_DELAY_GRANULARITY Returns the resolution of the adjustable delay time Return Value...

Page 295: ...t yet started Input Parameters hCam Camera handle Wait IS_WAIT The function waits until the image save is complete IS_DONT_WAIT The function returns immediately Digitising the image is completed in the background IS_FORCE_VIDEO_STOP Digitising is stopped immediately Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related Functions is_FreezeVideo is_Captu...

Page 296: ...s re inserted at its previous position in the sequence list Input Parameters hCam Camera handle nNum Number of the image memory to unlock When you pass IS_IGNORE_PARAMETER the image memory is only identified by its starting address nNum identifies the position in the sequence list not the memory ID assigned with is_AllocImageMem pcMem Starting address of the image memory Return Values IS_SUCCESS F...

Page 297: ...ms that the function will wait for an event to occur Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message IS_TIMED_OUT The specified timeout expired without the event having occurred Related Functions is_InitEvent is_EnableEvent is_DisableEvent is_ExitEvent Code Sample Activate and initialise FRAME event is_EnableEvent hCam IS_SET_EVENT_FRAME is_InitEvent hCa...

Page 298: ...factory information the EEPROM of the DCx camera can hold 64 bytes of user data Input Parameters hCam Camera handle Adr Starting address for data writes 0 63 pcString Pointer to the string containing the data to be written Count Number of characters to be written 1 64 Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message IS_INVALID_MODE Camera is in standby mo...

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

Page 300: ... pcImageMem Pointer to the memory containing the image 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 IS_AVI_ERR_COMPRESSION_RUN The current image could not be processed since compression is still in progress IS_AVI_ERR_INVALID_FI...

Page 301: ..._OpenAVI Input Parameters nAviID Instance ID set by the isavi_InitAVI function 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_OpenAVI isavi_InitAVI isavi_ExitAVI 308 305 299 308 305 299 ...

Page 302: ...eters nAviID Instance ID set by the isavi_InitAVI function which Name of the event to be disabled IS_AVI_SET_EVENT_FRAME_SAVED A new frame was saved to the AVI file 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 IS_AVI_ERR_PARAMET...

Page 303: ...tance ID set by the isavi_InitAVI function which Name of the event to be enabled IS_AVI_SET_EVENT_FRAME_SAVED A new frame was saved to the AVI file 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 IS_AVI_ERR_PARAMETER An invalid eve...

Page 304: ... Parameters nAviID Instance ID set by the isavi_InitAVI function 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 IS_AVI_ERR_INVALID_FILE The AVI file could not be closed Related Functions isavi_InitAVI isavi_OpenAVI isavi_CloseAVI ...

Page 305: ...set by the isavi_InitAVI function which Name of the event to be deleted IS_AVI_SET_EVENT_FRAME_SAVED A new frame was saved to the AVI file 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 IS_AVI_ERR_PARAMETER An invalid event was sp...

Page 306: ...Input Parameters nAviID Instance ID set by the isavi_InitAVI function strName Pointer to the memory location where the filename is written to The allocated memory must be large enough to accommodate the full file path NULL When NULL is passed the function returns the length of the filename Return Values IS_AVI_NO_ERR Function executed successfully IS_AVI_ERR_INVALID_ID The indicated AVI instance c...

Page 307: ...nce saved to the current AVI file Input Parameters nAviID Instance ID set by the isavi_InitAVI function size The size in kBytes Return Values IS_AVI_NO_ERR Function executed successfully IS_AVI_ERR_INVALID_ID The designated AVI instance could not be found Either the AVI ID is invalid or the instance was already deleted using isavi_ExitAVI Related Functions isavi_GetAVIFileName 305 299 301 ...

Page 308: ...er of frames saved to the current AVI file Input Parameters nAviID Instance ID set by the isavi_InitAVI function nFrames The number of frames Return Values IS_AVI_NO_ERR Function executed successfully IS_AVI_ERR_INVALID_ID The indicated AVI instance could not be found Either the AVI ID is invalid or the instance has already been deleted using isavi_ExitAVI Related Functions isavi_GetnLostFrames is...

Page 309: ...cannot be processed because a compression operation in still in progress Input Parameters nAviID Instance ID set by the isavi_InitAVI function nFrames The number of frames Return Values IS_AVI_NO_ERR Function executed successfully IS_AVI_ERR_INVALID_ID The indicated AVI instance could not be found Either the AVI ID is invalid or the instance has already been deleted using isavi_ExitAVI Related Fun...

Page 310: ... which is needed for calling the other DCx camera AVI functions hCam Handle of a selected or initialised DCx camera camera Return Values IS_AVI_NO_ERR Function executed successfully IS_AVI_ERR_PARAMETER The pnAviID pointer contains the value Null IS_AVI_ERR_NO_CODEC_AVAIL The maximum number of instances allowed in this system has been reached It is not possible to create another instance IS_AVI_ER...

Page 311: ...vi_InitAVI function which Name of the event to be created IS_AVI_SET_EVENT_FRAME_SAVED A new frame was saved to the AVI file 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 IS_AVI_ERR_EVENT_FAILED The event could not be initialised...

Page 312: ...Event NULL TRUE FALSE if hEvent NULL isavi_InitEvent AviDest hEvent IS_AVI_SET_EVENT_FRAME_SAVED isavi_EnableEvent AviDest IS_AVI_SET_EVENT_FRAME_SAVED if 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 ...

Page 313: ...VI instance could not be found Either the AVI ID is invalid or the instance has already been deleted using isavi_ExitAVI IS_AVI_ERR_CAPTURE_RUNNING Another capturing operation is in progress or an AVI file is still open IS_AVI_ERR_INVALID_FILE No valid AVI file was selected in the Windows Open File dialogue IS_AVI_ERR_NEW_FAILED No memory could be allocated for the AVI file IS_AVI_ERR_AVIFILEOPEN ...

Page 314: ...ers for saved and discarded images Input Parameters nAviID Instance ID set by the isavi_InitAVI function Return Values IS_AVI_NO_ERR Function executed successfully IS_AVI_ERR_INVALID_ID The indicated AVI instance could not be found Either the AVI ID is invalid or the instance has already been deleted using isavi_ExitAVI Related Functions isavi_GetnCompressedFrames isavi_GetnLostFrames 305 299 303 ...

Page 315: ...mera camera Input Parameters nAviID Instance ID set by the isavi_InitAVI function fr The frame rate to be set Default 25 0 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 IS_AVI_ERR_WRITE_INFO The AVI file could not be modified IS_...

Page 316: ...em uses the JPEG algorithm Input Parameters nAviID Instance ID set by the isavi_InitAVI function q Image quality 1 lowest 100 highest 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 IS_AVI_ERR_INVALID_VALUE The q parameter is outsi...

Page 317: ... RGB32 RGB24 Y8 and raw Bayer The output file will always be in RGB24 format regardless of the input data format For further information on the structure of the different colour formats see the Appendix Colour and Memory Formats section Input Parameters nAviID Instance ID set by the isavi_InitAVI function cMode Colour format of the input frames captured by the DCx camera Width Width of the entire ...

Page 318: ..._AVI_ERR_INVALID_FILE The AVI file is not open IS_AVI_ERR_CAPTURE_RUNNING Another capturing operation is in progress or an AVI file is still open IS_AVI_ERR_ALLOC_MEMORY No memory could be allocated IS_AVI_ERR_INVALID_CM The submitted colour mode is not supported for AVI capturing IS_AVI_ERR_INVALID_SIZE The submitted size is invalid IS_AVI_ERR_INVALID_POSITION The submitted position is invalid Re...

Page 319: ...stance ID set by the isavi_InitAVI function 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 IS_AVI_ERR_INVALID_FILE The AVI file is not open Related Functions isavi_StopAVI isavi_InitEvent isavi_ExitAVI 305 299 315 306 299 ...

Page 320: ...red Input Parameters nAviID Instance ID set by the isavi_InitAVI function 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 IS_AVI_ERR_INVALID_FILE The AVI file is not open Related Functions isavi_StartAVI isavi_InitEvent isavi_ExitA...

Page 321: ...orySequence The DCx camera memory board is not supported any longer see below 3 30 is_GetMemorySequenceWindow is_GetNumberOfMemoryImages is_GetRevisionInfo is_GetCameraInfo 3 20 is_GetWhiteBalanceMultipliers is_SetAutoParameter 3 31 is_HideDDOverlay is_DirectRenderer is_IsMemoryBoardConnected The DCx camera memory board is not supported any longer see below 3 30 is_LockDDMem is_DirectRenderer is_L...

Page 322: ...Multipliers is_SetAutoParameter 3 31 is_ShowDDOverlay is_DirectRenderer is_StealVideo is_DirectRenderer is_TransferImage The DCx camera memory board is not supported any longer see below 3 30 is_TransferMemorySequence is_UnlockDDMem is_DirectRenderer is_UnlockDDOverlayMem is_DirectRenderer is_UpdateDisplay is_DirectRenderer The is_SetWhiteBalance and is_SetWhiteBalanceMultipliers functions have be...

Page 323: ...ns In DirectDraw BackBuffer mode is_DisableDDOverlay disables overlay mode and releases the memory allocated to the overlay This results in discarding of the overlay data Input Parameters hCam Camera handle Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related Functions is_DisableDDOverlay is_EnableDDOverlay is_HideDDOverlay is_SetDisplayMode is_ShowDD...

Page 324: ...DDOverlay enables live overlay mode The overlay cannot be displayed directly but needs to be visualised before by calling is_ShowDDOverlay The overlay uses black as the so called key colour so that overlay graphics may not contain any black colour Input Parameters hCam Camera handle Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related Functions is_Set...

Page 325: ... Windows graphics commands such as Line Circle Rectangle TextOut are available You should release the device context handle as early as possible using the is_ReleaseDC function While a GetDC ReleaseDC block is executed the overlay buffer on the screen will not be updated Input Parameters hCam Camera handle phDC Pointer to the variable that is supposed to contain the device context handle Return Va...

Page 326: ...aw BackBuffer mode is_GetDDOvlSurface returns the pointer to the internal DirectDraw surface Thus the functionality provided by the DirectDraw Surface interface can be used Input Parameters hCam Camera handle ppDDSurf Contains the pointer to the DirectDraw Surface interface Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related Functions is_SetDisplayMo...

Page 327: ...ode is_HideDDOverlay hides the overlay Only the contents of the image buffer will be displayed This way the frame rate is higher on some systems than with the overlay shown By hiding the overlay its data is not lost Input Parameters hCam Camera handle Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related Functions is_ShowDDOverlay is_DisableDDOverlay i...

Page 328: ...o release the memory as early as possible using the is_UnlockDDMem function Calling is_LockDDMem will not interrupt the process of digitising an image and saving it to the memory area While a LockDDMem UnlockDDMem block is executed in DirectDraw BackBuffer mode the contents of the back buffer will not be refreshed on the screen Input Parameters hCam Camera handle ppMem Pointer to the variable that...

Page 329: ...dows GDI functions pPitch returns the line offset in bytes from the beginning of a line to the beginning of the next line Make sure to release the memory again as early as possible using the is_UnlockDDOverlayMem function While a LockDDOverlayMem UnlockDDOverlayMem block is executed the contents of the overlay buffer will not be refreshed on the screen Input Parameters hCam Camera handle ppMem Poi...

Page 330: ...tDraw video data stream There are two different steal modes Normal steal This option redirects a single frame from a DirectDraw video data stream to the active user memory The frame will not be displayed with DirectDraw Copy steal This option displays the frame with DirectDraw and copies it to the currently active image memory Input Parameters hCam Camera handle Mode IS_SET_STEAL_NORMAL Normal mod...

Page 331: ...ext handle of the overlay buffer If overlay display is enabled using the is_ShowDDOverlay function the contents of the overlay buffer will be updated on the screen after the handle release Input Parameters hCam Camera handle hDC Device context handle returned by is_GetDC Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related Functions is_GetDC is_ShowDD...

Page 332: ...unction instead see also Obsolete Functions This function can only be used for the 24 bit 32 bit and Y8 colour formats colour cameras Input Parameters hCam Camera handle nMode IS_SET_BAYER_CV_BETTER Good quality minor colour artifacts lower computational load IS_SET_BAYER_CV_BEST Best quality and edge acuity higher computational load IS_GET_BAYER_CV_MODE Returns the current setting Return Values I...

Page 333: ...ectRenderer function instead see also Obsolete Functions is_SetDDUpdateTime sets the timer interval used for the video image update cycle in DirectDraw BackBuffer mode Input Parameters hCam Camera handle ms Time in milliseconds Valid range 20 2000 ms Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related Functions is_SetDisplayMode is_UpdateDisplay 130 ...

Page 334: ... function instead see also Obsolete Functions is_SetHwnd sets a new window handle for image output in DirectDraw mode The new handle and the image output will only be effective when is_SetDisplayMode is called for the next time Input Parameters hCam Camera handle hwnd Window handle Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Related Functions is_SetD...

Page 335: ...ad see also Obsolete Functions Input Parameters hCam Camera handle xPos X position of the upper left corner yPos Y position of the upper left corner width Image width height Image height Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message IS_INVALID_MODE Camera is in standby mode function not allowed Related Functions is_SetAOI is_SetImagePos is_SetImageSize...

Page 336: ...e area make sure to call the functions in the correct order Starting from the original image it is mandatory to keep to the following order 1 is_SetImageSize 2 is_SetImagePos is_SetAOI combines both functions With is_SetAOI you can set the position and size of an area of interest using a single function call Changes to the image geometry or pixel clock affect the value ranges of the frame rate and...

Page 337: ...ZE_Y Returns the current image height IS_GET_IMAGE_SIZE_Y_MIN Returns the minimum AOI image height IS_GET_IMAGE_SIZE_Y_MAX Returns the maximum AOI image height IS_GET_IMAGE_SIZE_Y_INC Returns the increment for the AOI image height y 1 yMax Sets the image height 0 Return settings Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Current setting when used to...

Page 338: ...lecting the colour content 0 255 or the corresponding RGB value 0 16777215 Input Parameters hCam Camera handle r Red content of the key colour 0 255 IS_GET_KC_RED The function returns the red content value IS_GET_KC_GREEN The function returns the green content value IS_GET_KC_BLUE The function returns the blue content value IS_GET_KC_RGB The function returns the RGB colour g Green content of the k...

Page 339: ...334 DCx camera 2010 Thorlabs is_HideDDOverlay is_DisableDDOverlay is_EnableDDOverlay is_GetDDOvlSurface is_SetColorMode 322 318 319 321 241 ...

Page 340: ... BackBuffer mode is_ShowDDOverlay displays the overlay i e the most recent data stored in the overlay buffer With some graphics cards overlay display may reduce the frame rate Input Parameters hCam Camera handle Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Recommended Alternative is_DirectRenderer Related Functions is_HideDDOverlay is_DisableDDOverlay...

Page 341: ..._PrepareStealVideo function to specify to remove the image from the DirectDraw data stream or to copy it If you set the copy option the image will both be displayed using DirectDraw and copied to the currently active image memory See also the Events in Live Mode figure in the Event Handling section Input Parameters hCam Camera handle Wait IS_WAIT The function waits until the image save is complete...

Page 342: ... Using is_UnlockDDMem you can unlock the image memory in the DirectDraw modes This results in a refresh of the BackBuffer contents on the screen Input Parameters hCam Camera handle Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Recommended Alternative is_DirectRenderer Related Functions is_LockDDMem is_LockDDOverlayMem is_UnlockDDOverlayMem is_LockSeqBu...

Page 343: ...erlay buffer in DirectDraw BackBuffer mode This results in an overlay buffer refresh on the screen provided that the overlay display was enabled using is_ShowDDOverlay Input Parameters hCam Camera handle Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Recommended Alternative is_DirectRenderer Related Functions is_LockDDOverlayMem is_UnlockDDOverlayMem is...

Page 344: ...eters hCam Camera handle Return Values IS_SUCCESS Function executed successfully IS_NO_SUCCESS General error message Recommended Alternative is_DirectRenderer Related Functions is_SetDisplayMode is_LockDDOverlayMem is_UnlockDDOverlayMem is_LockDDMem is_UnlockDDMem 7 6 Lists and Programming Notes 7 6 1 Programming Notes on parameter validity Functions that refer to an initialized camera have the ca...

Page 345: ...era AVI functions make sure to include the following files in your project Header file uc480_tools h C Program Files Thorlabs DCx camera Develop Include Lib file uc480_tools lib C Program Files Thorlabs DCx camera Develop LIB Function library DLL uc480_tools dll C Windows System32 NOTE We suggest that you keep the function libraries DLL AX and OCX files in the default directory Under Windows these...

Page 346: ...ions which are exclusively used for visualisation purposes The access to image memory contents is extremely tedious due to the missing pointer arithmetics We suggest to use the DCx camera ActiveX component when programming in VB Net The DCx camera SDK includes a sample program for programming with Microsoft Visual Studio in the VB NET programming language using the uc480 ActiveX component 7 6 1 4 ...

Page 347: ...E We suggest that you keep the function libraries DLL AX and OCX files in the default directory Under Windows these files reside in C Windows System32 after the installation Copying these files to other locations may result in version conflicts 7 6 1 6 Thread Programming In general the DCx camera API is thread safe This means that the DCx camera API can be accessed by multiple threads simultaneous...

Page 348: ...P_MEMORY The driver could not release the allocated memory 17 IS_CANT_COMMUNICATE_WITH_DRIVER Communication with the driver failed because no driver has been loaded 18 IS_FUNCTION_NOT_SUPPORTED_YET The function is not supported yet 49 IS_INVALID_MEMORY_POINTER Invalid pointer or invalid memory ID 50 IS_FILE_WRITE_OPEN_ERROR File cannot be opened for writing 51 IS_FILE_READ_OPEN_ERROR File cannot b...

Page 349: ...r one 145 IS_IMAGE_NOT_PRESENT The requested image is not available in the camera memory or is no longer valid 148 IS_TRIGGER_ACTIVATED The function cannot be used because the camera is waiting for a trigger signal 151 IS_CRC_ERROR A CRC error correction problem occurred while reading the settings 152 IS_NOT_YET_RELEASED This function has not been enabled yet in this version 153 IS_NOT_CALIBRATED ...

Page 350: ...ck buffer surface not found 170 IS_RELEASE_BB_OVL_DC Error releasing the overlay device context 171 IS_BB_TIMER_NOT_CREATED The back buffer timer could not be created 172 IS_BB_OVL_NOT_EN The back buffer overlay was not enabled 173 IS_ONLY_IN_BB_MODE Only possible in BackBuffer mode 174 IS_INVALID_COLOR_FORMAT Invalid colour format 175 IS_INVALID_WB_BINNING_MODE Mono binning mono sub sampling do n...

Page 351: ...er is_FreeImageMem is_FreezeVideo is_GetActiveImageMem is_GetActSeqBuf is_GetAutoInfo is_GetBusSpeed is_GetCameraInfo is_GetCameraList is_GetCameraLUT is_GetCameraType is_GetCaptureErrorInfo is_GetColorConverter is_GetComportNumber is_GetDLLVersion is_GetError is_GetEthDeviceInfo is_GetExposureRange is_GetFramesPerSecond is_GetFrameTimeRange is_GetGlobalFlashDelays 118 119 121 124 126 127 128 129 ...

Page 352: ...ndwidth is_GetVsyncCount is_HasVideoStarted is_InitCamera is_InitEvent is_InquireImageMem is_IsVideoFinish is_LoadBadPixelCorrectionTable is_LoadImage is_LoadImageMem is_LoadParameters is_LockSeqBuf is_ReadEEPROM is_ReadI2C is_ResetCaptureErrorInfo is_ResetToDefault is_SaveBadPixelCorrectionTable is_SaveImage is_SaveImageEx is_SaveImageMem is_SaveImageMemEx is_SaveParameters is_SetAllocatedImageMe...

Page 353: ...am is_SetEdgeEnhancement is_SetErrorReport is_SetExposureTime is_SetExternalTrigger is_SetFlashDelay is_SetFlashStrobe is_SetFrameRate is_SetGainBoost is_SetGamma is_SetGlobalShutter is_SetHardwareGain is_SetHardwareGamma is_SetHdrKneepoints is_SetHWGainFactor is_SetImageAOI is_SetImageMem is_SetImagePos is_SetImageSize is_SetIO is_SetIOMask is_SetLED is_SetOptimalCameraTiming 219 221 228 229 327 ...

Page 354: ...savi_AddFrame Isavi_CloseAVI Isavi_DisableEvent Isavi_EnableEvent Isavi_ExitAVI Isavi_ExitEvent Isavi_GetAVIFileName Isavi_GetAVISize Isavi_GetnCompressedFrames Isavi_GetnLostFrames Isavi_InitAVI Isavi_InitEvent Isavi_OpenAVI Isavi_ResetFrameCounters Isavi_SetFrameRate Isavi_SetImageQuality Isavi_SetImageSize Isavi_StartAVI Isavi_StopAVI Function ist obsolete see chapter Obsolete Functions 277 279...

Page 355: ...ing table shows the byte arrangement in memory Figure 58 Color and memory formats An asterisk identifies formats which are filled starting with the most significant bit MSB but which may have less than the indicated number of payload bits depending on the camera model For the RGB16 and RGB15 data formats the MSBs of the internal 8 bit R G and B colours are used ...

Page 356: ... sections If a section does not exist in the ini file the corresponding camera parameters will not be modified when you load the file Structure of a DCx camera parameter file Parameter Description Value range Example Versions uc480 dll File version of the uc480 SDK 3 35 0000 uc480 sys File version of the USB driver 3 35 0000 Sensor Sensor Full name of the camera model DCU224 M Image size Image siz...

Page 357: ...emory Formats section IS_SET_CM_RGB32 Colour format 0 1 2 4 8 3 2 IS_SET_CM_RGB24 Colour format 0 1 2 4 8 3 2 IS_SET_CM_RGB16 Colour format 0 1 2 4 8 3 2 IS_SET_CM_RGB15 Colour format 0 1 2 4 8 3 2 IS_SET_CM_Y8 Colour format 0 1 2 4 8 3 2 IS_SET_CM_RGB8 Colour format 0 1 2 4 8 3 2 IS_SET_CM_BAYER Colour format 0 1 2 4 8 3 8 IS_SET_CM_UYVY Colour format 0 1 2 4 8 3 2 IS_SET_CM_UYVY_MONO Colour form...

Page 358: ...0 1 000000 Hardware Gamma Sensor based hardware correction of the gamma value 0 1 0 Blacklevel Mode Mode for black level correction of the sensor 0 1 32 2 1 Blacklevel Offset Manual offset for black level correction of the sensor 0 255 0 Hotpixel Mode Mode for hot pixel correction 0 1 2 4 2 2 Hotpixel Threshold Not used 0 GlobalShutter Enables the Global Start shutter of the sensor 0 1 0 Gain Sets...

Page 359: ...rol Enable exposure time control 0 1 0 Brightness gain control Enable sensor gain control 0 1 0 Brightness control once Carry out brightness control once 0 1 0 Brightness reference Reference value for brightness control 0 255 128 Brightness speed Brightness control speed 0 100 50 Brightness max gain Maximum gain for brightness control 0 100 100 Brightness max exposure Maximum exposure time for bri...

Page 360: ...oi Height Height of reference AOI for white balance control Sensor dependent1 1920 Auto WB Once Carry out white balance control once 0 1 0 Trigger and Flash Sets the digital inputs outputs Trigger delay Delay of triggered image capture in µs Sensor dependent1 15 Flash strobe Activate flash output 0 6 2 0 Flash delay Delay of the flash signal in µs Depends on sensor setting can be queried using is_...

Page 361: ......

Page 362: ...Maintenance and Service DCx camera Part VIII ...

Page 363: ...ine europe thorlabs com before sending the DCx camera for checkup and repair to Thorlabs refer to section Addresses 8 1 1 Version and other Information The menu entry Help Info about uc480 Viewer displays application relevant data Figure 59 Help menu About window The Camera type ID and Serial number is displayed in the title bar of the Camera Viewer Figure 60 Title bar with camera information In c...

Page 364: ...tions The DCx camera is not water resistant Attention To avoid damage to the DCx camera do not expose it to spray liquids or solvents 8 1 3 Cleaning If necessary the unit and the display can be cleaned with a cloth dampened with water You can use a mild 75 Isopropyl Alcohol solution for more efficient cleaning ...

Page 365: ...r after you connected your cameras chose the camera of choice and use the ID option to assign it Now you can select the individual cameras in the order you like with the UC480 viewer program This method can also be used to connect to several cameras via LabView How can I enable the long term exposure of 10min for the DCU camera series Choose the external trigger mode in the camera viewer program o...

Page 366: ...O Instrument Drivers uc480 The uc480 VIs in the following directory LabVIEW_DIR instr lib uc480 an additional copy can be found here C Program Files Thorlabs DCx camera OtherDrivers LabVIEW 8 x What is the location of the sample files and the corresponding source codes C Program Files Thorlabs DCx camera Samples C Program Files Thorlabs DCx camera Develop Source If these folders do not exist pleas...

Page 367: ...ce the frame rate so that there is more time to process the filled destination memory 2 Internal error during internal processing of the image 3 All destination buffers locked by the application Reduce the frame rate so that there is more time to process the filled destination memory 4 The computer takes too long to process the images in the API e g colour conversion Reduce the frame rate so that ...

Page 368: ...Thorlabs 8 2 1 Tools From start menu of the CD ROM you can find two tools helping you to check capabilities of your USB controllers and connectivity of a camera CheckUSB exe allows to display properties of your USB controller interface ...

Page 369: ...364 DCx camera 2010 Thorlabs uc480HardwareCheck exe displays all connected DCx cameras model and serial numbers and their compatibility ...

Page 370: ...365 Maintenance and Service 2010 Thorlabs ...

Page 371: ......

Page 372: ...Camera Basics DCx camera Part IX ...

Page 373: ...t PC a micro controller for trigger and flash signals pixel clock and image size an EEPROM where the cameras vendor type and serial number are stored and a memory area of 64 bytes which can freely be used by the use Sensor board This board includes The sensor An EEPROM where the type of camera is stored Timing board The timing board digitises the output signals of the sensor Figure 61 Block diagra...

Page 374: ...ger mode the sensor is in a wait state and exposes one image immediately after the occurrence of a trigger event A trigger event can be set off by a hardware signal via the camera s digital input or by software via USB Exposure and readout transfer of the image are done successively The possible frame rate depends on the exposure time For maximum exposure time the frame rate is approximately half ...

Page 375: ...mode The camera is already capturing the next image when new parameters are transferred to the camera Therefore it might take two or three frames until the new parameters take effect Figure 64 Setting new camera parameters in freerun mode 9 4 Pixel clock frame rate and exposure time Pixel clock The basic parameter for camera timing is the pixel clock It determines the speed at which the sensor cel...

Page 376: ...y accessible Since Windows controls the image display the image may be completely or partly overlapped by any other windows and dialog boxes DirectDraw BackBuffer mode In this mode the DCx driver writes the image data to the invisible memory area back buffer of the graphics card This process runs automatically and does not have to be controlled by the application software It requires an installed ...

Page 377: ...ubtracted from the image signal This compensates thermally generated voltages which would otherwise falsify the signals Normally the sensor adjusts the blacklevel automatically but the blacklevel value can also be manually adjusted 9 7 Readout of relevant image areas Each Camera sensor has a defined resolution determined by the number of horizontal and vertical pixels e g 1024 x 768 pixel However ...

Page 378: ...s of the bayer pattern the color information is lost mono binning DCU cameras provide binning of each two or four pixels Binning of horizontal or vertical pixels can be used independently Figure 66 Color Binning Figure 67 Monochrome Binning 9 7 3 Subsampling The sensor subsampling function skips pixels during the sensor read out The volume of data to be transferred is reduced and higher camera fra...

Page 379: ...amera 2010 Thorlabs DCU cameras provide subsampling of two or four pixels Subsampling of horizontal or vertical pixels can be used independently Figure 68 Color subsampling 2x Figure 69 Monochrome subsampling 2x ...

Page 380: ...ternal delay time the sensor is exposed with the specified exposure time The captured image is subsequently transferred to the PC HINT The delay time is due to internal camera switching times and depends on sensor type and specified parameters It is in each case below 100 µs Precise values for the camera delay times can be found in chapter Technical Data The camera is ready to process the next tri...

Page 381: ...lly specified in inch However the specified value does not describe the actual size of the active sensor area This specification of sensor size dates back to former tube systems The curvature of the imaging surface of the camera tube causes a distortion during display This reduces the usable display area of a 1 tube to a rectangle with a diagonal of 16 mm Dimensional specifications were taken over...

Page 382: ... the correct brightness and color information can be calculated for each pixel The full resolution of sensor is kept Color conversion into Y8 RGB or YUV format can be done at run time in the PC with the functions of the DCU software development kit SDK Figure 73 Bayer filter and mcro lenses 9 11 Fill factor The fill factor specifies the percentage of the sensor area which is exposed to light durin...

Page 383: ... pixel rows are reset and then exposed simultaneously At the end of the exposure all rows are simultaneously moved to a darkened area of the sensor The pixels are then read out row by row Exposing all pixels simultaneously has the advantage that fast moving objects can be captured without geometric distortions Sensors that use the global shutter system are more complex in design than rolling shutt...

Page 384: ...time by which flash activation is delayed You can also specify the flash duration This allows implementing a global flash functionality which exposes all rows of a rolling shutter sensor simultaneously Rolling shutter sensors offer a higher pixel density compared to global shutter CMOS sensors The rolling shutter system is used in DCx cameras with high resolution CMOS sensors Figure 77 Rolling shu...

Page 385: ...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 Figure 79 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 61 ...

Page 386: ...B2 0 in 2001 the bus bandwidth increased to 480 MBit s making USB2 0 suitable for devices with high data rates such as mass storage devices scanners or cameras 9 13 2 Cable and connection The maximum length for USB2 0 cables is limited to 5m in order to comply with the specifications Longer cables are allowed if high quality material is used The following illustration shows the structure of a shie...

Page 387: ...ble to directly connect two USB devices with exception of USB On the go compliant devices Also it is not possible to connect a DCU camera to a PDA or similar systems Theoretically 127 devices can be connected at one host controller With hubs and or repeater the root hub s connection facilities can be extended With the consideration that maximally 5 hubs repeater may be switched one behind the othe...

Page 388: ...s use the USB2 0 Bulk mode for transmitting images This mode uses error correction and retry on error to guarantee correct delivery of the image data There is no guaranteed bandwidth or latency To ensure error free communication with all devices the maximum bandwidth for data payload is limited to 416 MBit s Theoretically up to 50 MB s of data payload can be transmitted via USB2 0 In practice a hi...

Page 389: ......

Page 390: ...Appendices DCx camera Part X ...

Page 391: ...era family Table 14 Model names DC XXX X X Short form for DCx camera C CMOS U CCD Shutter 22 CCD Progressive Scan 15 16 CMOS Rolling Shutter Resolution 3 XGA 1024 x 768 0 78MP 45 SXGA 1280 x 1024 1 30MP Color format M Monochrome C Color NOTE The diagrams represented in the specifications show relative sensitivities of the DCU cameras in the spectral region Therefore is a comparison of the characte...

Page 392: ...e relative humidity 1 20 85 1 Non condensing Non condensing means that the relative air humidity must be below 100 Otherwise moisture will form on the camera surface If for example air has a relative humidity of 40 at 35 C the relative humidity will increase to over 100 if the air cools down to 19 5 C condensation begins to form NOTE Avoid high air humidity levels and rapid temperature changes whe...

Page 393: ... 10 g 10 1 1 2 IP Protection Classes The housings of the DCx models comply with IP 30 These standards are defined as follows First digit 3 Protection against the ingression of small particles diameter 2 5 mm Second digit 0 No special protection against liquids ...

Page 394: ...the inserted materials The glass cover of the sensor and all filters inserted into the optical path must be taken into account in the calculation Figure 86 Calculation flange back distance schematic demonstration x Distance screwed flange PCB flange back distance a Distance screwed flange active sensor area 17 526mm e Distance active sensor area PCB d Thickness of the glass cover of the sensor f T...

Page 395: ...with IR cut filter a 17 526 mm d 0 525 mm nGlass 1 50 f 1mm nFilter 1 53 Calculating the flange back distance for DCC cameras models with CS mount NOTE For USB DCx cameras with CS mount the flange back distance is only 12 526 mm Table 18 Distances and dimensions for calculating the flange back distance USB DCx sensor Sensor glass d mm Distance e mm Sensor height h mm CMOS 154xLE 0 55 1 27 0 085 2 ...

Page 396: ...a The adjusting ring of the DCC camera model has 10 adjusting positions For each adjusting position the flange back distance is altered by 50 µm Figure 87 Adjusting ring top view Figure 88 Adjusting ring bottom view Figure 89 Schematic illustration of adjusting ring To change the position of the adjusting ring please proceed exactly in the following order 1 Loosen the locking screw see figure belo...

Page 397: ...392 DCx camera 2010 Thorlabs Figure 90 Securing the adjusting ring ...

Page 398: ... mm Horizontal vertical rotation 1 0 Translational rotation 1 0 Flange back distance 0 05 mm 10 1 1 3 4 Maximum Immersion Depth for Lenses Some C mount lenses reach deep into the camera flange This may cause the lens to push against the back of the filter glass inside the camera or even make it impossible to screw in the lens The table below indicates the maximum possible immersion depth for each ...

Page 399: ... 7 USB DCC CS mount 4 mm 24 0 6 1 14 6 7 6 C mount with extension ring 5 mm 22 0 11 1 14 6 12 6 May vary depending on the inside diameter of the extension ring used NOTE The data given in the table include the following tolerances as a safety clearance for the diameter of 0 2 mm ...

Page 400: ...horlabs 10 1 2 Camera dimensions DCC camera Figure 92 DCC camera isometric view Lens mount Enclosure protection class Weight CS S mount SM1 mount IP30 with housing 32 g with housing Figure 93 Exploded view of the DCC camera ...

Page 401: ...396 DCx camera 2010 Thorlabs Dimensions Figure 94 Side view with interface DCC models Figure 95 Rear view DCC models Figure 96 Bottom view DCC modesl ...

Page 402: ...397 Appendices 2010 Thorlabs DCU cameras Figure 97 Front view DCU Figure 98 Rear view DCU Figure 99 Side view DCU Figure 100 Top view DCU Figure 101 Bottom view DCU ...

Page 403: ...al input is galvanically isolated using an opto coupler to protect the camera and the PC against surges Only DC voltages may be applied to the digital input Figure 102 Trigger connection 10 1 3 2 Digital Output Wiring Flash The flash strobe is optically isolated to DCU and your PC on order to protect your equipment It is adapted for voltages up to 24V DC The output of the opto coupler can be used ...

Page 404: ...In the following drawing examples of the connection of the digital output are to be found Figure 103 Rev 1 2 Flash Strobe output as Open Collector OC Figure 104 Rev 1 2 Flash Strobe output as Open Emitter OE Figure 105 Rev 2 0 Flash Strobe output as Open Collector OC ...

Page 405: ...400 DCx camera 2010 Thorlabs Figure 106 Rev 2 0 Flash Strobe output as Open Emitter OE ...

Page 406: ...in Assignment Figure 107 Pin assignment of the micro D Sub socket 1 Flash Strobe Output 2 Trigger Input 3 Shield 4 USB 5V 5 USB GND 6 Flash Strobe Output 7 Trigger Input 8 USB D 9 USB D 10 1 4 EEPROM Table 23 EEPROM Specification User EEPROM Size 64 Byte Data Retention 10 Years Read write cycles 100 0 00 cycles ...

Page 407: ... be compared to each other 10 1 5 1 Filters Thorlabs color cameras are supplied with a IR filter while monochrome cameras have a protection glass DCU223M DCU224M Plain glass filter removable Camera marking DCU22xM GL DCC1545M Plain glass filter glued non removable Camera marking DCC1545M GL DCU223C DCU224C BG40 IR Filter removable Camera marking DCU22xC BG40 DCC1645M HQ IR Filter glued non removab...

Page 408: ...403 Appendices 2010 Thorlabs Figure 108 Filter curve GL Figure 109 Filter curve BG 40 Figure 110 Filter curve HQ ...

Page 409: ...re time 14 fps 2 Exposure time in freerun mode 0 08 ms 2 1460 ms 3 Exposure time in trigger mode 0 08 ms 2 10 minutes 3 Binning vertical 4 Mode Monochrome Factor maximum resolution frame rate 2x 1280 x 512 Pixel 23 fps Factor maximum resolution frame rate 4x 1280 x 256 Pixel 31 fps Subsampling AOI horizontal vertical 4 Frame rate bei 320 x 240 pixel CIF 43 fps Absolute image width step width 16 12...

Page 410: ...w ith maximum pixel clock 3 Values are only achieved w ith minimum pixel clock 4 Function increases the frame rate Monochrome Color Figure 111 Sensor sensitivity of the DCU224x sensitivities in the shaded area 650nm are related to the response without any filter actual values with IR filter are below 5 For filter curves see Technical Data Filters HINT Application references for the DCU 224 Optimal...

Page 411: ...ps 2 Exposure time in freerun mode 0 066 ms 2 1040 ms 3 Exposure time in trigger mode 0 066 ms 2 10 minutes 3 Binning vertical 4 Mode Monochrome Factor maximum resolution frame rate 2x 1280 x 384 Pixel 53 fps Factor maximum resolution frame rate 4x 1280 x 192 Pixel 85 fps Subsampling AOI horizontal vertical 4 Frame rate bei 320 x 240 pixel CIF 78 fps Absolute image width step width 16 1024 Pixel 1...

Page 412: ...sed computer 2 Values are only achieved w ith maximum pixel clock 3 Values are only achieved w ith minimum pixel clock 4 Function increases the frame rate Monochrome Color Figure 112 Sensor sensitivity of the DCU223x sensitivities in the shaded area 650nm are related to the response without any filter actual values with IR filter are below 5 For filter curves see Technical Data Filters HINT Applic...

Page 413: ...me Micron MT9M001 Gain Monochrome model master gain 13x Offset control mode Auto manual additive Gain boost 1 5x Camera timing Pixel clock range MHz 5 43 1 Pixel clock range with subsampling binning MHz 5 50 1 Frame rate freerun mode fps 25 2 Frame rate trigger mode 1 ms exposure fps 23 2 Exposure time in freerun mode ms 0 035 2 980 3 Exposure time in trigger mode ms 0 035 2 980 3 AOI Mode Horizon...

Page 414: ...pling 160 x 128 pixels fps 511 Connected load 5 W 0 5 1 0 1 The maximum possible pixel clock frequency depends on the PC hardw are used 2 Requires maximum pixel clock frequency 3 Requires minimum pixel clock frequency 4 Use of this function increases the frame rate 5 The connected load depends on the sensor model and the pixel clock setting Monochrome Figure 113 Sensor sensitivity of the DCC1545M ...

Page 415: ...n MT9M131 Gain Color model master RGB 3 0x 3 1x Offset control mode Auto manual additive Gain boost 2 0x Camera timing Pixel clock range MHz 5 40 1 Pixel clock range with subsampling binning MHz 5 40 1 Frame rate freerun mode fps 25 2 Frame rate trigger mode 1 ms exposure fps 23 2 Exposure time in freerun mode ms 0 037 2 10s 3 Exposure time in trigger mode ms 0 037 2 10s 3 AOI Mode Horizontal 4 Ve...

Page 416: ...he maximum possible pixel clock frequency depends on the PC hardw are used 2 Requires maximum pixel clock frequency 3 Requires minimum pixel clock frequency 4 Use of this function increases the frame rate 5 The connected load depends on the sensor model and the pixel clock setting Color Figure 114 Sensor sensitivity of the DCC1645C sensitivities in the shaded area 650nm are related to the response...

Page 417: ...semblies to be built into a unit by the user e g OEM laser driver cards components mechanics and optics left over parts of units disassembled by the user PCB s housings etc If you wish to return a Thorlabs unit for waste recovery please contact Thorlabs or your nearest dealer for further information WEEE registration number Germany DE97581288 10 2 1 Waste Treatment on your own Responsibility If yo...

Page 418: ... that a particular objective can be achieved with the purchase of this product Insofar as permitted under statutory regulations we assume no liability for direct damage indirect damage or damages suffered by third parties resulting from the purchase of this product In no event shall any liability exceed the purchase price of the product Please note that the content of this User Manual is neither p...

Page 419: ...Japan Inc Higashi Ikebukuro Q Building 1st floor 2 23 2 Toshima ku Tokyo 170 0013 Japan Phone 81 3 5979 8889 Fax 81 3 5979 7285 Email sales thorlabs jp Web http www thorlabs jp China Thorlabs China Oasis Middlering Centre 3 Building 712 Room 915 Zhen Bei Road Shanghai China Sales and Support Phone 86 21 32513486 Fax 86 21 32513482 Email chinasales thorlabs com Web http www thorlabs com Our company...

Page 420: ......