MATRIX VISION - mvBlueFOX Technical Documentation
About this manual

Composition of the manual

This manual is based on a modular concept and contains several individual books. That means like in many object-oriented programming languages for each specific functionality you will have your own "class". Instead of classes, you have books. For example, if you want to know anything about the GUI based applications, then you have to go to the Application Usage book. If you want to know how images are acquired with your device, have a look in the respective programming language chapter.

Here is a short summary about all books that form this manual:

  • The manual starts with technical data about the device like sensors (for cameras) or electrical characteristics as well as a quick start chapter.

Afterwards, you will find the different books:

  • The installation package comes with a couple of tools offering a graphical user interface (GUI) to control mvIMPACT Acquire compliant devices.
    • wxPropView can be used to capture image data and to change parameters like AOI or gain
    • mvDeviceConfigure can be used to e.g. perform firmware updates, assign a unique ID to a device that is stored in non-volatile memory or to configure to log-message output.
  • HRTC - Hardware Real-Time Controller
    • It is possible to define sequences of operating steps to control acquisition or time critical I/O. This FPGA built-in functionality is called Hardware Real-Time Controller (short: HRTC).
  • DirectShow developers
    • This is the documentation of the MATRIX VISION DirectShow_acquire interface.
  • Use cases
    • This book offers solutions and explanations for standard use cases.

For C, C++, .NET developers, there are separate mvIMPACT Acquire manuals describing the API. Please refer to the Programming section

These documents can either be downloaded from http://www.matrix-vision.com or come as part of an installation package. The manuals e.g. contain information about

  • how to link and build applications using mvIMPACT Acquire
  • how the log output for mvIMPACT Acquire devices is configured and how it works in general
  • how to create custom client installers packages for Windows and Linux
  • the API itself

How to get started?

This chapter gives you a short overview, how to get started with your device 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 explains how to get started programming own applications.

Installation

To install the mvBlueFOX properly you have to follow these steps:
(Please follow the links for detailed descriptions.)

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 (excluding mvBlueLYNX) 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: http://www.matrix-vision.com.

The following diagram shows a schematic structure of the driver concept:

Driver_concept.png
Figure 1: Driver concept
  • 1 Part of any mvIMPACT Acquire driver installation package (Windows).
  • 2 Separately available for 32 bit and 64 bit. Requires at least one installed driver package.
  • 3 See 2, but requires an installed version of the mvBlueFOX driver.
  • 4 Part of the NeuroCheck installer but requires at least one installed frame grabber driver.
  • 5 Part 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.
  • 6 Part of Micro-Manager.

NeuroCheck support

A couple of devices are supported by NeuroCheck. However between NeuroCheck 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:

DeviceAdditional software needed
mvTITAN-G1mvSDK driver for mvTITAN/mvGAMMA devices
mvTITAN-CLmvSDK driver for mvTITAN/mvGAMMA devices
mvGAMMA-CLmvSDK driver for mvTITAN/mvGAMMA devices
mvBlueFOXmvIMPACT Acquire driver for mvBlueFOX devices, "NCUSBmvBF.dll"

For NeuroCheck 6.0 the following devices are supported:

DeviceAdditional software needed
mvTITAN-G1mvIMPACT Acquire driver for mvTITAN/mvGAMMA devices
mvTITAN-CLmvIMPACT Acquire driver for mvTITAN/mvGAMMA devices
mvGAMMA-CLmvIMPACT Acquire driver for mvTITAN/mvGAMMA devices
mvHYPERION-CLbmvIMPACT Acquire driver for mvHYPERION devices
Every other mvIMPACT Acquire compliant devicemvIMPACT 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:

DeviceAdditional software needed
mvTITAN-G1mvIMPACT Acquire driver for mvTITAN/mvGAMMA devices
mvTITAN-CLmvIMPACT Acquire driver for mvTITAN/mvGAMMA devices
mvGAMMA-CLmvIMPACT Acquire driver for mvTITAN/mvGAMMA devices
mvHYPERION-CLbmvIMPACT Acquire driver for mvHYPERION devices
Every other mvIMPACT Acquire compliant devicemvIMPACT 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

VisionPro support

Every mvIMPACT Acquire driver package under 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.

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.

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.

DirectShow support

Every mvIMPACT Acquire compliant device driver package comes with an interface 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.

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.

code

Image acquisition concept

The image acquisition is based on queues to avoid the loss of single images. With this concept you can acquire images 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.

Programming

To understand how to control the device and handle image data you will have a good introduction by reading the main pages of the corresponding mvIMPACT Acquire interface reference. Additionally, please have a look at the example programs. Several basic examples are available. For details please refer to

depending on the programming language you will use for your application.