Balluff mvHYPERION Series User manual

mvHYPERION-Series
Technical Manual
English - Version 2.00

i
1.1 About This Manual ............................................ 1
1.1.1 Composition of the manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1.1.2 How to get started? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1.1.2.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1.1.2.2 Basics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1.1.2.3 Image acquisition concept . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.1.2.4 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.1.2.5 Programming . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.2 Imprint .................................................. 5
1.3 Revisions ................................................ 6
1.4 Graphic symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
1.4.1 Notes, warnings, attentions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
1.5 Important Information .......................................... 7
1.5.1 European Union Declaration of Conformity statement . . . . . . . . . . . . . . . . . . . . . 7
1.6 Introduction ............................................... 9
1.6.1 What's inside and accessories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
1.7 Quickstart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
1.7.1 Hardware installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
1.7.2 Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
1.7.2.1 System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
1.7.2.2 Software installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
1.7.3 Linux ............................................... 16
1.7.3.1 System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
1.7.3.2 Installing the mvIMPACT Acquire driver . . . . . . . . . . . . . . . . . . . . . . . 17
1.7.4 Connecting a camera . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
1.7.5 Settings behavior during startup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
1.8 Technical Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
1.8.1 mvHYPERION-CLx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
1.8.1.1 Block diagrams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
1.8.1.2 Connectors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
1.8.1.3 Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
1.8.1.4 Device Feature And Property Lists . . . . . . . . . . . . . . . . . . . . . . . . . . 33
1.8.2 mvHYPERION-32R16 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
1.8.2.1 Block diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
1.8.2.2 Connectors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
1.8.2.3 Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
1.8.3 mvHYPERION-HD-SDI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
1.8.3.1 Block diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
1.8.3.2 Connectors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
1.8.3.3 Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
1.9 GUI tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
1.9.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
MATRIX VISION GmbH

ii
1.9.2 wxPropView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
1.9.3 mvDeviceConfigure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
1.9.4 mvIPConfigure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
1.9.5 mvGigEConfigure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
1.10 HRTC - Hardware Real-Time Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
1.10.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
1.10.1.1 Operating codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
1.10.1.2 Program controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
1.10.2 How to use the HRTC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
1.11 Developing applications using the mvIMPACT Acquire SDK . . . . . . . . . . . . . . . . . . . . . 46
1.12 DirectShow interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
1.12.1 Supported interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
1.12.1.1 IAMCameraControl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
1.12.1.2 IAMDroppedFrames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
1.12.1.3 IAMStreamConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
1.12.1.4 IAMVideoProcAmp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
1.12.1.5 IKsPropertySet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
1.12.1.6 ISpecifyPropertyPages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
1.12.2 Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
1.12.3 Setting up devices for DirectShow usage . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
1.12.3.1 Registering devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
1.12.3.2 Renaming devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
1.12.3.3 Using regsvr32 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
1.13 Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
1.14 Use Cases ............................................... 53
1.14.1 Working with line scan cameras . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
1.14.1.1 Pass-through of digital input signals . . . . . . . . . . . . . . . . . . . . . . . . . 53
1.14.1.2 Working with pulse start events . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
1.14.1.3 Working with an rotary encoder . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
1.14.1.4 Working with a Basler Sprint line scan color camera . . . . . . . . . . . . . . . . 59
1.14.1.5 Working with trigger events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
1.14.1.6 Synchronous acquisition with different camera settings . . . . . . . . . . . . . . . 72
1.14.2 Using Video Stream Recording . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
1.14.2.1 Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
1.14.2.2 Recording in wxPropView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
1.14.2.3 Recording Using The API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
1.14.3 Working With Gain And Black-Level Values Per Color Channel . . . . . . . . . . . . . . . . 82
1.14.3.1 Configuration in wxPropView . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
1.14.3.2 Configuration Using The API . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
MATRIX VISION GmbH

1.1 About This Manual 1
1.1 About This Manual
1.1.1 Composition of the manual
The manual starts with technical data of the frame grabber as well as a quick start chapter.
Afterwards, you will find the different books:
•GUI tools (p. 42)
–The frame grabbers can also be managed via user interface. The program is called wxPropView (p. 42).
•Developing applications using the mvIMPACT Acquire SDK (p. 46)
•DirectShow developers (p. 47)
–This is the documentation of the MATRIX VISION DirectShow_acquire interface.
•Use Cases (p. 53)
–This book offers solutions and explanations for standard use cases.
1.1.2 How to get started?
1.1.2.1 Introduction
This chapter gives you a short overview, how to get started with a MATRIX VISION frame grabber and where to find
the necessary information in the manual. It will also explain or link to the concepts behind the driver and the image
acquisition. Furthermore it shows you how to get start programming own applications.
1.1.2.2 Basics
1.1.2.2.1 Driver concept The driver supplied with the MATRIX VISION product represents the port between
the programmer and the hardware. The driver concept of MATRIX VISION provides a standardized programming
interface to all image processing products made by MATRIX VISION GmbH.
The advantage of this concept for the programmer is that a developed application runs without the need for any
major modifications to the various image processing products made by MATRIX VISION GmbH. You can also
incorporate new driver versions, which are available for download free of charge on our website.
The following diagram shows a schematic structure of the driver concept:
MATRIX VISION GmbH

