Piranha4 4K and 2K High Speed Dual Line CMOS Monochrome Camera User’s Manual 17 April 2013 03-032-20176-00 www.teledynedalsa.com 2 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual © 2013 Teled yne DALSA, Inc. All inform ation provid ed in this m anual is believed to be accurate and reliable. No responsibility is assum ed by Teled yne DALSA for its use. Teled yne DALSA reserves the right to make changes to this inform ation w ithout notice. Reprod uction of this manual in whole or in part, by any m eans, is prohibited w ithout prior perm ission having been obtained from Teled yne DALSA. About Teledyne Technologies and Teledyne DALSA, Inc. Teled yne Technologies is a lead ing provid er of sophisticated electr onic subsystem s, instrum entation and com m unication prod ucts, engineered system s, aerospace engines, and energy and pow er generation system s. Teled yne Technologies‘ operations are prim ari ly located in the United States, the United Kingdom and Mexico. For mo re inform ation, visit Teled yne Technologies‘ w ebsite at w w w.teled yne.com. Teled yne DALSA, a Teled yne Technologies com pany, is an international lead er in high performance d igital im aging and sem icond uctors w ith approxim ately 1,000 em ployees world w id e, head quartered in Waterloo, Ontario, Canad a. Established in 1980, the com pany d esigns, develops, manufactures and markets d igital im aging prod ucts and solutions, in add ition to provid ing MEMS prod ucts and services. For more inform ation, visit Teled yne DALSA‘s w ebsite at ww w .teled ynedalsa.com . Support For further inform ation not includ ed in this manual, or for inform ation on Teled yne DALSA‘s extensive line of im age sensing prod ucts, please contact: North America Europe Asia Pacific 605 McMurray Rd Waterloo, ON N2V 2E9 Canad a Tel: 519 886 6000 Fax: 519 886 8023 w w w.teled ynedalsa.com sales.am ericas@teled ynedalsa.com support@teled ynedalsa.com Breslauer Str. 34 D-82194 Gröbenzell (Munich) Germ any Tel: +49 - 8142 – 46770 Fax: +49 - 8142 – 467746 w w w. teled yned alsa.com sales.europe@teled ynedalsa.com support@teled ynedalsa.com Ikebukuro East 13F 3-4-3 H igashi-Ikebukuro Toshim a-ku, Tokyo 170-0013 Japan Tel: 81 3 5960 6353 Fax: 81 3 5960 6354 (fax) w w w .teled ynedalsa.com sales.asia@teled yned alsa.com support@teled ynedalsa.com 03-032-20176-00 Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual 3 Contents 1. System Precautions and Cleaning ___________________________________________________________________ 6 Precautions ..................................................................................................................................................... 6 Electrostatic Discharge and the CMOS Sensor ................................................................................................. 6 2. The Piranha4 Camera ___________________________________________________________________________ 7 Camera Highlights ............................................................................................................................................................. 7 Camera Performance Specifications .................................................................................................................................. 8 Certifications and Compliance ........................................................................................................................................... 9 Supported Industry Standards ........................................................................................................................................... 9 Responsivity ....................................................................................................................................................................... 10 Mechanicals........................................................................................................................................................................ 12 Camera Mounting and Heat Sink Considerations ........................................................................................... 14 3. Quick, Simple Steps to Acquire an Image ______________________________________________________________ 15 4. Software and Hardware Setup______________________________________________________________________ 16 Recommended System Requirements ............................................................................................................. 16 Setup Steps: Overview ....................................................................................................................................................... 16 1. Install and Configure Frame Grabber and Software .................................................................................. 16 2. Connect Camera Link and Power Cables .................................................................................................... 16 3. Establish communicating with the camera.................................................................................................. 16 4. Operate the Camera ................................................................................................................................... 16 Step 1. Install and configure the frame grabber and software ......................................................................................... 17 Install Frame Grabber .................................................................................................................................... 17 Install Sapera LT and CamExpert GUI ............................................................................................................ 17 Step 2. Connect Data, Trigger, and Power Cables ............................................................................................................. 18 Data Connector: Camera Link ........................................................................................................................ 19 Camera Link Bit Definitions............................................................................................................................ 21 Camera Link Drive Capability ......................................................................................................................... 22 Input Signals, Camera Link ............................................................................................................................ 22 Output Signals, Camera Link Clocking Signals............................................................................................... 23 Power Connector ............................................................................................................................................. 23 LEDs ................................................................................................................................................................ 24 Step 3. Establish Communication with the Camera ........................................................................................................... 24 Power on the camera ...................................................................................................................................... 24 Connect to the frame grabber ......................................................................................................................... 24 Connect to the camera .................................................................................................................................... 25 Check LED Status ............................................................................................................................................ 25 Software Interface ........................................................................................................................................... 25 Using Sapera CamExpert with Piranha4 Cameras ............................................................................................................ 26 CamExpert Panes ............................................................................................................................................ 27 4. Camera Operation______________________________________________________________________________ 29 Factory Settings ................................................................................................................................................................. 29 Area Mode ......................................................................................................................................................................... 29 Check Camera and Sensor Information ............................................................................................................................. 31 Teledyne DALSA 03-032-20176-00 4 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Verify Temperature and Voltage ....................................................................................................................................... 31 Saving and Restoring Camera Settings ............................................................................................................................. 32 Camera Link Configuration ............................................................................................................................................... 34 TDI and Single Line Modes................................................................................................................................................ 34 Sensitivity Modes and Pixel Readout .............................................................................................................. 35 Trigger Modes .................................................................................................................................................................... 36 Exposure Controls .............................................................................................................................................................. 36 Exposure Modes in Detail .................................................................................................................................................. 37 Set Line Rate ..................................................................................................................................................................... 39 Set Exposure Time ............................................................................................................................................................. 43 Control Gain and Black Level ............................................................................................................................................ 43 Set Image Size ................................................................................................................................................................... 44 Set Baud Rate .................................................................................................................................................................... 44 Pixel Format ...................................................................................................................................................................... 45 Camera Direction Control .................................................................................................................................................. 45 Camera Direction ............................................................................................................................................ 46 Pixel Readout Direction (Mirroring Mode) ........................................................................................................................ 46 Resetting the Camera ........................................................................................................................................................ 47 Calibrating the Camera ..................................................................................................................................................... 47 Appendix A: GenICam Commands _____________________________________________________________________ 51 Camera Information Category ........................................................................................................................................... 51 Camera Information Feature Descriptions...................................................................................................... 52 Camera Configuration Selection Dialog ......................................................................................................... 55 Camera Power-up Configuration .................................................................................................................... 55 User Set Configuration Management ............................................................................................................. 55 Camera Control Category .................................................................................................................................................. 56 Camera Control Feature Descriptions ............................................................................................................. 57 Digital I/O Control Feature Descriptions ........................................................................................................ 58 Flat Field Category ............................................................................................................................................................ 60 Flat Field Control Feature Description ............................................................................................................ 60 Region of Interest (ROI) .................................................................................................................................. 62 Image Format Control Category ........................................................................................................................................ 62 Image Format Control Feature Description .................................................................................................... 64 Binning .............................................................................................................................................................................. 65 Area of Interest (AOI) Setup .............................................................................................................................................. 65 Instructions on using the camera scan direction to control camera parameters ................................................................ 68 Transport Layer Control Category ..................................................................................................................................... 71 Transport Layer Feature Descriptions ............................................................................................................. 72 Acquisition and Transfer Control Category ........................................................................................................................ 72 Acquisition and Transfer Control Feature Descriptions................................................................................... 73 Serial Port Control Category .............................................................................................................................................. 74 Serial Port Control Feature Descriptions ........................................................................................................ 74 File Access Control Category .............................................................................................................................................. 75 File Access Control Feature Descriptions ......................................................................................................... 76 File Access via the CamExpert Tool ................................................................................................................. 77 Download a List of Camera Parameters ......................................................................................................... 78 03-032-20176-00 Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual 5 Appendix B: ASCII Commands _______________________________________________________________________ 80 Port Configuration .......................................................................................................................................... 81 Commands ...................................................................................................................................................... 82 Appendix C: Quick Setup and Image Acquisition ___________________________________________________________ 92 Appendix D: The Sensor Window _____________________________________________________________________ 95 Cleaning and Protecting Against Dust, Oil, and Scratches .............................................................................. 95 Cleaning the Sensor Window .......................................................................................................................... 96 Appendix E: Camera, Frame Grabber Communication _______________________________________________________ 97 Setting Up Communication between the Camera and the Frame Grabber .................................................... 97 EMC Declaration _________________________________________________________________________________ 99 Revision History _________________________________________________________________________________ 100 Index ________________________________________________________________________________________ 101 Teledyne DALSA 03-032-20176-00 6 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual 1. System Precautions and Cleaning Precautions Read these p recau tions and this m anu al carefu lly before u sing the cam era. Confirm that the cam era‘s p ackaging is u nd am aged before op ening it. If the p ackaging is d am aged p lease contact the related logistics p ersonnel. Do not op en the hou sing of the cam era. The w arranty is void ed if the hou sing is op ened . Keep the cam era‘s front p late tem p eratu re in a range of 0 °C to 65 °C d u ring op eration. Do not op erate the cam era in the vicinity of strong electrom agnetic field s. In ad d ition, avoid electrostatic charging, violent vibration, and excess m oistu re. To clean the d evice, avoid electrostatic charging by u sing a d ry, clean absorbent cotton cloth d am p ened w ith a sm all qu antity of p u re alcohol. Do not u se m ethylated alcohol. To clean the su rface of the cam era hou sing, u se a soft, d ry cloth. To rem ove severe stains u se a soft cloth d am p ened w ith a sm all qu antity of neu tral d etergent and then w ip e d ry. Do not u se volatile solvents su ch as benzene and thinners, as they can d am age the su rface finish. Fu rther cleaning instru ction s are below . Thou gh this cam era su p p orts hot p lu gging, it is recom m end ed that you p ow er d ow n and d isconnect p ow er to the cam era before you ad d or rep lace system com p onents. Electrostatic Discharge and the CMOS Sensor Im age sensors and the cam era bod ies hou sing are su scep tible to d am age from electrostatic d ischarge (ESD). Electrostatic charge introd u ced to the sensor w ind ow su rface can ind u ce charge bu ild u p on the u nd ersid e of the w ind ow . The charge norm ally d issip ates w ithin 24 hou r s and the sensor retu rns to norm al op eration. 03-032-20176-00 Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual 7 2. The Piranha4 Camera Camera Highlights Teled yne DALSA exp and s its Piranha4 d u al line CMOS cam era fam ily w ith 4K and 2K resolu tion m od els. The new Piranha4 m od els offer higher sp eed s and m ore resp onsive p ixe ls in a choice of sizes and resolu tions. Program m able featu res inclu d e m u ltip le region -of-interest, high d ynam ic range op eration, and rap id bi-d irectional sw itching, and are d esigned to m eet tod ay‘s d em and ing im aging ap p lications. Key Features H igh sp eed : u p to 140 kH z in TDI m od e and u p to 280 kH z in Area m od e Com bination of variou s p ixel sizes and resolu tions Bi-d irectional Com p act cam era bod y Programmability Mu ltip le Regions of Interest for calibration and d ata red u ction 8, 10, and 12 bit ou tp u t Flat field and lens shad ing correction 8 p rogram m able coefficient sets GenICam or ASCII com p liant interfacing Applications Au tom ated op tical insp ection Transp ortation safety and secu rity system s H igh p erform ance sorting system s Materials grad ing and insp ection system s Web insp ection General p u rp ose m achine vision Teledyne DALSA 03-032-20176-00 8 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Models The cam era is available in the follow ing configu rations: Table 1: Camera Models Comparison Piranha4 Dual Line Model Comparison Part Number Resolution Maximum Line Rates TDI Mode (Area Mode) Pixel Size P4-CM-04K10D-00-R P4-CM-04K07D-00-R 4096 x 2 p ixels 4096 x 2 p ixels 100 kH z (200 kH z) 70 kH z (140 kH z) 10.56 µm x 10.56 µm 7.04 µm x 7.04 µm P4-CM-02K14D-00-R P4-CM-02K10D-00-R 2048 x 2 p ixels 2048 x 2 p ixels 140 kH z (280 kH z) 100 kH z (200 kH z) 14.08 µm x 14.08 µm 10.56 µm x 10.56 µm Table 2: Software Software Cam era firm w are GenICam ™ su p p ort (XML cam era d escrip tion file) Sap era LT, inclu d ing Cam Exp ert GUI ap p lication and GenICam for Cam era Link im aging d river Product Number / Version Number Em bed d ed w ithin cam era Em bed d ed w ithin cam era Version 7.20 or later Camera Performance Specifications Table 3: Camera Performance Specifications Specifications Performance Im ager Form at Resolution Pixel Size Pixel Fill Factor Line Rate H igh speed CMOS d ual line scan 4096 x 2 and 2048 x 2 pixels 7.04 µm x 7.04 µm and 10.56 µm x 10.56 µm 100 % Up to 140 kH z in TDI m od e (280 kH z area m od e) Exposure Tim e Bit Depth 4 µs to 3 m s 8, 10, and 12 bit, selectable Connectors and Mechanicals Control & Data Interface Pow er Connector Pow er Supply Pow er Dissipation Size Mass Operating Tem p Base, Med ium , Full, and Deca Cam era Link configurations (2 x SDR-26) H irose 6-pin m ale circular + 12 V to + 24 V DC (+11.4 V to +25.2 V m axim um lim its) < 11 W 62 m m (W) x 62 m m (H ) x 48 m m (D) < 340 g 0 °C to 65 °C, front plate tem p erature Optical Interface Lens Mount M58 x 0.75 (4k) and M42 x 1(2k), F-m ount ad apter available Sensor to Cam era Front Distance 12 m m Sensor Alignm ent (aligned to sid es of cam era) 03-032-20176-00 Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual y (parallelism ) x y z z 9 0.08° or 100 µm ± 100 µm ± 100 µm ± 250 µm ± 0.2° Compliance Regulatory Com pliance Operating Ranges Dynam ic Range Rand om N oise Broad band Responsivity Gain DC Offset PRN U FPN SEE N EE Antibloom ing Integral non-linearity CE, FCC, and RoH S; GenICam Performance Single Line Dual Line 61.5 d B 3.42 DN * rm s 2 430 DN / (nJ/ cm ) 1x to 10x N om inal range 7 DN < 1% @ 50% Sat < 8 DN 2 9.52 nJ / cm 2 7.95 pJ / cm > 100 x Saturation 1.5 % DN 60 d B 4.16 DN rm s 2 677 DN / (nJ/ cm ) 1x to 10x N om inal range 14 DN < 1% @ 50% Sat < 8 DN 2 6.05 nJ / cm 2 6.14 pJ / cm > 100 x Saturation 2.5 % DN Notes FFC enabled FFC enabled *DN = d igital nu m ber Test Cond itions: Valu es m easu red u sing 12-bit, 1x gain. 10 kH z line rate Light sou rce: broad band , qu artz halogen, 3250 K w ith 700 nm IR cu toff filter. Front p late tem p eratu re: 45º C Certifications and Compliance Compliance EN 55011, FCC Part 15, CISPR 11, and ICES-003 Class A Rad iated Em issions Requirem ents EN 55024 and EN 61326-1 Im m unity to Disturbance RoH S per EU Directive 2002/ 95/ EC and WEEE per EU Directive 2002/ 96/ EC and China Electronic Ind ustry Stand ard SJ/ T11364-2006 GenICam XML Description File, Superset of the GenICam ™ Stand ard Features N am ing Convention specification V1.5, Cam era Link Serial Com m unication: GenICam ™ Generic Control Protocol (GenCP V1.0) Supported Industry Standards GenICam™ Piranha4 cam eras are GenICam com p liant. They im p lem ent a su p erset of the GenICam ™ Stand ard Featu res N am ing Convention sp ecification V1.5. This d escrip tion takes the form of an XML d evice d escrip tion file resp ecting the syntax d efined by the GenAp i m od u le of the GenICam ™ sp ecification. The cam era u ses the GenICam ™ Generic Control Protocol (GenCP V1.0) to com m u nicate over the Cam era Link serial p ort. Teledyne DALSA 03-032-20176-00 10 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual For m ore inform ation see w w w .genicam .org. Responsivity The resp onsivity grap h d escribes the sensor resp onse to d ifferent w avelengths of light (exclu d ing lens and light sou rce characteristics). Figure 1: Spectral Responsivity vs. Wavelength (Dual Line) 03-032-20176-00 Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual 11 Figure 2: Relationship between FPN and Temperature Teledyne DALSA 03-032-20176-00 12 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual 4 3 2 DESCRIPTION REV Mechanicals 62 B0.05 H 0.1 A E 0.05 M4x0.7 - 6H Z 6 (4X) (54) 12 B0.25 OPTICAL DISTANCE 31 B0.10 (19.1) ±0.2° IMAGE AREA 31 B0.10 [INSERT PDF HERE] B FIRST PIXEL REFERENCE HOLE A (20.34) M42x1 - 6H M4x0.7 - 6H Z 6 (2X) THIS SIDE (2X) FAR SIDE (47.87) (7) (42) (11.4) M4x0.7 - 6H Z 6 (2X) THIS SIDE (2X) FAR SIDE (7) CENTER OF IMAGE AREA C (9) (42) (54) 62 B0.05 (9) B 4 3 2 REV 01 DESCRIPTION ADDED VIEW OF CAMERA ASSEMBLY WITH OPTIONA (SHEET 2); DRAWING 03-129-20033-04 USED FOR REF NOTES: 1. UNITS: MILLIMETERS. 2. IMAGE AREA IS ALIGNED TO DATUMS A B & C . A 0.1 A 0.05 M4x0.7 - 6H 6 (4X) 62 0.05 (54) 12 0.25 OPTICAL DISTANCE UNLESS OTHERWISE SPECIFIED 1. UNITS: MM 2. DRAWING PER ASME Y14.5M-1994 3. TOLERANCES: LINEAR ±0.15 ANGLES ±0.5` SURFACE FINISH 3.2 (42) (54) 31 0.10 (19.1) ±0.2° 4 IMAGE AREA CENTER OF IMAGE AREA 31 0.10 (7) A C MAR 05/2013 APPROVED BY Ivan Bruulsema THIRD ANGLE PROJE Digitally signed by Ivan Bruulsema DN: cn=Ivan Bruulsema, o=Teledyne Dalsa, ou=Mech. Eng., email=ivan.bruulsema@teledynedalsa.com, c=CA Date: 2013.03.07 09:25:07 -05'00' TITLE APPLICATION/PROJECT HARMONY THIS DOCUMENT AND THE INFORMATION IT CONTAINS ARE PROPRIETARY TO TELEDYNE DALSA INC.. THIS DOCUMENT MUST NOT BE DUPLICATED, OR ITS CONTENT USED OR DISCLOSED (IN WHOLE OR IN PART) WITHOUT PERMISSION FROM TELEDYNE DALSA INC. 3 B DATE I. PLEIC DWG NO. PROPRIETARY (9) 62 0.05 (9) B AUTHOR M4x0.7 - 6H 6 (2X) THIS SIDE (2X) FAR SIDE PART NO. 2 (11.4) (20.34) M58x0.75 - 6H FIRST PIXEL REFERENCE HOLE M4x0.7 - 6H 6 (2X) THIS SIDE (2X) FAR SIDE (47.87) (7) (42) NOTES: 1. UNITS: MILLIMETERS. 2. IMAGE AREA IS ALIGNED TO DATUMS A B & C . Figure 3: 2K (Top) and 4K (Bottom) Camera Mechanicals A UNLESS OTHERWISE SPECIFIED 03-032-20176-00 1. UNITS: MM 2. DRAWING PER ASME Y14.5M-1994 3. TOLERANCES: LINEAR ±0.15 ANGLES ±0.5 SURFACE FINISH 3.2 AUTHOR DATE I. PLEIC JUL 23/2012 APPROVED BY Teledyne DALSA APPLICATION/PROJECT HARMONY THIRD ANGLE PROJECT TITLE DWG NO. 0 PROPRIETARY THIS DOCUMENT AND THE INFORMATION IT CONTAINS ARE PROPRIETARY TO TELEDYNE DALSA INC.. THIS DOCUMENT MUST NOT BE DUPLICATED, OR ITS CONTENT USED OR DISCLOSED (IN WHOLE OR IN PART) WITHOUT PERMISSION FROM TELEDYNE DALSA INC. PART NO. Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual 13 Figure 4: Nikon M58 to F-Mount Adapter Figure 5: Piranha4 Heat Sink Accessories Kit Optional Lens Mount and Heat Sink Accessories Part No. Description AC-LN -00002-A0-R M58 to F-m ount ad apter (12m m BFD), heavy d uty AC-MS-00108-00-R H eat sink for P4-4k/ 2k cam eras Teledyne DALSA 03-032-20176-00 14 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Camera Mounting and Heat Sink Considerations Up to tw o op tional heat sinks can be installed on the Piranha4 cam era. As illu strated , they are id eally p ositioned to allow close sp acing of the cam era s. These heat sinks are d esigned to p rovid e ad equ ate convection cooling w hen not obstru cted by enclosu res or m ou nting assem blies. Teled yne DALSA recognises that each cu stom er‘s ap p lication can be u niqu e. In consid eration, the P4 cam era heat sinks have been d esigned in su ch a w ay that they can be rep ositioned on the d ifferent faces of the cam era or rem oved entirely, d ep end ing on the m ou nting configu ration and its heat sinking p otential. Rep ositioning or rem oval of the heat sinks m u st be p erform ed w ith care in ord er to avoid tem p eratu re issu es. The cam era has the ability to m easu re its internal tem p eratu re. Use this featu re to record the internal tem p eratu re of the cam era w hen it is m ou nted in you r system and op erating u nd er the w orst case cond itions. The cam era w ill stop ou tp u ttin g d ata if its internal tem p eratu re reaches 80 °C. Refer to the Figu re 14. Cam Exp ert‘s Cam era Inform ation Wind ow Verify Tem p eratu re and Voltage section for m ore inform ation. 03-032-20176-00 Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual 15 3. Quick, Simple Steps to Acquire an Image For u sers w ho are fam iliar w ith Cam era Link cam eras, have a basic u nd erstand ing of their im aging requ irem ents, and w ho are p rim arily interested in evalu ating the Piranha4 cam era, an overview of the step s requ ired to get this cam era op erational and acqu iring im ages qu ickly can be fou nd in Ap p end ix C: Qu ick Setu p and Im age Acqu isition . Teledyne DALSA 03-032-20176-00 16 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual 4. Software and Hardware Setup Recommended System Requirements To achieve best system p erform ance, the follow ing m inim u m requ irem ents are recom m end ed : H igh band w id th fram e grabber, e.g. Xcelera-CL PX8 Fu ll Cam era Link fram e grabber (Part # ORX8CO-XPF00): w w w .teled yned alsa.com / im aging/ p rod u cts/ fg/ OR-X8C0-XPF00/ . Op erating system s: Wind ow s XP / Vista / 7, 32 / 64-bit. Setup Steps: Overview Take the follow ing step s in ord er to setu p and ru n you r cam era system . They are d escribed briefly below and in m ore d etail in th e sections that follow . 1. Install and Configure Frame Grabber and Software We recom m end the Xcelera-CL PX8 Fu ll fram e grabber or equ ivalent, d escribed in d etail on the teled yned alsa.com site here. Follow the m anu factu rer‘s installation instru ctions. A GenICam ™ com p liant XML d evice d escrip tion file is em bed d ed w ithin the cam era firm w are allow ing GenICam ™ com p liant ap p lication to know the cam era‘s cap abilities im m ed iately after connection. Installing Sap eraLT gives you access to the Cam Exp ert GUI, a GenICam ™ com p liant ap p lication. 2. Connect Camera Link and Power Cables Connect the Cam era Link cables from the cam era to the com p u ter. Connect a p ow er cable from the cam era to a +12 VDC to +24 VDC p ow er su p p ly. 3. Establish communicating with the camera Start the GUI and establish com m u nication w ith the cam era. ASCII Commands As an alternative to the Cam Exp ert (or equ ivalent) GUI, you can com m u nicate w ith this cam era u sing ASCII-based com m and s. Op en u p an ASCII interface and p ress the ESC key, then the com m u nication m od e w ill be sw itched into the ASCII com m and m od e other than t he GenICam m od e. A com p lete list of the com m and s and a d escrip tion of how to access them can be fou nd in the ap p end ix: Ap p end ix B: ASCII Com m and s. 4. Operate the Camera At this p oint you w ill be read y to start op erating the cam era in ord er to acqu ire im ages, set cam era fu nctions, and save settings. 03-032-20176-00 Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual 17 Step 1. Install and configure the frame grabber and software Install Frame Grabber Install a Full configu ration Cam era Link fram e grabber accord ing to the m anu factu rer‘s d escrip tion. We recom m end the Xcelera-CL PX8 fram e grabber or equ ivalent, d escribed in d etail on the teled yned alsa.com site here. Install Sapera LT and CamExpert GUI Com m u nicate w ith the cam era u sing a Cam era Link -com p liant interface. We recom m end you u se Cam Exp ert. Cam Exp ert is the cam era interfacing tool su p p orted by the Sap era library and com es bu nd led w ith Sap eraLT. Using Cam Exp ert is the sim p lest and qu ickest w ay to send com m and s to and receive inform ation from the cam era. Camera Link Control Communications The P4 fam ily of cam eras are GenICam ™ com p liant. Sap era u ses the GenICam ™ Generic Control Protocol (GenCP V1.0) to com m u nicate w ith the cam era over the Cam era Link serial p ort. When com m u nications are first established Sap era w ill w hen connecting for the first tim e d ow nload the GenICam ™ XML Descrip tion file. This file d etails how to access and control the cam era. Teledyne DALSA 03-032-20176-00 18 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Step 2. Connect Data, Trigger, and Power Cables N ote: the u se of cables typ es and lengths other than those sp ecified m ay resu lt in increased em ission or d ecreased im m u nity and p erform ance of the cam era. Power A +12V to +24V DC Hirose 6-pin B B A C Control & Data B Camera Link 26-pin SDR26 connectors B Status C Diagnostic LED Figure 6: Input and Output, Trigger, and Power Connectors ! 03-032-20176-00 WARN IN G! Grounding Instructions Static electricity can d am age electronic com p onents. It‘s critical that you d ischarge any static electrical charge by tou ching a grou nd ed su rface, su ch as the m etal com p u ter chassis, b efore hand ling the cam era hard w are. Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual 19 Data Connector: Camera Link The cam era u ses tw o Cam era Link SDR26 cables transm itting the Cam era Link Base, Med iu m , or Fu ll configu ration. The figu re below show s the SDR26 Cam era Link Connector and the tables that follow list the Cam era Link Base, Med iu m , and Fu ll configu ration s. For d etailed inform ation on Cam era Link p lease refer to the Cam era Link Road Map available from th e Know led ge Center on the Teled yne DALSA Web site: (http :/ / w w w .teled yned alsa.com / m v/ know led ge/ ap p notes.asp x). Figure 7. Camera Link Connector Data 2 Camera Connector 1 14 2 15 3 16 4 17 5 18 6 19 7 20 8 21 9 22 10 23 11 24 12 25 13 26 Teledyne DALSA Right Angle Frame Grabber Connector 1 14 25 12 24 11 23 10 22 9 21 8 20 7 19 6 18 5 17 4 16 3 15 2 13 26 Channel Link Signal inner shield inner shield Y0Y0+ Y1Y1+ Y2Y2+ YclkYclk+ Y3Y3+ 100 ohm terminated Z0Z0+ Z1Z1+ Z2Z2+ ZclkZclk+ Z3Z3+ inner shield inner shield Control / Data 1 Camera Right Angle Connector Frame Grabber Connector 1 1 14 14 2 25 15 12 3 24 16 11 4 23 17 10 5 22 18 9 6 21 19 8 7 20 20 7 8 19 21 6 9 18 22 5 10 17 23 4 11 16 24 3 12 15 25 2 13 13 26 26 Channel Link Signal inner shield inner shield X0X0+ X1X1+ X2X2+ XclkXclk+ X3X3+ SerTC+ SerTCSerTFGSerTFG+ CC1CC1+ CC2+ CC2CC3CC3+ CC4+ CC4inner shield inner shield 03-032-20176-00 20 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual *Exterior Overshield is connected to the shells of the connectors on both ends. Unused pairs should be terminated in 100 ohms at both ends of the cable. Inner shield is connected to signal ground inside camera Full Configuration Connector 1: Channel link X Camera/Frame Grabber Pin Tx0/Rx0 Tx1/Rx1 Tx2/Rx2 Tx3/Rx3 Tx4/Rx4 Tx5/Rx5 Tx6/Rx6 Tx7/Rx7 Tx8/Rx8 Tx9/Rx9 Tx10/Rx10 Tx11/Rx11 Tx12/Rx12 Tx13/Rx13 Tx14/Rx14 Tx15/Rx15 Tx16/Rx16 Tx17/Rx17 Tx18/Rx18 Tx19/Rx19 Tx20/Rx20 Tx21/Rx21 Tx22/Rx22 Tx23/Rx23 Tx24/Rx24 Tx25/Rx25 Tx26/Rx26 Tx27/Rx27 Bit Name D0(0) D0(1) D0(2) D0(3) D0(4) D0(7) D0(5) D1(0) D1(1) D1(2) D1(6) D1(7) D1(3) D1(4) D1(5) D2(0) D2(6) D2(7) D2(1) D2(2) D2(3) D2(4) D2(5) Not Used LVAL FVAL Not Used D0(6) 8 bits Camera Link Full Configuration Connector 2: Channel link Y Connector 3: Channel link Z Camera/Frame Grabber Pin Tx0/Rx0 Tx1/Rx1 Tx2/Rx2 Tx3/Rx3 Tx4/Rx4 Tx5/Rx5 Tx6/Rx6 Tx7/Rx7 Tx8/Rx8 Tx9/Rx9 Tx10/Rx10 Tx11/Rx11 Tx12/Rx12 Tx13/Rx13 Tx14/Rx14 Tx15/Rx15 Tx16/Rx16 Tx17/Rx17 Tx18/Rx18 Tx19/Rx19 Tx20/Rx20 Tx21/Rx21 Tx22/Rx22 Tx23/Rx23 Tx24/Rx24 Tx25/Rx25 Tx26/Rx26 Tx27/Rx27 Bit Name D3(0) D3(1) D3(2) D3(3) D3(4) D3(7) D3(5) D4(0) D4(1) D4(2) D4(6) D4(7) D4(3) D4(4) D4(5) D5(0) D5(6) D5(7) D5(1) D5(2) D5(3) D5(4) D5(5) Not Used LVAL FVAL Not Used D3(6) Camera/Frame Grabber Pin Tx0/Rx0 Tx1/Rx1 Tx2/Rx2 Tx3/Rx3 Tx4/Rx4 Tx5/Rx5 Tx6/Rx6 Tx7/Rx7 Tx8/Rx8 Tx9/Rx9 Tx10/Rx10 Tx11/Rx11 Tx12/Rx12 Tx13/Rx13 Tx14/Rx14 Tx15/Rx15 Tx16/Rx16 Tx17/Rx17 Tx18/Rx18 Tx19/Rx19 Tx20/Rx20 Tx21/Rx21 Tx22/Rx22 Tx23/Rx23 Tx24/Rx24 Tx25/Rx25 Tx26/Rx26 Tx27/Rx27 Bit Name D6(0) D6(1) D6(2) D6(3) D6(4) D6(7) D6(5) D7(0) D7(1) D7(2) D7(6) D7(7) D7(3) D7(4) D7(5) Not Used Not Used Not Used Not Used Not Used Not Used Not Used Not Used Not Used LVAL FVAL Not Used D6(6) Tap 1 bits are D0(x)...Tap 8 bits are D7(x) 03-032-20176-00 Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual 21 Camera Link Bit Definitions BASE Configuration Pixel Format T0 Port A Bits 0 thru 7 Port B Bits 0 thru 7 Port C Bits 0 thru 7 Mono 8 Tap 1 LSB..Bit 7 Pixels (1, 3, 5, ... 8189, 8191) Tap 2 LSB..Bit7 Pixels (2, 4, 6, ... 4094, 4096) xxxxxxx Mono 12 Tap 1 LSB.. Bit 7 Pixels (1, 3, 5, ... 8189, 8191) Tap 1 Bits 8,9,10,11 Pixels (1, 3, 5, ... 4093,4095) Tap 2 Bits 8,9,10,11 Pixels (2,4,6, ... 4094, 4096) Tap 2 LSB..Bit 7 Pixels (2,4,6, ... 4094, 4096) Medium Configuration Pixel Format T0 Port A Bits 0 thru 7 Port B Bits 0 thru 7 Port C Bits 0 thru 7 Port D Bits 0 thru 7 Port E Bits 0 thru 7 Port F Bits 0 thru 7 Mono 8 Tap 1 LSB..Bit 7 Pixels (1, 5, 9, ... 4089, 4093) Tap 2 LSB..Bit 7 Pixels (2, 6, 10, ... 4090, 4094) Tap 3 LSB..Bit 7 Pixels (3, 7, 11, ... 4091, 4095) Tap 4 LSB...Bit 7 Pixels (4, 8, 12, ... 4092, 4096) xxxxxxxx Xxxxxxxx Mono 10 / Mono 12 Tap 1 LSB.. Bit 7 Pixels (1, 5, 9, ... 4091, 4095) Tap 1 Bits 8,9,10,11 Pixels (1, 5, 9, ... 4091, 4095) Tap 2 LSB..Bit 7 Pixels (2, 6, 10, ... 4092, 4096) Tap 4 LSB…Bit 7 Pixels (4, 8, 12, ... 4090, 4094) Tap 3 LSB…Bit 7 Pixels (3, 7, 11, ... 4089, 4093) Tap 3 Bit 8,9,10,11 Pixels (3, 7, 11, ... 4089, 4093) Tap 2 Bits 8,9,10,11 Pixels (2, 6, 10, ... 4092, 4096) Tap 4 Bits 8,9,10,11 Pixels (4, 8, 12, ... 4090, 4094) Full Configuration Pixel Format T0 Port A LSB…Bit 7 Port B LSB…Bit 8 Port C LSB…Bit 8 Port D LSB…Bit 8 Port E LSB…Bit 8 Port F LSB…Bit 8 Port G LSB…Bit 8 Port H LSB…Bit 8 Mono 8 Tap 1 LSB… Bit 7 Pixels (1, 9, 17, ... 4081, 4089) Tap 2 LSB… Bit 7 Pixels (2, 10, 18, ... 4082, 4090) Tap 3 LSB… Bit 7 Pixels (3, 11, 19, ... 4083, 4091) Tap 4 LSB… Bit 7 Pixels (4, 12, 20, ... 4084, 4092) Tap 5 LSB… Bit 7 Pixels (5, 13, 21, ... 4085, 4093) Tap 6 LSB… Bit 7 Pixels (6, 14, 22, ... 4086, 4094) Tap 7 LSB…Bit 7 Pixels (7, 15, 23, ... 4087, 4095) Tap 8 LSB… Bit 7 Pixels (8, 16, 24, ... 4088, 4096) Teledyne DALSA 03-032-20176-00 22 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Deca Configuration Pixel Format T0 Port A LSB… Bit 7 Port B LSB… Bit 8 Port C LSB… Bit 8 Port D LSB… Bit 8 Port E LSB… Bit 8 Port F LSB… Bit 8 Port G LSB… Bit 8 Port H LSB… Bit 8 Port I Port K LSB…Bit 8 LSB…Bit 8 Mono 8 Tap 1 LSB… Bit 7 Pixels (1, 11, 21, ... 4081, 4091) Tap 2 LSB… Bit 7 Pixels (2, 12, 22, ... 4082, 4092) Tap 3 LSB… Bit 7 Pixels (3, 13, 23, ... 4083, 4093) Tap 4 LSB… Bit 7 Pixels (4, 14, 24, ... 4084, 4094) Tap 5 LSB… Bit 7 Pixels (5, 15, 25, ... 4085, 4095) Tap 6 LSB… Bit 7 Pixels (6, 16, 26, ... 4086, 4096) Tap 7 LSB… Bit 7 Pixels (7, 17, 27, ... 4087) Tap 8 LSB… Bit 7 Pixels (8, 18, 28, ... 4088) Tap 9 LSB… Bit 7 Pixels (9, 19, 29, ... 4089) Tap 10 LSB… Bit 7 Pixels (10, 20, 30, ... 4090) Table 4: Camera Link Bit Definitions Signal CC1 CC2 CC3 CC4 Configuration EXSYN C Spare Direction Spare Table 5: Camera Control Configuration For ad d itional Cam era Link d ocu m entation refer to the Teled yne DALSA Web site‘s Know led ge Center ap p lication notes. Camera Link Drive Capability The cam era link cable d rive cap ability on P4-4K cam eras has been im p roved to reach u p to 15 m eters. This p rovid es longer cable lengths w ithou t the need for ad d itional com p onents like, rep eaters etc. This cap ability has been tested u sing a nu m ber of fram e grabbers (listed in the table below ) and w as tested u sing stand ard cam era link cables from Com p o nent Exp ress Inc. The cable length d rive achieved on the variou s fram e grabbers is as follow s: Cable Length 10 m 15 m Frame Grabber (Manufacturer/Part Number) Teled yneDALSA Xcelera-CL PX4 / OR-X4C0-XPF00 Teled yneDALSA Xcelera-CL+ PX8 Full / OR-X8C0-XPF00 Matrox Rad ient eCL – RAD2GSF150400 Teled yneDALSA Xcelera-CL+ PX8 Full / OR-X8C0-XPF00 Table 6: Cable Length and Frame Grabber Pairings Input Signals, Camera Link The cam era accep ts control inp u ts throu gh the Cam era Link SDR26F connector. The cam era ship s in internal sync, and internally p rogram m ed integration . 03-032-20176-00 Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual 23 EXSYNC (Line Readout Trigger) Line rate can be set internally u sing the GenICam featu res. The external control signal EXSYN C is op tional and enabled throu gh the u ser interface. This cam era u ses the falling ed ge of EXSYN C to trigger p ixel read ou t. The EXSYN C signal tells the cam era w hen to integrate and read ou t the im age. It can be either an internally generated signal by the cam era, or it can be su p p lied externally via the serial interface. Dep end ing u p on the m od e of op eration the high tim e of the EXSYN C signal can rep resent the integration p eriod . N ote: The EXSYN C signal is m easu red at CC1 and w ill give a ―tru e‖ m easu rem ent (i.e. w ithin the m easu rem ent resolu tion of 25 ns) even thou gh the cam era w ill only trigger at a m axim u m of 100 KH z. Output Signals, Camera Link Clocking Signals These signals ind icate w hen d ata is valid , allow ing you to clock the d ata from the cam era to you r acqu isition system . These signals are p art of the Cam era Link configu ration and you shou ld refer to the Cam era Link Im p lem entation Road Map , available at ou r Know led ge Center, for the stand ard location of these signals. Clocking Signal Indicates LVAL (high) DVAL STROBE (rising ed ge) FVAL Ou tp u tting valid line N ot u sed Valid d ata Set to 0 Power Connector ! WARN IN G: It is extrem ely im p ortant that you ap p ly the ap p rop riate voltages to you r cam era. Incorrect voltages m ay d am age the cam era. Inp u t voltage requ irem ent: +12 VDC to +24 VDC, 2 Am p s. Before connecting p ow er to the cam era, test all p ow er su p p lies. Figure 8: 6-pin Hirose Circular Male Power Plug—Power Connector Pin 1 2 3 Table 7. Power Plug Pinout Description Pin Description +12 V to +24 V DC +12 V to +24 V DC +12 V to +24 V DC 4 5 6 GN D GN D GN D The cam era requ ires a single voltage inp u t +12 VDC to +24 VDC. The cam era m eets all p erform ance sp ecifications u sing stand ard sw itching p ow er su p p lies, althou gh w ell-regu lated linear su p p lies p rovid e op tim u m p erform ance. Teledyne DALSA 03-032-20176-00 24 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual WARNING: When setting up the camera’s power supplies follow these guidelines: ! Ap p ly the ap p rop riate voltages. Protect the cam era w ith a 2 am p slow -blow fu se betw een the p ow er su p p ly and the cam era. Do not u se the shield on a m u lti-cond u ctor cable for grou nd . Keep lead s as short as p ossible in ord er to red u ce voltage d rop . Use high-qu ality su p p lies in ord er to m inim ize noise. Note: If your power supply does not meet these requirements, then the camera performance specifications are not guaranteed. LEDs The cam era is equ ip p ed w ith an LED on the back to d isp lay the op erational statu s of the cam era. The table below su m m arizes the op erating states of the cam era and the corresp ond ing LED states. When m ore than one cond ition is active, the LED ind icates the cond ition w ith the highest p riority. Color of Status LED Meaning Off Blinking Green Red N o pow er or hardw are m alfunction Pow ering up or calibrating Read y Error. Check BiST register for the specific error Step 3. Establish Communication with the Camera Power on the camera Tu rn on the cam era‘s p ow er su p p ly. You m ay have to w ait w hile the cam era read ies itself for op eration. The cam era m u st boot fu lly before it w ill be recognized by the GUI—the LED shines green once the cam era is read y. Connect to the frame grabber 1. 2. 3. Start Sap era Cam Exp ert (or equ ivalent Cam era Link com p liant interfa ce) by d ou ble clicking the d esktop icon created d u ring the softw are installation. Cam Exp ert w ill search for installed Sap era d evices. In the Devices list area on the left sid e, the connected fram e grabber w ill be show n. Select the fram e grabber d evice by clicking on the nam e. N ote: The first tim e you set u p the cam era you w ill need to establish a com m u nication link betw een the cam era and fram e grabber. 03-032-20176-00 Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual 25 Connect to the camera 1. 2. Start a new Sap era Cam Exp ert ap p lication (or equ ivalent Cam era Link com p liant interfa ce) by d ou ble clicking the d esktop icon created d u ring the softw are installation. In the Devices list area on the left sid e, select the COM p ort below the Cam er a Link label. Figure 9. CamExpert GUI showing connected camera Check LED Status If the cam era is op erating correctly at this p oint, the d iagnostic LED w ill shine green. Software Interface All the cam era featu res can be controlled throu gh the Cam Exp ert interface. For exam p le, u nd er the Cam era Control m enu in the cam era w ind ow you can control the line rate and exp osu re tim es. Teledyne DALSA 03-032-20176-00 26 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual At this p oint you r host and cam era system shou ld be setu p and you can verify the cam era‘s op eration by retrieving a test p attern and setting the cam era‘s trigger and exp osu re tim e. Using Sapera CamExpert with Piranha4 Cameras Cam Exp ert is the cam era interfacing tool su p p orted by the Sap era library. When u sed w ith a Piranha4 cam era, Cam Exp ert allow s a u ser to test all cam era op erating m od es. Ad d itionally Cam Exp ert saves the cam era u ser settings configu ration to the cam era or saves m u ltip le configu rations as ind ivid u al cam era p aram eter files on the host system (*.ccf). Cam Exp ert can also be u sed to u p grad e the cam era‘s softw are. An im p ortant com p onent of Cam Exp ert is its live acqu isition d isp lay w ind ow w hich allo w s im m ed iate verification of tim ing or control p aram eters w ithou t the need to ru n a sep arate acqu isition p rogram . For context sensitive help , click on the bu tton then click on a cam era configu ration p aram eter. A short d escrip tion of the configu ration p ar am eter w ill be show n in a p op u p . Click on the op en the help file for m ore d escrip tive inform ation on Cam Exp ert. bu tton to The central section of Cam Exp ert p rovid es access to the cam era featu res and p aram eters. N ote: The availability of the featu res is d ep end ent on the Cam Exp ert u ser setting. A note on the CamExpert examples show n here: The examples show n for illustrative purposes and may not entirely reflect the features and parameters available from the camera model used in your application. 03-032-20176-00 Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual 27 CamExpert Panes Figure 10. CamExpert’s Camera Control Window The Cam Exp ert ap p lication u ses p anes to sim p lify choosing and configu ring cam era files or acqu isition p aram eters for the installed d evice. D evice Selector pane: View and select from any installed Sap era acqu isition d evice. Once a d evice is selected Cam Exp ert w ill only p resent acqu isition p aram eters ap p licable to that d evice. Op tionally select a cam era file inclu d ed w ith the Sap er a installation or saved by the u ser. Parameters pane: Allow s view ing or changing all acqu isition p aram eters su p p orted by the acqu isition d evice. Cam Exp ert d isp lays p aram eters only if those p aram eters are su p p orted by the installed d evice. This avoid s confu sion by elim inating p aram eter choices w hen they d o not ap p ly to the hard w are in u se. D isplay pane: Provid es a live or single fram e acqu isition d isp lay. Fram e bu ffer p aram eters are show n in an inform ation bar above the im age w ind ow . Control Buttons: The Disp lay p ane inclu d es Cam Exp ert control bu ttons. These are: Teledyne DALSA 03-032-20176-00 28 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Acquisition control button: Click once to start live grab, click again to stop. Single frame grab: Click to acquire one fram e from d evice. Trigger button: With the I/ O control param eters set to Trigger Enabled , click to send a single trigger com m and . CamExpert display controls: (these d o not m od ify the fram e buffer d ata) Stretch im age to fit, set im age d isplay to original size, or zoom the im age to virtu ally any size and ratio. Histogram / Profile tool: Select to view a histogram or line/ colum n profile d uring live acquisition or in a still im age. Output Message pane: Disp lays m essages from Cam Exp ert or the d evice d river. At this p oint you are read y to start op erating the cam era in ord er to acqu ire im ages, set cam era fu nctions, and save settings. 03-032-20176-00 Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual 29 4. Camera Operation Factory Settings The cam era ship s and p ow ers u p for the first tim e w ith the follow ing factory settings: Cam era Link Fu ll, 8 bit p ixels Internal trigger, line rate 10 kH z Internal exp osu re control, exp osu re tim e 50 µs 2 stage TDI 1x horizontal and vertical binning Offset 0, Gain 1x Area Mode The u se of area m od e in the P4 m ono cam era allow d ata rate to be tw ice as fast com p ared to TDI Stage =1 or TDI Stages = 2. Sim ilar to TDI Stage = 2 m od e both top and bottom lines of the sensor are exp osed at the sam e tim e. The d ifference being instead of su m m ing the lines each line is read ou t sep arately. Figu re xx illu strates how this is d one. On the first exsync both lines are exp osed and then the sensor is read ou t. One line is p rocessed and stored in cam era m em ory bu t the other line is p r ocessed and sent ou t the cam era link. The next exsync d oes not reach the sensor, bu t instead the store d ata is transferred ou t the cam era link p ort. Exsync Programmed Exposure Time Top and Bottom Lines Read out of Sensor Bottom Line Stored In Memory CL Output Top Line Transmitted out Camera Link Bottom Line Transmitted out Camera Link Figure 11. Area Mode data transfer timing In is im p ortant that the exp osu re tim e in area m od e be ap p rop riate for the line rate com ing in or set u p in the cam era. The exp osu re tim e shou ld not be longer than the inverse of the line rate or else the im age w ill sm ear. Scan d irection is also im p ortant. If th e d irection is w rong the im age w ill look chop p y as can be seen in figu re yy Teledyne DALSA 03-032-20176-00 30 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Figure 12. Image with in appropriate scan direction Figure 13. Image with proper scan direction 03-032-20176-00 Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual 31 Check Camera and Sensor Information Cam era and sensor inform ation can be retrieved via a controlling ap p lication —for exam p le, the Cam Exp ert GUI show n in the follow ing exam p les. Param eters su ch as cam era m od el, firm w are version, sensor characteristics, etc. are read to u niqu ely id entify the connected d evice. The cam era inform ation p aram eters are grou p ed together as m em bers of the Cam era Inform ation set. Figure 14. CamExpert’s Camera Information Window Verify Temperature and Voltage To d eterm ine the voltage and tem p eratu re at the cam era, u se the Refresh Voltage and Refresh Temperature featu res fou nd in the Camera Information set. The tem p eratu re retu rned is the internal tem p eratu re in d egrees Celsiu s. For p rop er op eration this valu e shou ld not exceed 80 °C. If the cam era exceed s the d esignated tem p eratu re it w ill stop im aging and the LED w ill tu rn red . Once you have d iagnosed and rem ed ied the issu e u se the reset camera fu nction. Note: The voltage d isp layed is the cam era‘s inp u t voltage. The voltage m easu rem ent featu re of the cam era p rovid es resu lts w ithin 1% of the actu al voltage. The m easu rem ent can be u sed to set the ap p lied voltage to the cam era. Teledyne DALSA 03-032-20176-00 32 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Saving and Restoring Camera Settings The p aram eters u sed to select, load and save u ser sets are grou p ed together u nd er the Cam era Inform ation set of featu res. There are 8 u ser sets available and one factory set. Camera Information Parameter User Set Default Selector User Set Selector User Set Load User Set Save Choices Select the cam era p aram eters to load w hen the cam era is reset or pow ered up as the Factory set, or as User Set 1 to 8. Selecting the set from the list autom atically saves it as the d efault set. Select the Factory or User set to Save or Load . -Factory Set -User Set 1 to 8. Load the set specified by User Set Selector to the cam era and m ake it the active / current set. Save the current set as selected user set. Description of the Camera Settings The cam era op erates in one of three settings: 1. 2. 3. 4. Cu rrent session. User setting. Factory setting (read -only). Defau lt setting. The cu rrent settings can be saved (thereby becom ing the u ser setting) u sing the User Set Save p aram eter. A p reviou sly saved u ser setting (User Set 1 to 8) or the factory settings can be restored u sing the User Set Selector and User Set Load p aram eters. Either the Factory or one of the User settings can be saved as the Defau lt Setting by selecting the set in the User Set Defau lt Selector. The chosen set au tom atically saves as the d efau lt setting and is the set load ed w hen the cam era is reset or p ow ered u p . The relationship betw een these three settings is illu strated in Figu re 15. Relationship betw een the Cam era Settings: 03-032-20176-00 Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual 33 Figure 15. Relationship between the Camera Settings Active Settings for Current Session The active setting for the cu rrent session is the set of configu ration s that are op erating w hile the cam era is cu rrently ru nning, inclu d ing all u nsaved changes you have m ad e to the settings before saving them . These active settings are stored in the cam era‘s volatile m em ory and w ill be lost and can not be restored if the cam era resets or if the cam era is p ow ered d ow n or loses p ow er. To save these settings for reu se the next tim e you p ow er u p or reset the cam era, or to p rotect against losing them in the case of p ow er loss, you m u st save the cu rrent settings u sing the User Set Save p aram eter. Once saved , the cu rrent settings becom e the selected User Set. User Setting The u ser setting is the saved set of cam era configu rations that you can cu stom ize, resave, and restore. By d efau lt the u ser settings are ship p ed w ith the sam e settings as the factory set. The com m and User Set Save saves the cu rrent settings to non-volatile m em ory as a User Set. The cam era au tom atically restores the last saved u ser settings w hen it p ow ers u p . To restore the last saved u ser settings, select the User Set p aram eter you w ant to restore and then select the User Set Load p aram eter. Factory Settings The factory setting is the cam era settings that w ere ship p ed w ith the cam era and w hich load ed d u ring the cam era‘s first p ow er-u p . To load or restore the original factory settings, at any tim e, select the Factory Setting p aram eter and then select the User Set Load p aram eter. Teledyne DALSA 03-032-20176-00 34 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual N ote: By d efau lt, the u ser settings are set to the factory settings. Default Setting Either the Factory or one of the User settings can be u sed as the Defau lt Setting by selecting the set in the User Set Defau lt Selector. The chosen set au tom atically becom es the d efau lt setting and is the set load ed w hen the cam era is reset of p ow ered u p . Camera Link Configuration Name Taps SPF* Cables Base 2 8, 10, 12 1 Med ium 4 8, 10, 12 2 Full 8 8 2 Deca 10 8 2 *Set Pixel Form at (nu m ber of bits p er p ixel) TDI and Single Line Modes You have the op tion to set the cam era m od es as either single line (w here only the bottom sensor is u sed , w hich resu lts in low er sensitivity) or as TDI (w here the p air of sensor lines is su m m ed , w hich resu lts in higher sensitivity). TDI Mode vs. Vertical Binning 2 TDI m od e d elays the line su m one line-tim e so that each row im ages the sam e area. Whereas w ith vertical binning 2, w hich can also be referred to as ―tall p ixel m od e,‖ the row s im age ad jacent areas and are su m m ed w ithou t sep aration d elay. This action com bined w ith horizontal binning 2 resu lts in a big p ixel that has half the resolu tion bu t is fou r tim es as resp onsive. 03-032-20176-00 Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual 35 Sensitivity Modes and Pixel Readout The cam era has the op tion to op erate in either TDI m od e or single line m od e. When in TDI m od e, the cam era u ses both line scan sensors and as a resu lt the resp onsivity increases (57%). When in single line m od e, the cam era u ses the bottom sensor only. The internal gain is 1.27x greater for single line m od e vs. TDI m od e. Figure 16: TDI Mode Examples In TDI m od e, the cam era u ses a m od el d ep end ent 7.04 µm x 7.04 µm or 10.56 µm x 10.56 µm p ixel and cap tu res the sam e im age tw ice, resu lting in a brighter im age. Figure 17: Single Line Mode Examples In single line m od e, the cam era u ses m od el d ep end ent 7.04 µm x 7.04 µm or 10.56 µm x 10.56 µm p ixel and cap tu res the im age u sing one sensor (Sensor 1). Teledyne DALSA 03-032-20176-00 36 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Trigger Modes The cam era‘s im age exp osu res are initiated by a trigger event. The trigger event is either a p rogram m able internal signal u sed in free ru nning m od e, an external inp u t u sed for synchronizing exp osu res to external triggers, or a p rogram m ed fu nction call m essage by the controlling com p u ter. These triggering m o d es are d escribed below . Internal trigger (trigger disabled): The cam era free-ru nning m od e has a p rogram m able internal tim er for line rate and a p rogram m able exp osu re p eriod . External trigger (trigger enabled): Exp osu res are controlled by an external trigger signal. The external trigger signal is the Cam era Link control line CC1. Exposure Controls The Exposure Control modes define how and when the camera will capture an image—the integration period. The integration period is the amount of time the camera‘s sensor is exposed to incoming light before the captured image is transmitted to the controlling computer. Exposure control is defined as the start of exposure and exposure duration. The start of exposure can be an internal timer signal (free-running mode) or an external trigger signal. The exposure duration can be programmable (such as the case of an internal timer) or controlled by the external trigger pulse width. The cam era can grab im ages in one of three w ays. You d eterm ine the three im aging m od es u sing a com bination of the Exp osu re Mod e p aram eters (inclu d ing I/ O p aram eters), Exp osu re Tim e and Line Rate p aram eters. Description Line Rate Internal line rate and exposure tim e External line rate and exposure tim e EXSYN C pulse controlling the line rate. Program m ed exposure tim e. Exposure Time Internal, program m able Controlled by EXSYN C pulse Controlled by EXSYN C pulse Trigger Source (Sync) Internal program m able External (EXSYN C) Internal External Internal program m able External Figure 18. Exposure controls The p aram eters u sed to select the im aging m od es—trigger sou rces (sync), exp osu re tim e, and line rate— are grou p ed together as the Cam era Controls. Camera Controls Parameter Line Rate (in H z) Exp osu re Mod e 03-032-20176-00 Description Cam era line rate in H z. Only available w hen the start line trigger p aram eter is d isabled (Trigger Mod e off). Set the op eration m od e for the cam era‘s exp osu re. Trigger Wid th or Tim ed . Trigger Wid th is only available w hen Trigger Mod e is enabled . Trigger Width Uses the w id th of the cu rrent line trigger signal p u lse to control the exp osu re d u ration. Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Exp osu re Tim e 37 Timed The exp osu re d u ration tim e is set u sing the Exp osu re Tim e featu re and the exp osu re starts w ith the Line Start event. Sets the exp osu re tim e (in m icrosecond s). Exp osu re Mod e featu re m u st be set to Tim ed Exposure Modes in Detail 1. Internally Programmable Line rate and Internally Programmable Exposure Time (Default) Line rate is the d om inant factor w hen ad ju sting the line rate or exp osu re tim e. When setting the line rate, exp osu re tim e w ill d ecrease, if necessary, to accom m od ate the new line rate. When ad ju sting the exp osu re tim e the range is lim ited by the line rate. Note: The cam era w ill not set line p eriod s shorter than the read ou t p eriod . GenICam parameters to set: I / O Controls > Trigger Mode > Off 2. External Line Rate and External Exposure Time (Trigger Width) In this m od e, EXSYN C sets both the line p eriod and the exp osu re tim e. The rising ed ge of EXSYN C m arks the beginning of the exp osu re and the falling ed ge initiates read ou t. N ote: GenICam parameters to set: I / O Controls > Trigger Mode > On Camera Control > Exposure Mode > Trigger Width Warning! When ru nning external line rate and external exp osu re tim e, the line rate m u st not exceed 1 / (exp osu re tim e + 1 µs). Und er these cond itions the exp osu re tim e w ill becom e ind eterm inate and resu lt in im age artefacts. This is not the case w hen ru nning inter nal exp osu re control. 3. External Line Rate, Programmable Exposure Time In this m od e, the line rate is set externally w ith the falling ed ge of EXSYN C generating the rising ed ge of a p rogram m able exp osu re tim e. GenICam parameters to set: I / O Controls > Trigger Mode > On Camera Control > Exposure Mode > Timed Teledyne DALSA 03-032-20176-00 38 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual 1. External Trigger Off, Internal Exposure Control Free running, not synchronized to an external signal Programmable Line Time 1 Programmable Exposure >1us Programmable Exposure1 Sensor Readout2 Programmable Exposure1 Sensor Readout2 Sensor Readout2 LVAL 10.2us 2. External Trigger On, Internal Exposure Control CC1 Falling edge triggers start of internal exposure3 CC1 Line Time Programmable Exposure1 >1us Programmable Exposure1 Sensor Readout2 Programmable Exposure1 Sensor Readout2 Sensor Readout2 LVAL 10.2us 3. External Trigger On, External Exposure Control CC1 Falling edge triggers start of exposure CC1 high duration sets the exposure time X1 X2 CC1 X3 Line Time Exposure = X1 >1us Exposure = X2 Sensor Readout2 Exposure = X3 Sensor Readout2 10.2us Sensor Readout2 LVAL Notes: 1. Exposure time > 4 micro-seconds 2. Sensor Readout time = 9.5 micro-seconds 3. One additional falling edge during exposure is latched Figure 19. Exposure Modes 03-032-20176-00 Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual 39 Set Line Rate To set the cam era‘s line rate u se the line rate p aram eter, p art of the Cam era Controls set. This featu re can only be u sed w hen the cam era is in Internal m od e—that is, w hen the start line trigger is d isabled (Trigger Mod e Off). N ote: A line rate < 1 / (Exp osu re tim e + 1 µs) w ill retu rn an error (―Invalid Param eter‖) if this cond ition is not m et. You m u st ad ju st these tw o p aram eters in the correct sequ ence to m aintain this cond ition. If the external line rate exceed s the m axim u m line rate allow ed for a m od e, the cam era w ill continu e to ou tp u t d ata at its m axim u m line rate. Thou gh no im age artefacts associated w ith over -sp eed w ill occu r, you m ay notice that u nd er over-sp eed cond itions the im age w ill ap p ear com p ressed and the ap p arent d istance travelled w ill be red u ced . Camera Control Parameter Line Rate (in H z) Description Cam era line rate in a range from 1 H z u p to 140 KH z. This featu re is only available w hen the cam era is in Internal Mod e— line trigger is d isabled (Trigger Mod e off). Line Rates Camera Link Configuration Maximum Line Rate Base 41 kH z Med iu m 81 kH z Full (TDI) 100 kH z Full (Area) 160 kH z Deca (Area) 200 kH z Teledyne DALSA 03-032-20176-00 40 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Table 8: Line Rates vs AOI CL Number CL Clock of AOI Configuration Rate 85 1 Base MH z 85 MH z 85 MH z 03-032-20176-00 2 3 Line Rate Formula (Hz) Max Line Rates (KHz) TDI: 41 Area: 41 Med iu m TDI: 81 Area: 81 Fu ll TDI: 100 Area: 160 Deca TDI: 100 Area: 200 Base TDI: 41 Area: 41 Med iu m TDI: 81 Area: 81 Fu ll TDI: 100 Area: 160 Deca TDI: 100 Area: 200 Base TDI: 41 Area: 41 Med iu m TDI: 81 Area: 81 Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual CL Clock Rate Number of AOI 85 MH z CL Clock Rate 66 MH z 4 Number of AOI Teledyne DALSA 1 CL Configuration 41 Line Rate Formula (Hz) Max Line Rates (KHz) Fu ll TDI: 100 Area: 160 Deca TDI: 100 Area: 200 Base TDI: 41 Area: 41 Med iu m TDI: 81 Area: 81 Fu ll TDI: 100 Area: 160 Deca TDI: 100 Area: 200 CL Configuration Line Rate Formula (Hz) Max Line Rates (KHz) Base TDI: 41 Area: 41 Med iu m TDI: 81 Area: 81 Fu ll TDI: 100 Area: 160 03-032-20176-00 42 CL Clock Rate Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Number of AOI 66 MH z 66 MH z 66 MH z 03-032-20176-00 2 3 4 CL Configuration Line Rate Formula (Hz) Max Line Rates (KHz) Deca TDI: 100 Area: 200 Base TDI: 41 Area: 41 Med iu m TDI: 81 Area: 81 Fu ll TDI: 100 Area: 160 Deca TDI: 100 Area: 200 Base TDI: 41 Area: 41 Med iu m TDI: 81 Area: 81 Fu ll TDI: 100 Area: 160 Deca TDI: 100 Area: 200 Base TDI: 41 Area: 41 Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual CL Clock Rate Number of AOI CL Configuration 43 Line Rate Formula (Hz) Max Line Rates (KHz) Med iu m TDI: 81 Area: 81 Fu ll TDI: 100 Area: 160 Deca TDI: 100 Area: 200 Set Exposure Time To set the cam era‘s exp osu re tim e, u se the Exposure Time p aram eter—a m em ber of the Cam era Controls set. This featu re is only available w hen the Exposure Mode p aram eter is set to Timed. The allow able exp osu re range is from 4 µs to 3,000 µs, d ep end ent on the valu e of the internal line rate. GenICam parameters: Camera Controls > Exposure Time (Timed Exposure Mode) > 4 µs to 3,000 µs. Control Gain and Black Level The cameras p rovid e gain and black level ad ju stments in the d igital d om ain for the CMOS sensor. The gain and black level controls can m ake small com p ensations to the acqu isition in situ ations w here lighting varies and the lens iris cannot be easily ad ju sted . The u ser can evalu ate gain and black level by u sing CamExp ert. The p aram eters that control gain and black level are grou p ed together in the Cam era Controls set. Camera Controls Black Level Gain Teledyne DALSA Ap p ly a d igital ad d ition after an FPN correction: ± 1/ 8 of available range. For exam p le in 12-bit m od e the available range is -512 to +511. Set the gain as an am p lification factor ap p lied to the vid eo signal across all p ixels: 1x to 10x. 03-032-20176-00 44 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Set Image Size To set the height of the im age, and therefore the nu m ber of lines to scan, u se the p aram eters grou p ed u nd er the Im age Form at Control set. Image Format Control Control the size of the transm itted im age Wid th Wid th of the im age. Read only. H eight H eight of the im age in lines. Read only. Pixel Form at Mono 8, Mono 10, or Mono 12 bit d ep th to Cam era Link. Test Im age Selector Select an internal test im age: Off Ram p A5 Each Tap Fixed All 1365 All 1 Set Baud Rate The bau d rate sets the sp eed (in bits p er second —bp s) of the serial com m u nication p ort and is available as p art of the Serial Port Control p aram eters. Serial Port Control Action Control the bau d rate u sed by the cam era‘s serial p ort Parameter Bau d Rate Options 9600 (factory d efau lt) 19200 57600 115200 230400* 460800* 921600* N ote: Du ring connection Cam Exp ert au tom atically sets the cam era to m axim u m allow able bau d . N u m ber of bits p er character u sed in the serial p ort Parity of the serial p ort Data Size *You r system requ ires a Px8 fram e grabber to achieve these bau d rates. 8 Parity N one N u m ber of stop bits p er character u sed in the serial p ort N u m ber of Stop Bits 1 03-032-20176-00 Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual 45 Pixel Format Use the Pixel Form at featu re, fou nd in the Image Format Control set, to select the form at of the p ixel to u se d u ring im age acqu isition, as either Mono 8, Mono 10, or Mono 12 bit d ep th. Image Format Control Parameter Pixel Form at Description Mono 8* Mono 10 Mono 12 *Only available form at for Full Cam eraLink configu ration. Camera Direction Control Fou nd in the Camera Control > D irection Control set of featu res. N ote: This featu re is only available w hen in TDI m od e. N ote: the Sensor Shift featu res are not available w hen the cam era is in low or tall p ixel sensitivity m od es. Camera Control > Direction Control Parameter Scan Direction Sou rce Scan Direction Teledyne DALSA Description When in TDI stages 2 or Area m od e, this com m and lets you select the Internal or external direction control. Use this featu re to accom m od ate object d irection change on a w eb and to m ou nt the cam era "u p sid e d ow n ." Read the cu rrent d irection. 03-032-20176-00 46 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Camera Direction When in TDI m od e or Area m od e y ou can select either forw ard or reverse cam era d irection. Selectable d irection accom m od ates object d irection change on a w eb and allow s you to m ou nt the cam era ―u p sid e d ow n‖. N ote that the exam p le here assu m es the u se of a lens (w hich inverts the im age). Figure 20: Object Movement and Camera Direction Example using a Lens Pixel Readout Direction (Mirroring Mode) Set the tap read ou t from left to right or from right to left. This featu re is esp ecially u sefu l if you w ant to m ou nt the cam era ―u p sid e d ow n.‖ Image Format Control Parameter Line Mirroring 03-032-20176-00 Description Off: All p ixels are read ou t from left to right. On: All p ixels are read ou t from right to left. Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual 47 Resetting the Camera The featu re Camera Reset, p art of the Transport Layer set, resets the cam era. The cam era resets w ith the d efau lt settings, inclu d ing a bau d rate of 9600. Transport Layer Parameter Cam era Reset Description Resets the cam era and p u ts in the d efau lt settings, inclu d ing a 9600 bau d rate. Calibrating the Camera Important N ote: to ensu re best resu lts, the cond itions u nd er w hich you calibrate the cam era (e.g. tem p eratu re and illu m ination) shou ld be as close to the actu al op erating cond itions as p ossible. . Figure 21: Flat Field Calibration in CamExpert Teledyne DALSA 03-032-20176-00 48 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Digital Processing - Video Calibrate FPN flatfieldCalibrationFPN (ccf) ( monochrome ) x + Calibrate PRNU flatfieldCorrectionMode flatfieldCalibrationPRNU flatfieldCorrectionAlgorithm (cpa,ffm) Filter Threshold ImageEnhancementStrength (sft) Offset BlackLevel (ssb) x Gain Gain (ssg) Output Video “Output_LUT” Figure 22: Camera Calibration Process. Calibration The goal of calibration is to p rod u ce a u niform , w hite balanced and , if requ ired , color corrected im age at the d esired level ou t of the cam era w hen it is im aging a u niform w hite object, u sing the op tical setu p of the u ser‘s ap p lication. The u ser shou ld configu re the cam era to u se the EXSYN C and exp osu re tim ing they d esire p lu s ad ju st the light level for norm al op eration. The lens shou ld be at the d esired m agnification, ap ertu re and be in focu s. As the w hite reference located at the object p lane w ill be in focu s, any featu res on its su rface (e.g. d u st, scratches) w ill end u p in the calibration p rofile of the cam er a. To avoid this, u se a clean w hite p lastic or ceram ic m aterial, not p ap er. Id eally, the w hite object shou ld m ove d u ring the calibration p rocess as the averaging p rocess of the cam era w ill d im inish the effects on any sm all variation in the w hite reference. The u ser m ay w ish to start the calibration p rocess by evalu ating the characteristics of their setu p w ith no calibration enabled . This can be read ily achieved by d isabling FPN , PRN U & color correction coefficients, setting w hite balance red , green and blu e gains to one, and the system gain to one. Begin by ad ju sting the system gain u ntil the p eak intensity of the three colors is at the d esired DN level. You m ay w ant to u se the w hite balance gains to ad ju st the p eak of each color to be a sim ilar DN valu e , bu t this is not necessary. Before p roceed ing any fu rther, it is d esirable to com p lete an FPN calibration. This is best p erform ed u sing a lens cap to ensu re no light gets into the cam era . Once com p lete, a PRN U calibration can be p erform ed u sing a target v alu e you w ant all the p ixels to achieve. This target valu e can be higher or low er than the p eak valu es you observed w hile initially setting u p the cam era. Once PRN U calibration is com p lete, it w ill take several second s, all three colors shou ld be at the ta rget valu e, w hite balance gains w ill have been ad ju sted to su it the cam eras op tim u m setu p for a balanced w hite ou tp u t, and the correction coefficient w ill be enabled . The system gain w ill rem ain as originally set. The coefficient and gain p aram eters, tim in g and control configu ration etc can be stored in any one of eight u ser sets and au tom atically retrieved at p ow er u p or by u ser selection. If a color correction m atrix is d esired , the u ser can d ow nload and save a color correction file d erived from the p roce ss d escribed above. Note: For the color correction to be effective, the cam era shou ld have a w hite balanced ou tp u t w hen color correction is off. Cam Expert has a d efault tim eout of 20 second s per com m and , w hich is too short for the FFC calibration to run fully. You can change the d efault tim eout by setting a com m and line argum ent in the short-cut: Right click on the short-cut in the start m enu and select properties. Ad d –tim eout 60 to increase the com m and tim eout to 60 second s (See below ). N ote that you m ust includ e a character space betw een the closing quotation m ark in the target and the hyphen before the tim eout value. Repeat for d esktop short-cu t 03-032-20176-00 Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual 49 Figure 23: Setting the camera’s timeout value 1. Flat Field This Flat Field set contains a nu m ber of featu res that are u sed to correct im age d istortion d u e to lens vignetting and u neven illu m ination . N ote: 1. Flat field coefficients consist of an offset and gain for each p ixel. 2. These are the first u ser corrections ap p lied to the im age. 3. The flat field coefficients are saved and load ed w ith the u ser set . Flat Field Parameter Description flatfield CorrectionMod e 1. 2. 3. flatfield CorrectionAlgorithm 1. 2. flatfield CalibrationTarget 1. 2. flatfield CalibrationSam p leSize 1. 2. 1. flatfield CalibrationROIOffsetX Off – Flat field correction coefficients are not ap p lied . On – Flat field correction coefficients are ap p lied . Initialize – Send ing this valu e w ill reset all cu rrent coefficients (offsets to 0 and gains to 1x). Basic – Direct calcu lation of coefficients based on cu rrent average line valu es and target. Low Pass – A low p ass filter is first ap p lied to the cu rrent average line valu es before calcu lating the coefficients. Use this algorithm if the calibration target is not u niform w hite or it s not p ossible to d efocu s the im age. Becau se of the low p ass filter this algorithm is not able to correct p ixel-to-p ixel variations and so it is p referable to u se the ―Basic‖ algorithm if p ossible. After calibration all p ixels w ill be scaled to ou tp u t this level Range d ep end s on p ixel form at: 8 bit: 0 to 255 DN 10 bit: 0 to 1023 DN 12 bit: 0 to 4095 DN N u m ber of lines to average w hen calibrating 2048 or 4096 Together w ith ―flatfield CalibrationROIWid th‖ sp ecifies the range of p ixels to be calibrated . Pixel coefficients ou tsid e this range are not changed . It is p ossible to calibrate d ifferent regions sequ entially. flatfield CalibrationROIWid th Teledyne DALSA 03-032-20176-00 50 flatfield CalibrationFPN Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual 1. 2. flatfield CalibrationPRN U 3. 4. 1. 2. 3. Save average line (of ―flatfield CalibrationSam p leSize‖ row s). This is the first u ser correction ap p lied – it is su btracted from each line. This featu re m ay not be of u se to m any u sers as the cam era alread y su btracts tru e ―d ark cu rrent‖, bu t it m ay be u sefu l for som e to p rovid e a p er p ixel offset correction. Range 0 to 511 DN , 12 bit Defau lt valu e is 0 DN for each p ixel Use ―flatfield CorrectionAlgorithm ‖ to calcu late the p er p ixel gain to achieve the sp ecified target ou tp u t. Range 0 to 15.9998x Defau lt 1x 2. Contrast Enhancement Tw o featu res to m axim ize the u se of the ou tp u t d ynam ic range (esp ecially w hen p ixel form at is less than 12 bits). Typ ical u se is to su btract m inim u m p ixel valu e exp ected and then gain u p m axim u m p ixel valu e to ap p roach fu ll scale. Offset 1. Single valu e ad d ed to each p ixel 2. Range -512 to 511 DN , scaled d ow n accord ing to p ixel form at 3. Positive valu es m ay be u sed to m easu re d ark noise Gain 1. Floating p oint d igital m u ltip lier ap p lied to each p ixel 2. Range 1x to 10x 03-032-20176-00 Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual 51 Appendix A: GenICam Commands This ap p end ix lists the available GenICam cam era featu res. Access these featu res u sing the Cam Exp ert interface. Featu res listed in the d escrip tion table bu t tagged as Invisible are typ ically reserved for Teled yne DALSA Su p p ort or third p arty softw are u sage, and not typ ically requ ired by end u ser ap p lications. A note on the CamExpert examples show n here: The examples show n for illustrative purposes and may not entirely reflect the features and parameters available from the camera model used in your application. Camera Information Category Cam era inform ation can be retrieved via a controlling ap p lication. Param eters su ch as cam era m od el, firm w are version, etc. are read to u niqu ely id entify the connected P4 d evice. These featu res are typ ically read -only. The Cam era Inform ation Category grou p s inform ation sp ecific to the ind ivid u al cam era. In this category the nu m ber of featu res show n is id entical w hether the view is Beginner, Exp ert, or Gu ru . Featu res listed in the d escrip tion table bu t tagged as Invisible are u su ally for Teled yne DALSA or third p arty softw are u sage—not typ ically need ed by end u ser ap p lications. Teledyne DALSA 03-032-20176-00 52 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Camera Information Feature Descriptions The follow ing table d escribes these p aram eters along w ith their view attribu tes and in w hich version of the d evice the featu re w as introd u ced . Ad d itionally the Device Version colu m n w ill ind icate w hich p aram eter is a m em ber of the DALSA Featu res N am ing Convention (u sing the tag D FN C), verses the GenICam Stand ard Featu res N am ing Convention (SFN C not show n). The Device Version nu m ber rep resents the cam era softw are fu nctional grou p , not a firm w are revision nu m ber. Display Name Feature Description Mod el N am e DeviceMod elN am e Disp lays the d evice m od el nam e. (RO) Vend or N am e DeviceVend orN am e Disp lays the d evice vend or nam e. (RO) Device Version DeviceVersion Manu factu rer Info DeviceManu factu rerInfo Disp lays the d evice version. This tag w ill also highlight if the firm w are is a beta or cu stom d esign. (RO) This featu re p rovid es extend ed m anu factu rer inform ation abou t the d evice. (RO) 03-032-20176-00 Device Version & View 1.00 Beginner 1.00 Beginner 1.00 Beginner 1.00 Beginner Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Display Name Feature Firm w are Version DeviceFirm w areVersion Serial N u m ber DeviceID Pow er-u p Configu ration Selector UserSetDefau ltSelector Factory Setting UserSet1 D efault UserSet1 UserSet2 UserSet2 UserSet3 UserSet3 UserSet4 UserSet4 UserSet5 UserSet5 UserSet6 UserSet6 UserSet7 UserSet7 UserSet8 UserSet8 User Set Selector UserSetSelector Factory Setting D efault UserSet 1 UserSet1 UserSet 2 UserSet2 UserSet3 UserSet3 UserSet4 UserSet4 UserSet5 UserSet5 Teledyne DALSA 53 Description Disp lays the cu rrently load ed firm w are version nu m ber. Firm w are files have a u niqu e nu m ber and have the .cbf file extension. (RO) Disp lays the d evice‘s factory set cam era serial nu m ber. (RO) Selects the cam era configu ration set to load and m ake active on cam era p ow er-u p or reset. The cam era configu ration sets are stored in cam era non -volatile m em ory. (RW) Load factory default feature settings Select the u ser d efined configu ration UserSet 1 as the Pow er-u p Configu ration. Select the u ser d efined configu ration UserSet 2 as the Pow er-u p Configu ration Select the u ser d efined configu ration UserSet 3 as the Pow er-u p Configu ration Select the u ser d efined configu ration UserSet 4 as the Pow er-u p Configu ration. Select the u ser d efined configu ration UserSet 5 as the Pow er-u p Configu ration. Select the u ser d efined configu ration UserSet 6 as the Pow er-u p Configu ration. Select the u ser d efined configu ration UserSet 7 as the Pow er-u p Configu ration. Select the u ser d efined configu ration UserSet 8 as the Pow er-u p Configu ration. Selects the cam era configu ration set to load featu re settings from or save cu rrent featu re settings to. The Factory set contains d efau lt cam era featu re settings. (RW) Select the default camera feature settings saved by the factory Select the User-d efined Configu ration sp ace UserSet1 to save to or load from featu res settings p reviou sly saved by the u ser. Select the User-d efined Configu ration sp ace UserSet2 to save to or load from featu res settings p reviou sly saved by the u ser. Select the User-d efined Configu ration sp ace UserSet3 to save to or load from featu res settings p reviou sly saved by the u ser. Select the User-d efined Configu ration sp ace UserSet4 to save to or load from featu res settings p reviou sly saved by the u ser. Select the User-d efined Configu ration sp ace UserSet5 to save to or load from featu res settings p reviou sly saved by the u ser. Device Version & View 1.00 Beginner 1.00 Beginner 1.00 Beginner 1.00 Beginner 03-032-20176-00 54 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Display Name Feature Description Device Version & View UserSet6 UserSet6 UserSet7 UserSet7 UserSet8 UserSet8 Pow er-on User Set UserSetDefau ltSelector Cu rrent User Set UserSetSelector Load Configu ration UserSetLoad Save Configu ration UserSetSave Device Bu ilt-In Self Test Statu s d eviceBISTStatu s LED Color d eviceLEDColorControl Tem p eratu re DeviceTem p eratu re Disp lays the internal op erating tem p eratu re of the cam era. (RO) Refresh Tem p eratu re refreshTem p eratu re Press to d isp lay the cu rrent internal op erating tem p eratu re of the cam era. Inp u t Voltage d eviceInp u tVoltage Disp lays the inp u t voltage to the cam era at the p ow er connector (RO) Refresh Voltage refreshVoltage Press to d isp lay the cu rrent inp u t voltage of the cam era at the p ow er connector License Key secu rityUp grad e 03-032-20176-00 Select the User-d efined Configu ration sp ace UserSet6 to save to or load from featu res settings p reviou sly saved by the u ser. Select the User-d efined Configu ration sp ace UserSet7 to save to or load from featu res settings p reviou sly saved by the u ser. Select the User-d efined Configu ration sp ace UserSet8 to save to or load from featu res settings p reviou sly saved by the u ser. Allow s the u ser to select betw een the factory set and 1 to 8 u ser sets to be load ed at p ow er u p Points to w hich u ser set (1-8) or factory set that is load ed or saved w hen the UserSetLoad or UserSetSave com m and is u sed Load s the cam era configu ration set sp ecified by the User Set Selector featu re, to the cam era and m akes it active. (W) Saves the cu rrent cam era configu ration to the u ser set sp ecified by the User Set Selector featu re. The u ser sets are located on the cam era in non-volatile m em ory. (W) Determ ine the statu s of the d evice u sing the ‗Bu ilt-In Self Test‘. Possible retu rn valu es are d evice-sp ecific. (RO) Disp lays the statu s of the LED on the back of the cam era. (RO) 1.00 Beginner 1.00 Beginner 1.00 Beginner 1.00 Beginner 1.00 DFN C Beginner 1.00 DFN C Beginner 1.00 DFN C Beginner 1.00 DFN C Beginner 1.00 DFN C Beginner 1.00 DFN C Beginner 1.00 DFN C Gu ru Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual 55 Camera Configuration Selection Dialog Cam Exp ert p rovid es a d ialog box w hich com bines the featu res to select the cam era p ow er u p state and for the u ser to save or load a cam era state from Genie m em ory. Camera Power-up Configuration The first d rop list selects the cam era configu ration state to load on p ow er-u p (see featu re UserSetDefaultSelector). The u ser chooses from one factory d ata set or one of tw o p ossible u ser saved states. User Set Configuration Management The second d rop list allow s the u ser to change the cam era configu ration anytim e after a p ow er-u p (see featu re UserSetSelector). To reset the cam era to the factory configu ration, select Factory Setting and click Load . To save a cu rrent cam era configu ration, select User Set 1 to 8 and click Save. Select a saved u ser set and click Load to restore a saved configu ration. Teledyne DALSA 03-032-20176-00 56 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Camera Control Category The P4 cam era controls, as show n by Cam Exp ert, grou p s sensor sp ecific p aram eters. This grou p inclu d es controls for line rate, exp osu re tim e, scan d irection, and gain. Param eters in gray are read only, either alw ays or d u e to another p aram eter being d isabled . Param eters in black are u ser set in Cam Exp ert or p rogram m able via an im aging ap p lication. 03-032-20176-00 Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual 57 Camera Control Feature Descriptions The follow ing table d escribes these p aram eters along w ith their view attribu te and m inim u m cam era firm w are version requ ired . Ad d itionally the firm w are colu m n w ill ind icate w hich p aram eter is a m em ber of the DALSA Featu res N am ing Convention (DFN C), verses the GenICam Stand ard Featu res N am ing Convention (SFN C not show n). The Device Version nu m ber rep resents the cam era softw are fu nctional grou p , not a firm w are re vision nu m ber. Display Name Feature Description Trigger Sou rce Trigger Sou rce Defines the sou rce of external trigger (RO) Trigger Selector Trigger Selector Defines w hat the trigger initiates (RO) Trigger Mod e Trigger Mod e Determ ines the sou rce of trigger to the cam era, internal or external (CC1) Inp u t Pixel Size 8 Bits/ Pixel 10 Bits/ Pixel 12 Bits/ Pixel Internal Line Rate p ixelSizeInp u t Measu red Line Rate Refresh m easu red line rate Exp osu re Tim e Sou rce Tim ed m easu reLineRate Size of the im age inp u t p ixels, in bits p er p ixel. (RO) Sensor ou tp u t d ata p ath is 8 bits p er p ixel. Sensor ou tp u t d ata p ath is 10 bits p er p ixel. Sensor ou tp u t d ata p ath is 12 bits p er p ixel. Sp ecifies the cam era internal line rate, in H z w hen Trigger m od e set to internal. N ote that any u ser entered valu e is au tom atically ad ju sted to a valid cam era valu e. Sp ecifies the line rate p rovid ed to the cam era by either internal or external sou rce (RO) Press to show the cu rrent line rate p rovid ed to the cam era by either internal or external sou rces Trigger Wid th TriggerWid th Exp osu re Tim e Exp osu reTim e Measu red Exp osu re Tim e Refreshed m easu red exp osu re tim e m easu reExp osu reTim e Teledyne DALSA Bp p 8 Bp p 10 Bp p 12 Acqu isitionLineRate refreshMeasu reLineRate Exp osu reMod e Tim ed refreshMeasu reExp osu reTim e Sets the op eration m od e for the cam era‘s exp osu re (or shu tter). (RO) The exp osu re d u ration tim e is set u sing the Exp osu re Tim e featu re and the exp osu re starts w ith a LineStart event. Uses the w id th of the trigger signal p u lse to control the exp osu re d u ration. Sets the exp osu re tim e (in m icrosecond s) w hen the Exp osu re Mod e featu re is set to Tim ed . Sp ecifies the exp osu re tim e p rovid ed to the cam era by either internal or external sou rce (RO) Press to d isp lay the cu rrent exp osu re tim e p rovid ed to the cam era. 03-032-20176-00 Device Version & View 1.00 DFN C Beginner 1.00 DFN C Beginner 1.00 DFN C Beginner 1.00 DFN C Gu ru 1.00 Beginner 1.00 Beginner 1.00 Beginner 1.00 Beginner 1.00 Beginner 1.00 Beginner 1.00 Beginner 58 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Display Name Direction Sou rce Feature sensorScanDirectionSou rce Internal Description Device Version & View 1.00 Beginner Direction d eterm ined by valu e of SensorScanDirection External Internal Direction sensorScanDirection Gain Forw ard Reverse Gain Offset BlackLevel Line Sp atial Correction sensorLineSp atialCorrection Direction control d eterm ined by valu e on CC3 When ScanDirectionSou rce set to Internal, d eterm ines the d irection of the scan Sets the selected gain as an am p lification factor ap p lied to the im age. Controls the black level as an absolu te p hysical valu e. This rep resents a DC offset ap p lied to the vid eo signal, in DN (d igital nu m ber) u nits. Set the nu m ber of row s betw een im aging lines Digital I/O Control Feature Descriptions 03-032-20176-00 Teledyne DALSA 1.00 Beginner 1.00 Beginner 1.00 Beginner 1.00 Beginner Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Display Name Feature 59 Description Trigger Sou rce Trigger Sou rce Defines the sou rce of external trigger (RO) Trigger Selector Trigger Selector Defines w hat the trigger initiates (RO) Trigger Mod e Trigger Mod e Determ ines the sou rce of trigger to the cam era, internal or external (CC1) Teledyne DALSA 03-032-20176-00 Device Version & View 1.00 DFN C Beginner 1.00 DFN C Beginner 1.00 DFN C Beginner 60 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Flat Field Category The P4 Flat Field controls, as show n by Cam Exp ert, grou p p aram eters u sed to configu re cam era p ixel form at, and im age crop p ing. Ad d itionally a featu re control to select and ou tp u t an internal test im age sim p lifies the p rocess of setting u p a cam era w ithou t a lens. Param eters in gray are read only, either alw ays or d u e to another p aram eter being d isabled . Param eters in black are u ser set in Cam Exp ert or p rogram m able via an im aging ap p lication. Featu res listed in the d escrip tion table bu t tagged as Invisible are u su ally for Teled yne DALSA or third p arty softw are u sage—not typ ically need ed by end u ser ap p lications. Flat Field Control Feature Description The follow ing table d escribes these p aram eters along w ith their view attribu te and m inim u m cam era firm w are version requ ired . Ad d itionally the firm w are colu m n w ill ind icate w hich p aram eter is a m em ber of the DALSA Featu res N am ing Convention (DFN C), verses the GenICam Stand ard Featu res N am ing Convention (SFN C not show n). The Device Version nu m ber rep resents the cam era softw are fu nctional grou p , not a firm w are revision nu m ber. Display Name Mod e 03-032-20176-00 Feature flatfield CorrectionMod e Description Device Version & View 1.00 Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Display Name Feature Off Off On On Initialize Initialize ScanDirectionControlled ScanDirectionControlled Select flatfield Correction Scan Direction Reverse Set flatfield ScanDirectionReverseSet Calibration Algorithm flatfield CorrectionAlgorithm Basic Basic Low Pass Low Pass Calibration Target flatfield CalibrationTarget Calibration Sam p le Size Lines_2048 Lines_4096 flatfield CalibrationSam p leSize ROI Offset X Lines_2048 Lines_4096 flatfield CalibrationROIOffsetX ROI Wid th flatfield CalibrationROIWid th Teledyne DALSA 61 Description FPN and flat field coefficients d isabled . FPN and flat field coefficients enabled . Reset all FPN to 0 and all flat field coefficients to 1. Different u ser set load ed d ep end ing on d irection. Device Version & View Beginner DFN C When flatfield CorrectionMod e is set to ScanDirectionControlled this featu re selects the UserSEt (1 to8) w hich w ill be u sed for the reverse scan d irection. Selection betw een tw o d ifferent flat field algorithm s. Direct calcu lation of coefficients based on average line valu es and target. First each color is flat field ed to its p eak valu e and then the color gains are u sed to achieve the target. A low p ass filter is first ap p lied to the average line valu es before calcu lating the coefficients. Use this algorithm if the calibration target is not u niform ly w hite or it is not p ossible to d efocu s the im age. Becau se of the low p ass filter this algorithm is not able to correct p ixel-to-p ixel variations and so it is p referable to u se the ―Basic‖ algorithm . 1.00 Beginner DFN C Set a valu e betw een 0 and 255 to w hich the flat field algorithm w ill taget the im age to. Sets the nu m ber of lines to be averaged d u ring a flat field calibration 1.00 Beginner DFN C 1.00 Beginner DFN C Set the starting p oint of a region of interest w here a flat field calibration w ill be p erform ed Sets the w id th of the region on interest w here a flat field calibration w ill be p erform ed 1.00 Beginner DFN C 1.00 Beginner DFN C 1.00 Beginner DFN C 03-032-20176-00 62 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Display Name Feature Description Calibrate FPN flatfield CalibrationFPN Initiates the FPN calibration p rocess Calibrate PRN U flatfield CalibrationPRN U Initiates the PRN U or Flatfield p rocess Device Version & View 1.00 Beginner DFN C 1.00 Beginner DFN C Region of Interest (ROI) The ROI featu re is related to flat field calibration. It is im p ortant to sp ecify an ROI w hen the object being im aged has areas that have black, non illu m inated areas su ch as beyond the ed ge of a film that is front illu m inated , or is satu rated , again beyond the ed ge of a film bu t in this case bright field back illu m inated . The ROI featu re allow s from one to fou r sp ecific regions of the p ixel line to be sp ecified w here flat field calibration w ill take p lace. Pixel d ata ou tsid e the ROI w ill not be u sed w hen p erform ing flat field calibration. Image Format Control Category The P4 Im age Form at controls, as show n by Cam Exp ert, grou p s p aram eters u sed to configu re cam era p ixel form at, im age crop p ing, and the test p attern. Param eters in gray are read only, either alw ays or d u e to another p aram eter being d isabled . Param eters in black are u ser set in Cam Exp ert or p rogram m able via a n im aging ap p lication. Featu res listed in the d escrip tion table bu t tagged as Invisible are u su ally for Teled yne DALSA or third p arty softw are u sage—not typ ically need ed by end u ser ap p lications. 03-032-20176-00 Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Teledyne DALSA 63 03-032-20176-00 64 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Image Format Control Feature Description The follow ing table d escribes these p aram eters along w ith their view attribu te and m inim u m cam era firm w are version requ ired . Ad d itionally the firm w are colu m n w ill ind icate w hich p aram eter is a m em ber of the DALSA Featu res N am ing Convention (DFN C), verses the GenICam Stand ard Featu res N am ing Convention (SFN C not show n). The Device Version nu m ber rep resents the cam era softw are fu nctional grou p , not a firm w are revision nu m ber. Display Name Feature Description Test Pattern TestIm ageSelector Off Off Ram p Line Mirroring Off On Ram p ReverseX Off On Selects a grey scale Pixel Form at Pixel Form at Ou tp u t im age p ixel cod ing form at of the sensor. Wid th Wid th Max Wid th Wid thMax H eight H eight Mu ltip le AOI Mod e Off Active m u ltip leAOIMod e Off Active Wid th of the Im age p rovid ed by the d evice (in p ixels).(RO) The m axim u m im age horizontal d im ension of the im age. (RO) H eight of the Im age p rovid ed by the d evice (in lines). (RO) Tu rns on an ou tp u t Area of Interest Area of interest is off Area of interest is on Mu ltip le AOI Cou nt m u ltip leAOICou nt Set the nu m ber of ou tp u t area of interest 1-4 Mu ltip le AOI Selector m u ltip leAOISelector Selects the area of interest to be setu p AOI Offset X m u ltip leAOIOffsetX Set the start of area of interest (p ixels) AOI Wid th m u ltip leAOIWid th Set the w id th of area of interest (p ixels) 03-032-20176-00 Selects the typ e of test im age that is sent by the cam era. Choices are either as d efined by SN FC and / or as p rovid ed by the d evice m anu factu rer. Selects sensor vid eo to be ou tp u t from sensor Device Version & View 1.00 Beginner DFN C 1.00 Beginner DFN C Vid eo ou tp u t in norm al ord er Vid eo ou tp u t in a reverse ord er 1.00 Beginner DFN C 1.00 Beginner 1.00 Beginner 1.00 Beginner 1.00 Beginner DFN C 1.00 Beginner DFN C 1.00 Beginner DFN C 1.00 Beginner 1.00 Beginner DFN C Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual 65 Binning Binning is the com bining of tw o or m ore im age sensor p ixels to form a new com bined p ixel. A binned im age u sing the sam e exp osu re settings as a non-binned im age w ill show an im p roved signal-to-noise ratio, red u ced scanning tim es (d u e to low er sp atial resolu tion) and save as a sm aller im age file size com p ared w ith a non-binned im age, at the exp ense of low er im age resolu tion. In 2 x 2 binning, 4 p hysical p ixels on the sensor are com bined into one im age p ixel. This op erating m od e is id eal for ap p lications that requ ire faster acqu isition and p rocessing tim es and requ ire greater signal collection. For this cam era, the d efau lt bin ning valu e is 1 x 1, The Binning Vertical and Binning Horizontal featu res in the Image Format Control set rep resents the nu m ber of horizontal p ixels that w ill be com bined (ad d ed ) together. N ote: Com p ared to ru nning the cam era in high -sensitivity m od e, ru nning the cam era in 2 x 2 binning m od e w ill resu lt in 4x resp onsivity, not 2x. Image Format Control Parameter Binning Vertical Binning H orizontal Description This featu re rep resents the nu m ber of vertical p hotosensitive cells that m u st be com bined (ad d ed ) together : 2. N ote: TDI stages m u st be set to 1 before vertical binning can be changed to 2x. This featu re rep resents the nu m ber of horizontal p hoto sensitive cells that m u st be com bined (ad d ed ) together. Figure 24: 2x2 Binning in Area Mode Area of Interest (AOI) Setup The Area of Interest (AOI) featu re can be u sed to red u ce the am ou nt of im age-d ata ou tp u t from the cam era. Use this featu re w hen there are areas in the im age that contain u nneed ed inform ation. An exam p le w here you w ou ld u se this featu re is in an ap p lication that is insp ecting several sep arated lanes of objects w ith one cam era and the im age betw een the lanes can be ignored . Teledyne DALSA 03-032-20176-00 66 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual The AOI featu re allow s from one to fou r sp ecific areas of the p ixel line to be sp ecified w here im age d ata w ill be ou tp u t. Since the AOI featu re red u ces the am ou nt of d ata ou tp u t, this has the ad d itional benefit of allow ing the cam eras to op erate at higher EXSYN C rates w hen u sing base or m ed iu m cam era link m od es. For exam p le, if the total nu m ber of p ixels for the sp ecified AOI`s is less than 1 K w hen u sing base Cam era Link m od e at 85 MH z, the m axim u m EXSYN C rate can be 100 KH z; versu s 41 KH z if all 4 K p ixels w ere ou tp u t. N ote: The setu p of AOI is alw ays w ith resp ect to the sensor. Therefore, if you are u sing the m irroring m od e w ith AOI, be aw are that p ixel one w ill be on the right sid e of the d isp layed im age. In order to set up an AOI for the camera: 1. 2. 3. 4. 5. The AOI m od e m u st first be in the off p osition. Use the AOI Cou nt to select the total nu m ber of AOIs d esired to a m ax of 4. To set u p each AOI ind ivid u ally u se the AOI Selector to p oint to the AOI to be set u p . AOI Offset X is u sed ind icate the starting p ixel of the AOI. AOI Wid th is u sed to ind icate the w id th of the AOI. 1. Must be off to set up the AOI. 2. Set up the num ber of AOI d esired to m ax of 4. 3. Select area to set up. 4. Select beginning of selected area 5. Set up w id th of selected area 03-032-20176-00 Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual 67 In order to initiate operation of the AOI once setup: 1. 2. The AOI m od e m u st be changed to Active. Be su re to set the fram e grabber im age w id th to the su m of all AOI w id ths set u p in the cam era. Once all AOI are set up change to active. Active Teledyne DALSA 03-032-20176-00 68 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Instructions on using the camera scan direction to control camera parameters The cam era is cap able of ad ju sting cam era p aram eters on -the-fly based on the scan d irection of the cam era. These p aram eters inclu d e gain, flat field coefficients, w hite balance and exp osu re tim e. 1. 2. The first step is to p u t the cam era in the reverse d irection. This can be d one u sing a reverse signal throu gh CC3 and the Direction Sou rce set to external or by having the Direction Sou rce set to Internal and the Internal Direction set to reverse. Set u p all the d esired p aram eters, inclu d ing flat field corrections. First, setup param eters for reverse d irection. 3. 03-032-20176-00 Save the cam era p aram eters to a User set other than the d efau lt u ser set. Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual 69 Save to a user set choice. 4. 5. The next step is to p u t the cam era in the forw ard d irection. This can be d one u sing a forw ard signal throu gh CC3 and the Direction Sou rce set to external or by having the Direction Sou rce set to Internal and the Internal Direction set to forw ard . Set u p all the d esired p aram eters inclu d ing d oing a flat field . Setup param eters for forw ard d irection. 6. Teledyne DALSA Save the cam era set to User Set other than the saved to for the reverse d irection. The forw ard d irection u ser set and the d efau lt u ser set m u st be the sam e. 03-032-20176-00 70 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Forw ard d irection user set and d efault user set m ust be the sam e. Save to a d ifferent user set than the one selected for reverse d irection . Set the Flat Field m od e to Scan d irection Controlled . In the Flat Field area change the m od e to Scan Direction Controlled . A Note on External Direction, Direction Source, and User Sets If u sing external d irection control throu gh CC3 ensu re that the Direction Sou rce is both set to external and saved in the u ser set. Also ensu re that the p olarity on CC3 is set ap p rop riately for the d esired d irection. 03-032-20176-00 Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual 71 Transport Layer Control Category Param eters in gray are read only, either alw ays or d u e to another p aram eter being d isabled . Param eters in black are u ser set in Cam Exp ert or p rogram m able via an im aging ap p lication. Featu res listed in the d escrip tion table bu t tagged as Invisible are u su ally for Teled yne DALSA or third p arty softw are u sage—not typ ically need ed by end u ser ap p lications. Teledyne DALSA 03-032-20176-00 72 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Transport Layer Feature Descriptions The follow ing table d escribes these p aram eters along w ith their view attribu te and m inim u m cam era firm w are version requ ired . Ad d itionally the firm w are colu m n w ill ind icate w hich p aram eter is a m em ber of the DALSA Featu res N am ing Convention (DFN C), verses the GenICam Stand ard Featu res N am ing Convention (SFN C not show n). Display Name Feature Description Restart Cam era DeviceReset Used to restart the cam era, w arm reset XML Major Version DeviceManifestXMLMajorVersion XML Minor Version DeviceManifestXMLMinorVersion Last GenCP Statu s genCPStatu s Refresh GenCP Statu s Cam era Link Configu ration refreshGenCPStatu s Together w ith DeviceManifestXMLMinorVersion sp ecifies the GenICam ™ featu re d escrip tion XML file version (RO) Together w ith DeviceManifestXMLMajorVersion sp ecifies the GenICam ™ featu re d escrip tion XML file version (RO) If a featu re read or w rite fails then Sap era only retu rns that it fails – read this featu re to get the actu al reason for the failu re Retu rns the last error Read ing this featu re clears it Press to retu rn the cu rrent statu s of the GenCP Cam era Link Ou tp u t configu ration Cam era Link Configu ration Tap Geom etry ClConfigu ration Base Med iu m Fu ll Deca clDeviceClockFrequ ency CL85MH z CL66MH z DeviceTap Geom etry Device Version & View 1.00 Beginner DFN C 1.00 Beginner DFN C 1.00 Beginner DFN C 1.00 Beginner DFN C 1.00 Beginner 1.00 Beginner Set the cam era link clock rate 1.00 Beginner (RO) 1.00 Beginner Acquisition and Transfer Control Category The P4 Acqu isition and Transfer controls, as show n by Cam Exp ert, grou p s p aram eters u sed to configu re the op tional acqu isition m od es of the d evice. Param eters in gray are read only, either alw ays or d u e to another p aram eter being d isabled . Param eters in black are u ser set in Cam Exp ert or p rogram m able via an im aging ap p lication. Featu res listed in the d escrip tion table bu t tagged as Invisible are u su ally for Teled yne DALSA or third p arty softw are u sage—not typ ically need ed by end u ser ap p lications. 03-032-20176-00 Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual 73 Acquisition and Transfer Control Feature Descriptions The follow ing table d escribes these p aram eters along w ith their view attribu te and m inim u m cam era firm w are version requ ired . Ad d itionally the firm w are colu m n w ill ind icate w hich p aram eter is a m em ber of the DALSA Featu res N am ing Convention (DFN C), verses the GenICam Stand ard Featu res N am ing Convention (SFN C not show n). Display Name Feature Description Device Registers Stream ing Start Device Registers Stream ing End Check Stream Valid ity DeviceRegistersStream ingStart Annou nces the start of registers stream ing w ithou t im m ed iate checking for consistency. Annou nces end of registers stream ing and p erform s valid ation for registers consistency before activating them . Press to check the valid ity of the cu rrent register set. Registers Valid DeviceRegistersValid Teledyne DALSA DeviceRegistersStream ingEnd DeviceRegistersCheck States if the cu rrent register set is valid and consistent. Device Version & View 1.00 Beginner DFN C 1.00 Beginner DFN C 1.00 Beginner DFN C 1.00 Beginner DFN C 03-032-20176-00 74 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Serial Port Control Category The Serial Port control in Cam Exp ert allow s the u ser to select an available cam era serial p ort and review its settings. This section also d escribes the Genie TS Fram ew ork Virtu al Serial Port Driver and the u se of the Genie TS serial p ort as an interface from an Ethernet netw ork to a serial p ort control system for other d evices. Featu res listed in the d escrip tion table bu t tagged as Invisible are u su ally for Teled yne DALSA or third p arty softw are u sage—not typ ically need ed by en d u ser ap p lications. Serial Port Control Feature Descriptions The Device Version nu m ber rep resents the cam era softw are fu nctional grou p , not a firm w are revision nu m ber. Display Name Bau d Rate Feature DeviceSerialPortBau d Rate Bau d Bau d Bau d Bau d Bau d Bau d Bau d Bau d Bau d Bau d Bau d Bau d Bau d Bau d 9600 19200 57600 115200 230400 460800 921600 Serial Port Parity 03-032-20176-00 9600 19200 57600 115200 230400 460800 921600 d eviceSerialPortParity Description Sets the bau d rate u sed by the selected d evice‘s serial p ort. Available bau d rates are d evice-sp ecific. Bau d rate is 9600 Bau d rate is 19200 Bau d rate is 57600 Bau d rate is 115200 Bau d rate is 230400 Bau d rate is 460800 Bau d rate is 921600 View 1.00 Beginner DFN C Sets the p arity checking typ e on the selected serial p ort.(RO) 1.00 Beginner Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Display Name N one Data Size Eight Bits Stop Bits Stop bits1 Feature N one d eviceSerialPortDataSize bp c8 d eviceSerialPortN u m berOf Stop Bits Stop bits1 75 Description Parity checking is d isabled Sets the bits p er character (bp c) to u se (RO). Use 8 bits p er character Sets the nu m ber of stop bits to u se. Use 1 stop bit View DFN C 1.00 Beginner DFN C 1.00 Beginner DFN C File Access Control Category The File Access control in Cam Exp ert allow s the u ser to qu ickly u p load variou s d ata files to the connected P4. The su p p orted d ata files are for P4 firm w are u p d ates, Flat Field coefficients. LUT d ata tables, and a cu stom im age for u se as an internal test p attern. Featu res listed in the d escrip tion table bu t tagged as Invisible are u su ally for Teled yn e DALSA or third p arty softw are u sage—not typ ically need ed by end u ser ap p lications. Teledyne DALSA 03-032-20176-00 76 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual File Access Control Feature Descriptions Display Name File Selector Feature FileSelector FPGA Cod e Firm w are1 Micro Cod e CCI XML User Set Factory FlatField coefficients User FPN ColorCorrectionMatrix Cam eraData File Op eration Selector FileOp erationSelector Op en Op en Close Close Read Read Write Write Delete Delete File Op eration Execu te FileOp erationExecu te File Op en Mod e FileOp enMod e Read Write File Access Bu ffer Read Write FileAccessBu ffer File Access Offset FileAccessOffset File Access Length FileAccessLength 03-032-20176-00 Description Selects the file to access. The file typ es w hich are accessible are d evice-d ep end ent. Up load new FPGA to the cam era w hich w ill execu te on the next cam era reboot cycle. Up load new m icro cod eto the cam era w hich w ill execu te on the next cam era reboot cycle. Up load new CCI to the cam era w hich w ill execu te on the next cam era reboot cycle. Up load new XML to the cam era w hich w ill execu te on the next cam era reboot cycle. Use UserSetSelector to sp ecify w hich u ser set to access. Use UserSetSelector to sp ecify w hich u ser flatfield to access. Use UserSetSelector to sp ecify w hich u ser FPN to access. Up load new color correction m atrix to the cam era. Dow nload cam era inform ation and send for cu stom er su p p ort. Selects the target op eration for the selected file in the d evice. This op eration is execu ted w hen the File Op eration Execu te featu re is called . Select the Op en op eration - execu ted by FileOp erationExecu te. Select the Close op eration - execu ted by FileOp erationExecu te. Select the Read op eration - execu ted by FileOp erationExecu te. Select the Write op eration - execu ted by FileOp erationExecu te. Select the Delete op eration - execu ted by FileOp erationExecu te. Execu tes the op eration selected by File Op eration Selector on the selected file. Selects the access m od e u sed to op en a file on the d evice. Select READ only op en m od e Select WRITE only op en m od e Defines the interm ed iate access bu ffer that allow s the exchange of d ata betw een the d evice file storage and the ap p lication. Controls the m ap p ing offset betw een the d evice file storage and the file access bu ffer. Controls the m ap p ing length betw een the d evice file storage and the file access bu ffer. View 1.00 Beginner DFN C 1.00 Gu ru 1.00 Gu ru 1.00 Gu ru 1.00 Gu ru 1.00 Gu ru 1.00 Gu ru Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Display Name File Op eration Statu s Feature FileOp erationStatu s Su ccess Su ccess Failu re Failu re File Unavailable FileUnavailable File Invalid FileInvalid File Op eration Resu lt FileOp erationResu lt File Size FileSize 77 Description Disp lays the file op eration execu tion statu s. (RO). The last file op eration has com p leted su ccessfu lly. The last file op eration has com p leted u nsu ccessfu lly for an u nknow n reason. The last file op eration has com p leted u nsu ccessfu lly becau se the file is cu rrently u navailable. The last file op eration has com p leted u nsu ccessfu lly becau se the selected file in not p resent in this cam era m od el. Disp lays the file op eration resu lt. For Read or Write op erations, the nu m ber of su ccessfu lly read / w ritten bytes is retu rned . (RO) Rep resents the size of the selected file in bytes. View 1.00 Gu ru 1.00 Gu ru 1.00 Gu ru File Access via the CamExpert Tool 1. Click on the ―Setting…‖ bu tton to show the file selection m enu . 2. From the Typ e d rop m enu , select the file typ e that w ill be u p load ed to the cam era. Teledyne DALSA 03-032-20176-00 78 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual 3. 4. 5. 6. 7. From the File Selector d rop m enu , select the cam era m em ory location for the u p load ed d ata. This m enu p resents only the ap p licable d ata locations for the selected file typ e. Click the Brow se bu tton to op en a typ ical Wind ow s Exp lorer w ind ow . Select the sp ecific file from the system d rive or from a netw ork location. Click the Up load bu tton to execu te the file transfer to the cam era. N ote that firm w are changes requ ire a d evice reset com m and from the Cam era Inform ation Controls and , ad d itionally, Cam Exp ert shou ld be shu td ow n and restarted follow ing a reset. Download a List of Camera Parameters For d iagnostic p u rp oses you m ay w ant to d ow nload a list of all the p aram eters and valu es associated w ith the cam era. 1. Go to File Access Control 2. Click on Settings 3. In the ―Typ e‖ d rop d ow n box select ―Miscellaneou s.‖ 4. In the ―File selector‖ d rop d ow n box select ―Cam eraData .‖ 5. 6. H it ―Dow nload ‖ Save the text file and send the file to Teled yne DALSA cu stom er su p p ort. 03-032-20176-00 Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Teledyne DALSA 79 03-032-20176-00 80 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Appendix B: ASCII Commands The follow ing com m and s can be u sed to control the Teled yne DALSA Piranha4 cam eras. Accessing the Three Letter Commands (TLC) To access the TLC an ASCII-based com m u nications interface ap p lication, su ch as H yp erTerm inal. Ad d itionally it is p ossible to u se the fu nctions of clserxxx.dll or clallserial.dll as d efined in the Cam era Link Sp ecification. Figure 25: Serial DLL hierarchy as mentioned in the Camera Link Specification 1. 2. 3. 4. 5. Cycle p ow er to the cam era: by either a) issu ing the reset cam era com m and (rc), or b) p ow ering the cam era OFF and then ON . Load the ASCII interface u sing: 9600 bau d 8 d ata bits no p arity 1 stop bit no flow control local echo (carriage retu rn / linefeed ) Wait for a stable statu s LED color (green or red ) before p roceed ing. N ote that all entries in H yp erTerm inal w ill be ignored u ntil a stable LED color is obtained . In case of H yp erTerm inal, p ress the <ESC> key. Once <ESC> has been entered the help screen ap p ear s. 03-032-20176-00 Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual 81 Notes on Using Alternatives to HyperTerminal If you are u sing interfaces other than H yp erTerm inal, the ASCII character, ESC, is d ecim al 27 and need s to be issu ed . From the com m and line insert ESC by u sing ALT+2+7 of the activated N u m Pad . In som e cases this need s to be follow ed by a carriage retu rn or a linefeed to send this to the cam era. In ASCII the ESC character m ay look like this: “←”. ASCII to GenCP To sw itch from the ASCII-com m and interface to the GenCP interface, the cam era m u st be either reset (RC) or the p ow er m u st be cycled . N ote that GenCP and ASCII com m and s cannot be accessed sim u ltaneou sly. N ote that the HyperTerminal application is not available on the Window s 7 OS. Alternatives to HyperTerminal The follow ing alternative ASCII-interfaces have been tested and show n to w ork w ith this cam era: Pu TTY and TeraTerm . N ote that Pu TTY d oes not have Xm od em cap ability w hile TeraTerm d oes. Xm od en is requ ired to u p d ate cod e in the cam era. TeraTerm http :/ / logm ett.com / ind ex.p hp ?/ d ow nload / tera -term -473-freew are.htm l Pu TTY http :/ / p u tty.en.softonic.com / The cam era resp ond s to a sim p le ASCII-based p rotocol. A carriage retu rn <CR> end s each com m and . Example: to return the current detector settings gcp <CR> A com p lete list of the available d etector com m and s, their fo rm at and p aram eters can be d isp layed by send ing the help (h) com m and . Port Configuration Bau d : Bits: Parity: Stop bits: Flow Control: 9,600 8 N one 1 N one Echo typ ed characters locally. Rules The interface is not case sensitive One com m and and argu m ent(s) p er line To enter a floating p oint nu m ber p refix it w ith a ―F‖ – for exam p le ―ssg 0 f1.5‖ Error cod es retu rned are the sam e as the GenICam ™ interface – see Diagnostics | Error Cod es Follow each com m and w ith the carriage retu rn character – 0x0D Teledyne DALSA 03-032-20176-00 82 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Commands Full N ame Calibrate User FPN Mnemonic CCF Argument(s) # of lines to average D escription 2048 4096 Calibrate u ser FPN d ark flat field coefficients Full N ame Camera Link Speed Mnemonic CLS Argument(s) Frequ ency D escription Cam era Link clock frequ ency Full N ame Camera Link Mode Mnemonic CLM Argument(s) Mod e D escription Cam era Link Mod e Full N ame Calibrate Flatfield Mnemonic CPA Argument(s) Algorithm D escription N otes 03-032-20176-00 0. 1. 85 MH z 66 MH z 0. 1. 2. 3. Base Med iu m Full Deca 0. Basic 1. Low -p ass Filter # of lines to average 2048 4096 Target 0 to 4095 DN in 12 bit m od e 0 to 1023 DN in 10 bit m od e 0 to 255 DN in 8 bit m od e Calibrate u ser PRN U flat field coefficients Perform flat field calibration u sing the average of <# lines>. With filter algorithm this average line is then sm oothed and ou tlier p ixels are interp olated . Use this featu re if you r w hite reference is not featu reless. Ad ju st p ixel gain su ch that ou tp u t w ill be <target>. The target is first d ivid ed by horizontal binning factor and gain and then the offset is su btracted . Therefore the ou tp u t w ill go to the target. Becau se the PRN U can be less than 1, the target m ay be below the cu rrent m axim u m valu e. Coefficients are saved and load ed w ith u ser set (e.g. USS / USL) Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Full N ame D evice Scan Type Mnemonic D ST Argument(s) Mod e D escription N otes 83 0. Line Scan 1. Area Scan Use this com m and to sw itch betw een Area and Single Line m od es. Full N ame Flatfield Mode Mnemonic FFM Argument(s) Mod e 0. 1. 2. 3. Disable u se of u ser FPN and PRN U flat field correction coefficients Enable u se of u ser FPN and PRN U flat field correction coefficients Reset u ser FPN coefficients to zero and u ser PRN U coefficients to one Scan d irection controlled u ser set load ing D escription N otes Set flat field m od e Full N ame Set Flatfield Scan D irection Reverse Set Mnemonic FRS Argument(s) D escription N otes User Set N u m ber 1 to 8 Set scan d irection controlled reverse set Teledyne DALSA 03-032-20176-00 84 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Full N ame D isplay Camera Configuration Mnemonic GCP Argument(s) D escription N otes Disp lay cu rrent valu e of cam era configu ration p aram eters USER>gcp Model P4_CM_04K10D_00_R Microcode 03-081-20271-00 CCI 03-110-20270-00 FPGA 03-056-20419-00 Serial # 19620110 BiST: Good DefaultSet Ext Trig Line Rate Meas L.R. Max L.R. Exp. Mode Exp. Time Meas E.T. Max E.T. 0 Off 10000 10003 19607 Timed 50000 49993 99000 Test Pat. Direction TDI Stages Vert. Bin Hor. Bin Flat Field Filter Offset Gain Mirror AOI Mode: Scan Type CL Speed CL Config Pixel Fmt CPA ROI USER> 0:Off Internal, Forward 1 1 1 Off 0 0 1.00 Off Off Line Scan 85MHz Full 8 bits 1-4096 [Hz] [Hz] [Hz] [ns] [ns] [ns] Full N ame Get Value Mnemonic GET Argument(s) <‘p aram eter> D escription The ―get‖ com m and d isp lays the cu rrent valu e(s) of the featu re sp ecified in the string p aram eter. N ote that the p aram eter is p reced ed by a single qu ote ―‘‖. Using this com m and w ill be easier for control softw are than p arsing the ou tp u t from the ―gcp ‖ com m and . N otes 03-032-20176-00 Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Full N ame Help Mnemonic H Argument(s) D escription N otes Disp lay list of three letter com m and s 85 USER>h P4 (03-081-20271-00): Command Line Interpreter Oct 15 2012, 10:14:26 ccf - Calibrate User FPN <2048|4096> cls - Camera Link Speed <0 - 85MHz, 1 - 66MHz> clm - Camera Link Mode <0:Base 1:Med 2:Full 3:Deca> cpa - Calibrate Flatfield <0:basic 1:filter><2048|4096><DN target> dst - Device Scan Type <0 - Line Scan, 1 - Area Scan> ffm - Flat Field Mode <0:Off 1:On 2:Initialiaze 3:Scan direction controlled> frs - Set Flatfield Scan Direction Reverse Set <set 1-8> gcp - Display Camera Configuration get - Get value '<string> h - Help lpc - Load Pixel Coefficients <set 0-8> rc - Reset Camera roi - Set Flatfield ROI <1st pixel> <last pixel> rpc - Reset Flatfield Coefficients sac - Set AOI Count <value 1-4> sad - Set AOI Selector, Offset and Width <selector 1-AOI Count> <1st pixel> <width >= 40> sam - Set AOI Mode <1-enable, 0-disable> sbh - Horizontal Binning <1|2> sbr - Set Baud Rate <9600|57600|115200> sbv - Vertical Binning <1|2> scd - Direction <0:Fwd, 1:Rev 2:Ext> sem - Exposure Mode <0:Int 1:Ext> set - Exposure Time <ns> smm - Mirroring <0:Off 1:On> spf - Pixel Format <0:8 bits 1:10 bits 2:12 bits> ssb - Offset <DN> ssf - Internal Line Rate <Hz> ssg - Gain <0-System> f<gain> stg - TDI Stages <1|2> stm - External Trigger <0:Off 1:On> svm - Test Pattern <1, 3-6> usd - Default User Set <0-8> usl - Load User Set <0-8> uss - Save User Set <1-8> vt - Temperature vv - Input Voltage USER> Teledyne DALSA 03-032-20176-00 86 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Full N ame Load Pixel Coefficients Mnemonic LPC Argument(s) Set selector D escription N otes Load u ser set Load s FPN coefficients and PRN U coefficients from a u ser set ( only coefficeints, no other cam era p aram eters) Full N ame Reset Camera Mnemonic RC Argument(s) D escription N otes 0. Factory set 1-8. User sets Resets the cam era to the saved u ser d efau lt settings. These settings are saved u sing the u sd com m and . The m icro-controller reboots: Load any file u p d ates Clear over tem p eratu re cond ition Perform start u p cam era tests (BiST) Load FPGA cod e Configu re FPGA and sensor. Load d efau lt u ser set Bau d rate set to 9600 Full N ame Set Flatfield ROI Mnemonic ROI Argument(s) First p ixel Last p ixel 1 to 1 to 1 to 1 to 2048 4096 2048 4096 D escription N otes Flat field region of interest Sp ecifies the p ixels that CCF and CPA w ill calibrate o Pixel coefficients ou tsid e this region are not changed Last p ixel m u st be greater than or equ al to first p ixel Full N ame Reset Flatfield Coefficients Mnemonic RPC Argument(s) D escription N otes Reset all u ser FPN valu es to zero and all u ser PRN U coefficients to one 03-032-20176-00 Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual 87 Full N ame Set AOI Count Mnemonic SAC Argument(s) D escription N otes N u m ber of AOI‘s Set AOI Cou nter Full N ame Set AOI Selector Mnemonic SAD Argument(s) D escription N otes Selector Offset Wid th Define an AOI Mu st not overlap w ith Full N ame Set AOI Mode Mnemonic SAM Argument(s) Mod e D escription N otes Set AOI m od e Full N ame Set Binning Horizontal Mnemonic SBH Argument(s) Binning D escription N otes Set horizontal binning Available in all m od es: single line, TDI and Area Full N ame Set Baud Rate Mnemonic SBR Argument(s) Bau d rate D escription N otes Set bau d rate Send com m and and then change sp eed of H yp erTerm inal Teledyne DALSA 1 to 4 1 to 4 1 to AOI Cou nt – any p ixel can be starting p ixel N o less than 40 p ixels an alread y existing AOI 0. 1. Off / Disable Active / Enable 1. 2. Single p ixel Binning of 2 p ixels 9600 57600 115200 03-032-20176-00 88 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Full N ame Set Binning Vertical Mnemonic SBV 1. 2. Argument(s) Single p ixel Binning of 2 p ixels D escription N otes Set vertical binning Mu st be in Single line m od e (stg 1) Mu st be in Line scan m od e (d st 0) Full N ame D irection Mnemonic SCD Argument(s) Direction D escription N otes Set sensor scan d irection Full N ame Exposure Mode Mnemonic SEM Argument(s) Mod e D escription N otes Set exp osu re tim e m od e In internal m od e the exp osu re tim e is controlled by the SET com m and In external m od e the sensor is exp osed w hile CC1 signal is high External m od e is only available w hen the trigger m od e is also external (STM 1) SEM 1 overrid es internally generated ind ep end ent exp osu re tim es When CC1 signal falls line is read Full N ame Exposure Time Mnemonic SET Argument(s) D escription N otes Exp osu re tim e 11 000 to 3000000 [ns] Set internal exp osu re tim e in nanosecond s – 25 ns resolu tion Line tim e > ( Exp osu re tim e + 1,500 ns ) Full N ame Mirroring Mnemonic SMM Argument(s) Mod e D escription N otes Set m irroring m od e 03-032-20176-00 0. 1. 2. Forw ard Reverse (not available in single line m od e) External – controlled by CC3 signal (not available in single line m od e) 0. 1. Internal (―Tim ed ‖) External (―Pu lseWid th‖) 0. 1. Off Im age is flip p ed on the vertical axis Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Full N ame Pixel Format Mnemonic SPF Argument(s) Selector D escription N otes Set p ixel form at Full N ame Offset Mnemonic SSB Argument(s) Offset 89 0. 1. 2. 8 bits 10 bits 12 bits (only available w ith Base or Med iu m Cam era Link configu rations) N otes 8 bit -32 to 31 10-bit -128 to 127 12-bit -512 to 511 Set contrast offset – single valu e ad d ed to all p ixels after PRN U/ flat field coefficients (before gain). Range changes d ep end ing on p ixel form at (SPF) Full N ame Internal Line Rate Mnemonic SSF Argument(s) D escription N otes Line rate 1 to 70,000 [H z] Set internal line rate in H z Line tim e > ( Exp osu re tim e + 1,500 ns ) Full N ame Gain Mnemonic SSG Argument(s) Selector Gain 1.0 to 10.0 Set gain as a single valu e m u ltip lied by all p ixels. Floating p oint nu m ber: 1.0 to 10.0. N ote that gain valu e m u st be p reced ed by an ―f‖ (e.g. ssg 0 f1.5) D escription D escription N otes Full N ame Set TD I Stages Mnemonic STG Argument(s) Selector TDI stage D escription N otes Teledyne DALSA 1. 2. Single line m od e (low er sensitivity). TDI m od e (higher sensitivity) In single line m od e the cam era m u st be internal d irection control TDI m od e: a p air of lines su m m ed w ith su itable d elay 03-032-20176-00 90 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Full N ame External Trigger Mnemonic STM Argument(s) Mod e D escription N otes Set trigger m od e In internal m od e line rate is controlled by SSF com m and In external m od e read ou t starts on falling ed ge of CC1 signal and is a vailable only w hen STM = 1 (external trigger on) Exp osu re tim e equ als high tim e of EXSYN C on signal on CC1 Full N ame Test Pattern Mnemonic SVM Argument(s) Mod e D escription N otes Select test p attern When a test p attern is selected all d igital p rocessing (e.g. flat field , gain) is d isabled – it is re-enabled w hen sensor vid eo is selected Full N ame D efault User Set Mnemonic USD Argument(s) Set selector D escription N otes 1. 2. 0. 1. 2. 3. 4. 5. Internal (―Tim ed ‖) External (―Pu lsWid th‖) Sensor Vid eo Ram p A5 Each_tap _fixed All_1365 All_1 0. Factory set 1-8. User sets Select u ser set to load w hen cam era is reset The settings inclu d e all those listed by the GCP com m and p lu s the u ser FPN coefficients, and u ser PRN U coefficients Full N ame Load User Set Mnemonic USL Argument(s) Set selector D escription N otes Load u ser set Load s and m akes cu rrent all the settings listed by the GCP com m and p lu s the u ser FPN coefficients, and u ser PRN U coefficients 03-032-20176-00 0. Factory set 1-8. User sets Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual 91 Full N ame Save User Set Mnemonic USS Argument(s) D escription N otes Set selector 1 to 8 Save u ser set Saves all the cu rrent settings listed by the GCP com m and p lu s the u ser FPN coefficients, and u ser PRN U coefficients Full N ame Temperature Mnemonic VT Argument(s) D escription N otes Disp lay internal tem p eratu re in d egrees Celsiu s Full N ame Voltage Mnemonic VV Argument(s) D escription N otes Disp lay su p p ly voltage Teledyne DALSA 03-032-20176-00 92 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Appendix C: Quick Setup and Image Acquisition If you are fam iliar w ith the op eration of Cam era Link cam eras and have an u nd erstand ing of im aging fu nd am entals, the follow ing step s w ill show you how to qu ickly se t u p this cam era and begin acqu iring im ages. 1. On Power Up The cam era has been calibrated and configu red at the factory to be read y for you r evalu ation w hen first p ow ered u p . The d efau lt cond itions are set as follow s: System gain is set to the low est valu e of one. Flat field calibration is not active as this featu re is d ep end ent on you r light sou rce and lens. Line rate and exp osu re tim e are set to for internal generation by the cam era. Cam era Link m od e is set to the stand ard 8-bit fu ll m od e w hich allow s op eration of u p to 100 KH z line rate. Set you r Cam era Link fram e grabber u p to receive the stand ard 8-bit fu ll m od e. 2. Communicating with the Camera The cam era is d esigned to p ow er u p w ith a GenICam -com p liant interface. Cam Exp ert p rovid es an easy-to-u se GUI that can be u sed to set u p and evalu ate the cam era. The cam era also com es w ith Teled yne DALSA‘s three letter com m and (TLC) interface op tion, w hich can be accessed u sing a su itable term inal p rogram su ch as H yp erTerm inal ™. If you w ant to u se the TLC interface, p ress the ‗Esc‘ key w hile u sing a term inal p rogram only after the LED ind icator on the cam era tu rns green. N ote that the cam era d efau lts to 9.6 KBau d w hen first p ow ered u p . On receiving the ‗Esc‘ character, the cam era w ill ou tp u t a list of the available TLC com m and s. You can then p roceed to enter TLC com m and s as requ ired . Enter ‗h‘ at any tim e to get the list of com m and s from the cam era. Enter the ‗gcp ‘ com m and at any tim e to get the cu rrent setu p cond itions of the cam era. 03-032-20176-00 Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual 93 3. Setting Up Your Optical Configuration Typ ically, the first thing you w ant to d o is to evalu ate the cam era‘s im age qu ality u nd er op erating cond itions sim ilar to those that you are likely to u se in you r ap p lication. In ord er to d o this, take the follow ing step s: The illu m ination, lens m agnification, and focu s shou ld be set u p as p er you ap p lication. Getting the m agnification right is best accom p lished by setting the object -to-sensor d istance. Use the form u la lens focal length x (2 + 1/magnification + magnification) to calcu late this d istance. Magnification equ als the sensor p ixel size (10.56 µm ) / (you r object p ixel size in u m ). The ap p roxim ate p osition of the sensor is at the first groove on the sid e of the cam era case from the front face of the cam era. 4. Camera Timing & Control It is easiest and qu ickest to evalu ate the cam era u sing the internal tim ing setu p s for line rate and exp osu re tim e. The cam era starts u p in the d efau lt configu ration of cam era link fu ll, TDI m od e, forw ard d irection, 10 KH z line rate and 50 µsec exp osu re tim e. If this line rate is too slow for you r ap p lication, you w ill get a com p ressed im age in the scan d irection. You can increase the line rate by u sing the ‗ssf‘ com m and . You can set the exp osu re tim e u sing the ‗set‘ com m and . Ensu re that the exp osu re tim e p eriod is not greater than the p eriod of the line rate m inu s 1.0 µsec. The cam era w ill ind icate an error if you select an exp osu re tim e that is too long. The m inim u m exp osu re tim e is 4 µsec. Set you r cam era d irection u sing the ‗scd ‘ com m and . 5. Acquiring an Image You can now begin im aging. Unless you have an ap p lication em p loying lots of light, the im age is likely to be too d ark. Use the system gain to ad ju st the cam era ou tp u t to achieve the d esired resp onse. The system gain range is from 1x to 10x. Use the ‗ssg‘ com m and . Once you have a su itable resp onse, you can now focu s the lens. The im age m ay be d arker at the ed ges d u e to lens vignetting, bu t this w ill be im p roved once the cam era is calibrated . Calibration is p erform ed u sing a w hite reference w here you r object is norm ally located . o Use a w hite m aterial that has no textu re, su ch as a non glossy p lastic. o If you m u st u se w hite p ap er, m ake su re it is m oving d u ring the calibration p rocess. If you d o not d o this, you r im age w ill have vertica l strip es. Calibration is easily p erform ed u sing the ‗cp a‘ com m and . Teledyne DALSA 03-032-20176-00 94 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual The cp a com m and has 3 p aram eters. o The first p aram eter is a selection betw een: ‗0‘ – Per p ixel FFC calibration ‗1‘ – A low p ass FFC calibration o We recom m end that the second op tion is u sed to correct for any im age non u niform ity d u e to the lens and setu p . o The second p aram eter is the nu m ber of lines you w ant to average over. Use a valu e of 4096 to achieve the best average. o The third p aram eter is the 12-bit target valu e you w ant to achieve after calibration. The cp a com m and takes several second s to com p lete. The slow er the line rate, the longer it w ill take. On com p letion of the ‗cp a‘ com m and , you shou ld see an im age from the cam era that is flat field corrected w ith the lens at the target level you set. You are now read y to evalu ate the im age qu ality of the P4 cam era u nd er you r op erating cond itions. 03-032-20176-00 Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual 95 Appendix D: The Sensor Window Cleaning and Protecting Against Dust, Oil, and Scratches The sensor w ind ow is p art of the op tical p ath and shou ld be hand led like other op tical com p onents, w ith extrem e care. Du st can obscu re p ixels, p rod u cing d ark p atches on the sensor resp onse. Du st is m ost visible w hen the illu m ination is collim ated . The d ark p atches shift p osition as the angle of illu m inati on changes. Du st is norm ally not visible w hen the sensor is p ositioned at the exit p ort of an integrating sp here, w here the illu m ination is d iffu se. Du st can norm ally be rem oved by blow ing the w ind ow su rface u sing an ionized air gu n. Oil is u su ally introd u ced d u ring hand ling. Tou ching the su rface of the w ind ow barehand ed w ill leave oily resid u es. Using ru bber fingercots and ru bber gloves can p revent contam ination. H ow ever, the friction betw een ru bber and the w ind ow m ay p rod u ce electrostatic charge that m ay d am age the sensor. To avoid ESD d am age and to avoid introd u cing oily resid u es, avoid tou ching the sensor. Scratches d iffract incid ent illu m ination. When exp osed to u niform illu m ination, a sensor w ith a scratched w ind ow w ill norm ally have brighter p ixels a d jacent to d arker p ixels. The location of these p ixels w ill change w ith the angle of illu m ination. An important note on w indow blemishes: When flat field correction is p erform ed , w ind ow cleanliness is p aram ou nt. The figu re below show s an exam p le of w hat can hap p en if a blem ish is p resent on the sensor w ind ow w hen flat field correction is p erform ed . The blem ish w ill cast a shad ow on the w afer. FFC w ill com p ensate for this shad ow by increasing the gain. Essentially FFC w ill create a w hite sp ot to com p ensate for the d ark sp ot (shad ow ). As long as the angle of the incid ent light rem ains u nchanged then FFC w orks w ell. H ow ever w hen the angle of incid ence changes significantly (i.e. w hen a lens is ad d ed ) then the shad ow w ill shift and FFC w ill m akes things w orse by not correcting the new shad ow (d ark sp ot) and overcorrecting w here the shad ow u sed to be (w hite sp ot). While the d ark sp ot can be p otentially cleaned , the w hite sp ot is an FFC artifact that can only be corrected by another FFC calibration. Teledyne DALSA 03-032-20176-00 96 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Cleaning the Sensor Window Recommended Equipment Glass cleaning station w ith m icroscop e w ithin clean room . 3M ionized air gu n 980 (http :/ / solu tions.3m canad a.ca/ w p s/ p ortal/ 3M/ en_CA/ WW2/ Cou ntry/ ) Ionized air flood system , foot op erated . Sw ab (H UBY-340CA-003) (http :/ / w w w .cleancross.net/ m od u les/ xfsection/ ar ticle.p hp ?articleid =24) Single d rop bottle (FD-2-ESD) E2 (Eclip se op tic cleaning system (w w w .p hotosol.com ) Use localized ionized air flow on to the glass d u ring sensor cleaning. Blow off m obile contam ination u sing an ionized air gu n. Place the sensor u nd er the m icroscop e at a m agnification of 5x to d eterm ine the location of any rem aining contam ination. Clean the contam ination on the sensor u sing one d rop of E2 on a sw ab. Wip e the sw ab from left to right (or r ight to left bu t only in one d irection). Do this in an overlap p ing p attern, tu rning the sw ab after the first w ip e and w ith each su bsequ ent w ip e. Avoid sw ip ing back and forth w ith the sam e sw ab in ord er to ensu re that p articles are rem oved and not sim p ly tr ansferred to a new location on the sensor w ind ow . This p roced u re requ ires you to u se m u ltip le sw abs. Discard the sw ab after both sid es of the sw ab have been u sed once. Rep eat u ntil there is no visible contam ination p resent. Procedure 03-032-20176-00 Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual 97 Appendix E: Camera, Frame Grabber Communication Setting Up Communication between the Camera and the Frame Grabber Teled yne DALSA Cam era Link cam eras su p p ort the GenCP Cam era Link stand ard s. To configu re Teled yne DALSA GenCP Cam era Link Cam eras: 1. Install the Teled yne DALSA fram e grabber in the host com p u ter; refer to the hard w are installation m anu al. 2. Install Sap era LT and the Teled yne DALSA fram e grabber d river. 3. Connect the cam era to the fram e grabber; refer to the cam era installation m anu al. 4. Pow er u p the cam era and w ait u ntil the statu s LED is solid green. 5. Ru n the Sap era Configu ration u tility and select the fram e grabber serial p ort connected to the cam era. Set Teledyne D ALSA camera detection to Automatic D etection and Baudrate to Auto D etect & Maximize. 6. If the cam era w ill be configu red u sing three-letter text com m and s via a term inal p rogram , su ch as H yp erTerm inal, then set COM port mapping (optional) to an available COM p ort (e.g. COM2). Teledyne DALSA 03-032-20176-00 98 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual 7. Start the Cam Exp ert ap p lication. In the D evice tab, select CameraLink Medium Color RGB #1. 8. Mod ify the cam era and fram e grabber p aram eter settings as requ ired . At p resent, w hen u sing GenCP cam eras, the cam era and fram e grabber p aram eters m u st be ad ju sted sep arately. Test the im age acqu isition by clicking the Grab bu tton. 9. Save the fram e grabber configu ration to a new *.ccf file. 03-032-20176-00 Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual 99 EMC Declaration The CE Mark Evalu ation of the Teled yne DALSA P4-CM-0xKxxD-00-R Cam eras, w hich are m anu factu red by Teled yne DALSA Inc., m eets the follow ing requ irem ents: Standard Test Description EN 55011, FCC Part 15, CISPR 11, and ICES-003 Rad iated em issions requ irem ents. EN 61326-1 and EN 55024 Im m u nity to d istu rbances. Changes or m od ifications not exp ressly ap p roved by Teled yne DALSA cou ld void the u ser's au thority to op erate the equ ip m ent. N ame and Signature of authorized person H ank H elm ond Qu ality Manager, Teled yne DALSA Corp . Dated : Ap ril 2013 Teledyne DALSA 03-032-20176-00 100 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual Revision History Revision Number 00 03-032-20176-00 Change Description Initial release. Revision Date 17 April 2013 Teledyne DALSA Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual 101 Index external frame rate, programmable exposure time, 37 externally controlled, 37 internally controlled, 37 exposure m od es descriptions of, 36 exposure tim e set, 43 EXSYN C, 23 A antibloom ing, 9 B baud rate, 44 binning, 65 black level control, 43 F C factory settings, 29 calibration, 47 flat field, 49 process chain, 48 cam era control signals, 22 cam era inform ation, 31 cam era interfacing tool, 26 Cam era Link configurations, 34 input signals, 22 outputs, 23 Cam era Link connector, 19 Cam Expert, 27 certifications, 9 cleaning sensor window, 96 clock signals, 23 com m and s GenICam, 51 com pliance, 9 connectors, 18 Camera Link, 19 power, 23 G Gain control, 43 ground ing instructions, 18 GUI CamExpert, 27 overview, 25 I im age acquisition, 36 input/ outp ut, 18 interface mechanical, 8 L LED definitions, 24 M D d ata bus, 23 DC offset, 9 d irection sensor shift, 46 web movement, 46 d irection control, 45 m echanical camera, 12 specifications, 8 m od els, 8 O operating ranges, 9 E EMC Declaration of Conform ity, 99 exposure control, 36 Teledyne DALSA P perform ance specifications, 8 03-032-20176-00 102 Piranha4 4K and 2K Dual Line Monochrome CMOS Camera User's Manual current, 33 default, 34 factory, 29, 33 loading, 32 saving, 32 user, 33 setup overview, 16 shift d irection, 46 size image, 44 softw are required, 8 specifications mechanical, 8 operating, 9 performance, 8 pixel form at, 45 pow er connector, 23 connectors, 23 guidelines, 24 pinout, 23 precautions, 6 Q quantum efficiency graph, 10 R rand om noise, 9 rebooting, 47 requirem ents PC, 16 responsivity, 9 graph, 10 revision history, 100 S safety, 6 Sapera, 26 sensor controls, 56, 62, 72 settings 03-032-20176-00 T TDI Stages, 34 tem perature verify, 31 trigger m od es, 36 V voltage verify, 31 Teledyne DALSA