XIMEA xiX MX023MG-SY-X2G2 User manual

xiX
[ksi-x: or sai-ex:]
•PCI Express cameras for integration
Technical Manual
Version 1.3, August, 2018

xiX - Technical Manual Version 1.3 2
1. Introduction
1.1. About This Manual
Dear customer,
Thank you for purchasing a product from XIMEA.
We hope that this manual can answer your questions, but should you have any further questions or if you wish to claim a
service or warranty case, please contact your local dealer or refer toXIMEA Support on our website: www.ximea.com/support
The purpose of this document is toprovide a description of the XIMEA xiX-Series cameras and to describe the correct way to
install related software anddrivers and run it successfully. Please read thismanual thoroughly before operating your new
camera for the first time. Please follow all instructions and observe the warnings.
Thisdocument is subject to change without notice.
1.2. About XIMEA
XIMEA is one of the worldwide leaders for innovative camera solutions with a 20-year history of research, development and
production of digital imageacquisition systems. Based in Slovakia, Germany and the US and with a global distributor network,
XIMEA offers their cameras worldwide. In close collaboration with customers XIMEA has developed a broad spectrum of
technologies and cutting-edge, highly competitive products.
XIMEA's camera centric technology portfolio comprises a broad spectrum of digital technologies, from data interfaces such as
PCI express, USB 2.0, 3.0 and USB 3.1, to cooled digital cameras with CCD and CMOS sensors, as well as X-ray cameras.
XIMEAhas threedivisions – generic machine vision and integratedvision systems, scientific imaging and OEM/custom.
XIMEA cameras find usein many industrial applications, such asmotion control, robotics, or quality control in manufacturing.
The broad spectrum of cameras also includes thermally stabilized X-ray cameras, and specialty cameras for medical
applications, research, surveillance and defense.
1.2.1. Contact XIMEA
XIMEA is a worldwide operating Company
Headquarters, Sales worldwide
XIMEA GmbH
Am Mittelhafen 16
48155 Münster
Germany
Tel: [phone]
Fax: [phone]
Sales America
XIMEA Corp.
8725 W 14th Ave, Ste 110
Lakewood, CO 80215
USA
Tel: [phone]
Fax: [phone]
R&D, Production
XIMEA s.r.o.
Lesna 52
900 33 Marianka
Slovakia
Internet www.ximea.com
General inquiries [e-mail]
Sales [e-mail]
Support [e-mail]

xiX - Technical Manual Version 1.3 3
1.3. Standard Conformity
The xiX cameras have been testedusing the followingequipment:
•List equipment: To be added
1.3.1. CE Conformity
To be added
1.3.2. For customers in the US: FCC Conformity
To be added
1.3.3. For customers in Canada
The xiX cameras comply with the ClassA limits for radio noise emissions set out in Radio Interference Regulations.

xiX - Technical Manual Version 1.3 4
1.3.4. RoHS Conformity
The xiX cameras comply with the requirements of the RoHS (Restriction of Hazardous Substances)Directive 2011/65/EU.
1.3.5. WEEE Conformity
The xiX cameras comply with therequirements of the WEEE (waste electrical and electronic equipment) Directive 2003/108/EC.
1.3.6. GenICam GenTL API
GenICam standard transport layer interface, grabbing images. GenICam/GenTL provides an agnostic transport layer interface
to acquire images or otherdata and to communicate with a device. Each XIMEA camera can be GenTL Producer.
1.4. Helpful Links
•XIMEA Homepage http://www.ximea.com/
•PCIe zone https://www.ximea.com/en/pci-express-camera/pcie-camera-zone
•xiAPI stable versions download https://www.ximea.com/support/documents/4
•xiAPI beta versions download https://www.ximea.com/support/documents/14
•Frequently Asked Questions http://www.ximea.com/support/wiki/allprod/Frequently_Asked_Questions
•Knowledge Base http://www.ximea.com/support/wiki/allprod/Knowledge_Base
•Vision Libraries http://www.ximea.com/support/projects/vision-libraries/wiki
•XIMEA Registration http://www.ximea.com/en/products/register
•XIMEA Live Support http://www.ximea.com/support/wiki/allprod/XIMEA_Live_Support
•XIMEA General Terms& Conditions http://www.ximea.com/en/corporate/generaltc