2
Figure 1: Driver concept
•1Part of any mvIMPACT Acquire driver installation package (Windows).
•2Separately available for 32 bit and 64 bit. Requires at least one installed driver package.
•3See 2, but requires an installed version of the mvBlueFOX driver.
•4Part of the NeuroCheck installer but requires at least one installed frame grabber driver.
•5Part of the mvIMPACT SDK installation. However, new designs should use the .NET libs that are now part
of mvIMPACT Acquire ("mv.impact.acquire.dll"). The namespace "mv.impact.acquire" of
"mv.impact.acquire.dll" provides a more natural and more efficient access to the same features
as contained in the namespace "mvIMPACT_NET.acquire" of "mvIMPACT_NET.dll", which is why
the latter one should only be used for backward compatibility but NOT when developing a new application.
•6Part of Micro-Manager.
1.1.2.2.2 NeuroCheck support A couple of devices are supported by NeuroCheck. However between Neuro -
Check 5.x and NeuroCheck 6.x there has been a breaking change in the internal interfaces. Therefore also the list
of supported devices differs from one version to another and some additional libraries might be required.
For NeuroCheck 5.x the following devices are supported:
Device Additional software needed
mvTITAN-G1 mvSDK driver for mvTITAN/mvGAMMA devices
mvTITAN-CL mvSDK driver for mvTITAN/mvGAMMA devices
mvGAMMA-CL mvSDK driver for mvTITAN/mvGAMMA devices
mvBlueFOX mvIMPACT Acquire driver for mvBlueFOX devices, "NCUSBmvBF.dll"
MATRIX VISION GmbH