xiX - Technical Manual Version 1.3 5
1.5. Table of Contents
1. Introduction................................................................................................................................................................2
1.1. About This Manual.............................................................................................................................................2
1.2. About XIMEA.....................................................................................................................................................2
1.2.1. Contact XIMEA..........................................................................................................................................2
1.3. Standard Conformity..........................................................................................................................................3
1.3.1. CE Conformity...........................................................................................................................................3
1.3.2. For customers in the US: FCCConformity...................................................................................................3
1.3.3. For customers in Canada...........................................................................................................................3
1.3.4. RoHS Conformity.......................................................................................................................................4
1.3.5. WEEE Conformity......................................................................................................................................4
1.3.6. GenICam GenTL API..................................................................................................................................4
1.4. Helpful Links......................................................................................................................................................4
1.5. Table of Contents...............................................................................................................................................5
2. xiX Camera Series ....................................................................................................................................................11
2.1. What is xiX......................................................................................................................................................11
2.2. Advantages.....................................................................................................................................................11
2.3. PCI Express Vision Camera Applications............................................................................................................12
2.4. Common features............................................................................................................................................12
2.5. What is xSWITCH.............................................................................................................................................13
2.5.1. xSWITCH examples.................................................................................................................................15
2.6. Model Nomenclature........................................................................................................................................16
2.7. Models Overview, sensor and models................................................................................................................17
2.8. Accessories.....................................................................................................................................................18
3. Hardware Specification.............................................................................................................................................19
3.1. Power Supply..................................................................................................................................................19
3.2. General Specification.......................................................................................................................................19
3.2.1. Environment...........................................................................................................................................19
3.2.2. Firmware / Host driver / API features........................................................................................................19
3.3. Mounting points...............................................................................................................................................20
3.4. Lens Mount.....................................................................................................................................................21
3.4.1. Screws...................................................................................................................................................22
3.5. Optical path.....................................................................................................................................................23
3.5.1. Filter glasses..........................................................................................................................................23
3.5.2. Monochrome and near infrared extended camera models (MX X2G2 models only)......................................23
3.5.3. Color camera models (MXX2G2 models only)...........................................................................................24
3.6. Model Specific Characteristics..........................................................................................................................25
3.6.1. MX023xG-SY-X2G2-Fx............................................................................................................................25
3.6.1.1. Sensor and camera parameters......................................................................................................25
3.6.1.2. Quantum efficiency curves [%]........................................................................................................26
3.6.1.3. Drawings MX023xG-SY-X2G2-FL (C-mount [with C/CS mount module B]).........................................27
3.6.1.4. Drawings MX023xG-SY-X2G2-FV (C-mount [with C/CS mount module B]).........................................27
3.6.1.5. Referenced documents...................................................................................................................28
3.6.1.6. Sensor features..............................................................................................................................28
3.6.2. MX031xG-SY-X2G2-Fx............................................................................................................................29
3.6.2.1. Sensor and camera parameters......................................................................................................29

xiX - Technical Manual Version 1.3 6
3.6.2.2. Quantum efficiency curves [%]........................................................................................................30
3.6.2.3. Drawings MX031xG-SY-X2G2-FL (C-mount [with C/CS mount module B]).........................................31
3.6.2.4. Drawings MX031xG-SY-X2G2-FV (C-mount [with C/CS mount module B]).........................................31
3.6.2.5. Referenced documents...................................................................................................................32
3.6.2.6. Sensor features..............................................................................................................................32
3.6.3. MX050xG-SY-X2G2-Fx............................................................................................................................33
3.6.3.1. Sensor and camera parameters......................................................................................................33
3.6.3.2. Quantum efficiency curves [%]........................................................................................................34
3.6.3.3. Drawings MX050xG-SY-X2G2-FL (C-mount [with C/CS mount module B]).........................................35
3.6.3.4. Drawings MX050xG-SY-X2G2-FV (C-mount [with C/CS mount module B]).........................................35
3.6.3.5. Referenced documents...................................................................................................................36
3.6.3.6. Sensor features..............................................................................................................................36
3.6.4. MX089xG-SY-X2G2-Fx............................................................................................................................37
3.6.4.1. Sensor and camera parameters......................................................................................................37
3.6.4.2. Quantum efficiency curves [%]........................................................................................................38
3.6.4.3. Drawings MX089xG-SY-X2G2-FL (C-mount [with C/CS mount module B]).........................................39
3.6.4.4. Drawings MX089xG-SY-X2G2-FV (C-mount [with C/CS mount module B]).........................................39
3.6.4.5. Referenced documents...................................................................................................................40
3.6.4.6. Sensor features..............................................................................................................................40
3.6.5. MX124xG-SY-X2G2-Fx............................................................................................................................41
3.6.5.1. Sensor and camera parameters......................................................................................................41
3.6.5.2. Quantum efficiency curves [%]........................................................................................................42
3.6.5.3. Drawings MX124xG-SY-X2G2-FL (C-mount [with C mount module B]) ..............................................43
3.6.5.4. Drawings MX124xG-SY-X2G2-FV (C-mount [with C mount module B])..............................................43
3.6.5.5. Referenced documents...................................................................................................................44
3.6.5.6. Sensor features..............................................................................................................................44
3.6.6. MX120xG-CM-X4G2-Fx..........................................................................................................................45
3.6.6.1. Sensor and camera parameters......................................................................................................45
3.6.6.2. Quantum efficiency curves [%]........................................................................................................46
3.6.6.3. Drawings MX120xG-CM-X4G2-FL...................................................................................................47
3.6.6.4. Drawings MX120xG-CM-X4G2-FV..................................................................................................47
3.6.6.5. Referenced documents...................................................................................................................48
3.6.6.6. Sensor features..............................................................................................................................48
3.6.7. MX200xG-CM-X4G2-Fx..........................................................................................................................49
3.6.7.1. Sensor and camera parameters......................................................................................................49
3.6.7.2. Quantum efficiency curves [%]........................................................................................................50
3.6.7.3. Drawings MX200xG-CM-X4G2-FL...................................................................................................51
3.6.7.4. Drawings MX200xG-CM-X4G2-FV..................................................................................................51
3.6.7.5. Referenced documents...................................................................................................................52
3.6.7.6. Sensor features..............................................................................................................................52
3.6.8. MX500xG-CM-X4G2-Fx..........................................................................................................................53
3.6.8.1. Sensor and camera parameters......................................................................................................53
3.6.8.2. Quantum efficiency curves [%]........................................................................................................54
3.6.8.3. Drawings MX500xG-CM-X4G2-FL...................................................................................................55
3.6.8.4. Drawings MX500xG-CM-X4G2-FV..................................................................................................55
3.6.8.5. Referenced documents...................................................................................................................56