1.1 About This Manual 3
For NeuroCheck 6.0 the following devices are supported:
Device Additional software needed
mvTITAN-G1 mvIMPACT Acquire driver for mvTITAN/mvGAMMA de-
vices
mvTITAN-CL mvIMPACT Acquire driver for mvTITAN/mvGAMMA de-
vices
mvGAMMA-CL mvIMPACT Acquire driver for mvTITAN/mvGAMMA de-
vices
mvHYPERION-CLb mvIMPACT Acquire driver for mvHYPERION devices
Every other mvIMPACT Acquire compliant device mvIMPACT Acquire driver for the corresponding device
family, "mv.impact.acquire.NeuroCheck6. -
dll" (comes with the driver package, but the driver
package must be installed AFTER installing NeuroCheck 6
For NeuroCheck 6.1 the following devices are supported:
Device Additional software needed
mvTITAN-G1 mvIMPACT Acquire driver for mvTITAN/mvGAMMA de-
vices
mvTITAN-CL mvIMPACT Acquire driver for mvTITAN/mvGAMMA de-
vices
mvGAMMA-CL mvIMPACT Acquire driver for mvTITAN/mvGAMMA de-
vices
mvHYPERION-CLb mvIMPACT Acquire driver for mvHYPERION devices
Every other mvIMPACT Acquire compliant device mvIMPACT Acquire driver for the corresponding device
family, "mv.impact.acquire.NeuroCheck6_ -
1.dll" (comes with the driver package, but the driver
package must be installed AFTER installing NeuroCheck
6.1
1.1.2.2.3 VisionPro support Every mvIMPACT Acquire driver package on Windows comes with an adapter to
VisionPro from Cognex. The installation order does not matter. After the driver package and VisionPro has been
installed, the next time VisionPro is started it will allow selecting the mvIMPACT Acquire device. No additional steps
are needed.
MATRIX VISION devices that also comply with the GigE Vision or USB3 Vision standard don't need any software
at all, but can also use VisionPro's built-in GigE Vision or USB3 Vision support.
1.1.2.2.4 HALCON support HALCON comes with built-in support for mvIMPACT Acquire compliant devices, so
once a device driver has been installed for the mvIMPACT Acquire device, it can also be operated from a HALCON
environment using the corresponding acquisition interface. No additional steps are needed.
MATRIX VISION devices that also comply with the GigE Vision or USB3 Vision standard don't need any software
at all, but can also use HALCON's built-in GigE Vision or USB3 Vision support.
As some mvIMPACT Acquire device driver packages also come with a GenTL compliant interface, these can also
be operated through HALCON's built-in GenTL acquisition interface.
1.1.2.2.5 LabVIEW support Every mvIMPACT Acquire compliant device can be operated under LabVIEW
through an additional set of VIs which is shipped by MATRIX VISION as a separate installation ("mvLabVIEW
Acquire").
MATRIX VISION devices that also comply with the GigE Vision or USB3 Vision standard don't need any additional
software at all, but can also be operated through LabVIEW's GigE Vision or USB3 Vision driver packages.
MATRIX VISION GmbH

4
1.1.2.2.6 DirectShow support Every mvIMPACT Acquire compliant device driver package comes with an inter-
face to DirectShow. In order to be usable from a DirectShow compliant application, devices must first be registered
for DirectShow support. How to this is explained here (p. 48).
1.1.2.2.7 Micro-Manager support Every mvIMPACT Acquire compliant device can be operated under
https://micro-manager.org when using mvIMPACT Acquire 2.18.0 or later and at least Micro-Manager
1.4.23 build AFTER 15.12.2016. The adapter needed is part of the Micro-Manager release. Additional information
can be found here: https://micro-manager.org/wiki/MatrixVision.
1.1.2.3 Image acquisition concept
The image acquisition is based on queues to avoid the loss of single images. With this concept you can acquire im-
ages via single acquisition or triggered acquisition. For detailed description of the acquisition concept, please have
a look at "How the capture process works" in the mvIMPACT_Acquire_API manual matching the programming
language you are working with.
1.1.2.4 Installation
To install the frame grabber properly you have to follow these steps:
(Please follow the links for detailed descriptions.)
•Windows:
–Please check the system requirements (p. 11).
–Please install the software and driver (p. 12).
–Please install the hardware (p. 11).
•Linux:
–Please check the system requirements (p. 16).
–Please install the software and driver (p. 17).
–Please install the hardware (p. 11).
1.1.2.5 Programming
To control the camera and handle the images, you will have a good introduction by reading the main pages of the
"mvIMPACT Acquire" interface references. Additionally, please have a look at the example programs. Several
basic examples are available. The separate mvIMPACT Acquire manuals
•"mvIMPACT_Acquire_API_CPP_manual.chm",
•"mvIMPACT_Acquire_API_C_manual.chm", and
•"mvIMPACT_Acquire_API_NET_manual.chm"
are available as downloads from our website http://www.matrix-vision.com.
MATRIX VISION GmbH

1.2 Imprint 5
1.2 Imprint
MATRIX VISION GmbH
Talstrasse 16
DE - 71570 Oppenweiler
Telephone: [phone]
Fax: [phone]
Website: http://www.matrix-vision.de
E-Mail:
•[email protected]
•[email protected]
•[email protected]
Author
U. Lansche
Date
2020
This document assumes a general knowledge of PCs and programming.
Since the documentation is published electronically, an updated version may be available online. For this reason we
recommend checking for updates on the MATRIX VISION website.
MATRIX VISION cannot guarantee that the data is free of errors or is accurate and complete and, therefore, as-
sumes no liability for loss or damage of any kind incurred directly or indirectly through the use of the information of
this document.
MATRIX VISION reserves the right to change technical data and design and specifications of the described products
at any time without notice.
Copyright
MATRIX VISION GmbH. All rights reserved. The text, images and graphical content are protected by copyright
and other laws which protect intellectual property. It is not permitted to copy or modify them for trade use or
transfer. They may not be used on websites.
• Windows® XP, Windows® Vista, Windows® 7, 8, 10 are trademarks of Microsoft, Corp.
• Linux® is a trademark of Linus Torvalds.
• Jetson is a registered trademark of NVIDIA Corporation.
• NVIDIA and Jetson are trademarks and/or registered trademarks of NVIDIA Corporation in the U.S. and other
countries.
• Arm and Cortex are registered trademarks of Arm Limited (or its subsidiaries) in the US and/or elsewhere.
All other product and company names in this document may be the trademarks and tradenames of their
respective owners and are hereby acknowledged.
The manual has been generated with Doxygen (Website: http://www.doxygen.org).
Parts of the log file creation and the log file display make use of Sarissa (Website: http://dev. -
abiss.gr/sarissa) which is distributed under the GNU GPL version 2 or higher, GNU LGPL version
2.1 or higher and Apache Software License 2.0 or higher. The Apache Software License 2.0 is part of this
driver package.
MATRIX VISION GmbH

6
1.3 Revisions
Date Rev. Author Description Driver / Firmware version
13. January 2021 V2.00 LAN Seperated GUI tools (p. 42) .
1.4 Graphic symbols
1.4.1 Notes, warnings, attentions
Note
Anote indicates important information that helps you optimize usage of the products.
Warning
Awarning indicates how to avoid either potential damage to hardware or loss of data.
Attention
An attention indicates a potential for property damage, personal injury, or death.
All due care and attention has been taken in preparing this manual. In view of our policy of continuous product
improvement, however, we can accept no liability for completeness and correctness of the information contained in
this manual. We make every effort to provide you with a flawless product.
In the context of the applicable statutory regulations, we shall accept no liability for direct damage, indirect damage
or third-party damage resulting from the acquisition or operation of a MATRIX VISION product. Our liability for intent
and gross negligence is unaffected. In any case, the extend of our liability shall be limited to the purchase price.
MATRIX VISION GmbH