xiX - Technical Manual Version 1.3 7
3.6.8.6. Sensor features..............................................................................................................................56
3.7. User interface – LEDs......................................................................................................................................57
3.8. xiX X2G2 Interface connector............................................................................................................................58
3.8.1. Interface connector location.....................................................................................................................58
3.8.2. Pinning...................................................................................................................................................58
3.8.3. Inserting / detaching FPC cable................................................................................................................59
3.9. xiX X4G2 Interface connector............................................................................................................................62
3.9.1. Interface connector location.....................................................................................................................62
3.9.2. Pinning...................................................................................................................................................62
3.9.3. Inserting / detaching FFC cable................................................................................................................64
3.10. xiX Digital Input / Output (GPIO) Interface...........................................................................................................66
3.10.1. Optically isolated Digital Input..................................................................................................................66
3.10.1.1. Digital Input – signal levels.............................................................................................................66
3.10.1.2. Digital Input – Internal Schematic....................................................................................................67
3.10.1.3. Digital Input – Wiring......................................................................................................................67
3.10.1.4. Digital Input – Timing.....................................................................................................................68
3.10.2. Optically isolated Digital Output................................................................................................................68
3.10.2.1. Optically isolated Digital Output - General info..................................................................................68
3.10.2.2. Optically isolated Digital Output Delay..............................................................................................68
3.10.2.3. Optically isolated Digital Output – Internal schematic........................................................................69
3.10.2.4. Digital Output – Wiring...................................................................................................................69
3.10.2.5. Digital Output – Timing...................................................................................................................74
3.10.3. Non-isolated Digital Lines........................................................................................................................75
3.10.3.1. Non-isolated Digital Input/Output (INOUT)General info......................................................................75
3.11. Heat Dissipation...............................................................................................................................................76
3.12. CBL-MX-X2G2-0M07/ CBL-MX-X2G2-0M10/ CBL-MX-X2G2-0M25/ CBL-MX-X2G2-0M50................................76
3.13. CBL-MX-X4G2-0M10 / CBL-MX-X4G2-0M25 / CBL-MX-X4G2-0M50................................................................76
3.14. MX camera adapters........................................................................................................................................77
3.15. Tripod Adapter.................................................................................................................................................78
3.15.1. Tripod Adapter MX X2G2 (MECH-MC-BRACKET-KIT).................................................................................78
3.15.2. Drawings................................................................................................................................................78
3.15.3. Tripod Adapter MX X4G2.........................................................................................................................79
3.15.4. Drawings................................................................................................................................................79
3.16. xiX X4G2 Lens adapter – MECH-60MM-EF-ADAPTER........................................................................................80
4. Operation.................................................................................................................................................................81
4.1. System Requirements......................................................................................................................................81
4.1.1. Software Requirements...........................................................................................................................81
4.1.2. Hardware Requirements..........................................................................................................................81
4.1.2.1. System Configuration.....................................................................................................................81
4.2. Video Formats.................................................................................................................................................83
4.2.1. Full Resolution........................................................................................................................................83
4.2.2. ROIs – Region Of Interest........................................................................................................................83
4.2.3. Downsampling Modes.............................................................................................................................83
4.2.3.1. Binning..........................................................................................................................................83
4.2.3.2. Skipping........................................................................................................................................83
4.2.4. Image Data Output Formats.....................................................................................................................84

xiX - Technical Manual Version 1.3 8
4.2.5. Digitization bit depth................................................................................................................................85
4.3. Acquisition modes............................................................................................................................................86
4.3.1. Free-Run................................................................................................................................................86
4.3.2. Triggered Acquisition ..............................................................................................................................86
4.3.2.1. Software Trigger............................................................................................................................86
4.3.2.2. Hardware Trigger...........................................................................................................................86
4.3.2.3. Triggered acquisition - single frame................................................................................................87
4.3.2.4. Triggered acquisition - burst of frames............................................................................................88
4.3.2.5. Exposure defined by trigger pulse length..........................................................................................88
4.3.2.6. Multiple exposures in one frame......................................................................................................89
4.4. Camera Parameters and Features.....................................................................................................................90
4.4.1. Exposure Time........................................................................................................................................90
4.4.2. Gain.......................................................................................................................................................90
4.5. Host-Assisted Image Processing Parameters Available in xiAPI...........................................................................90
4.5.1. Auto Exposure – Auto Gain......................................................................................................................90
4.5.2. White Balance........................................................................................................................................90
4.5.2.1. Assisted Manual White Balance......................................................................................................90
4.5.2.2. Auto White Balance........................................................................................................................90
4.5.3. Gamma..................................................................................................................................................90
4.5.4. Sharpness..............................................................................................................................................90
4.5.5. Color Correction Matrix............................................................................................................................91
4.5.6. Sensor Defect Correction.........................................................................................................................91
4.5.7. HDR.......................................................................................................................................................92
5. Software..................................................................................................................................................................95
5.1. Accessing the Camera.....................................................................................................................................95
5.1.1. Proprietary API........................................................................................................................................95
5.1.2. Standard Interface..................................................................................................................................95
5.1.2.1. GenICam.......................................................................................................................................95
5.1.3. Vision Library Integration.........................................................................................................................95
5.2. XIMEA CamTool...............................................................................................................................................96
5.3. Supported Vision Libraries................................................................................................................................98
5.3.1. Libraries maintained by XIMEA.................................................................................................................98
5.3.1.1. MathWorks MATLAB......................................................................................................................98
5.3.1.2. MVTec HALCON.............................................................................................................................98
5.3.1.3. National Instruments LabVIEW Vision Library....................................................................................98
5.3.1.4. OpenCV.........................................................................................................................................98
5.4. XIMEA Windows Software Package...................................................................................................................99
5.4.1. Contents.................................................................................................................................................99
5.4.2. Installation..............................................................................................................................................99
5.5. XIMEA Linux Software Package.......................................................................................................................102
5.5.1. Contents...............................................................................................................................................102
5.5.2. Installation............................................................................................................................................102
5.6. XIMEA macOS Software Package....................................................................................................................104
5.6.1. Contents...............................................................................................................................................104
5.6.2. Installation............................................................................................................................................104
5.6.3. Start XIMEA CamTool............................................................................................................................105

xiX - Technical Manual Version 1.3 9
5.7. Programming.................................................................................................................................................106
5.7.1. XIMEA APIs...........................................................................................................................................106
5.7.2. xiAPI Overview......................................................................................................................................106
5.7.3. xiAPI Functions Description....................................................................................................................106
5.7.4. xiAPI Parameters Description.................................................................................................................107
5.7.5. xiAPI Examples.....................................................................................................................................107
5.7.5.1. Connect Device............................................................................................................................107
5.7.5.2. Parameterize Device.....................................................................................................................107
5.7.5.3. Acquire Images............................................................................................................................108
5.7.5.4. Control Digital Input / Output (GPIO)...............................................................................................108
5.7.6. xiAPI Auto Bandwidth Calculation...........................................................................................................109
5.7.7. GenICam..............................................................................................................................................109
5.8. XIMEA Control Panel......................................................................................................................................110
6. Appendix................................................................................................................................................................111
6.1. Troubleshooting and Support..........................................................................................................................111
6.1.1. Worldwide Support................................................................................................................................111
6.1.2. Before Contacting Technical Support......................................................................................................111
6.1.3. Frequently Asked Questions...................................................................................................................111
6.1.3.1. What is PCIe Gen2?.....................................................................................................................111
6.1.3.2. What is the real transfer speed?....................................................................................................112
6.1.3.3. Why can I not achieve maximum transfer speed?...........................................................................112
6.1.3.4. What voltage should beapplied to Digital Input of xiXto turn it on/off?.............................................112
6.1.3.5. What is the implementation of Digital Output (VDO) of xiX? .............................................................112
6.2. Product service request (PSR).........................................................................................................................113
6.2.1. Step 1 - Contact Support.......................................................................................................................113
6.2.2. Step 2 - Create Product Service Request (PSR).......................................................................................113
6.2.3. Step 3 - Wait for PSR Approval..............................................................................................................113
6.2.4. Step 4 - Sending the camera to XIMEA...................................................................................................113
6.2.5. Step 5 - Waiting for Service Conclusion..................................................................................................113
6.2.6. STEP 6 - Waiting for return delivery........................................................................................................113
6.3. Safety instructions and precautions.................................................................................................................114
6.3.1. Disassembling......................................................................................................................................114
6.3.2. Mounting / Screwing.............................................................................................................................114
6.3.3. Connections.........................................................................................................................................114
6.3.4. Power supply........................................................................................................................................114
6.3.5. Environment / protect against water.......................................................................................................114
6.3.6. Recommended light conditions..............................................................................................................114
6.3.7. Protect the optical components..............................................................................................................115
6.3.8. Mechanical loads..................................................................................................................................115
6.3.9. Camera / lens cleaning..........................................................................................................................115
6.3.10. Protect against static discharge (ESD)....................................................................................................115
6.4. Warranty.......................................................................................................................................................115
6.5. Disclaimer of Warranty...................................................................................................................................116
6.6. List Of Trademarks........................................................................................................................................116
6.7. Standard Terms & Conditions of XIMEA GmbH.................................................................................................116
6.8. Copyright ......................................................................................................................................................121

xiX - Technical Manual Version 1.3 10
6.9. Revision History.............................................................................................................................................121
7. Glossary.................................................................................................................................................................122
8. list of figures..........................................................................................................................................................123
9. list of tables............................................................................................................................................................126