Dalsa Xtium-CL MX4 User Manual

Xtium-CL MX4

™

User's Manual

P/N: OC-Y4CM-MUSR0

sensors | cameras |

frame grabbers

| processors | software | vision solutions

Edition 1.20

www.teledynedalsa.com

NOTICE

© 2018 Teledyne DALSA, Inc. All rights reserved.
This document may not be reproduced nor transmitted in any form or by any means, either

electronic or mechanical, without the express written permission of TELEDYNE DALSA. Every effort
is made to ensure the information in this manual is accurate and reliable . Use of the products
described herein is understood to be at the user’s risk. TELEDYNE DALSA assumes no liability
whatsoever for the use of the products detailed in this do cument and reserves the right to make
changes in specifications at any time and without notice.

Microsoft® is a registered trademark; Windows®, Windows® 7, Windows® 8 and Windows® 10
are trademark s of M icrosoft Corpo ra t ion.

All other trademarks or intellectual property mentioned herein belongs to their respective owners.

Edition 1.20 released on April 27, 2018
Document Number: OC-Y4CM-MUSR0

About Teledyne DALSA

Teledyne DALSA is an inte rnational high performance semiconductor and electronics comp any that
designs, develops, manufactures, a nd m arke ts digita l imaging products and solutions, in addition
to providing wafer foundry services.

Teled y n e DALSA Digital Imaging offers the widest range of machine vision components in the
world. From industry-leading image sensors through powerful and sophisticated cameras, frame
grabbers, vision processors and software to easy-to-use vision appliances and custom vision
modules.

Contents

OVERVIEW 7

PRODUCT PART NUMBERS 7
ABOUT THE XTIUM-CL MX4 FRAME GRABBER 8

Series Key Features 8
Supported Camera Link Configurations 8

User Programmable Configurations 9

ACUPlus: Acquisition Control Unit 9
DTE: Intelligent Data Transfer Engine 10

PCI Express x4 Gen2 Interface 10

Advanced Controls Overview 10

Visual Indicators 10
External Event Synchronization 10
Camera Link Communicatio ns Ports 10
Quadrature Shaft Encoder 10

DEVELOPMENT SOFTWARE OVERVIEW 11

Sapera++ LT Library 11
Sapera Processing Library 11

QUICK START SETUP & INSTALLATION 12

INSTALLIN G XT IUM-CL MX4 16

WARNING! (GROUNDING INSTRUCTIONS) 16
INSTALLATION 16

Sapera LT Library & Xtium-CL MX4 Driver Installation 17

Teledyne DALSA Device Drivers 17
Installation Procedure 17

Xtium-CL MX4 Firmware Loader 18

Firmware Update: Automatic Mode 18
Firmware Update: Manual Mode 19
Performing a Manual Firmware Update 19
Executing the Firmware Loader from the Start Menu 20

UPGRADING SAPERA OR BOARD DRIVER 21

Board Driver Upgrade Only 21
Upgrading both Sapera and Board Driver 21

USING THE CAMERA LINK SERIAL CONTROL PORT 22

COM Port Assignment 22

DISPLAYING XTIUM-CL MX4 BOARD INFORMATION 23

Device Manager – Board Viewer 23
Information Field Description 24
Device Information Report 26

CONFIGURING SAPERA 27

Viewing Installed Sapera Servers 27
Increasing Contiguous Memory for Sapera Resources 27

Host Computer Frame Buffer Memory Limitations 28
Contiguous Memory for Sapera Messaging 28

CAMEXPERT QUICK START 29

INTERFACING CAMERAS WITH CAMEXPERT 29
SAPERA CAMERA CONFIGURATION FILES 31

Camera Types & Files 31

Camera Files Distributed with Sapera 31

Overview of Sapera Acquisition Parameter Files (*.ccf or *.cca/*.cvi) 31

Xtium-CL MX4 User's Manual Contents • i

Concepts and Differences between the Parameter Files 31
CCF File Details 32
CCA File Details 32
CVI File Details 32

Saving a Camera File 32
Camera Interfacing Check List 33

USING CAMEXPERT WITH XTIUM-CL MX4 34
BASIC TIMING CATEGORY 35

Parameter Descriptions 35

ADVANCED CONTROL CATEGORY 37

Parameter Descriptions 37

EXTERNAL TRIGGER CATEGORY 39

Parameter Descriptions 39

IMAGE BUFFER AND ROI CATEGORY 41

Parameter Descriptions 41

USING THE FLAT FIELD CORRECTION TOOL 43

Xtium-CL MX4 Flat Field Support 43

Loading the Required Camera File 43

Set up Dark and Bright Acquisitions with the Histogra m Tool 43

Verify a Dark Acquisition 43
Verify a Brig ht Acquisition 44

Flat Field Correction Calibration Procedure 45

Flat Field Calibration Window 45

Using Flat Field Correction 46

USING THE BAYER FILTER TOOL 47

Bayer Filter White Balance Calibration Procedure 47

Using the Bayer Filter 47

SAPERA DEMO APPLICATIONS 48

Grab Demo Overview 48
Grab Demo Workspace Details 48
Using the Grab Demo 49

Server Selection 49
CCF File Selection 49
Grab Demo Main Wind ow 50

XTIUM-CL MX4 REFERENCE 51

BLOCK DIAGRAM 51
XTIUM-CL FLOW DIAGRAM 52
ACQUISITION TIMING 53
LINE TRIGGER SOURCE SELECTION FOR LINE SCAN APPLICATIONS 54

Parameter Values Specific to the Xtium-CL MX4 54

CVI/CCF File Parameters Used 54

SHAFT ENCODER INTERFACE TIMING 55

Dual Balanced Shaft Encoder RS-422 Inputs: 55

Example using any Encoder Input with Pulse-drop Counter 55
Example using Sequential Encoder Input 56
CVI/CCF File Parameters Used 56

VIRTUAL FRAME TRIGGER FOR LINE SCAN CAMERAS 57

Virtual Frame Trigger Timing Diagrams 57

Synchronization Signals for a 10 Line Virtual Frame 57
Synchronization Signa ls for Fixed Frame Lengt h A cquisition 58

Synchronization Signals for Variable Fr ame Leng th Acquisition 59
SAPERA ACQUISITION METHODS 61
TRIGGER TO IMAGE RELIABILITY 61

Supported Events and Transfer Methods 62

Acquisition Event s 62

Transfer Even t s 63

ii • Contents Xtium-CL MX4 User's Manual

Trigger Signal Validity 64

Supported Transfer Cycling Methods 64
OUTPUT LUT AVAILABILITY 65
METADATA: THEORY OF OPERATION 66

Metadata Data Structure 66

FLAT FIELD CORRECTION: THEORY OF OPERATION 67

Flat Field Correction Lists 67
Flat Field Correction Sets 68

Xtium-CL MX4 specific limitations 68

Programming the sets 68
XTIUM-CL MX4 SUPPORTED PARAMETERS 69

Camera Related Capabilities 69
Camera Related Parameters 70
VIC Related Parameters 75
ACQ Related Parameters 80
Transfer Related Capabilities 81
Transfer Related Parameters 82
General Outputs #1: Related Capabilities (GIO Module #0) 82
General Outputs #1: Related Parameters (GIO Module #0) 82
General Inputs #1: Related Capabilities (GIO Module #1) 83
General Inputs #1: Related Parameters (GIO Module #1) 83
Bidirectional General I/Os: Related Capabilities (GIO Module #2) 83
Bidirectional General I/Os: Related Parameters (GIO Module #2) 83

SAPERA SERVERS & RESOURCES 84

SERVERS AND RESOURCES 84
WINDOWS EMBEDDED 7 INSTALLATION 85

TECHNICAL SPECIFICATIONS 86

XTIUM-CL MX4 BOARD SPECIFICATIONS 86
HOST SYSTEM REQUIREMENTS 88
EMI CERTIFICATIONS 89
CONNECTOR AND SWITCH LOCATIONS 90

Xtium-CL MX4 Board Layout Drawing 90
Connector / LED Descr iption List 90

CONNECTOR AND SWITCH SPECIFICATIONS 91

Xtium-CL MX4 End Bracket Detail 91
Status LED Functional Description 92
J3: Camera Link Connector 1 93
J2: Camera Link Connector 2 94
Camera Link Camera Control Signal Overview 95
J1: External Signals Connector (Female DH60-27P) 96
J4: Internal I/O Signals Connector (26-pin SHF-113-01-L-D-RA) 96

Xtium-CL MX4 rev. A2 96

Xtium-CL MX4 rev. A1 97

Note 1: General Inputs / External Trigger Inputs Specifications 98

Block Diagram: Connecting External Drivers to General Inputs on J1 or J4 100

External Driver Electrical Requirements 101

Note 2: General Outputs /Strobe Output Specifications 102

Block Diagram: Connecting External Receivers to the General Outputs 103

External Receiver Electrical Requirements 104

Note 3: RS-422 Shaft Encoder Input Specifications 105

Note 3.1: Interfacing to an RS-422 Driver Output 106

Note 3.2: Interfacing to a TTL (also called Push-Pull) Output 107

Note 3.3: Interfacing to a Line Driver (also called O pen Emitter) Output 107

Note 3.4: Interfacing to an Open Collector Output 108

J5: Multi-Board Sync / Bi-directional General I/Os 108

Hardware Preparation 108

Xtium-CL MX4 User's Manual Contents • iii

Configuration via Sapera Application Programming 108

Configuration via Sapera CamExpert 109

J7: Power Connector 110

DC Power Details 110

Differences between Rev A1 and Rev A2 110

CABLES & ACCESSORIES 111

DH40-27S Cable to Blunt End (OR-YXCC-27BE2M1, Rev B1) 111
DH40-27S Connector Kit for Custom Wiring 112
Cable assemblies for I/O connector J4 113

Teledyne DALSA I/O Cable (part #OR-YXCC-TIOF120) 113

Third Party I/O Cables for J4 113

Board Sync Cable Assembly OR-YXCC-BSYNC40 114
Power Cable Assembly OR-YXCC-PWRY00 115

CAMERA LINK INTERFACE 116

CAMERA LINK OVERVIEW 116

Rights and Trademarks 116

DATA PORT SUMMARY 116
CAMERA SIGNAL SUMMARY 117

Video Data 117

Camera Controls 117

Communication 117
CAMERA LINK CABLE MANUFACTURER CONTACT INFORMATION 117

APPENDIX A: SIL E NT INSTALLATION 118

Silent Mode Installation 118

Creating a Response File 118

Running a Silent Mode Installation 118

Silent Mode Uninstall 119

Creating a Response File 119

Running a Silent Mode Unins tall 119

Silent Mode Installation Return Code 119
Installation Setup with CorAppLauncher.exe 119
Custom Driver Installation using install.ini 120

Crea ting the insta ll.ini File 120

Run the Installation using install.ini 120

APPENDIX B: TROUBLESHOOTING INSTALLATION PROBLEMS 121

OVERVIEW 121
PROBLEM TYPE SUMMARY 121

First Step: Check the Status LED 121
Possible Installation Problems 122
Possible Functional Problems 122

TROUBLESHOOTING PROCEDURES 123

Diagnostic Tool Overview 123

Diagnostic Tool Main Window 123

Diagnostic Tool Se lf Test Window 124

Diagnostic Tool Live Monitoring Window 125

Checking for PCI Bus Conflicts 125
Windows Device Manager 127
BSOD (blue screen) Following a Board Reset 127
Sapera and Hardware Windows Drivers 128
Recovering from a Firmware Update Error 128
Driver Information via the Device Manager Program 129
Teledyne DALSA Log Viewer 130
On-board Image Memory Requirements for Acquisitions 130

Dual Camera Input Configuration 130

Symptoms: CamExpert Detects no Boards 131

iv • Contents Xtium-CL MX4 User's Manual

Troubleshooting Procedure 131

Symptoms: Xtium-CL MX4 Does Not Grab 131
Symptoms: Card grabs black 131
Symptoms: Card acquisition bandwidth is less than expected 132
Symptoms: PoCL does not power the camera 133

CONTACT INFORMATION 134

SALES INFORMATION 134
TECHNICAL SUPPORT 134

Xtium-CL MX4 User's Manual Contents • v

Figures

Figure 1: Automatic Firmware Update 18
Figure 2: Manual Firmware Update 19
Figure 3: Firmware Update Progress 19
Figure 4: Start Menu Firmware Update Shortcut 20
Figure 5: Sapera Configuration Program 22
Figure 6: Board Information via Device Manager 23
Figure 7: Device Manager File Menu Save Device Info Command 26
Figure 8: CamExpert Program 29
Figure 9: Saving a New Camera File (.ccf) 33
Figure 10: Grab Demo – Server Selection 49
Figure 11: Grab Demo Main Window 50
Figure 12: Xtium-CL MX4 Model Block Diagram 51
Figure 13: Xtium-CL MX4 Flow Diagram 52
Figure 14: Acquisition Timing 53
Figure 15: Encoder Input with Pulse-drop Counter 55
Figure 16: Using Shaft Encoder Direction Parameter 56
Figure 17: Synchronization Signals for a 10 Line Virtual Frame 58
Figure 18: Line scan, Fixed Frame, No Trigger 58
Figure 19: Line scan, Fixed Frame, Edge Trigger 58
Figure 20: Line scan, Fixed Frame, Level Trigger (Roll-Over to Next Frame) 59
Figure 21: Line scan, Variable Frame, Edge Trigger (Active High determines Frame Length) 59
Figure 22: Line scan, Fixed Frame, Level Trigger ( Roll-Over) 59
Figure 23: EMI Certifications 89
Figure 24: Board Layout 90
Figure 25: End Bracket Details 91
Figure 26: CamExpert - Camera Link Controls 95
Figure 27: General Inputs Electrical Diagram 98
Figure 28: External Trigger Input Validation & Delay 99
Figure 29:Rev A2: External Signals Connec tion Diagram 100
Figure 30:Rev A1: Ex te rnal Signals Connec t io n Diagram 101
Figure 31: General Outputs Electrical Diagram 102
Figure 32:Rev A2: Output Signals Connection Diagram 103
Figure 33:Rev A1: Output Signals Connection Diagram 104
Figure 34: RS-422 Shaft Encoder Input Electrical Diagram 105
Figure 35:External RS-422 Signals Connection Diagram 106
Figure 36: Interfacing TTL to RS-422 Shaft Encoder Inputs 107
Figure 37: DH60-27P Cable No. OR-YXCC-27BE2M1 Detail 111
Figure 38: Photo of cable OR-YXCC-27BE2M1 111
Figure 39: OR-YXCC-H270000 Custom Wiring Kit 112
Figure 40: I/O Cable #OR-YXCC-TIOF120 113
Figure 41: Photo of cable OR-YXCC-BSYNC40 114
Figure 42: Photo of cable assembly OR-YXCC-PWRY00 115
Figure 43: Create an install.ini File 120
Figure 44: Diagnostic Tool Main Window 123
Figure 45: Diagnostic Tool Self Test Window 124
Figure 46: PCI Diagn ostic Tool Live Monitoring Window 125
Figure 47: PCI Diagnostic Program 126
Figure 48: PCI Diagnostic Program – PCI bus info 126
Figure 49: Using Windows Device Manager 127
Figure 50: Board Firmware Version 129
Figure 51: PCI Diagnostic – checking the BUS Master bit 132
Figure 52: CamExpert PoCL Parameter 133
Figure 53: CamExpert Video Status Bar 133

vi • Contents Xtium-CL MX4 User's Manual

Overview

Product Part Numbers

Xtium-CL MX4 Board

Item Product Number

Xtium-CL MX4 OR-Y4C0-XMX00
For OEM clients, this manual in printe d form, is available on request. OC-Y4CM-MUSR0

Xtium-CL MX4 Software

Item Product Number

Sapera LT version 8.20 or later for full fe a ture support (requir ed but sold
separately).

1. Sapera LT: Provides ever ything needed to build imaging
application.

2. Current Sapera-complia nt board hardware drivers

3. Sapera documentation (c ompiled HTML help, Adobe Acrobat®
(PDF)

(optional) Sapera P r oc es s ing Imaging Development Libr a ry includes over 600
optimized image-processing routines.

OC-SL00-0000000

Contact Sales at
Teledyne DALSA

Optional Xtium-CL MX4 Cables & Accessories

Item Product Number

DH60-27S cable ass embly to blunt end:

6 ft cable I/O 27 pin Hir os e c onnector to blunt end.
This cable assembly connects to J1.
(see "J1: External Signals Connector (Female DH60-27P))

Cable set to connect to J4 Internal I/O Signals connector
(J4: 26-pin SHF-113-01-L-D-RA)

DH40-27S Connector Kit for Custom Wiring:
Comprised of a DH40-27S connector plus screw lock housing kit

Cable assembly to connect to J5 (Board Sync)
Connecting 2 boards

Connection 3 or 4 boa r d s
Power interface cable required when supplying pow er to ca m er a s and/or

J1/J4
Power Over Camera Link (PoCL) Video Input Cable

2 meter HDR to MDR
2 meter HDR to HDR

OR-YXCC-27BE2M1, Rev B1

See suggested cables

OR-YXCC-H270000

OR-YXCC-BSYNC20

OR-YXCC-BSYNC40

OR-YXCC-PWRY00

OR-COMC-POCLD2

OR-COMC-POCLDH

Xtium-CL MX4 User's Manual Overview • 7

About the Xtium-CL MX4 Frame Grabber

Series Key Features

• Co mpliant with Camera Link specification version 2.0

• Uses a PCIe x4 Gen2 slot to maximize transfers to host computer buffers

• Acquire from Monochrome, RGB, Bayer and Bi-Color cameras, both area scan and line scan

• Supports multiple tap fo rmats, in multiple pixels depths

• Pixel clock range from 20 to 85 MHz

• Output lookup tables

• White Balance Gain for RGB pixels

• Vertical and Horizontal Flip supported on board

• Flat Field and Flat Line correction: pixel replacement using either neighborhood pixels or

3x2 cluster replacement.

• External Input Triggers and Shaft Encoder inputs, along with Strobe outputs

• Supports a number of acquisition events in compliance with "Trigger to Image Reliability"

• RoHS compliant

• Supports Power Over Camera Link (PoCL)

Supported Camera Link Configurations

The Camera Link industry standard is maintained by the Automated Imaging Association (AIA).

Camera Link configurations are Base, Medium, Full and Deca (Extended-Full).

Configuration Data

Bits

Base 24 255 MB/s 1
Medium 48 510 MB/s 2
Full 64 680 MB/s 2
Deca (80-bits) 80 850 MB/s 2

Maximum T hroughput Cables

8 • Overview Xtium-CL MX4 User's Manual

User Programma ble Con f igurations

The Xtium-CL MX4 supports the following C amera Link configurations, usin g one of 3 available
firmware designs:

Firmware Supported Camera Link Configurations

One Full Camera Link Input

(installation def a ult selection)

One 80-bit Camera Link
Input

Two Base Camera Li nk Input

(any 2 of the supported
configuration)

• 1 Base, 1 Medium or 1 Full Camera Link m onochrome or bayer
camera, 1/2/3/4/8 tap segm ented, 2 taps alternate, or 2/3/4/ 8
taps parallel.

• 1 Base or 1 Medium Camera Link RGB camera, 1 tap and 2 taps
segmented/parallel.

• Full Camera Link packed RGB camera.

• One 10 Tap @ 8-b it m onochrome or bayer c a mera

• One 8 Tap @ 10-b it m onochrome or bayer c a mera

• One 80-bit pack ed R G B camera

• One 80-bit pack ed Bi-Color camera

• Base Camera Link monochrome or Bayer camera, 1/2/3 tap

segmented, 2 taps alternate, 2/3 taps parallel.

• Base Camera Link RGB camera, 1 tap64

Use the Xtium-CL MX4 firmware firmware loader function in the Teledyne DALSA Device manager
utility to select firmware for one of the supported modes. Firmware selection is made either during
driver installation or manually later on (see Firmware Update: Manual Mode).

ACUPlus: Acquisition Control Unit

ACUPlus consists of a grab controller, one pixel packer, and one time base generator per camera
input. ACUPlus delivers a flexible acquisition front end and supports pixel clock ra tes o f up to
85MHz.

ACUPlus acquires variable frame sizes up to 64KB per horizontal line and up to 16 million lines per
frame. ACUPlus can also capture an infinite numb er of lines from a line scan camera without los i ng
a single line of data.

Xtium-CL MX4 User's Manual Overview • 9

DTE: Intelligent Data Transfer Engine

The Xtium-CL MX4 intelligent Data Transfer Engine ensures fast image data transfers between the
board and the host computer with zero CPU usage. The DTE provides a high degree of data
integrity during continuous image acquisition in a non-real time operating system like Windows.
DTE consists of multiple independent DMA units, Tap Descriptor Tables, and Auto-loading Scatter­Gather tables.

PCI Express x4 Gen2 Interface

The Xtium-CL MX4 is a universal PCI Express x4 Gen2 board, compliant with the PCI Express 2.0
specification. The Xtium-CL MX4 board achieves transfer rates up to 1.7 Gbytes/sec. to host
memory. Note that performance can be lower depending on PC and/or programmed configuration.

The Xtium-CL MX4 board occupies one PCI Express x4 Gen2 expansion slot and one chassis
opening.

Important:

• To obtain maximum transfer rate to host memory, make sure the Xtium-CL MX4 is in a Gen2
slot. Although the board will work in a Gen1 slot, only half the performance is achieved.

• The system motherboard BIOS should allow setting the PCIe maximum payload size to 256 MB
or higher. Systems with fixed settings of 128 MB will limit performance for transfers to host
memory.

• If the computer only has a PCI Express x16 slot, test directly or review the computer
documentation to verify if the Xtium-CL MX4 is supported since computer motherboards may
only support x16 graphic video board products in x16 slots.

Advanced Controls Overview

Visual Indicators

Xtium-CL MX4 features 3 LED indicators to facilitate system installation and setup. These indicators
provide visual feedback on the board status and camera status.

External Event Synchronization

Trigger inputs and strobe signals precisely synchronize image captures with external events.

Camera Link Communica tions Ports

One PC independent communication port per camera input provides Camera Link camera
configuration. This port does not require addition PC resources like free interrupts or I/O address
space. Accessible via the board device driver, the communication port presents a seamless
interface to Windows-based standard communication applications like HyperTerminal, etc. The
communication port is accessible directly from the Camera Link connectors.

Quadrature Shaft Encoder

An important feature for web sc anning applications, the Quadrature Shaft Encoder inputs allow
synchronized line captures from external web encoders. The Xtium-CL MX4 provides an RS-422
input that supports a tick rate of up to 5 MHz.

10 • Overview Xtium-CL MX4 User's Manual

Development Software Overview

Sapera++ LT Librar y

Sapera++ LT is a powerful development library for image acquisition and control. Sapera++ LT
provides a single API across all current and future Teledyne DALSA hardware. Sapera++ LT
delivers a comprehensive feature set including program portability, versatile camera controls,
flexible display functionality and management, plus easy to use a pp lication development wizards.
Applications are developed using either C++ or .NET frameworks.

Sapera++ LT comes bundled with CamExpert, an easy to use camera configuration utility to create
new, or modify existing camera con f iguration fil es.

Sapera Proces si ng Library

Sapera Processing is a comprehensive set of C++ classes or .NET classes for image processing and
analysis. Sapera Processing offers highly optim i zed tools for image processing, blob analysis,
search (pattern recognition), OCR and barcode decoding.

Xtium-CL MX4 User's Manual Overview • 11

Install the Xtium-CL MX4 in an available PCIe x4 (or x8) slot on the host computer.

Download and install the Sapera LT SDK software from the Teledyne DALSA website.

Download and install the Xtium-CL MX4 device driver from the Teledyne DALSA website.

Quick Start Setup & Installation

The following procedure outlines the basic steps required to install the Teledyne DALSA Xtium-CL
MX4. For complete installation details and information, see Installing Xtium-CL MX4.

If using PoCL, connect power to the board J7

connector.

http://teledynedalsa.com/imaging/support/downloads/sdks/

https://www.teledynedalsa.com/imaging/support/downloads/drivers/

12 • Quick Start Setup & Ins tall a tio n Xtium-CL MX4 User's Manual

To complete the installation, update the Xtium-CL MX4 firmware when prompted; select

Reboot when all software and board drivers are installed.

Automatic to update with the default configuration (Full Camera Link) or Manual to select
another option (2 Base Camera Link or 80-Bits Camera Link).

Launch Sapera LT CamExpert
the list of available devices.

Connect camera(s) to the board Camera Link connectors. Ensure cameras are properly
powered.

If using PoCL, use CamExpert to enable the PoCL feature in the the Basic Timing
category.

to verify the installation; the board should be present in

Xtium-CL MX4 User's Manual Quick Start Setup & Installation • 13

In CamExpert, click Detect Camera.

If the Detect Camera button is disabled, click Settings to open the the Communication
Settings dialog to configure CamExpert to detect attached cameras using a serial port

.

When CamExpert detects a camera (if GenCP compliant), camera parameters are
displayed along with the board parameters.

When properly connected, the video status bar displays camera signals in green.

14 • Quick Start Se t up & Install a tion Xtium-CL MX4 User's Manual

using the Sapera LT API in your application to acquire images

Click Grab to acquire a test image to validate the setup.

Modify the board and camera parameters as necessary. When completed, save the

camera configuration file

.

The Xtium-CL MX4 can be configured using the the parameter settings in this file when

Xtium-CL MX4 User's Manual Quick Start Setup & Installation • 15

Installing Xtium-CL MX4

Warning! (Grounding Instructions)

Static electricity can damage electronic components. Please discharge any static electrical charge
by touching a grounded surface, such as the metal computer chassis, before performing any
hardware installation. If you do not feel comfortable performing the installation, please consult a
qualified computer technician.

Important: Never remove or install any h a r d ware component with the computer power
on. Disconnect the power cord from the computer to disable the power s ta ndby mode.

Installation

The Sapera LT Development Library (or ‘runtime library’ if application execution without
development is preferred) must be installed before the Xtium-CL MX4 device driver.

The installation sequenc e is as follows:
 Turn the computer of f, disconnect the power cord (disables power standby mode), and open the

computer chassis to allow access to the expansion slot area.

 Install the Xtium-CL MX4 into a free PCI Express x4 Gen2 expansion slot (or an available x8

slot). Note that some computer's x16 slot may support the Xtium-CL MX4.

 Connect a spare power supply connector to J7

on the external signals connector J1 or J4. See Power Cable Assembly OR-YXCC-PWRY00 for
information about an adapter for older computers.

 Close the computer chass is and turn the computer on.
 Logon to the computer as administrator or with an account that has administrator privileges.

This prevents the case where some c om puters unexpectedly power up when a board is
installed.

for PoCL cameras or when DC power is required

For information on performing a s ilent installation, refer to Appendix A: Silent Installation.
For troubleshooting installation problems, refe r to Appendix B: Troubleshooting Installation

Problems

Xtium-CL MX4 User's Manual Installing Xtium-CL MX4 • 16

The Sapera LT SDK installation includ es compiled demo and example programs, along with

states as described in D1: Boot-up/PCIe Status LED.

Sapera LT Library & Xtium-CL MX4 Driver Installation

Sapera LT SDK (full version), the image acquisition and control SDK for Teledy ne DALSA
cameras and frame grabbers is available for download from the Teledyne DALSA website:

http://teledynedalsa.com/imaging/support/downloads/sdks/

Run-time versions are a lso available for download at this location.

project source c ode , in both C++ and .NET languages, for most Microsoft Visual Studio
development platforms. The Sapera LT ++ and Sapera LT . NET dem o s ou r c e c ode a re
found in the Sapera\Demos directory.

Refer to Sapera LT User’s Manual for additional details about Sapera LT.

Teledyne DALSA Device Drivers

All Teledyne DALSA device drivers are available for download from the Teledyne DALSA website:

https://www.teledynedalsa.com/imaging/support/downloads/drivers/

Installation Procedure

 Sapera LT is installed before Teledyne DALSA board drivers.
 Download the Sapera LT SDK from the Teledyne DALSA website and run the executable file; the

installation menu is presented.

 The installation program may prompt to reboot the computer. It is not necessary to reboot the

computer between the installation of Sapera LT and the board driver.

 Download the Xtium-CL MX4 device driver from the Teledyne DALSA website and run the

executable file; the installation menu is presented.

 During the late stages of the installat ion, the Xtium-CL MX4 firmware loader application starts.

This is described in detail in the following section.

 Reboot when all software and board drivers are installed.

If Windows displays any unexpected message conc erning the board, power off
the system and verify the Xtium-CL MX4 is installed in the slot properly. You
should also note the board’s status LED color and comp are it to the defined LED

Xtium-CL MX4 User's Manual Installing Xtium-CL MX4 • 17

Xtium-CL MX4 Firmware Loader

The Device Manager-Firmware Loader program automatically executes at the end of the driver
installation and on every subsequent reboot of the computer. It will determine if the Xtium-CL MX4
requires a firmware update. If firmware is required, a dialog displays. This dialog also allows the
user to load firmware for alternate operational modes of the Xtium-CL MX4.

Important: In the rare case of firmware loader errors please see Recovering from a Firmware
Update Error.

Firmware Update: Aut o mati c Mode

Click Automatic to update the Xtium-CL MX4 firmware. The Xtium-CL MX4 supports various
firmware configurations with the default being a Full, Medium, or Base camera.

for details on all supported modes, selected via a manual firmware update.
With multiple Xtium-CL MX4 boards in the system, all are updated with new firmware. If any

installed Xtium-CL MX4 board installed in a system already has the correct firmware version, an
update is not required. In the following screen shot, a single Xtium-CL MX4 Full board is installed
and ready for a firmware upgrade.

Figure 1: Automatic Firmware Update

18 • Installing Xtium-CL MX4 Xtium-CL MX4 User's Manual

Firmware Update: Manual Mode

Select Manual mode to load firmware other then the default version or when, in the case of
multiple Xtium-CL MX4 boards in the same system, if each requires different firmware.

The following figure shows the Device Manager manual firmware screen. Displayed is information
on all installed Xtium-CL MX4 boards, their serial numbers, and their firmware components.

Performing a Manual Firmware Update

To perform a manual firmware update:

• Select the Xtium-CL MX4 to update via the board selection box (if there are multiple boards

in the system)

• From the Configuration field drop menu select the firmware version required (typical

required to support different cameras)

• Click on the Start Update button

Figure 2: Manual Firmware Update

• Observe the firmware update progress in the message output window

Figure 3: Firmware Update Progress

• Close the Device manager program when the device reset complete message is shown

Xtium-CL MX4 User's Manual Installing Xtium-CL MX4 • 19

Executing the Firmware Load er from the Start Menu

If required, the Xtium-CL MX4 Firmware Loader program is executed via the Windows Start Menu
shortcut Start • Programs • Teledyne DALSA • Xtium-CL MX4 Drive r • F irmware Update.

Figure 4: Start Menu Firmware Update Shortcut

A firmware change after installation is required to select a different configuration mode. For
supported configurations, see the Supported Camera Link Configurations section.

20 • Installing Xtium-CL MX4 Xtium-CL MX4 User's Manual

Upgrading Sapera o r Board Driver

When installing a new ve rsion of Sapera or a Teledyne DALSA acquisition board driver in a
computer with a previous instal lation, the current version must be un-installed first. Described
below are two upgrade situations. Note that if the board is installed in a different slot, the new
hardware wizard opens. Answer as instructed in section Installation.

Board Driver Upgrade Only

Minor upgrades to acquisition board drivers are distributed as ZIP files available in the Teledyne
DALSA web site www.teledynedalsa.com/mv/support
the next release of the Sapera Essential CD-ROM.

Often minor board driver upgrades do not require a new revision of Sapera. To confirm that the
current Sapera version will work with the new board driver:

• Check the new board driver ReadMe file before installing, for information on the minimum

Sapera version required.

• If the ReadMe file does not s pecify the Sapera version required, contact Teledyne DALSA

Technical Support (see Technical Support ).

To upgrade the board driver only:

• Logon the computer as an administrator or with an account that has administrator

privileges.

• In Windows 7, from the start menu select Start • Settings • Control Panel • Programs

and Features. Double-click the Teledyne DALSA Xtium board driver and click Remove.

• In Windows 8 & Windows 10, just type Control Panel while in the start screen, or click

the arrow in the lower left side to bring up the all applications window. Select Programs and
Features, then double-click the Teledyne DALSA Xtium board driver and click Remove.

• Install the new board drive r. Run Setup.exe if installing manually from a downloaded driver

file.

• If the new driver is on a Sapera Essential CD-ROM follow the installation procedure

described in & Xtium-CL MX4 Driver.

Important: You cannot install a Teledyne DAL SA board driver without Sapera LT installed on the
computer.

. Board driver revisions are also available on

Upgrading both Sapera and Board Driver

When upgrading both Sapera and the acquisition bo ard driver, follow the procedure described
below.

• Logon the computer as an administrator or with an account that has administrator

privileges.

• In Windows 7, from the start menu select Start • Settings • Control Panel • Programs

and Features. Double-click the Teledyne DALSA Xtium board driver and click Remove.

Follow by also removing the older version of Sapera LT.

• In Windows 8 & Windows 10, just type Control Panel while in the start screen, or click

the arrow in the lower left side to bring up the all applications window. Select Programs

and Features, then double-click the Teledyne DALSA Xtium board driver and click
Remove. Do the same procedure with SaperaLT.

• Reboot the computer and logon the computer as an administrator again.

• Install the new versions of Sapera and the board driver as if this was a first time

installation. See Sapera LT Library & Xtium-CL MX4 Driver Installation and & Xtium-CL MX4
Driver for installation procedures.

Xtium-CL MX4 User's Manual Installing Xtium-CL MX4 • 21

Using the Camera Link Serial Control Port

The Camera Link cabling specification includes a serial communication port for direct camera
control by the frame grabber (see J3: Camera Link Connector 1 ). The Xtium-CL MX4 driver
supports this serial communication port either directly (such as the Serial Command window in
CamExpert) or by mapping it to a host computer COM port. Any serial port comm unication
program, such as Windows HyperTerminal, can connect to the camera in use and modify its
function modes via its serial port controls. The Xtium-CL MX4 serial port supports communication
speeds from 9600 to 921600bps. The serial port is created by the kernel driver, so it will be
available even if no Sapera LT application has started.

Note: if the serial communic a tion program can dir ectly select the Xtium-CL MX4 serial port then
mapping to a system COM port is not necessary.

When required, map the Xtium-CL MX4 serial port to an available COM port by using the Sapera
Configuration tool. Run the program from the Windows start menu: Start • Programs • D A LSA •
Sapera LT • Sapera Configuration.

COM Port Assignment

The lower section of the Sapera Configuration program screen contains the serial port configuration
menu. Configure as follows:

• Use the Physical Port drop menu to select the Sapera board device from all available

Sapera boards with serial ports (when more then one board is in the system).

• Use the Optional COM Ports Mapping drop menu to assign an available C OM number to

that Sapera board serial port.

• Click on the Save Settings Now button then the Close button. Reboot the computer at the

prompt to enable the serial port mapping.

Figure 5: Sapera Configuration Program

22 • Installing Xtium-CL MX4 Xtium-CL MX4 User's Manual

Displaying Xtium-CL MX4 Board Information

The Device Manager program also displays information about the Xtium-CL MX4 boards installed in
the system. To view board information run the program via the Windows Start Menu shortcut Start

• Programs • Teledyne DALSA • Xtium-CL MX4 Device Driver • Device Manager.

Device Manager – Board Viewer

The following screen image shows the Device Manager program with the Information/Firmware tab
active. The left window displays all Teledyne DALSA Xtium-CL MX4 boards in the system and their
individual device components. The right window displays the information stored in the selected
board device. This example screen shows the Xtium-CL MX4 board information.

Figure 6: Board Information via Device Manager

Xtium-CL MX4 User's Manual Installing Xtium-CL MX4 • 23

Serial Number

• 0x0000000000020000: Rev A2

components. Currently there are no optional components available.

show 0.

Note: Boards shipped with driver 1.11 or earlier will show Default.

level, contact Teledyne DALSA Technical Support.

the configuration dialog box. Disable any GIO reservations that are

Information Field Description

Field Description

[Read-Only]: Serial Number of the board

Hardware ID

Hardware Configuration [Read-Only]: This field will state the presence or absence of optional

ECO Number [Read-Only]: Indicates the last Engineering Change Order applied to

User Interface Outputs [Read-Only]: Number of available user interface outputs on the

[Read-Only]: This field identifies hardware changes that affect the
operation of the board.

Possible values are:

• 0x0000000000000000: Rev A1

the board.
Note: For boards Rev A1 shipped with driver 1.00, this entry will

show 0.

board. Possible values are:

• 4: Rev A1

• 8: Rev A2

Note: For boards Rev A1 shipped with driver 1.00, this entry will

General Input Opto Read-Only]: Type of opto-coupler on the board. Possible values are:

• TLP130 (Default)

• IL208

User Data Read/Write]: This is a 64 byte general purpose user storage area.

For information on how to read/write this field at the a ppl ication

User Interface GIOs
Reservation

[Read/Write]: Use this field to reserve User Interface GIOs for use
by the acquisition module.

To specifiy th e GIO reservations, click on the ‘Value’ field to open

24 • Installing Xtium-CL MX4 Xtium-CL MX4 User's Manual

not required. Click OK to update the value field.

Outputs 1 & 2 reserved for Strobe Outputs.

applica tion le v e l.

update the value field.

By default, boards are shipped with User Interface General Inputs 1
& 2 reserved for External Triggers and User Interface General

User Interface GIOs
Default Input Level

[Read/Write]: Use this field to select the def a ult input level of the
User Interface GIOs.
Click on the ‘Value’ field to select the input signal level detection
required.

By default, boards are shipped with User Interface General Inputs
set to 24V. Note that the input level can also be modified at the

Open Interface GIOs
Reservation

[Read/Write]: Use this field to reserve Open Interface GIOs for use
by the acquisition module. 2.

To specify the open interface GIO reservations, click on the ‘Value’
field. Disable any GIO reservations that are not required. Click OK to

Xtium-CL MX4 User's Manual Installing Xtium-CL MX4 • 25

reserved for Board Sync 1 &

By default, boards are shipped with Open Interface GIOs 1 & 2

Device Information Report

Teledyne DALSA T e ch n i ca l Support may requ es t device information report to aid in troubleshooting
installation or operational problems. Generate the Xtium-CL MX4 device manager report file
(BoardInfo.txt) by clicking File • Save Device Info.

Figure 7: Device Manager File Menu Save Device Info Command

26 • Installing Xtium-CL MX4 Xtium-CL MX4 User's Manual

Configuring Sapera

Viewing Installed Sapera Servers

The Sapera configuration program (Start • Programs • Teledyne DALSA • Sapera LT •
Sapera Configuration) allows the user to see all available Sapera servers for the installed

Sapera-compatible boards. The System entry represents the system server. It corresponds to the
host machine (your computer) and is the only server tha t should always be present.

Increasing Contiguou s Memory for Sapera Resources

The Contiguous Memory section lets the user specify the total amount of contiguous me mory (a
block of physical memory, occupying consecutive addresses) reserved for the resources needed for
Sapera buffers allocation and Sapera messaging. For both items, the Requested value dialog
box shows the ‘CorMem’ driver default memory setting while the Allocated value displays the
amount of contiguous me mory allocated successfully. The default values will generally satisfy the
needs of most applications.

The Sapera buffers value determines the total amount of contiguous memory reserved at boot
time for the allocation of dynamic resources used for frame buffer management such as scatter­gather list, DMA descriptor tables plus other kernel needs. Adjust this value higher if your
application generates any out-of-memory error while allocating host frame buffers or whe n
connecting the buffers via a transfer object.

You can approximate the worst-case scenario amount of contiguous memory required as follows:

• Calculate the tota l amount of hos t memory used for one frame buffer

[number of pixels per line x number of lines x 2 (if buffer is 10/12/14 or 16 bits)].

• Provide 200 bytes per frame b u ffer for Sapera buffer resources.

• Provide 64 bytes per frame buffer for metadata. Memory for this data is reserved in chunks

of 64kB blocks.

• Provide 48 bytes per frame buffer for buffer management. Memory for this data is reserved

in chunks of 64kB blocks.

• For each frame buffer DMA table, allocate 24 bytes + 8 bytes for each 4kB of buffer.

For example, for a 120x50x8 image:
120x50 = 6000 = 1.46 4kB blocks -> roundup to 2 4kB blocks.
Therefore 24 bytes + (2 * 8 bytes) = 40 bytes for DMA tables per frame buffer.
Memory for this data is reserved in chunks of 64kB blocks.
If vertical flipping is enabled, one must add 16 bytes per line per buffer.
For example, for an image 4080x3072 image: 16 bytes * 3072 = 49152 bytes.

• Note that Sapera LT reserves the 1

per frame buffer mentioned above.

• Test for any memory error when allocating host buffers. Simply use the Buffer menu of the

Sapera Grab demo program (see Grab Demo Overview) to allocate the number of host
buffers required for your acquisition source. Feel free to test the maximum limit of host
buffers possible on your host system – the Sapera Grab demo will not crash when the
requested number of host frame buffers is not allocated.

• The following ca lculation is an example of the amount of contiguous memory to reserve

beyond 5MB with 80,000 buffers of 2048x1024x8:
a) (80000 * 64 bytes)
b) (80000 * 48 bytes)
c) (80000 * (24 + (((2048*1024)/4kB) * 8))) = 323MB
d) Total = a (rounded up to nearest 64kB) + b (rounded up to nearest 64kB) + c (rounded
up to nearest 64kB).

st

5MB of its own resources, which includes the 200 bytes

Xtium-CL MX4 User's Manual Installing Xtium-CL MX4 • 27

Host Computer Frame Buffer M em ory Limitations

When planning a Sapera application and its host frame buffers used, plus other Sapera memory
resources, do not forget the Windows operating system memory needs.

A Sapera application using the preferred scatter gather buffers could consume most of the
remaining system memory, with a large allocation of frame buffers. If using frame buffers allocated
as a single contiguous memory block, Windows will limit the allocation dependent on the installed
system memory. Use the Buffer menu of the Sapera Grab demo program to allocate host buffer
memory until an error message signals the limit allowed by the operating system used.

Contiguous Memory for Sapera Messaging

The current value for Sapera messaging determines the total amount of contiguous memory
reserved at boot time for messages allocation. This memory space stores arguments when a
Sapera function is called. Increase this value if you are using functions with large argum ents, such
as arrays and experience any memory errors.

28 • Installing Xtium-CL MX4 Xtium-CL MX4 User's Manual

Device

Selection

Drop Menu

Parameter Features

*black are changeable

*gray are informative

only

Acquisition

Information

CamExpert Control Buttons

Acquisition

Display

Window

Parameter Category Selection

Feature Values Quick

Guide

Message

Window

CamExpert Quick Start

Interfacing Cameras with CamExpert

CamExpert is the camera-interfacing tool for Teledyne DALSA frame grabber boards supported by
the Sapera library. CamExpert is the primary tool to configure, test and calibrate your camera and
imaging setup. Dis play tools include, image pixel value readout , image zoom, and histogram.

An important component of CamEx pert is its liv e acquisition display win dow which allows
immediate verification of timing or control parameters without the need to run a separate
acquisition program.

Functional tools include hardware Flat Field calibration and operation support (see

Flat Field
Correction: Theory of Operation), plus support for either hardware based or software Bayer filter

camera decoding with auto white balance calibration.
After CamExpert identifies the camera (as per the Camera Link device discovery protocol), timing

parameters are displayed and the user can test image acquisition by clicking on Grab.

Xtium-CL MX4 User's Manual CamExpert Quick Start • 29

Figure 8: CamExpert Program

CamExpert groups parameters into functional categories. The parameters shown depend on the
frame grabber used and what camera is connected. The parameter values are either the camera
defaults or the last stored value when the camera was used.

 Device Selector: Two drop menus allow selection of which device and which saved

configuration to use.

• Device: Select whic h acquisition device to control and configure a camera file. Requ ired in
cases where there are multiple boards in a system and when one board supports multiple
acquisition types.

• Configuration: Select the timing for a specific camera model included with the Sapera
installation or a standard video standard. The User's subsection is where user created
camera files are stored.

• Detection: The Settings button opens a menu to select the form of automatic came ra
detection, such as serial port text based controls or GenCP for Camera Link. The Detect
Camera button attempts to identify the connected camera.

 Parameter Groups: Select a function category and change parameter values as required.

Descriptions for the camera parameters change dependent on the camera.

• Basic Timing: Provides or change static camera parameters.

• Advanced Controls: Advanced parameters used to select various integration methods,

frame trigger type, Camera Link controls, and so forth.

• External Trigger: Parameters to configure the external trigger characteristics.

• Image Buffer and ROI: Allows control of the host buffer dimension and format.

• Display: An impor tant component of C amExpert is its live acquisition d isplay window, which

allows immediate verification of timing or control parameters without the need to run a
separate acquisition program. Grab starts continuous acquisition (button then toggles to
Freeze to stop). Snap is a single frame grab. Trigger is a software trigger to emulate an
external source.

• Output Messages and Video Status Bar: Events and errors are logged for review. Camera
connection status is displayed where green indicates signal present.

• Camera Link Serial Command: Select this Tab to open a serial command port to the camera.
This allows the user to issue configuration co mmands if supported by the camera.

CamExpert is described more fully in the Sapera Getting started and Sapera Introduction manuals.

30 • CamExpert Quick Start Xtium-CL MX4 User's Manual

Sapera Camera Configuration Files

CamExpert generates the Sapera camera configuration file (yourcamera.ccf) based on timing and
control parameters entered. When using the Sapera LT API in your imaging application, the frame
grabber parameter settings can be loaded from this file. in For backward compatibility with
previous versions of Sapera, CamExpert also reads and writes the *.cca and *.cvi camera
parameter files.

Every Sapera demo program starts with a dialog window to select a camera configuration file (for
details on the included demos, see the Sapera De mo Appl ications section). Even when using the
Xtium-CL MX4 with common video signals, a camera file is required. Therefore, CamExpert is
typically the first Sapera application run after an installation. Existing .ccf files can be copied to any
new board installations when similar cameras are used.

Camera Types & Files

The Xtium-CL MX4 supports digital area scan or line scan cameras using the Camera Link interface
standard. Browse our web site [http://www.teledynedalsa.com/imaging/
on Teledyne DALSA Camera Link cameras.

Camera Files Distributed with Sa p era

] for the latest information

The Sapera distribution includes camera files for a selection of Xtium-CL MX4 supported cameras.
Using the Sapera CamExpert program, you may use the camera files (CCA) provided to generate a
camera configuration file (CCF) that describes the desired camera and frame grabber configuration.

Teledyne DALSA continually updates a camera application library composed of application
information and prepared camera files. Camera files are ASCII text, readable with Windows
Notepad on any computer without having Sapera installed.

Overview of Sapera Acquisition Parameter Files (*.c c f or *.cca/*.cvi)

Concepts and Differences betw een the Parameter Files

There are two components to the legacy Sapera acquisition parameter file set: CCA files (also
called cam-files) and CVI files (als o called VIC files, i.e. video input cond itioning). The files store
video-signal parameters (CCA) and video conditioning parameters (CVI), which in turn simplifies
programming the frame-grabber acquisition hardware for the camera in use. Sapera LT 5.0
introduces a new camera configuration file (CCF) that combines the CCA and CVI files into one file.

Typically, a camera application will use a CCF file per camera operating mode (or one CCA file in
conjunction with several CVI files, where each CVI file defines a specific camera-operating mode).
An application can also have multiple CCA/CCF files to support different image format modes
supported by the camera or sensor (such as image binning or var iable ROI).

Xtium-CL MX4 User's Manual CamExpert Quick Start • 31

CCF File Details

A file using the “.CCF” extension, (Camera Configuration fi les), is the camera (CCA) and frame
grabber (CVI) parameters grouped into one file for easier configuration file management. This is
the default Camera Configuration file used with Sapera LT 5.0 and the CamExpert utility.

CCA File Details

Teledyne DALSA distributes camera files using the legacy “.CCA” extension, (CAMERA files), which
contain all parameters describing the camera video signal characteristics and operation mode s
(what the camera outputs). The Sapera parameter groups within the file are:

• Video format and pixe l definition

• Video resolution (pixel rate, pixels per line, lines per frame)

• Synchronization source and timing

• Channels/Taps configuration

• Supported camera modes and related parameters

• Extern al signal assignment

CVI File Details

Legacy files using the “.CVI” extension contain all operating parameters related to the frame
grabber board - what the frame grabber can actually do with camera controls or incoming video.
The Sapera parameter groups within the file are:

• Activate and se t any supported camera control mode or control variable.

• Define the integr a tion mode and duration.

• Define the strobe o utput control.

• Allocate the frame grabber transfer ROI, the host video buffer size and buffer type

(RGB888, RGB101010, MONO8, and MONO16).

• Configuration of line/frame trigger parameters such as source (internal via the frame

grabber /external via some outside event), electrical format (TTL, RS-422, OPTO-isolated),
and signal active edge or level characterization.

Saving a Camera File

Use CamExpert to save a camera file (*.ccf ) usable with any Sapera demo program or user
application.

When parameters are setup as required in CamExpert, click on File•Sa ve As to save the new .ccf
file. The dialog that opens allows adding details such as camera information, mode of operation,
and a file name for the .ccf file. The following image is a sample for a Teledyne DALSA Falcon
camera. Note the default folder where User camera files are saved.

32 • CamExpert Quick Start Xtium-CL MX4 User's Manual

Figure 9: Saving a New Camera File (.ccf)

Camera Interf acing Check List

Before interfacing a camera from scratch with CamExpert:

• Confirm that Teledyne DALSA has not already published an application note with camera

files [ www.teledynedalsa.com

• Confirm that the correct version or board revision of Xtium-CL MX4 is used. Confirm that the

required firmware is loaded into the Xtium-CL MX4.

• Confirm that Sapera does not already have a .cca file for your camera installed on your hard

disk. If there is a .cca file supplied with Sapera, then use CamExpert to generate the .ccf file
with default parameter values matching the frame grabb er capabilities.

• Check if the Sapera installation has a similar type of camera file. A similar .cca file can be

loaded into CamExpert and modified to match timing and operating parameters for your
camera, and lastly save them as Camera Configuration file (.ccf).

• Finally, if there is no file for your camera, run CamExpert after installing Sapera and the

acquisition board driver, select the board acquisition server, and manually enter the camera
parameters.

].

Xtium-CL MX4 User's Manual CamExpert Quick Start • 33

Using CamExpert with Xtium-CL MX4

The Sapera CamExpert tool is the interfacing tool for Xtium-CL MX4 frame grabbers and connected
cameras; it is supported by the Sapera library and hardware. CamExpert allows a user to test
frame grabber and camera functions. Additionally CamExpert saves the frame grabber settings
configuration as individual camera parameter files on the host system (*.ccf).

When an acquisition server is selected, CamExpert only presents parameters supported by the
selected device.

The three Xtium-CL MX4 firmware options provide the following acquisition servers:

Firmware Acquisition Ser vers

1 x Full Camera Link

(default config uration)

80-Bits Camera Link

2 x Base Camera Link

Depending on the selected server, different parameters may be displayed. For example, with an
RGB acquisition server, the Color Type parameter is not displayed since its value is not
configurable.

For more information, see the Sapera Servers & Resources section.

34 • CamExpert Quick Start Xtium-CL MX4 User's Manual

Basic Timing Category

The Basic Timing category groups parameters such as camera type, the active image size, and
other settings related to basic timing.

Parameter Descriptions

The following table describes the CamExpert Basic Timing category of Sapera LT parameters.
Acquisition serve r note s, if applicable, indicate if parameter availablility or supported values are
dependent on the selected frame grabber acquisition server and acquisition device.

Display Name Parameter Description Notes

Camera Type CORACQ_PRM_SCAN Vid eo sou rce image type. Possible values

Color Type CORACQ_PRM_VIDEO Sets the color format of the input source . Not shown for RGB or

Pixel Depth CORACQ_PRM_PIXEL_DEPTH

Horizontal Active (in
Pixels)

Horizontal Offst (in
Pixels)

Vertical Active (in Lines) CORACQ_PRM_VACTIVE Sets the vertical camera resolution in lines

Vertical Offset (in Lines) CORACQ_PRM_VBACK_INVALID Sets the number of invalid lines before the

CORACQ_PRM_HACTIVE

CORACQ_PRM_HBACK_INVALID

are areascan or line scan.

Pixel depth (bits per pixel) of the input
source.

Sets the horizontal camera resolution in
pixels. This corresponds to the visible part
of the image from the camera.

Sets the number of invalid pixels before
the active portion of the line, in pixels per
tap. Valid range is 0-65535.

per frame. This corresponds to the visible
part of the image from the camera. Valid
range is 1-16777215.

active portion of the line. Valid range is 0-

16777215.

Not shown for Bayer

servers (areascan

only).

Bayer servers.

Monochrome servers

support:

Monochrome

Bayer mosaic

Not shown for RGB

servers.

Monchrome servers

support:

8, 10, 12, 14 or 16 bit

Bayer servers support:

8, 10 or 12 bit

For application server

specifc support, refer to

the parameter

CORACQ_PRM_HACTIVE

description.

Not shown for linescan

cameras.

Not shown for linescan

cameras.

Xtium-CL MX4 User's Manual CamExpert Quick Start • 35

Pixel Clock Input
Frequency (MHz)

Data Valid CORACQ_PRM_DATA_VALID_ENABLE

Camera Sensor
Geometry Setting

PoCL CORACQ_PRM_POCL_ENABLE Enables/disables sending power through

PoCL Status CORACQ_PRM_SIGNAL_STATUS Status of POCL signals connected to the

CORACQ_PRM_PIXEL_CLK_EXT

CORACQ_PRM_TAPS
CORACQ_PRM_TAP_OUTPUT
CORACQ_PRM_CAMLINK_CONFIGURATION

Specifies the external pixel clock
frequency, in MHz. Valid range is 20­85MHz.

Specifies if the acquisi tion board uses the
camera data valid signal. Boolean
parameter (TRUE or FALSE).

Defines the number of taps output and
how multi-tap data is output by the
camera.

the Camera Link cable. Boolean parameter
(TRUE or FALSE).

acquisition device. Possible values are
Active or Not Active.

For application server

specifc support, refer to

the parameter

CORACQ_PRM_x

descriptions.

36 • CamExpert Quick Start Xtium-CL MX4 User's Manual

Advanced Control Category

The Advanced Control category groups parameters for configuring camera cont rol signals, board
sync outputs and other advanced settings.

Parameter Descriptions

The following table describes the CamExpert Ad va n ced Con t r ol category of Sapera LT parameters.
Acquisition serve r note s, if applicable, indicate if parameter availablility or supported values are
dependent on the selected frame grabber acquisition server and acquisition device.

Display
Name

Internal Frame
Trigger

Internal Frame
Trigger Frequency
(in Hz)

Line Sync Source

Interal Line
Trigger Frequency
(in Hz)

Camera Line
Trigger Frequency
Min (in Hz)

Camera Line
Trigger Frequency
Max (in Hz)

Camera Control
method selected

Parameter Description Notes

CORACQ_PRM_INT_FRAME_TRIGGER_ENABLE Enables/disables the acquisition device’s

CORACQ_PRM_INT_FRAME_TRIGGER_FREQ

CORACQ_PRM_EXT_LINE_TRIGGER_ENABLE
CORACQ_PRM_INT_LINE_TRIGGER_ENABLE
CORACQ_PRM_SHAFT_ENCODER_ENABLE

CORACQ_PRM_INT_LINE_TRIGGER_FREQ

CORACQ_PRM_CAM_LINE_TRIGGER_FREQ_MIN

CORACQ_PRM_CAM_LINE_TRIGGER_FREQ_MAX Sets the camera’s maximum line tr ig g e r

CORACQ_PRM_TIME_INTEGRATE_ENABLE
CORACQ_PRM_CAM_TRIGGER_ENABLE
CORACQ_PRM_LINE_TRIGGER_ENABLE

internal frame trigger. Boolean parameter
(TRUE or FALSE).

Internal frame trigger frequency in Hz. Set
to the required frame rate when using
internal frame trigger to control camera
acquisition. Valid range is 0.001-10000Hz.

Selects the line trigger sou rce for linescan
cameras, unless free-running.

Sets the internal line trigg er frequency, in
Hz. App l ies only w hen the Line Sync Source
is set to Internal Line Trigger.

Sets the camera’s minimum lin e trigger
frequency. Minimum value is 1Hz.

frequency. Maximum value is 10000000 Hz.

Enables or disables an available camera
control method. Each supported control
method has one or more operating mode s
to choose from; refer to the parameters:

Camera Trigger Method Setting
Time Integration Method Setting.

Applies to

areascan cameras

only.

Applies to linescan

cameras only.

Applies to linescan

cameras only.

Applies to linescan

cameras only.

Applies to linescan

cameras only.

Xtium-CL MX4 User's Manual CamExpert Quick Start • 37

Time Integration
Method Setting

Camera Trigger
Method Setting

Line Integration
Method Setting

Line Trigger
Method Setting

Camera Frames
Per Trigger

Camera Control
During Readout

Strobe Method
Setting

Line Trigger Auto
Delay

Time Stamp Base CORACQ_PRM_TIME_STAMP_BASE

Board Sync
Output 1 Source

Board Sync
Output 2 Source

CC1
to
CC4

CORACQ_PRM_TIME_INTEGRATE_METHOD
CORACQ_PRM_TIME_INTEGRATE_DELAY
CORACQ_PRM_TIME_INTEGRATE_PULSE0_DELAY
CORACQ_PRM_TIME_INTEGRATE_PULSE1_DELAY
CORACQ_PRM_TIME_INTEGRATE_PULSE0_DURATION
CORACQ_PRM_TIME_INTEGRATE_PULSE1_DURATION
CORACQ_PRM_TIME_INTEGRATE_PULSE0_POLARITY
CORACQ_PRM_TIME_INTEGRATE_PULSE1_POLARITY

CORACQ_PRM_CAM_TRIGGER_METHOD When an asynchronous trigger pulse to a

CORACQ_PRM_LINE_INTEGRATE_METHOD

CORACQ_PRM_LINE_TRIGGER_METHOD

CORACQ_PRM_CAM_FRAMES_PER_TRIGGER Specifies the number of frames output by

CORACQ_PRM_CAM_CONTROL_DURING_READOUT Specifies if the camera control signals can

CORACQ_PRM_STROBE_METHOD
CORACQ_PRM_STROBE_ENABLE
CORACQ_PRM_STROBE_DELAY
CORACQ_PRM_STROBE_DURATION
CORACQ_PRM_STROBE_LEVEL
CORACQ_PRM_STROBE_POLARITY

CORACQ_PRM_LINE_TRIGGER_AUTO_DELAY

CORACQ_PRM_BOARD_SYNC_OUTPUT1_SOURCE Specifies the signal to output on board sync

CORACQ_PRM_BOARD_SYNC_OUTPUT2_SOURCE Specifies the signal to output on board sync

CORACQ_PRM_CAM_IO_CONTROL General purpose camera control. Four LVDS

When the Camera Control method is Time
Integration, select and configure the control
method required.

Click on the parameter field to open the
configuration dialog .

camera is required, select and configure the
required method.

Sets the method for controlling the
camera’s line integration.

Sets the method for line trig g er pul se
output.

the camera per trigger. Valid only for area
scan cameras. Valid range is 1-262142.

be sent during the readout of a frame.
Possible values are Valid or Invalid.

When a strobe output signal from the
acquisition board is required, select and
configure the control method required.

Note, method 1 is only available for
areascan camera type; method 3 for line
scan only.

Enables delaying line triggers to a camera
based on the selected method. Used to
avoid over-triggering a camera.

Sets the counter stamp time base. Possible
values are:

Microseconds
(CORACQ_VAL_TIME_BASE_US)
Line Counts
CORACQ_VAL_TIME_BASE_LINE_VALID
External line trigger or shaft encoder
CORACQ_VAL_TIME_BASE_LINE_TRIGGER
CORACQ_VAL_TIME_BASE_SHAFT_ENCODE
R
100 Nanoseconds
CORACQ_VAL_TIME_BASE_100NS (0x200)

output 1. This parameter permits the
synchronization of two acquisition devices
using a signal from one acquisition device
and synching the second acquisition device
with it.

output 2. This parameter permits the
synchronization of two acquisition devices
using a signal from one acquisition device
and synching the second acquisition device
with it.

pairs are reserved for genera l purpose
camera control. They are defined as camera
inputs and frame grabber outpus. C a mer a
manufacturers can define these signals to
meet their needs for a particular product.

Applies to linescan

cameras only

Applies to linescan

cameras only

Applies to linescan

cameras only

38 • CamExpert Quick Start Xtium-CL MX4 User's Manual

External Trigger Category

The External category groups parameters for configuring an external trigger for controlling image
acquisition.

Parameter Descriptions

The following table describes the CamExpert External Trigg er ca t egory of Sapera LT pa ra m eters.
Acquisition serve r note s, if applicable, indicate if parameter availablility or supported values are
dependent on the selected frame grabber acquisition server and acquisition device.

Display
Name

Parameter Description

External Trigger CORACQ_PRM_EXT_TRIGGER_ENABLE

External Trigger
Detection

External Trigger
Level

CORACQ_PRM_EXT_TRIGGER_DETECTION Defines the signal detected that generates an external

CORACQ_PRM_EXT_TRIGGER_LEVEL Specifies the electrical level of the external trigger

Enables/disables external trigger on the acquisition
board. When enabled, the acquisition board acquires an
image frame from the camera after receiving the trigger .
Boolean parameter (TRUE or FALSE).

Note: Applies to area scan cameras only.

trigger event to the acquisition device.
Two types of trigger are available:

Level Trigger: Active Low / Hi g h

Logic level (Low/High) on the trigger input enables
continuous image capture until the trigger input is set to
opposite logic .

Edge Trigger: Rising / Falling edge

Edge transition of a trigger pulse captures one image
frame.

connected to the acquisition board.
Possible valu es:
TTL single-ended logic signal
RS-422 balanced logic signal
12V single-ended logic signal
24V single-ended logic signal

Xtium-CL MX4 User's Manual CamExpert Quick Start • 39

External Trigger

External Trigger
Source

Minumum Duration
(in

μs)

Frame Count per
External Trigger

External Trigger
Delay

External Trigger
Delay Time Base

External Trigger
Ignore Delay

CORACQ_PRM_EXT_TRIGGER_SOURCE

CORACQ_PRM_EXT_TRIGGER_DURATION

CORACQ_PRM_EXT_TRIGGER_FRAME_COUNT

CORACQ_PRM_EXT_TRIGGER_DELAY Sets the delay between the reception of the trigger signal

CORACQ_PRM_EXT_TRIGGER_DELAY_TIME_BASE

CORACQ_PRM_EXT_TRIGGER_IGNORE_DELAY Sets t he time delay, in µsec, where if another ex te rn al

Specifies the physic al input source the external frame
trigger is connected to or which trigger input is used on
the acquisition device.

Note: to assign the external trigger source to a GPIO it
must be reserved; By default, boards are shipped with
User Interface General I n p u ts 1 & 2 reserve d fo r Ex t ern al
Triggers and User Interface General Outputs 1 & 2
reserved for Strobe Outputs.

Refer to User Interface GIOs Reservation
information on using the Teledyne DALSA Device
Manager tool to reserve GPIOs.

Minimum external trigg er pulse duration (in µs), needed
for the pulse to be acknowledged by the acquisition
device. If the duration of the p uls e i s shorter, the pulse is
ignored.

This feature is useful for trigger pulse debouncing. If the
value is ‘0’, no validation is performed

Number of images to acquire upon receiving an external
trigger. Valid range is 1-262142.

Note, infinit e frame co unt (-1) is not supported.

and the start of the image acquisition. Units are specified
by the External Trigger Delay Ti me Ba se parameter.

Sets the external trigger d el a y time ba se.
Possible values:

ns nanoseconds
us microseconds
ms milliseconds
line line counts
line trigger external line trigger or shaft

shaft encoder

frame image frame counts

trigger occurs, it is ignor e d. Valid range is 0-85899344.
The start of the delay (time '0') is the end of the next

vertical sync for analog cameras, or the beginning of the
next frame valid for digital cameras, following a valid
external trigger.

encoder pulse counts (after drop
and/or multiply factors)

shaft encoder pulse counts (after
drop and/or multiply fact or s)

for more

40 • CamExpert Quick Start Xtium-CL MX4 User's Manual

Image Buffer and ROI Category

The Image Buffer and ROI category groups parameters for the configuring the image buffer format,
size and offset settings, as well as image flipping.

Parameter Descriptions

The following table describes the CamExpert Image Buffer and ROI category of Sapera LT
parameters. Acquisition server notes, if applicable, indicate if parameter availablility or supported
values are dependent on the selected frame grabber acquisition server and acquisition device.

Display
Name

Parameter Description Notes

Image Width (in
Pixels)

Image Height (in
Lines)

Image Left Offset
(in Pixels)

CORACQ_PRM_CROP_WIDTH

CORACQ_PRM_CROP_HEIGHT Cropped height of the acquisition ima g e, in

CORACQ_PRM_CROP_LEFT Number of pixels t o crop from the left side of

Cropped width of th e acquisition image, in
pixels; this parameter defines the width of the
image transferred to the frame buffer.

The maximum width is the active horizontal of
the image source (see the Horizontal Active
parameter in the Basic Timing category).

Cropping increments depend on the s elected
acquisition server; CamExpert auto matically
adjusts numerical entries to valid increments.

lines; this parameter defines the vertical
dimension of the image transferred to the
frame buffer.

The maximum height is the active vertical
width of the image source (see the

Active parameter in the Basic Timing

category).
Cropping increments depend on the s elected

acquisition server; CamExpert auto matically
adjusts numerical entries to valid increments.

the acquisition image before transfer to the
frame buffer.

The maximum left offset is the active
horizontal width of the image source less one
increment step.

Cropping increments depend on the selected
acquisition server; CamExpert auto matically
adjusts numerical entries to valid increments.

Vertical

Note: image data is not scaled.

Note: image data is not scaled.

Note: image data is not scaled.

Xtium-CL MX4 User's Manual CamExpert Quick Start • 41

Image Top Offset
(in Lines)

Image Buffer
Format

Image Flip CORACQ_PRM_FLIP

Acquisition Frame
Length

CORACQ_PRM_CROP_TOP

CORACQ_PRM_OUTPUT_FORMAT

CORACQ_PRM_FRAME_LENGTH

Number of lines to crop from the top of the
acquisition image before transfer to the frame
buffer.

The maximum top offset is the active vertical
height of the image source less one increment
step.

Cropping increments are acquisition hardware
dependent; CamExpert automatically adjusts
numerical entries to valid increments.

Data format for the acquisition image transfer
to the frame buffer.

Enables real-time on-board horizontal image
flip function.

The Xtium-CL MX4 also supports a vertical flip
operation using CORXFER_PRM_FLIP

Specifies if the images out p ut by the
acquisition device have a fixed or variable
frame length.

.

Note: image data is not scaled.

The data buffer format is
dependent on the selected
acquisition se rver; f o r deta i ls
refer to the

CORACQ_PRM_OUTPUT_FORMAT

parameter description

Note: Full Packed RGBY

acquisition server does not

support the image flip operation.

Only available using Camera Link

Full Packed RGBY server.

42 • CamExpert Quick Start Xtium-CL MX4 User's Manual

Using the Flat Field Correction Tool

Flat Field Correction is the process of eliminating small gain differences between pixels in a sensor
array. That sensor when exposed to a uniformly lit field will have no gray level differences between
pixels when calibrated flat field correction is applied to the image. The CamExpert Flat Field tool
functions with hardware supporting flat field processing.

Xtium-CL MX4 Flat Field Su ppo rt

The Xtium-CL MX4 supports hardware based real-time Flat Field Correction when used with a
monochrome video source. The Xtium-CL MX4 supports two methods for pixel replacement:

 Neighborhood Replacement: a bad pixel is replaced with the average of its 2 neighbors on the

same video line.

 3x2 Cluster Replacement: a bad pixel is replaced with the average of its 5 neighbors, its two

line neighbors and the 3 pixel neighbors from the line above. Support for this feature using
Sapera Classes and CamExpert will be available in Sapera LT 8.20, therefore contact Teledyne
DALSA Technical Support for any inquiry regarding this feature. Note that this process requires
a cluster map file defining bad pixels, provided by the camera manufacturer.

 Note that the MX4 Flat Field algorithm handles all cases of bad pixels being on the frame edge

or where neighboring pixels are also bad.

Loading the Required Camera F ile

Select the required camera configuration file for the connected camera. Verify the acquisition with
the live grab function. Make camera adjustments to get good images.

Set up Dark and Bright Acquisitions with th e Histog ram Tool

Before performing calibration, verify the acquisition with a live grab. Also at this time make
preparations to grab a flat light gray level image, required for the calibration, such as a clean
evenly lighted white wall or non-glossy paper with the lens slightly out of focus. Ide a lly a controlled
diffused light source aimed directly at the lens sho uld be use d. Note the lens iris position for a
bright but not saturated image. Additionally check that the lens iris closes well or have a lens cover
to grab the dark calibration image.

Verify a Dark Acquisit ion

Close the camera lens iris and cover the lens with a lens cap. Using CamExpert, click on the grab
button and then the histogram button. The following figure shows a typical histogram for a very
dark image (8-bit acquisition).

Xtium-CL MX4 User's Manual CamExpert Quick Start • 43

Important: In this example, the average pixel value for the frame is close to black. Also note

that most sensors will show a much higher maximum pixel value due to one or more "hot p ixels".
The sensor specification accounts for a small number of hot or stuck pixels (pixels that do not react
to light over the full dynamic range specified for that sensor).

Verify a Bright Acquis ition

Aim the camer a at a diffused light source or evenly lit white w all with no shadows falling on it.
Using CamExpert, click on the grab button and then the histogram button. Use the lens iris to
adjust for a bright gray approximately around a pixe l value of 200 (for 8-bit pixels). The following
figure shows a typical histogram for a bright gray image.

44 • CamExpert Quick Start Xtium-CL MX4 User's Manual

Important: In this example, the average pixel value for the frame is bright gray. Also note that

sensors may show a much higher maximum or a much lowe r m inimum pixel value due to one or
more "hot or dead pixels". The sensor specification accounts for a small number of hot, stuck, or
dead pixels (pixels that do not react to light over the full dynamic range specified for that sensor).

Once the bright gray acquisition setup is done, note the camera position and lens iris position so as
to be able to repeat it during the calibration procedure.

Flat Field Correction Calibration Procedure

Calibration is the process of taking two reference images, one of a black field – one of a light gray
field (not saturated), to generate cor rection data for images captured by the CCD. Each CCD pixel
data is modified by the correction factor ge nerated by the calibration process, so that each pixel
now has an identical response to the same illumination.

Start the Flat Field calibration tool via the CamExpert menu bar:
Tools • Flat Field Correction • Calibration.

Flat Field Calibration Wind ow

The Flat Field calibration window provides a three step process to acquire two reference images
and then save the flat field correction data for the camera used. To aid in determining if the
reference images are valid, a histogram tool is provided so that the user can review the images
used for the correction data.

Xtium-CL MX4 User's Manual CamExpert Quick Start • 45

• Setup the camera to capture a uniform black image. Black paper with no illumination and

the camera lens’ iris closed to minimum can provide such a black image.

• Click on Acquire Black Image. The flat field demo will grab a video frame, analyze the

pixel gray level spread, and present the statistics. The desired black reference image should
have pixel values less then 20. If acceptable accept the image as the black reference.

• Setup the camera to acquire a uniform white image (but not saturated white). Even

illumination on white paper can be used, with a gray level of 128 minimum. It is preferable
to prepare for the white level calibration before the calibration procedure.

• Click on Acquire Whi te Image. The flat field demo will grab a video frame, analyze the

pixel gray level spread, and present the statistics. The captured gray level for all pixels
should be greater than 128. If acceptable accept the image as the white reference.

• Click on Save. The flat field correction data is saved as a TIF image with a file name of your

choice (such as camera name and serial number).

Using Flat Field Correctio n

From the CamExpert menu bar enable Flat Field correction
(Tools • Flat Field Correction • Enable). Now when doing a live grab or snap, the incoming
image is corrected by the current flat field calibration data for each pixel.

Use the menu function Tools • Flat Field Correction • Load to load in a flat field correction
image from a previous saved calibration data. CamExpert allows saving and loading calibration
data for all cameras used with the imaging system .

46 • CamExpert Quick Start Xtium-CL MX4 User's Manual

Using the Bayer Filter Tool

CamExpert supports the use of Bayer Filter cameras by providing a tool to select the Bayer filter
mosaic pattern and to perform an auto white balance. Color calibration can then be manually fine
tuned with RGB gain and gamma adjustments.

The CamExpert Bayer filter tool supports using both software or hardware based decoding. With
boards that have Bayer filter decoding in hardware, CamExpert directly controls the hardware for
high performance real-time acquisitions from Bayer filter c ameras. When standard acquisition
boards are used, CamExpert performs software Bayer filter decoding using the host system
processor.

Bayer Filter White Balance Calibration Procedure

The following procedure uses the hardware Bayer filter support (Bayer Decoder firmware loaded)
and any supported Bayer color camera. It is assumed that C amExpert was used to generate a
camera file with correct camera timing parameters.

 On the CamExpert menu bar, click on Tools • Bayer Filter. The following menu should show

Hardware selected by default when the frame grabber has Bayer support.

 Select Setting to access the color calibration windo w (see following figure).

 Click Grab to start live acquisition.
 Aim and focus the camera. The camera should see an area of white or place white paper in

front of the object being imaged.

 Click on one of the four Bayer pixel alignment patterns to match the camera (best color before

calibration). Typically the CamExpert default is correct for a majority of cameras.

 Adjust the lens iris to reduc e the exposure brightness so that the white image area is now

darker. Make certain that no pixel in the white area is saturated.

 Using the mouse left button, click and drag a ROI enclosing a portion of the white area.
 Click on the Auto White Balance button. CamExpert will make RGB gain adjustments.
 Open the camera iris to have a correctly exposed image.
 Review the image for color balance.
 Manually make additiona l adjustments to the RGB gain values. Fine tune the color balance to

achieve best results. Adjust the gamma factor to optionally improve the display.

 Stop the live acquisition and save the camera file (which now contains the Bayer RG B

calibration information). Note that the gamma factor is not save because it is not a Sapera
parameter but only a display tool.

Using the Bayer Filter

A Sapera application, when loading the camera file par ameters, will have the RGB gain adjustment
values. The application can incorporate a calibration menu for RGB adjustments as required.

Xtium-CL MX4 User's Manual CamExpert Quick Start • 47

Sapera Demo Applications

Grab Demo Overview

The Grab Demo program demonstrates the basic acquisition functions included in the Sapera
library. The program either allows you to acquire images, in continuous or in one-time mode, while
adjusting the acquisition parameters. The program code may be extracted for use within your own
application.

The Grab Demo is available as a compiled binary; source code is provided for both C++ and .NET
projects using Visual Studio 2005/2008/2010/2012/2013/2015.

All demos are available through the Start menu.

Grab Demo Workspace Details

Program
file

Visual C++
Solution

Visual .NET
Solution

Remarks

Xtium-CL MX4 User's Manual Sapera Demo Applications • 48

…\...\Sapera\Demos\Binaries\GrabDemo.exe

…\...\Sapera\Demos\Classes\Vc\SapDemos_2005.sln
…\...\Sapera\Demos\Classes\Vc\SapDemos_2008.sln
…\...\Sapera\Demos\Classes\Vc\SapDemos_2010.sln
…\...\Sapera\Demos\Classes\Vc\SapDemos_2012.sln
…\...\Sapera\Demos\Classes\Vc\SapDemos_2013.sln
…\...\Sapera\Demos\Classes\Vc\SapDemos_2015.sln

…\...\Sapera\Demos\NET\SapDemos_2005.sln
…\...\Sapera\Demos\NET\SapDemos_2008.sln
…\...\Sapera\Demos\NET\SapDemos_2010.sln
…\...\Sapera\Demos\NET\SapDemos_2012.sln
…\...\Sapera\Demos\NET\SapDemos_2013.sln
…\...\Sapera\Demos\NET\SapDemos_2015.sln

This demo is based on Sapera LT classes. See the Sapera User’s and Reference manuals for
more information.

Using the Grab Demo

Server Selection

Run the grab demo from the start menu:
Start•Programs•Sapera LT•Demos•Frame Grabbers•Grab Demo.

The de mo prog ram first displays the acq uisitio n configuration menu. The first drop menu displayed
permits selecting from any installed Sapera acquisition servers (installed Teledyne DALSA
acquisition hardware using Sapera drivers). The second drop menu permits selecting from the
available input devices present on the selected server.

Figure 10: Grab Demo – Server Selection

CCF File Selection

Use the acquisition configuration menu to select the required c amera configuration file for the
connected camera. Sapera camera files contain timing parameters and video conditioning
parameters. The default folder for camera configuration files is the same used by the CamExpert
utility to save user generated or modified camera files.

Use the Sape ra C a mExpert utility program to generate the camera configuration file based on
timing and control parameters entered. T he CamExpert live acquisition window allows immediate
verification of those parameters. CamExpert reads both Sapera *.cca and *.cvi for backward
compatibility with the original Sapera camera files.

Xtium-CL MX4 User's Manual Sapera Demo Applications • 49

Grab Demo Main Window

The Grab Demo program provides basic acquisition control for the selected frame grabber. The
loaded camera file (.ccf) defines the Frame buffer defaults.

Figure 11: Grab Demo Main Window

Refer to the Sapera LT User's Manual (OC-SAPM-USER), in section "Demos and Examples –
Acquiring with Grab Demo", for more information o n the Gra b De mo and others provided with
Sapera LT.

50 • Sapera Demo Applicatio ns Xtium-CL MX4 User's Manual

Xtium-CL MX4 Reference

Host PCI Express X4 (or greater)

Slot

DTE

Data-Transfer-Engine

with OLUT

PCI Express Gen

2 X4 Controller

Data

X

tium-CL MX4

Simplified Block Diagram

Data

Control

Data

ACU-

Plus

SDR26 #

1

Data

SerDes

Receiver

CC1
CC

2

CC

3

CC4
TX

RX

CLK

4

FVAL
LVAL
DVAL
SPARE

2

Data

&

Grab Controls

LVDS

Drivers and

Receiver

UART #1

Time Base

SDR26 #

2

CLK

4

Twisted Pairs

Data

SerDes

Receiver

CLK

FVAL
LVAL
DVAL
SPARE

Twisted Pairs

2

Data &

Grab Controls

CLK

4

Data

SerDes

Receiver

CLK

FVAL
LVAL
DVAL
SPARE

Twisted Pairs

2

Data

&

Grab Controls

CLK

4

RX

TX

Control

Dual Shaft Encoder

I/O Controll er

12V

500

mA/reset

Power Out

Gnd

Indicators

LEDs

Camera On/Grab On

Acquisition

Status Indicator 1

Acquisition Status Indicator 2

Camera On/Grab On

Frame Buffer and

DMA table Memory

(512 MB

)

Opto-coupled

Quad Trigger

/

General Inputs

TTL

8

Strobe /

General Outputs

(4 on Rev A1)

RS-422

D1

Board Status

24

24

24

J

1 — DH60-27P

J

4 — 26-pin SHF-113-01

-L-

D-RA

* Caution — connect only to one,

never both

5V

100 mA/reset

Power Out

Gnd

Block Diagram

Figure 12: Xtium-CL MX4 Model Block Diagram

Xtium-CL MX4 User's Manual Xtium-CL MX4 Refer ence • 51

Camera

Link

Front-End

Image
Buffer

FFC/FLC

Cropper (Fine

)

Host

DMA

ACU-Plus

DTE

Horizontal Flip

Look Up Table

White-Balance

Gain (RGB

Pixels)

Cropper

(Coarse)

Color

Conversion

(Bayer)

Xtium-CL Flow Diagram

The following diagram represents the sequence in which the camera data acquired is processed
through the Xtium-CL.

Figure 13: Xtium-CL MX4 Flow Diagram

 Camera Link Front End: Extracts the clock, LV AL, FVAL and data from the Camera Link ports

based on the Camera Link configuration selected.

 Image Buffer: Stores the video data using the model of video frames.
 Cropper (Coarse): Horizontal cropper used when reading out from the memory.
 Color Conversion: When enabled for particular cameras, converts Bayer and Bi-Color video

data into RGB data.

 White Balance Gain: Applies White Balance Gain to RGB data.
 FFC/FLC: Flat Field/Flat Line correction. Applies to Monochrom e data o n ly.
 Lookup Tables: Applies lookup table transformation to the data going to the host memory.
 Horizontal Flip: Performs the line data flip process.
 Cropper (Fine): Crops the resulting image when used, using a 4-byte resolution.
 Host DMA: Transfers the data from frame grabber into the host buffer memory. This module

will also perform the vertical flip if enabled.

52 • Xtium-CL MX4 Reference Xtium-CL MX4 User's Manual

PCLK

2

LVAL

3

FVAL
(Vsync)

Pixel Clock Range: 20 MHz up to 85 MHz

Min/Max

9

HB

5

Min/Max

4,9

VB

6

LVAL/FVAL setup time1: Minimum 15ns

DATA

first

7

last

8

(Hsync)














"Horizontal Ba ck invalid = x" where ‘x ’







Acquisition Timing

Figure 14: Acquisition Timing

1 The setup times for LVAL a nd FVAL are the same. Both mus t be high and stable before the rising

edge of the Pixel Clock.

2 Pixel Clock must always be present
3 LVAL must be active high to acquire camera data
4 Minimum of 1
5 HB - Horizontal Bla nking:

Minimum: 1 clock cycle
Maximum: no limits

7 First Active Pixel (unless otherw is e s p ecified in the CCA file –

defines the number of pix els to be skipped).

8 Last Active Pixel – defined in the CCA file under “Horizontal active = y" – where ‘y’ is the total

number of active pixels pe r tap.

9 Maximum Valid Data:

 8-bits/pixel x 64k Pixels/line (LVAL)
 16-bits/pixel x 32k Pixels/ line (LVAL)
 32-bits/pixel x 16k Pixels/ line (LVAL)
 16 Million lines (FVAL)

6 VB - Vertical Blan king:

Minimum: 1 line
Maximum: no limits

Xtium-CL MX4 User's Manual Xtium-CL MX4 Refer ence • 53

Line Trigger Source Selection for Line scan Applications

Line scan imaging applications require some form of external event trigger to synchronize line scan
camera exposures to the moving object. This synchronization signal is either an external trigger
source (one exposure per trigger event) or a shaft encoder source composed of a single or dual
phase signal (also known as a quadrature).

The Xtium-CL MX4 shaft encoder inputs provide additional functionality with pulse drop, pulse
multiply, and pulse direction support.

The following table describes the line-trigger source types supported by the Xtium-CL MX4. Refer
to the Sapera Acquisition Parameters Reference Manual (OC-SAPM-APR00) for descriptions of the
Sapera parameters.

Parameter Values Specific to the Xtium-CL MX4

PRM

Value

Configuration
& Input used

Input used as:
External Line Trigger

Input used as:
External Shaft Encoder

0 Dual – Camera #1

Dual – Camera #2
Full/80bit

1

2

3

4 From Board Sync #1 n/a
5 From Board Sync #2 n/a

Dual – Camera #1
Dual – Camera #2
Full/80bit

Dual – Camera #1
Dual – Camera #2
Full/80bit

Dual – Camera #1
Dual – Camera #2
Full/80bit

if
CORACQ_PRM_EXT_LINE_
TRIGGER_ENABLE = true

From Shaft Encoder Phase A
(default)

From Shaft Encoder Phase B
(default)

From Shaft Encoder Phase A
(default)

From Shaft Encoder Phase A From Shaft Encoder Phase A

From Shaft Encoder Phase B From Shaft Encoder Phase B

n/a From Shaft Encoder Phase A & B

if
CORACQ_PRM_SHAFT_
ENCODER_ENABLE =true

From Shaft Encoder Phase A
(default)

From Shaft Encoder Phase B
(default)

From Shaft Encoder Phase A & B
(default)

CVI/CCF File Parameters Used

• External Line Trigger Source = prm value

• External Line Trigger Enable = true/false

• Shaft Encoder Enable = true/false

54 • Xtium-CL MX4 Reference Xtium-CL MX4 User's Manual

K D

D

K D

D K

D

D K

D

D K

D D

Shaft Encoder phase A

Shaft Encoder phase B

K = Keep

D = Drop or Skip

Note: in this example, Number of trigger to drop = 2

Line acquired

Shaft Encoder Interface Timing

Dual Balanced Shaft Encoder RS-422 Inputs:

• Input Phase A: Connector J1/J4: Pin 3 (Phase A +) & Pin 2 (Phase A -)

• Input Phase B: Connector J1/J4: Pin 6 (Phase B+) & Pin 5 (Phase B-)

• See J1: External Signals Connector (Female DH60-27P) for complete connector signal

details)

Web inspection systems with variable web speeds typically provide one or two synchronization
signals from a web mounted encoder to coordinate trigger signals. These trigger signals are used
by the acquisition line scan camera. The Xtium-CL MX4 supports single or dual phase shaft en c od e r
signals. Dual encoder signals are typically 90 de grees out of phase relative to each other and
provide greater web motion resolution.

Example using any Encoder Input with Pulse-drop Counter

When enabled, the triggered camera acquires one scan line for each shaft encoder pulse-edge. To
optimize the web application, a second Sapera parameter defines the number of triggers to skip
between valid acquisition triggers. The figure below depicts a system where a valid camera trigger
is any pulse edge from either shaft encoder signal. After a trigger, the two following triggers are
ignored (as defined by the Sapera pulse drop parameter).

Xtium-CL MX4 User's Manual Xtium-CL MX4 Refer ence • 55

Figure 15: Encoder Input with Pulse-drop Counter

Shaft Encoder phase A

Shaft Encoder phase B

Example using Sequential Encoder Input

Support of a dual phase encoder should consider the direction of motion of one phase signal to the
other. Such a case might exist where system vibrations and/or conveyor backlash can cause the
encoder to briefly travel backwards. The acquisition device must in those cases count the reverse
steps and subtract the forward steps such that only pulses after the reverse count reaches zero are
considered. By using the event “Shaft Encoder Reverse Counter Overflow”, an application can
monitor an overflow of this counter.

Also, if a maximum line rate camera trigger source is a high jitter shaft encoder, the parameter
CORACQ_PRM_LINE_TRIGGER_AUTO_DELAY can be used to automatically delay line triggers to
avoid over-triggering a camera, and thus not miss a line. Note that some cameras integrate this
feature. See also the event “Line Trigger Too Fast
feature.

The example figure below shows shaft e ncoder s ignals with high jitter. If the acquisition is
triggered when phase B follows phase A, with jitter present phase B may precede phase A. Use of
the Shaft Encoder Direction parameter will prevent false trigger conditions.

” that can be enabled when using the ‘auto delay’

Figure 16: Using Shaft Encoder Direction Parameter

Note: Modify camera file par a meter s ea s ily with the Sapera CamExpert program.

CVI/CCF File Parameters Used

Shaft Encoder Enable = X, where:

• If X = 1, Shaft Encoder is enabled

• If X = 0, Shaft Encoder is disabled

Shaft Encoder Pulse Drop = X, where:

• X = number of trigger pulses ignored between valid triggers

Shaft Encoder Pulse Multiply = X, where:

• X = number of trigger pulses generated for each shaft encoder pulses

Shaft Encoder Pulse Drop/Multiply Order = X, where:

• If X = 1, the drop operation will be do ne first, followed by the multiplier operation

• If X = 0 or 2, the multiplier operation will be done first, followed by the drop operation

Shaft Encoder Direction = X, where:

• X = 0, Ignore direction

• X = 1, Forward steps are detected by pulse order A/B (forward motion)

• X = 2, Forward steps are detected by pulse order B/A (reverse motion)

Note: For information on camera configura tion files, see the S a pe r a Acquisition Pa rameters
Reference Manual (OC-SAPM-APR00).

56 • Xtium-CL MX4 Reference Xtium-CL MX4 User's Manual

Virtual Frame Trigger for Line Scan Cameras

When using line scan came ras, a frame buffer is allocated in host system memory to store
captured video lines. To control when a video line is stored as the first line in this “virtual” frame
buffer, an external frame trigger signal is used.

For fixed length frames, the Sapera vertical cropping parameter controls the number of lines
sequentially grabbed and stored in the virtual fr a m e buffer.

For variable length frames, the External Frame Trigger (when a level or dual input type is
selected) controls the number of lines sequentially grabbed up to the maximum of lines in the
virtual frame buffer.

For both fixed and variable length frames, choosing an active low/high or dual input permits
grabb ing multiple consecutive images as long as the chosen signal is active. This act ion is also
called “rolling over” to the next buffer. When choosing a single rising or falling edge, a single frame
will be acquired, there is never any roll over.

External Frame Trigger Detection Fixed Frame Variable F r am e

Active Low/High Roll Over Roll Ove r
Rising/Falling E dg e No Roll Over No Roll Over
Dual Input Risin g / Falling Edge Roll Over Roll Over

Virtual Frame Trigger Timing Diagrams

The following timing diagrams show the use of a virtual frame trigger to define when an image line
is stored at the beginning of the virtual frame buffer. The virtual frame trigger signal (generated by
some external event) connects to the Xtium-CL MX4 trigger input.

 Virtual frame trigger can be differential (RS-422) or single ended (TTL, 12V, 24V) industry

standard, and be rising or falling edge active, active high or low, or double pulse rising or falling
edge.

 Virtual frame trigger connects to the Xtium-CL MX4 via the External Trigger Input 1 & 2 inputs.

• Trigger Input #1 on connector J1: pin 8

• Trigger Input #2 on connector J1: pin 9

 The Sapera vertical cropping parameter specifies the number of lines captured (maximum size

of virtual frame).

Synchronization Signals for a 10 Line Virtual Frame

The following timing diagram shows an example of gra bbing 10 image lines from a line scan
camera and the use of a virtual frame trigger to define when a video line is stored at the beginning
of the virtual frame buffer.

In this example, virtual frame trigger control is configured for rising edge trigger.
 Camera control signals are a ctive at all times. These continually trigger the camera acquisition

in order to avoid corrupted video lines at the beginning of a virtual frame.

 The camera control signals are either timing controls on Xtium-CL MX4 shaft encoder inputs, or

line triggers generated internally by the Xtium-CL MX4.

The following timing diagram shows the relationship between External Frame Trigger input,
External Shaft Encoder input (one phase used with the second terminated), and camera control
output to the camera.

Xtium-CL MX4 User's Manual Xtium-CL MX4 Refer ence • 57

LVAL

Notes:

• In this example -- 10 lines are acquired

• The Maximum frame rate = Max. Line Rate / nb lines (Hz)

• In / Out signal reference is relative to frame grabber

Video Line

Camera

Control

Shaft Encoder

Virtual Frame

Trigger

In

In

In

In

Out

10 Lines

Acquired

n Lines

Ignored

Frame Valid

Grab Start

Illegal Grab Start

Frame Valid

Trigger

T

T T

Ignored

Grab Start

Figure 17: Synchronization Signals for a 10 Line Virtual Frame

Synchronization Signals for Fixed Fr ame Length Acquisition

A trigger event is only generated when a grab is active; when not grabbing no trigger events are
generated. When a frame is complete, the frame grabber checks for the specified active trigger
level and, if present, grabs the next frame; otherwise, it waits for the next detected active trigger
level.

In the following diagrams:

“T” indicates a valid external trigger event (SapAcquisition::EventExternalTrigger).
“Ignored” is an ignored event (SapAcquisition::EventExternalTriggerIgnored).

such that
Ignored + T = total triggers received by frame grabber

58 • Xtium-CL MX4 Reference Xtium-CL MX4 User's Manual

Figure 18: Line scan, Fixed Frame, No Trigger

Figure 19: Line scan, Fixed Frame, Edge Trigger

Frame Valid

Trigger

(Active High)

Grab Start

T T T T

Frame Valid

Trigger

(Active High)

Grab Start

T

Grab Start (SapTransfer) called before trigger

Grab Start (SapTransfer) called after trigger

T

Trigger event issued at grab start

T

Frame Valid

Trigger

(Rising Edge)

Grab Start

T

T

T

Buffer 1

Undefined

(Should Not Grab)

Buffer 2

Trigger > Frame

Buffer 3

Frame Max Height

1 frame per trigger edge; selected level determines frame length (up to max)

Frame Valid

Level Trigger
(Active High)

Grab Start

T T

T

Buffer 1

Buffer 4

Buffer 2

Trigger Level > Max Frame Height

Buffer 3

Frame Max Height

Figure 20: Line scan, Fixed Frame, Level Trigger (Roll-Over to Next Frame)

Synchronization Signals for Variable Frame Length Acquisition

For variable length frames, trigger ignored events are not issued
(SapAcquisition::EventExternalTriggerIgnored); a valid trigger event always initiates either a frame
start or frame end .

Figure 21: Line scan, Variable Frame, Edge Trigger (Active High determines Frame Length)

Xtium-CL MX4 User's Manual Xtium-CL MX4 Refer ence • 59

Figure 22: Line scan, Fixed Frame, Level Trigger ( Roll-Over)

CVI File (VIC) Parameters Used

The VIC parameters listed below provide the control functionality for virtual frame trigger. Sapera
applications load pre-configured CVI files or change VIC parameters during runtime.

Note: Sapera camera file parameters are easily modified by using the CamExpert program.

External Frame Trigger Enable = X, where: (with Virtual Frame Trigger enabled)

• If X = 1, External Frame Trigger is enabled

• If X = 0, External Frame Trigger is disabled

External Frame Trigger Detection = Y, where:
If Y= 1, External Frame Trigger is active low

• If Y = 2, External Frame Trigger is active high

• If Y = 4, External Frame Trigger is active on rising edge

• If Y = 8, External Frame Trigger is active on falling edge

• If Y = 32, External Frame Trigger is dual-input rising edge

• If Y = 64, External Frame Trigger is dual-input falling edge

Note:. For dual-input triggers, Trigger Input #1 signals the start of the frame trigger, Tr igger
Input #2 signals the end of the frame trigger.

External Frame Trigger Level = Z, where: (with Virtual Frame Trigger signal type)

• If Z = 1, External Frame Trigger is a TTL signal

• If Z = 2, External Frame Trigger is a differential signal (RS-422)

• If Z = 8, External Frame Trigger is a 24V signal

• If Z = 64, External Frame Trigger is a 12V signal

Note: For information on camera configura tion files, see the S a pe r a Acquisition Pa rameters
Reference Manual (OC-SAPM-APR00).

60 • Xtium-CL MX4 Reference Xtium-CL MX4 User's Manual

Sapera Acquisition Methods

Sapera acquisition methods define the co ntrol and timing of the camera and frame grabber board.
Various methods are available, grouped as:

• Camera Trigger Methods (method 1 supported)

• Line Trigger Methods (method 1)

• Line Integration Methods (method 1 through 4 supported)

• Time Integration Methods (method 1, 3, 5, 6, 8)

• Strobe Methods (me thod 1, 3, 4 supported)

Refer to the Sapera LT Acquisition Parameters Reference manual (OC-SAPM-APR00) for detailed
information concerning camera and acquis ition control methods.

Trigger to Image Reliability

Trigger-to-image reliability incorporates all stages of image acquisition inside an integrated
controller to increase reliability and simplify error recovery. The trigger-to-image reliability model
brings together all the requirements for image acquisition to a central management unit. These
include signals to control camera timing, on-board frame buffer memory to compensate for PCI bus
latency, and comprehensive error notification. If the Xtium-CL MX4 detects a problem, the
application can take appropriate action to return to normal operation.

The Xtium-CL MX4 is designed with a robust ACU (Acquisition and Control Unit). The ACU monitors
in real-time, the acquisition state of the input plus the DTE (Data Transfer Engine) which transfers
image data from on-board memory into PC memory. In general, thes e m an a g emen t p ro c e ss es are
transparent to end-user applications. With the Xtium-CL MX4, applications ensure trigger-to-image
reliability by monitoring events and co ntrolling transfer methods as described below:

Xtium-CL MX4 User's Manual Xtium-CL MX4 Refer ence • 61

Event generated d uring acquisiti on, with the detection of the star t of a video frame

Event generated on detection of the start of a video fra m e by the board acquis ition
hardware. Acquisition does n ot need to be active; therefore, this ev ent can verify a

Supported Events and Transfer Methods

Listed below are the supported acquisition and transfer events. Event monitoring is a major
component to the Trigger-to-Image Reliability framework.

Acquisition Events

Acquisition event s pertain to the acquisition module. They provide feedback on the image capture
phase.

Event Description

External Trigge r
(Used/Ignored)

Start of Frame

End of Frame

Data Overflow

Frame Valid

Pixel Clock

(Present/Absent)

Frame Lost

External Line Trigger
Too Slow

Line Trigger Too Fast

Shaft Encoder
Reverse Count
Overflow

Generated when the external trigger pin is asserted, which indicates the start of
the acquisition process. T her e a r e tw o ty pes of external trigger events: ‘U s ed’ or
‘Ignored’. Following an external trigger, if the ev ent generates a captured image,
an External Trigger Used event will be generated
(CORACQ_VAL_EVE N T _T YPE_EXTERNAL_TRIGGER) . If there is no captured image,
an External Trigger Ignored event will be generated
(CORACQ_VAL_EVE N T _T YPE_EXTERNAL_TRIGGER_IG N O R ED). An external trigger
event is ignored if the event rate is higher than the possible fr ame rate of the
camera.

by the board acquisition ha r dware. The Sapera event valu e is
CORACQ_VAL_EVENT_TYPE_START_OF_FRAME.

Event generated during ac quisition, with the detection of the end of a video frame
by the board acquisition ha r dware. The Sapera event valu e is
CORACQ_VAL_EVENT_TYPE_END_OF_FRAME.

The Data Overflow event indicates that there is not enough bandwidth for the
acquired data transfer without los s . Data Overflow would occur with lim ita tions of
the acquisition m odule and should never occur.
The Sapera event value is COR A CQ_VAL_EVENT_TYPE_DATA _O VERFLOW.

valid signal is connected. The Sapera event value is
CORACQ_VAL_EVENT_TYPE_VERTICAL_SYNC.

Event generated on the transition from detecting or n ot detecting a pixel clock
signal. The Sapera event values are CORACQ_VAL_EVEN T_TYPE_NO_PIXEL_CLK
and CORACQ_VAL_EVEN T_TY PE_PIXEL_CLK.

The Frame Lost event indicates that an acquired image failed to transfer to on­board memory. An example is if there are no free on-board buff er s a vailable for
the new image. This may be the cas e if the image transfer f r om onboard buffers to
host PC memory is not sustainable due to bus bandwidth is sues or no host bu ffers
are available to receive an ima ge.
The Sapera event value is COR A CQ_VAL_EVENT_TYPE_FRAME_LOST.

Event which indicates tha t th e detected shaft encoder input tick rate is too slow for
the device to take into account the s pe c ified shaft encode r m ultiplier valu e. The
Sapera event value is
CORACQ_VAL_EVENT_TYPE_EXT_LINE_TRIGGER_TOO_SLOW.

Event which ind ic a te s a previous line-trigger did not generate a complet e v ideo
line from the camera. Note that du e to jitter associated with using shaf t encoders,
the acquisition de vice can delay a line tr ig ger if a previous line has not yet
completed. This event is gen era ted if a second line trigger comes in while the
previous one is still pendin g. This event is generated onc e per virtual frame. The
Sapera event value is C ORACQ_VAL_EVENT_TYPE_LINE_TRIGGER_TOO_FAST.

Event which indicates that the shaft encoder has travelled in the opposite d irection
expected and that the number of pulses encountered during that travel has
exceeded the acquisition dev ic e c ounter. The acquisition dev ic e w ill th us not be
able to skip the appropriate number of pulses when the expec ted direction is
detected. The Sapera event value is
CORACQ_VAL_EVENT_TYPE_SHAFT_ENCODER_REVERSE_COUNT_OVERFLOW.

62 • Xtium-CL MX4 Reference Xtium-CL MX4 User's Manual

Transfer Events

Transfer events are the ones related to the transfer module. Transfer events provide feedback on
image transfer from onboard memory frame buffers to PC memory frame buffers.

Event Description

Start of Frame

End of Frame

End of Line

End of N Lines

End of Transfer

Start of Frame event generated when the first image pixel is transferred from on­board memory int o P C memory.
The Sapera event value is COR XFER_VAL_EVENT_TYPE_S T ART_OF_FRAME.

End of Frame event generated when the last image pixel is transferred from on­board memory int o P C memory.
The Sapera event value is COR XFER_VAL_EVENT_TYPE_E N D _OF_FRAME.

The End of Line event is generated after a video line is trans f er r ed to a PC buffer.
The Sapera event value is CORXFER_V A L_EVENT_TYPE_END_OF_LI N E.

The End of N Lines event is genera ted a fter a set number of video lin es a re
transferred to a PC buffer . The Sapera event value is
CORXFER_VAL_EVENT_TYPE_END_OF_NLINES.

End of Transfer event generated at the completion of the last image tra nsfer from
on-board memory in to PC memory. Is s ue a stop command to the transfer module
to complete a transfer (if transfers are already in progress). If a frame transfer of
a fixed number of images is reques ted, the transfer module wil l stop tra nsfer
automatically. The Sapera even t value is
CORXFER_VAL_EVENT_TYPE_END_OF_TRANSFER.

Xtium-CL MX4 User's Manual Xtium-CL MX4 Refer ence • 63

Trigger Signal Validity

The ACU ignores external trigger signal noise with its programmable debounce control. Program
the debounce parameter for the minimum pulse duration considered as a valid external trigger
pulse. For more information see Note 1: General Inputs / External Trigger Inputs Specifications.

Supported Transfer Cycling Methods

The Xtium-CL MX4 supports the following transfer modes, which are either synchronous or
asynchronous. Note that the Xtium does not make any use of the trash buffer. Images are
accumulated in on-board memory in a FIFO type manner. When no memory is available for a new
image to be stored, the image is discarded and the CORACQ_VAL_EVENT_TYPE_FRAME_LOST is
generated. On-board memory can get filled up if the rate at which the images are acquired is
greater than the rate at which the DMA engine can write them to host buffer memory. On-board
memory can also get filled-up if there are no more empty buffers available to transfer the on -board
images.

When stopping the image acquisition, the event CORXFER_VAL_EVENT_TYPE_END_OF_TRANSFER
will occur once all images currently in the on-board memory are transferred to host buffer memory.
Note that if the application does not provide enough empty buffers, the Xtium event will not occur
and an acquisition abort will be required.

• CORXFER_VAL_CYCLE_MODE_SYNCHRONOUS_WITH_TRASH

Before cycling to the next buffer in the list, the transfer device will check the next buffer's
state. If its state is full, the transfer will keep the image in on-board memory until the next
buffer’s state changes to empty. If the on-board memory gets filled, frame lost events will
be generated.

• CORXFER_VAL_CYCLE_MODE_SYNCHRONOUS_NEXT_EMPTY_WITH_TRASH

When starting an acquisition, the b uffer list is put in an empty buffer queue list in the exact
order they were added to the transfer. Whenever a user sets a buffer to empty, it is added
to the empty buffer queue list, so that after cycling once through t he original buffer list, the
buffers acquired into will follow the order in which they are put empty by the user. So in th is
mode, the on-board images will be transferred to host buffer memory as long as there are
buffers in the empty buffer queue list. If the on-board memory gets filled, the frame lost
event will start occurring.

• CORXFER_VAL_CYCLE_MODE_ASYNCHRONOUS

The transfer device cycles through all buffers in the list without concern about the buffer
state.

64 • Xtium-CL MX4 Reference Xtium-CL MX4 User's Manual

Output LUT Availability

The following table defines the supported output LUT (look up tables) for the Xtium-CL MX4. Note
that unsupported modes are not listed.

Number of Digital

Bits

Output Pixel

Format

LUT Format Notes*

8

8
10 MONO 8 10-in, 8-out
10 M ONO 16 10-in, 16-out 10 bits in 10 LSBs of 16-bit
12 MONO 8 12-in, 8-out 8 MSB
12 MON O 16 12-in, 16-out 12 bits in 12 LSBs of 16-bit

8 x 3 (RGB) RGB888 8-in, 8-out
8 x 3 (RGB) RGB8888 8-in, 8-out

10 x 3 (RGB) RGB888

12 x 3 (RGB) RGB888

MONO 8

MONO 16

RGB8888

RGB101010

RGB16161616

RGB8888

RGB101010

RGB16161616

8-in, 8-out

8-in, 16-out

10-in, 8-out

10-in, 8-out
10-in, 10-out
10-in, 16-out

12-in, 8-out

12-in, 8-out
12-in, 10-out
12-in, 16-out

8 bits in 8 LSBs of 16-bit

10 bits in 10 LSBs of 16-bit

12 bits in 12 LSBs of 16-bit

*When no LUTs are available or LUTs are disabled, the data is packed in the LSBs of the target
destination.

Xtium-CL MX4 User's Manual Xtium-CL MX4 Refer ence • 65

Metadata: Theory of Operation

The following provides additional details on the Me ta data implementation.

Metadata Data Structure

The Xtium-CL MX4 supports metadata at the end of each line when enabled through the parameter
CORACQ_PRM_META_DATA. The metadata consists of 64 bytes. The content of the metadata
represents a snapshot of the state of the frame grabber at the beginning of each LVAL received.

typedef struct
{
ULONGLONG shaftEncoderCount;
ULONGLONG lineCount;
ULONGLONG lineTriggerCount;
ULONGLONG timeStamp;
ULONG frameCounter;
UCHAR generalInputs;
UCHAR generalOutputs;
UCHAR biDirectionalIOs;
UCHAR reserved[25];

} MX4_METADATA, *PMX4_METADATA;

 shaftEncoderCount: 64-bit counter of pulses received on the shaft encoder. This is a ‘machine

counter’ that increments in one direction (forward) and decrements (reverse) in the opposite
direction.

 lineCount: 64-bit counter of line valid (LVAL) received.
 lineTriggerCount: 64-bit counter of line triggers sent to the camera.
 timeStamp: 64-bit counter of the frame grabber on-board timestamp. See also

CORACQ_PRM_TIME_STAMP_BASE and CORACQ_PRM_TIME_STAMP.

 frameCounter: 32-bit counter of frames received. This represents the frame number that the

line belongs to.

 generalInputs: status of the general inputs (for example, Low, bit = 0 or High, bit = 1).
 generalOutputs: status of the general outputs (for example, Low, bit =0 or High, bit = 1).
 biDirectionalIOs: status of the bi-directional I/Os (for example, Low, bit = 0 or High, bit = 1).
 reserved: 25 bytes reserved for future usage.

For a demo application showing this feature, please contact Teledyne DALSA technical support.

66 • Xtium-CL MX4 Reference Xtium-CL MX4 User's Manual

Flat Field Correction: Theory of Operation

The following provides additional details on the Flat Field Correction and Flat Line Correction
(FFC/FLC) implementation.

Flat Field Correctio n List s

The Xtium-CL MX4 supports defining more than one Flat Field Correction (FFC) / Flat Line
Correction (FLC) data sets. Using the Xfer parameter CORXFER_PRM_FLATFIELD_CYCLE_MODE,
the user can decide to cycle automatically through the list of FFC/FLC sets by setting the parameter
to CORXFER_VAL_FLATFIELD_CYCLE_MODE_AUTOMATIC, or select a specific FFC/FLC set from the
list by setting the parameter to CORXFER_VAL_FLATFIELD_CYCLE_MODE_OFF and selecting the
FFC/FLC index to use with the parameter CORACQ_PRM_FLAT_FIELD_SELECT.

While the cycling mode is set to off, users can upload new coefficients to an inactive FFC set even
when grabbing. When cycling automatically, the FFC/FLC sets are selected in a round-robin fashion,
changing at the beginning of every new frame.

The architecture of the Xtium-CL MX4 is such that the FFC/FLC data sets are independent of the
host buffers. In automatic mode, the FFC/FLC sets are chosen in a round-robin fashion as images
are acquired. So if using the Xfer cycling mode Synchrounous with Trash, it is recommended that
the number of host buffers be a multiple of the number of FFC/FLC in the list in order to maintain
the FFC/FLC relationship with the Host buffers.

 When the FFC/FLC cycle mode automatic is activ e, reset the acquisition module to start on the

st

FFC/FLC data set of the selected list as follows:

1

st

• Disconnect/Reconnect the tr ansfer (assuming 1

• Selecting a set using the CORACQ_PRM_FLAT_FIELD_SET_SELECT parameter will choose

 When the FFC/FLC cycle mode automatic is activ e, start the acquisition module to start on a

specific FFC/FLC of the selected list as follows:

• While acquisition is stopped, by selecting an Xfer pair [ACQ, Buffer]. The index of the

st

the 1

FFC/FLC will be selected based on the modulo of the number of FFC/FLC in the list with
respect to the [ACQ, Buffer] index pair.

FFC/FLC in the list of the selected set.

buffer is empty).

Xtium-CL MX4 User's Manual Xtium-CL MX4 Reference • 67

Flat Field Correction Sets

The concept of sets allows a user to define multiple lists of FFC/FLC correction data. The FFC/FLC
API allows users to allocate and pre-program those FFC/FLC sets. When acquiring images, the
board driver will cycle through the FFC/FLC list of the selected set. During that operation, users ca n
upload new FFC/FLC data to non-active sets without any ill effects.

When changing the active set while grabbing, the new active set will be switched when the current
cycling of the current list is completed.

Xtium-CL MX4 specific limitations

 Software driver permits the creation of up to 16 FFC/FLC sets.
 Software driver permits the use of up to 16 sets.
 When the FFC cycling mode is off, the concept of sets is not used. Whichever a FFC index is

chosen using CORACQ_PRM_FLAT_FIELD_SELECT, it will be used independently of the set it
belongs to.

 Upload of any FFC data is permitted at any time, even while grabbing. If an upload is done to

an FFC index of the currently select set while grabbing, then the resulting acquired image will
be undefined.

 When changing FFC cycling mode, the acquisition must be stopped.

Programming the sets

The following scheme is used to program FFC/FLC data within a set:

// select an active set
CorAcqSetPrm( hAcq, CORAQ_PRM_FLAT_FIELD_SET_SELECT, 0);

// Create 4 new FFC that will be part of the currently active set ‘0’
For( i = 0; i < 4; i++)
{
CorAcqNewFlatfield( hAcq, pFlatfieldNumber); // Will create FFC #1, #2, #3, #4
}

// select an active set
CorAcq SetPrm( hAcq, CORAQ_PRM_FLAT_FIELD_SET_SELECT, 1);

// Create 4 new FFC that will be part of the currently active set ‘1’
For( i = 0; i < 4; i++)
{
CorAcqNewFlatfield( hAcq, pFlatfieldNumber); // Will create FFC #5, #6, #7, #8
}

68 • Xtium-CL MX4 Reference Xtium-CL MX4 User's Manual

Xtium-CL MX4 Supported Parameters

The tables below describe the Sapera capab ilities supported by the Xtium-CL MX4. Unless specified,
each capability applies to all configuration modes and all acquisition modes.

The information here is subject to change. The application needs to verify capabilities . New board
driver releases may change product specifications.

Sapera describes the Xtium-CL MX4 family as:

• Board Server: Xtium-CL_MX4_1

• Acquisition Module: dependent on firmware used

Camera Related Capabilities

Capability Values

CORACQ_CAP_CONNECTOR_TYPE CORACQ_VAL_CONNECTOR_TYPE_CAMLINK (0x2)
CORACQ_CAP_CONNECTOR_CAMLINK

(Pin – 01, Pin – 02, Pin – 03, Pin - 04)

CORACQ_VAL_SIGNAL_NAME_NO_CONNECT (0x1)
CORACQ_VAL_SIGNAL_NAME_PULSE0 (0x8)
CORACQ_VAL_SIGNAL_NAME_PULSE1 (0x10)
CORACQ_VAL_SIGNAL_NAME_GND (0x4000)
CORACQ_VAL_SIGNAL_NAME_EXT_TRIGGER_1 (0x200)
CORACQ_VAL_SIGNAL_NAME_EXT_TRIGGER_2 (0x200000)
CORACQ_VAL_SIGNAL_NAME_SHAFT_ENCODER_PHASE_A (0x40000)
CORACQ_VAL_SIGNAL_NAME_SHAFT_ENCODER_PHASE B (0x80000)
CORACQ_VAL_SIGNAL_NAME_EXT_LINE_TRIGGER_1 (0x400)
CORACQ_VAL_SIGNAL_NAME_EXT_LINE_TRIGGER_2 (0x100000)

Xtium-CL MX4 User's Manual Xtium-CL MX4 Refer ence • 69

Camera Related Parameters

Parameter Values

CORACQ_PRM_CHANNEL

CORACQ_PRM_FRAME CORACQ_VAL_FRAME_PROGRESSI VE (0x2)
CORACQ_PRM_INTERFACE CORACQ_VAL_INTERFACE_DIGITAL (0x2)
CORACQ_PRM_SCAN

CORACQ_PRM_SIGNAL CORACQ_VAL_SIGNAL_DIFFERENTIAL (0x2)
CORACQ_PRM_VIDEO

Full Packed RGBY CORACQ_VAL_VIDEO_RGBY (0x40)
CORACQ_PRM_PIXEL_DEPTH Base/Full mono

Base/Medium Color RGB

CORACQ_PRM_VIDEO_STD CORACQ_VAL_VIDEO_STD_NON_STD (0x1)
CORACQ_PRM_FIELD_ORDER CORACQ_VAL_FIELD_ORDER_NEXT_FIEL D (0x4)

Base/Full Mono

10T8B Mono /

8T10B Mono

Base/Medium Color

Full Packed RGB

80B Packed RGB

Base/Full Bayer

10T8B Bayer
8T10B Bayer

80B Packed Bi-

10T8B Mono

8T10B Mono

Base/Full Bayer

Full Packed RGB

80B Packed Bi-Color

10T8B Bayer

80B Packed RGB

8T10B Bayer

Full Packed RGBY

CORACQ_VAL_CHANNEL_SINGLE (0x1)
CORACQ_VAL_CHANNEL_DUAL (0x2)

CORACQ_VAL_SCAN_AREA (0x1)
CORACQ_VAL_SCAN_LINE (0x2)

CORACQ_VAL_VIDEO_MONO (0x1)

CORACQ_VAL_VIDEO_RGB (0x8)

RGB

CORACQ_VAL_VIDEO_BAYER (0x10)

CORACQ_VAL_VIDEO_BICOLOR (0x20)

Color

8 bits, # LUT = 1, LUT format = CORDATA_FORMAT_MONO8
8 bits, # LUT = 1, LUT format = CORDATA_FORMAT_MONO16
10 bits, # LUT = 1, LUT format = CORDATA_FORMAT_MONO8
10 bits, # LUT = 1, LUT format = CORDATA_FORMAT_MONO16
12 bits, # LUT = 1, LUT format = CORDATA_FORMAT_MONO8
12 bits, # LUT = 1, LUT format = CORDATA_FORMAT_MONO16
14 bits, # LUT = 0, LUT format = CORDATA_FORMAT_MONO16
16 bits, # LUT = 0, LUT format = CORDATA_FORMAT_MONO16

8 bits, # LUT = 1, LUT format = CORDATA_FORMAT_MONO8
8 bits, # LUT = 1, LUT format = CORDATA_FORMAT_MONO16

10 bits, # LUT = 1, LUT format = CORDATA_FORMATMONO8
10 bits, # LUT = 1, LUT format = CORDATA_FORMATMONO16

8 bits, # LUT = 1, LUT format = CORDATA_FORMAT_COLORNI8
10 bits, # LUT = 1, LUT format = CORDATA_FORMAT_COLORNI8
10 bits, # LUT = 1, LUT format = CORDATA_FORMAT_COLORNI10
10 bits, # LUT = 1, LUT format = CORDATA_FORMAT_COLORNI16
12 bits, # LUT = 1, LUT format = CORDATA_FORMAT_COLORNI8
12 bits, # LUT = 1, LUT format = CO RD ATA_FORMAT _COLORNI10
12 bits, # LUT = 1, LUT format = CORDATA_FORMAT_COLORNI16

8 bits, # LUT = 1, LUT format = CORDATA_FORMAT_COLORNI8

8 bits, # LUT = 1, LUT format = CORDATA_FORMAT_COLORNI8
12 bits, # LUT = 1, LUT format = CORDATA_FORMAT_COLORNI8
12 bits, # LUT = 1, LUT format = CORDATA_FORMAT_COLORNI10
12 bits, # LUT = 1, LUT format = CORDATA_FORMAT_COLORNI16

8 bits, # LUT = 1, LUT format = CORDATA_FORMAT_COLORNI8
10 bits, # LUT = 1, LUT format = CORDATA_FORMAT_COLORNI8
10 bits, # LUT = 1, LUT format = CO RD ATA_FORMAT_COLORNI10
10 bits, # LUT = 1, LUT format = CORDATA_FORMAT_COLORNI16

8 bits, # LUT = 0, LUT format = CORDATA_FORMAT_COLORNI8

70 • Xtium-CL MX4 Reference Xtium-CL MX4 User's Manual

CORACQ_PRM_HACTIVE

CORACQ_PRM_HSYNC

CORACQ_PRM_VACTIVE

CORACQ_PRM_VSYNC

CORACQ_PRM_HFRONT_INVALID min = 0 pixel

CORACQ_PRM_HBACK_INVALID min = 0 pixel

CORACQ_PRM_VFRONT_INVALID min = 0 line

CORACQ_PRM_VBACK_INVALID

CORACQ_PRM_PIXEL_CLK_SRC CORACQ_VAL_PIXEL_CLK_SRC_EXT (0x2)
CORACQ_PRM_PIXEL_CLK_EXT min = 20000000 Hz

CORACQ_PRM_SYNC CORACQ_VAL_SYNC_SEP_SYNC (0x4)
CORACQ_PRM_HSYNC_POLARITY CORACQ_VAL_ACTIVE_LOW (0x1 )
CORACQ_PRM_VSYNC_POLARITY CORACQ_VAL_ACTIVE_LOW (0x1)
CORACQ_PRM_TIME_INTEGRATE_METHOD

CORACQ_PRM_CAM_TRIGGER_METHOD CORACQ_VAL_CAM_TRIGGER_METHOD_1 (0x1)
CORACQ_PRM_CAM_TRIGGER_POLARITY

CORACQ_PRM_CAM_TRIGGER_DURATION min = 1 µs

CORACQ_PRM_CAM_NAME Base/Full Mono

Base/Medium Color RGB

CORACQ_PRM_LINE_INTEGRATE_METHOD

CORACQ_PRM_LINE_TRIGGER_METHOD CORACQ_VAL_LINE_TRIGGER_METHOD_1 (0x1)
CORACQ_PRM_LINE_TRIGGER_POLARITY CORACQ_VAL_ACTIVE_LOW (0x1)

Base/Full Mono

Base/Full Bayer

10T8B Mono

10T8B Bayer

8T10B Mono

8T10B Bayer

Base/Medium Color

Full Packed RGB

Full Packed RGBY

80B Packed RGB

80B Packed Bi-

10T8B Mono
8T10B Mono

Base/Full Bayer

Full Packed RGB

80B Packed RGB

80B Packed Bi-Color

10T8B Bayer
8T10B Bayer

Full Packed RGBY

min = 4 pixel, max = 65536 pixel, step = 1 pixel

min = 4 pixel, max = 6553 pixel, step = 1 pixel

min = 4 pixel, max = 4096 pixel, step = 1 pixel

min = 4 pixel, max = 16384 pixel, step = 1 pixel

RGB

min = 4 pixel, max = 21845 pixel, step = 1 pixel
min = 4 pi x el, max = 32768 pixel, step = 1 pixel

Color

min = 1 pixel
max = 4294967295 pixel
step = 1 pixel

min = 1 line
max = 16777215 line
step = 1 line

min = 0 line
max = 4294967295 line
step = 1 line

max = 65535 pixel
step = 1 pixel

max = 65535 pixel
step = 1 pixel

max = 16777215 line
step = 1 line

min = 0 line
max = 16777215 line
step = 1 line

max = 85000000 Hz
step = 1 Hz

CORACQ_VAL_TIME_INTEGRATE_METHOD_1 (0x1)
CORACQ_VAL_TIME_INTEGRATE_METHOD_3 (0x4)
CORACQ_VAL_TIME_INTEGRATE_METHOD_5 (0x10)
CORACQ_VAL_TIME_INTEGRATE_METHOD_6 (0x20)
CORACQ_VAL_TIME_INTEGRATE_METHOD_8 (0x80)

CORACQ_VAL_ACTIVE_LOW (0x1)
CORACQ_VAL_ACTIVE_HIGH (0x2)

max = 85899345 µs
step = 1 µs

Default Area Scan 1 tap Mono
Default Area Scan 10 taps Parallel Mono
Default Area Scan 8 taps Parallel Mono
Default Area Scan 1 tap Color
Default Bayer Area Scan 1 tap Color
Default Area Scan Full Packed RGB
Default Area Scan 80-bit Pack ed RGB
Default Area Scan 80-bit Packed Bi-Color
Default Bayer Area Scan 10 taps Parallel Color
Default Bayer Area Scan 8 taps Parallel Color
Default Line Scan Full Packed RGBY

CORACQ_VAL_LINE_INTEGRATE_METHOD_1 (0x1)
CORACQ_VAL_LINE_INTEGRATE_METHOD_3 (0x4)
CORACQ_VAL_LINE_INTEGRATE_METHOD_4 (0x8)

CORACQ_VAL_ACTIVE_HIGH (0x2)

Xtium-CL MX4 User's Manual Xtium-CL MX4 Refer ence • 71

CORACQ_PRM_LINE_TRIGGER_DELAY

CORACQ_PRM_LINE_TRIGGER_DURATION

CORACQ_PRM_TAPS Base/Full Mono

Base/Medium Color RGB

CORACQ_PRM_TAP_OUTPUT

Base Medium Color RGB

CORACQ_PRM_TAP_1_DIRECTION

CORACQ_PRM_TAP_2_DIRECTION

CORACQ_PRM_TAP_3_DIRECTION 80-bit

CORACQ_PRM_TAP_4_DIRECTION 80-bit

Base/Full Bayer

10T8B Mono

10T8B Bayer

8T10B Mono

8T10B Bayer

Full Packed RGB

Full Packed RGBY

80B Packed RGB

80B Packed Bi-Color

Base/Full Mono

Base/Full Bayer

Full Packed RGB

Full Packed RGBY

10T8B Mono
8T10B Mono

80B Packed RGB

80B Packed Bi-Color

10T8B Bayer
8T10B Bayer

Medium Color RGB

80-bit
configurations

Other

80-bit
configurations

Other

configurations

Other

configurations

Other

min = 0 pixel
max = 85899345 pixel
step = 1 pixel

min = 0 pixel
max = 85899345 pixel
step = 1 pixel

min = 1 tap, max = 8 taps, step = 1 tap

min = 10 taps, max = 10 taps, step = 1 tap

min = 8 taps, max = 8 taps, step = 1 tap

min = 1 tap, max = 2 taps, step = 1 tap
min = 1 tap, max = 1 tap, step = 1 tap

CORACQ_VAL_TAP_OUTPUT_ALTERNATE (0x1)
CORACQ_VAL_TAP_OUTPUT_SEGMENTED (0x2)
CORACQ_VAL_TAP_OUTPUT_PARALLEL (0x4)

CORACQ_VAL_TAP_OUTPUT_PARALLEL (0x4)

CORACQ_VAL_TAP_OUTPUT_SEGMENTED (0x2)
CORACQ_VAL_TAP_OUTPUT_ALTERNATE (0x1)

CORACQ_VAL_TAP_OUTPUT_SEGMENTED (0x2)
CORACQ_VAL_TAP_DIRECTION_LR (0x1)

CORACQ_VAL_TAP_DIRECTION_UD (0x4)
CORACQ_VAL_TAP_DIRECTION_FROM_TOP (0x10)

CORACQ_VAL_TAP_DIRECTION_LR (0x1)
CORACQ_VAL_TAP_DIRECTION_RL (0x2)
CORACQ_VAL_TAP_DIRECTION_UD (0x4)
CORACQ_VAL_TAP_DIRECTION_DU (0x8)
CORACQ_VAL_TAP_DIRECTION_FROM_TOP (0x10)
CORACQ_VAL_TAP_DIRECTION_FROM_MID (0x20)
CORACQ_VAL_TAP_DIRECTION_FROM_BOT (0x40)

CORACQ_VAL_TAP_DIRECTION_LR (0x1)
CORACQ_VAL_TAP_DIRECTION_UD (0x4)
CORACQ_VAL_TAP_DIRECTION_FROM_TOP (0x10)

CORACQ_VAL_TAP_DIRECTION_LR (0x1)
CORACQ_VAL_TAP_DIRECTION_RL (0x2)
CORACQ_VAL_TAP_DIRECTION_UD (0x4)
CORACQ_VAL_TAP_DIRECTION_DU (0x8)
CORACQ_VAL_TAP_DIRECTION_FROM_TOP (0x10)
CORACQ_VAL_TAP_DIRECTION_FROM_MID (0x20)
CORACQ_VAL_TAP_DIRECTION_FROM_BOT (0x40)

CORACQ_VAL_TAP_DIRECTION_LR (0x1)
CORACQ_VAL_TAP_DIRECTION_UD (0x4)
CORACQ_VAL_TAP_DIRECTION_FROM_TOP (0x10)

CORACQ_VAL_TAP_DIRECTION_LR (0x1)
CORACQ_VAL_TAP_DIRECTION_RL (0x2)
CORACQ_VAL_TAP_DIRECTION_UD (0x4)
CORACQ_VAL_TAP_DIRECTION_DU (0x8)
CORACQ_VAL_TAP_DIRECTION_FROM_TOP (0x10)
CORACQ_VAL_TAP_DIRECTION_FROM_MID (0x20)
CORACQ_VAL_TAP_DIRECTION_FROM_BOT (0x40)

CORACQ_VAL_TAP_DIRECTION_LR (0x1)
CORACQ_VAL_TAP_DIRECTION_UD (0x4)
CORACQ_VAL_TAP_DIRECTION_FROM_TOP (0x10)

CORACQ_VAL_TAP_DIRECTION_LR (0x1)
CORACQ_VAL_TAP_DIRECTION_RL (0x2)
CORACQ_VAL_TAP_DIRECTION_UD (0x4)
CORACQ_VAL_TAP_DIRECTION_DU (0x8)
CORACQ_VAL_TAP_DIRECTION_FROM_TOP (0x10)
CORACQ_VAL_TAP_DIRECTION_FROM_MID (0x20)
CORACQ_VAL_TAP_DIRECTION_FROM_BOT (0x40)

72 • Xtium-CL MX4 Reference Xtium-CL MX4 User's Manual

CORACQ_PRM_TAP_5_DIRECTION

CORACQ_PRM_TAP_6_DIRECTION

CORACQ_PRM_TAP_7_DIRECTION 80-bit

CORACQ_PRM_TAP_8_DIRECTION

CORACQ_PRM_PIXEL_CLK_DETECTION CORACQ_VAL_RISING_EDGE (0x4)
CORACQ_PRM_CHANNELS_ORDER CORACQ_VAL_CHANNELS_ORDER_NORMAL (0x1)

CORACQ_PRM_CAM_LINE_TRIGGER_FREQ_MIN 1 Hz
CORACQ_PRM_CAM_LINE_TRIGGER_FREQ_MAX 10000000 Hz
CORACQ_PRM_CAM_TIME_INTEGRATE_DURATION_MIN 1 µs
CORACQ_PRM_CAM_TIME_INTEGRATE_DURATION_MAX 85899345 µs
CORACQ_PRM_TIME_INTEGRATE_PULSE1_POLARITY CORACQ_VAL_ACTIVE_LOW (0x1)

CORACQ_PRM_TIME_INTEGRATE_PULSE1_DELAY min = 0 µs

CORACQ_PRM_TIME_INTEGRATE_PULSE1_DURATION

CORACQ_PRM_CAM_IO_CONTROL (*) All 4 CCs can be driven with one of the following signals:

CORACQ_PRM_TIME_INTEGRATE_PULSE0_POLARITY

CORACQ_PRM_TIME_INTEGRATE_PULSE0_DELAY

80-bit
configurations

Other

80-bit
configurations

Other

configurations

Other

80-bit
configurations

Other

CORACQ_VAL_TAP_DIRECTION_LR (0x1)
CORACQ_VAL_TAP_DIRECTION_UD (0x4)
CORACQ_VAL_TAP_DIRECTION_FROM_TOP (0x10)

CORACQ_VAL_TAP_DIRECTION_LR (0x1)
CORACQ_VAL_TAP_DIRECTION_RL (0x2)
CORACQ_VAL_TAP_DIRECTION_UD (0x4)
CORACQ_VAL_TAP_DIRECTION_DU (0x8)
CORACQ_VAL_TAP_DIRECTION_FROM_TOP (0x10)
CORACQ_VAL_TAP_DIRECTION_FROM_MID (0x20)
CORACQ_VAL_TAP_DIRECTION_FROM_BOT (0x40)

CORACQ_VAL_TAP_DIRECTION_LR (0x1)
CORACQ_VAL_TAP_DIRECTION_UD (0x4)
CORACQ_VAL_TAP_DIRECTION_FROM_TOP (0x10)

CORACQ_VAL_TAP_DIRECTION_LR (0x1)
CORACQ_VAL_TAP_DIRECTION_RL (0x2)
CORACQ_VAL_TAP_DIRECTION_UD (0x4)
CORACQ_VAL_TAP_DIRECTION_DU (0x8)
CORACQ_VAL_TAP_DIRECTION_FROM_TOP (0x10)
CORACQ_VAL_TAP_DIRECTION_FROM_MID (0x20)
CORACQ_VAL_TAP_DIRECTION_FROM_BOT (0x40)

CORACQ_VAL_TAP_DIRECTION_LR (0x1)
CORACQ_VAL_TAP_DIRECTION_UD (0x4)
CORACQ_VAL_TAP_DIRECTION_FROM_TOP (0x10)

CORACQ_VAL_TAP_DIRECTION_LR (0x1)
CORACQ_VAL_TAP_DIRECTION_RL (0x2)
CORACQ_VAL_TAP_DIRECTION_UD (0x4)
CORACQ_VAL_TAP_DIRECTION_DU (0x8)
CORACQ_VAL_TAP_DIRECTION_FROM_TOP (0x10)
CORACQ_VAL_TAP_DIRECTION_FROM_MID (0x20)
CORACQ_VAL_TAP_DIRECTION_FROM_BOT (0x40)

CORACQ_VAL_TAP_DIRECTION_LR (0x1)
CORACQ_VAL_TAP_DIRECTION_UD (0x4)
CORACQ_VAL_TAP_DIRECTION_FROM_TOP (0x10)

CORACQ_VAL_TAP_DIRECTION_LR (0x1)
CORACQ_VAL_TAP_DIRECTION_RL (0x2)
CORACQ_VAL_TAP_DIRECTION_UD (0x4)
CORACQ_VAL_TAP_DIRECTION_DU (0x8)
CORACQ_VAL_TAP_DIRECTION_FROM_TOP (0x10)
CORACQ_VAL_TAP_DIRECTION_FROM_MID (0x20)
CORACQ_VAL_TAP_DIRECTION_FROM_BOT (0x40)

CORACQ_VAL_CHANNELS_ORDER_REVERSE (0x2)

CORACQ_VAL_ACTIVE_HIGH (0x2)

max = 85899345 µs
step = 1 µs

min = 1 µs
max = 85899345 µs
step = 1 µs

Logic High
Logic Low
External Trigger #1 (redirect from physical input signal)
External Trigger #2 (redirect from physical input signal)
Shaft Encoder Phase A (redirect from physical input signal)
Shaft Encoder Phase B (redirect from physical input signal)
External Line Trigger #1(redirect from physical input signal)
External Line Trigger #2(redirect from physical input signal)

CORACQ_VAL_ACTIVE_LOW (0x1)
CORACQ_VAL_ACTIVE_HIGH (0x2)

min = 0 µs
max = 85899345 µs
step = 1 µs

Xtium-CL MX4 User's Manual Xtium-CL MX4 Refer ence • 73

CORACQ_PRM_TIME_INTEGRATE_PULSE0_DURATION

CORACQ_PRM_LINE_INTEGRATE_PULSE1_POLARITY

CORACQ_PRM_LINE_INTEGRATE_PULSE1_DELAY min = 0 pixel

CORACQ_PRM_LINE_INTEGRATE_PULSE1_DURATION min = 1 pixel

CORACQ_PRM_LINE_INTEGRATE_PULSE0_POLARITY

CORACQ_PRM_LINE_INTEGRATE_PULSE0_DELAY

CORACQ_PRM_LINE_INTEGRATE_PULSE0_DURATION

CORACQ_PRM_CAMLINK_CONFIGURATION Base Mono

CORACQ_PRM_DATA_VALID_ENABLE Base/Full Mono

CORACQ_PRM_DATA_VALID_POLARITY CORACQ_VAL_ACTIVE_HIGH (0x2)
CORACQ_PRM_TAP_9_DIRECTION 10T8B Mono

CORACQ_PRM_TAP_10_DIRECTION

CORACQ_PRM_TIMESLOT CORACQ_VAL_TIMESL OT_1 (0x1)
CORACQ_PRM_COLOR_ALIGNMENT Base/Full Bayer

CORACQ_PRM_CAM_CONTROL_DURING_READOUT CORACQ_VAL_CAM_CONTROL_DURING_READOUT_INVALID (0x0)

Base Bayer

Full Mono

Full Bayer

10T8B Mono

10T8B Bayer

8T10B Mono

8T10B Bayer

Base Color RGB

Medium Color

Full Packed RGB

Full Packed RGBY

80B Packed RGB

80B Packed

Bi-Color

Base/Medium

Color RGB

Full Packed RGB

Full Packed RGBY

10T8B Mono
8T10B Mono

80B Packed RGB

80B Packed Bi-

10T8B Bayer
8T10B Bayer

10T8B Bayer

10T8B Mono

10T8B Bayer

10T8B Bayer
8T10B Bayer

80B Packed Bi-

min = 1 µs
max = 85899345 µs
step = 1 µs

CORACQ_VAL_ACTIVE_LOW (0x1)
CORACQ_VAL_ACTIVE_HIGH (0x2)

max = 85899345 pixel
step = 1 pixel

max = 85899345 pixel
step = 1 pixel

CORACQ_VAL_ACTIVE_LOW (0x1)
CORACQ_VAL_ACTIVE_HIGH (0x2)

min = 0 pixel
max = 85899345 pixel
step = 1 pixel

min = 1 pixel
max = 85899345 pixel
step = 1 pixel

CORACQ_VAL_CAMLINK_CONFIGURATION_BASE (0x1)

CORACQ_VAL_CAMLINK_CONFIGURATION_BASE (0x1)
CORACQ_VAL_CAMLINK_CONFIGURATION_MEDIUM (0x2)
CORACQ_VAL_CAMLINK_CONFIGURATION_FULL (0x4)

CORACQ_VAL_CAMLINK_CONFIGURATION_10TAPS_FORMAT2 (0x40)

CORACQ_VAL_CAMLINK_CONFIGURATION_8TAPS_10BITS (0x80)

CORACQ_VAL_CAMLINK_CONFIGURATION_BASE (0x1)
CORACQ_VAL_CAMLINK_CONFIGURATION_BASE (0x1)

RGB

CORACQ_VAL_CAMLINK_CONFIGURATION_MEDIUM (0x2)
CORACQ_VAL_CAMLINK_CONFIGURATION_FULL_PACKED (0x100)

CORACQ_VAL_CAMLINK_CONFIGURATION_FLAG_BGR (0x80000000)

CORACQ_VAL_CAMLINK_CONFIGURATION_80BITS_PACKED (0x200)
CORACQ_VAL_CAMLINK_CONFIGURATION_FLAG_BGR (0x80000000)

CORACQ_VAL_CAMLINK_CONFIGURATION_80BITS_PACKED (0x200)
TRUE

FALSE

Not available

Color

CORACQ_VAL_TAP_DIRECTION_LR (0x1)
CORACQ_VAL_TAP_DIRECTION_UD (0x4)
CORACQ_VAL_TAP_DIRECTION_FROM_TOP (0x10)

CORACQ_VAL_TAP_DIRECTION_LR (0x1)
CORACQ_VAL_TAP_DIRECTION_UD (0x4)
CORACQ_VAL_TAP_DIRECTION_FROM_TOP (0x10)

CORACQ_VAL_COLOR_ALIGNMENT_GB_RG (0x1)
CORACQ_VAL_COLOR_ALIGNMENT_BG_GR (0x2)
CORACQ_VAL_COLOR_ALIGNMENT_RG_GB (0x4)
CORACQ_VAL_COLOR_ALIGNMENT_GR_BG (0x8)

CORACQ_VAL_COLOR_ALIGNMENT_RGBG (0x10)
CORACQ_VAL_COLOR_ALIGNMENT_BGRG (0x20)

Color

CORACQ_VAL_CAM_CONTROL_DURING_READOUT_VALID (0x1)

74 • Xtium-CL MX4 Reference Xtium-CL MX4 User's Manual

VIC Related Parameters

Parameter Values

CORACQ_PRM_CAMSEL

Base/Medium Color RGB

CORACQ_PRM_CROP_LEFT Base/Full Mono

Base/Medium Color RGB

CORACQ_PRM_CROP_TOP

CORACQ_PRM_CROP_WIDTH Base/Full Mono

Base/Medium Color RGB

CORACQ_PRM_CROP_HEIGHT

CORACQ_PRM_DECIMATE_METHOD CORACQ_VAL_DECIMATE_DISABLE (0x1)
CORACQ_PRM_LUT_ENABLE Full Packed RGBY

CORACQ_PRM_LUT_NUMBER Default = 0
CORACQ_PRM_STROBE_ENABLE TRUE

CORACQ_PRM_STROBE_METHOD CORACQ_VAL_STROBE_METHOD_1 (0x1)

CORACQ_PRM_STROBE_POLARITY

CORACQ_PRM_STROBE_DURATION

CORACQ_PRM_STROBE_DELAY min = 0 µs

CORACQ_PRM_TIME_INTEGRATE_ENABLE TRUE

Base/Full Mono

10T8B Mono
8T10B Mono

Full Packed RGB

Full Packed RGBY

Base/Full Bayer

80B Packed Bi-Color

10T8B Bayer
8T10B Bayer

80B Packed RGB

10T8B Mono

Base/Full Bayer

10T8B Bayer

8T10B Mono

8T10B Bayer

Full Packed RGB

Full Packed RGBY

80B Packed RGB

80B Packed Bi-Color

10T8B Mono

Base/Full Bayer

10T8B Bayer

8T10B Mono

8T10B Bayer

Full Packed RGB

Full Packed RGBY

80B Packed RGB

80B Packed Bi-Color

All other modu les

CAMSEL_MONO = from 0 to 0

CAMSEL_RGB = from 0 to 0

min = 0 pixel, max = 65512 pixel, step = 2 pixel
min = 0 pixel, max = 65506 pixel, st e p = 4 pixel
min = 0 pixel, max = 65512 pixel, step = 1 pixel
min = 0 pixel, max = 65512 pixel, step = 1 pixel
min = 0 pixel, max = 32744 pixel, step = 2 pixel
min = 0 pi x el, max = 32744 pixel, step = 4 pixel
min = 0 pi x el, max = 16380 pixel, step = 1 pixel

min = 0 pixel, max = 16380 pixel, step = 1 pixel
min = 0 pixel, max = 32764 pixel, step = 1 pixel
min = 0 line

max = 16777215 line
step = 1 line

min = 24 pixel, max = 65536 pixel, step = =2 pixel
min = 24 pixel, max = 65530 pixel, step = =4 pixel
min = 24 pixel, max = 65536 pixel, step = 1 pixel
min = 24 pixe l, max = 65536 pixel, step = 1 pixel
min = 24 pixe l, max = 32768 pixel, step = 2 pixel
min = 24 pixe l, max = 32768 pixel, step = 1 pixel
min = 4 pixel, max = 16384 pixel, step = 1 pixel

min = 4 pixel, max = 16384 pixel, step = 1 pixel
min = 4 pi x el, max = 32768 pixel, step = 1 pixel
min = 1 line

max = 16777215 line
step = 1 line

Not Available
TRUE

FALSE

FALSE

CORACQ_VAL_STROBE_METHOD_3 (0x4)
CORACQ_VAL_STROBE_METHOD_4 (0x8)

CORACQ_VAL_ACTIVE_LOW (0x1)
CORACQ_VAL_ACTIVE_HIGH (0x2)

min = 1 µs
max = 85899345 µs
step = 1 µs

max = 85899345 µs
step = 1 µs

FALSE

Xtium-CL MX4 User's Manual Xtium-CL MX4 Refer ence • 75

CORACQ_PRM_TIME_INTEGRATE_DURATION

CORACQ_PRM_CAM_TRIGGER_ENABLE

CORACQ_PRM_OUTPUT_FORMAT Base/Full Mono

10T8B / 8T10B

Base/Medium Color RGB

Base/Full Bayer

Full Packed RGB

Full Packed RGBY

80B Packed RGB

80B Packed Bi-Color

10T8B Bayer

8T10B Bayer

CORACQ_PRM_EXT_TRIGGER_ENABLE

CORACQ_PRM_VIC_NAME Base/Full Mono

10T8B Mono
8T10B Mono

Base/Medium Color RGB

Base/Full Bayer

Full Packed RGB

80B Packed RGB

80B Packed Bi-Color

10T8B Bayer
8T10B Bayer

Full Packed RGBY

CORACQ_PRM_LUT_MAX Full Packed RGBY

All other modu les

CORACQ_PRM_EXT_TRIGGER_DETECTION CORACQ_VAL_ACTIVE_LOW (0x1)

CORACQ_PRM_LUT_FORMAT Base/Full mono/10T8B

8T10B

Base/Medium Color RGB

Base/Full Bayer

Full Packed RGB

80B Packed RGB

80B Packed Bi-Color

10T8B Bayer
8T10B Bayer

CORACQ_PRM_VSYNC_REF CORACQ_VAL_SYNC_REF_END (0x2)
CORACQ_PRM_HSYNC_REF CORACQ_VAL_SYNC_REF_END (0x2)
CORACQ_PRM_LINE_INTEGRATE_ENABLE

min = 1 µs
max = 85899345 µs
step = 1 µs

TRUE
FALSE

CORACQ_VAL_OUTPUT_FORMAT_MONO8
CORACQ_VAL_OUTPUT_FORMAT_MONO16
CORACQ_VAL_OUTPUT_FORMAT_MONO8P2
CORACQ_VAL_OUTPUT_FORMAT_MONO8P3
CORACQ_VAL_OUTPUT_FORMAT_MONO8P4

CORACQ_VAL_OUTPUT_FORMAT_RGB8888
CORACQ_VAL_OUTPUT_FORMAT_RGB888
CORACQ_VAL_OUTPUT_FORMAT_RGB101010
CORACQ_VAL_OUTPUT_FORMAT_RGB16161616

CORACQ_VAL_OUTPUT_FORMAT_RGB8888
CORACQ_VAL_OUTPUT_FORMAT_RGB888
CORACQ_VAL_OUTPUT_FORMAT_RGB101010
CORACQ_VAL_OUTPUT_FORMAT_RGB16161616
CORACQ_VAL_OUTPUT_FORMAT_MONO8
CORACQ_VAL_OUTPUT_FORMAT_MONO16

CORACQ_VAL_OUTPUT_FORMAT_RGB8888
CORACQ_VAL_OUTPUT_FORMAT_RGB888

CORACQ_VAL_OUTPUT_FORMAT_RGB888_MONO8
CORACQ_VAL_OUTPUT_FORMAT_RGB8888

CORACQ_VAL_OUTPUT_FORMAT_RGB888
CORACQ_VAL_OUTPUT_FORMAT_RGB101010
CORACQ_VAL_OUTPUT_FORMAT_RGB16161616

CORACQ_VAL_OUTPUT_FORMAT_RGB8888
CORACQ_VAL_OUTPUT_FORMAT_RGB888
CORACQ_VAL_OUTPUT_FORMAT_BICOLOR88

CORACQ_VAL_OUTPUT_FORMAT_RGB8888
CORACQ_VAL_OUTPUT_FORMAT_RGB888
CORACQ_VAL_OUTPUT_FORMAT_MONO8

CORACQ_VAL_OUTPUT_FORMAT_RGB8888
CORACQ_VAL_OUTPUT_FORMAT_RGB888
CORACQ_VAL_OUTPUT_FORMAT_RGB101010
CORACQ_VAL_OUTPUT_FORMAT_RGB16161616
CORACQ_VAL_OUTPUT_FORMAT_MONO16

CORACQ_VAL_EXT_TRIGGER_OFF (0x1)
CORACQ_VAL_EXT_TRIGGER_ON (0x8)

Default Area Scan 1 tap Mono
Default Area Scan 10 taps Parallel Mono
Default Area Scan 8 taps Parallel Mono
Default Area Scan 1 tap Color
Default Bayer Area Scan 1 tap Color
Default Area Scan Full Packed RGB
Default Area Scan 80-bit Packed RGB
Default Area Scan 80-bit Packed Bi-Color
Default Bayer Area Scan 10 taps Parallel Color
Default Bayer Area Scan 8 taps Parallel Color
Default Line Scan Full Packed RGBY

0
1

CORACQ_VAL_ACTIVE_HIGH (0x2)
CORACQ_VAL_RISING_EDGE (0x4)
CORACQ_VAL_FALLING_EDGE (0x8)

Default = CORDATA_FORMAT_MONO8
Default = CORDATA_FORMAT_MONO16
Default = CORDATA_FORMAT_COLORNI8
Default = CORDATA_FORMAT_COLORNI8
Default = CORDATA_FORMAT_COLORNI8

Default = CORDATA_FORMAT_COLORNI8
Default = CORDATA_FORMAT_COLORNI10

TRUE
FALSE

76 • Xtium-CL MX4 Reference Xtium-CL MX4 User's Manual

CORACQ_PRM_LINE_INTEGRATE_DURATION

CORACQ_PRM_LINE_TRIGGER_ENABLE

CORACQ_PRM_EXT_FRAME_TRIGGER_ENABLE TRUE

CORACQ_PRM_EXT_FRAME_TRIGGER_DETECTION CORACQ_VAL_ACTIVE_LOW (0x1)

CORACQ_PRM_EXT_LINE_TRIGGER_ENABLE TRUE

CORACQ_PRM_EXT_LINE_TRIGGER_DETECTION

CORACQ_PRM_SNAP_COUNT Not available
CORACQ_PRM_INT_LINE_TRIGGER_ENABLE TRUE

CORACQ_PRM_INT_LINE_TRIGGER_FREQ

CORACQ_PRM_BIT_ORDERING CORACQ_VAL_BIT_ORDERING_STD (0x1)
CORACQ_PRM_EXT_TRIGGER_LEVEL CORACQ_VAL_LEVEL_TTL (0x1)

CORACQ_PRM_STROBE_LEVEL CORACQ_VAL_LEVEL_TTL (0x1)
CORACQ_PRM_EXT_FRAME_TRIGGER_LEVEL

CORACQ_PRM_EXT_LINE_TRIGGER_LEVEL CORACQ_VAL_LEVEL_422 (0x2)
CORACQ_PRM_INT_LINE_TRIGGER_FREQ_MIN 8 Hz
CORACQ_PRM_INT_LINE_TRIGGER_FREQ_MAX 500000 Hz
CORACQ_PRM_MASTER_MODE Not available
CORACQ_PRM_SHAFT_ENCODER_DROP min = 0 tick

CORACQ_PRM_SHAFT_ENCODER_ENABLE TRUE

CORACQ_PRM_EXT_TRIGGER_FRAME_COUNT

CORACQ_PRM_INT_FRAME_TRIGGER_ENABLE

CORACQ_PRM_INT_FRAME_TRIGGER_FREQ

CORACQ_PRM_FRAME_LENGTH CORACQ_VAL_ FRAME_LENGTH_FIX (0x1)

CORACQ_PRM_FLIP Full Packed RGBY

All other modu les

CORACQ_PRM_EXT_TRIGGER_DURATION

CORACQ_PRM_TIME_INTEGRATE_DELAY min = 0 µs

CORACQ_PRM_CAM_RESET_DELAY min = 0 µs

min = 1 pixel
max = 85899345 pixel
step = 1 pixel

TRUE
FALSE

FALSE

CORACQ_VAL_ACTIVE_HIGH (0x2)
CORACQ_VAL_RISING_EDGE (0x4)
CORACQ_VAL_FALLING_EDGE (0x8)
CORACQ_VAL_DOUBLE_PULSE_RISING _EDG E (0x20)
CORACQ_VAL_DOUBLE_PULSE_FALLING_EDGE (0x4 0)

FALSE
CORACQ_VAL_RISING_EDGE (0x4)

CORACQ_VAL_FALLING_EDGE (0x8)

FALSE
Default = 5000 Hz

When reading back this parameter, the value returned will be what
the frame grabber is set to, which may not be exactly what was
programmed due to the frame grabber parameter’s resolution.

CORACQ_VAL_LEVEL_422 (0x2)
CORACQ_VAL_LEVEL_12VOLTS (0x040)
CORACQ_VAL_LEVEL_24VOLTS (0x8)

CORACQ_VAL_LEVEL_TTL (0x1)
CORACQ_VAL_LEVEL_422 (0x2)
CORACQ_VAL_LEVEL_12VOLTS (0x040)
CORACQ_VAL_LEVEL_24VOLTS (0x8)

max = 254 tick
step = 1 tick

FALSE
min = 1 frame

max = 262142 frames
step = 1 frame
Note: Infinite not supported

TRUE
FALSE

min = 1 milli-Hz
max = 1000000000 milli-Hz
step = 1 milli-Hz

CORACQ_VAL_FRAME_LENGTH_VARIABLE (0x2)
Not Available
CORACQ_VAL_FLIP_OFF (0x00)

CORACQ_VAL_FLIP_HORZ (0x01)
min = 0 µs

max = 255 µs
step = 1 µs

max = 85899345 µs
step = 1 µs

max = 0 µs
step = 1 µs

Xtium-CL MX4 User's Manual Xtium-CL MX4 Refer ence • 77

CORACQ_PRM_CAM_TRIGGER_DELAY

CORACQ_PRM_SHAFT_ENCODER_LEVEL CORACQ_VAL_LEVEL_422 (0x2)
CORACQ_PRM_LUT_NENTRIES 8-bit/pix el component

CORACQ_PRM_EXT_FRAME_TRIGGER_SOURCE (*) min = 0

CORACQ_PRM_EXT_LINE_TRIGGER_SOURCE (*)

CORACQ_PRM_EXT_TRIGGER_SOURCE (*)

CORACQ_PRM_SHAFT_ENCODER_MULTIPLY

CORACQ_PRM_EXT_TRIGGER_DELAY min = 0

CORACQ_PRM_EXT_TRIGGER_DELAY_TIME_BASE CORACQ_VAL_TIME_BASE_LINE_VALID (0x4)

CORACQ_PRM_COLOR_DECODER_ENABLE Base/Full Mono

CORACQ_PRM_COLOR_DECODER_METHOD

CORACQ_PRM_WB_GAIN Base/Full Color RGB

CORACQ_PRM_WB_GAIN_RED

CORACQ_PRM_WB_GAIN_GREEN

CORACQ_PRM_WB_GAIN_BLUE

10-bit/pixel component
12-bit/pixel component

14/16-bit/pixel co m ponent

10T8B/8T10B

Base/Medium Color

Full Packed RGB

Full Packed RGBY

80B Packed RGB

Base/Full Bayer

10T8B Bayer
8T10B Bayer

80B Packed

Bi-Color

Full Bayer
10T8B Bayer
8T10B Bayer

80B Packed

Bi-Color

Full Packed RGB

80B Packed RGB

80B Packed Bi-Color

Base/Full Bayer

10T8B Bayer
8T10B Bayer

Base/Full Color RGB

Full Packed RGB

80B Packed RGB

80B Packed Bi-Color

Base/Full Bayer

10T8B Bayer
8T10B Bayer

Base/Full Color RGB

Full Packed RGB

80B Packed RGB

80B Packed Bi-Color

Base/Full Bayer

10T8B Bayer
8T10B Bayer

Base/Full Color RGB

Full Packed RGB

80B Packed RGB

80B Packed Bi-Color

Base/Full Bayer

10T8B Bayer
8T10B Bayer

min = 0 µs
max = 85899345 µs
step = 1 µs

256 entries
1024 entries
4096 entries
0 entries

max = 5
step = 1

min = 0
max = 5
step = 1

min = 0
max = 5
step = 1

min = 1
max = 32
step = (2

max = 16777215
step = 1

CORACQ_VAL_TIME_BASE_LINE_TRIGGER (0x8)
CORACQ_VAL_TIME_BASE_SHAFT_ENCODER (0x40)
CORACQ_VAL_TIME_BASE_NS (0x80)

Not available

RGB

TRUE
FALSE

CORACQ_VAL_COLOR_DECODER_METHOD_1 (0x1)

CORACQ_VAL_COLOR_DECODER_METHOD_7 (0x40)
Min = 100000, max = 900000, step = 1

Min = 100000, max = 900000, step = 1

Min = 100000, max = 900000, step = 1

Min = 100000, max = 900000, step = 1

N

)

78 • Xtium-CL MX4 Reference Xtium-CL MX4 User's Manual

CORACQ_PRM_EXT_TRIGGER_IGNORE_DELAY

CORACQ_PRM_BOARD_SYNC_OUTPUT1_SOURCE (*)

CORACQ_PRM_BOARD_SYNC_OUTPUT2_SOURCE (*) min = 0

CORACQ_PRM_EXT_TRIGGER_SOURCE_STR [0] = Automatic

CORACQ_PRM_EXT_LINE_TRIGGER_SOURCE_STR [ 0 ] = Automatic

CORACQ_PRM_VERTICAL_TIMEOUT_DELAY Not available
CORACQ_PRM_POCL_ENABLE TRUE

CORACQ_PRM_SHAFT_ENCODER_DIRECTION

CORACQ_PRM_LINE_TRIGGER_AUTO_DELAY

CORACQ_PRM_TIME_STAMP_BASE CORACQ_VAL_TIME_BASE_US (0x1)

CORACQ_PRM_BOARD_SYNC_OUTPUT1_SOURCE_STR [0] = Disabled

CORACQ_PRM_BOARD_SYNC_OUTPUT2_SOURCE_STR [0] = Disabled

CORACQ_PRM_SHAFT_ENCODER_ORDER

CORACQ_PRM_CAM_FRAMES_PER_TRIGGER Not a vailable
CORACQ_PRM_LINE_INTEGRATE_TIME_BASE CORACQ_VAL_TIME_BASE_PIXEL_CLK (0X100)
CORACQ_PRM_EXT_TRIGGER_IGNORE_REGION_DURATION

CORACQ_PRM_STROBE_DESTINATION (*) Not available

min = 0 µs
max = 85899344 µs
step = 1 µs

min = 0
max = 10
step = 1

max = 10
step = 1

[1] = External Trigger #1
[2] = External Trigger #2
[3] = Board Sync #1
[4] = Board Sync #2
[5] = Software Trigger

[1] = Shaft Encoder Phase A
[2] = Shaft Encoder Phase B
[3] = Shaft Encoder Phase A & B
[4] = Board Sync #1
[5] = Board Sync #2

FALSE
CORACQ_VAL_SHAFT_ENCODER_DIRECTION_IGNORE (0x00)

CORACQ_VAL_SHAFT_ENCODER_DIRECTION_FORWARD (0x01)
CORACQ_VAL_SHAFT_ENCODER_DIRECTION_R EVERSE ( 0x02)

CORACQ_VAL_LINE_TRIGGER_AUTO_DELAY_DISABLE (0x0)
CORACQ_VAL_LINE_TRIGGER_AUTO_DELAY_F R EQ_ MAX (0x2)

CORACQ_VAL_TIME_BASE_LINE_VALID (0X4)
CORACQ_VAL_TIME_BASE_LINE_TRIGGER (0X8)
CORACQ_VAL_TIME_BASE_SHAFT_ENCODER (0X40)
CORACQ_VAL_TIME_BASE_100NS (0x200)

[1] = External Frame Trigger
[2] = Reserved
[3] = CC1
[4] = CC2
[5] = CC3
[6] = CC4
[7] = Ext Trigger Ignore Region
[8] = Shaft Encoder Before Mult/Drop
[9] = Shaft Encoder After Mult/Drop
[10] = Internal Line Trigger

[1] = External Frame Trigger
[2] = Reserved
[3] = CC1
[4] = CC2
[5] = CC3
[6] = CC4
[7] = Ext Trigger Ignore Region
[8] = Shaft Encoder Before Mult/Drop
[9] = Shaft Encoder After Mult/Drop
[10] = Internal Line Trigger

CORACQ_VAL_SHAFT_ENCODER_ORDER_AUTO (0X0)
CORACQ_VAL_SHAFT_ENCODER_ORDER_DROP_MULTIP L Y (0X1)
CORACQ_VAL_SHAFT_ENCODER_ORDER_MULTIPLY_DROP (0X2)

* For auto mode, the order is multiply/drop.

min = 0 µs
max = 6553 µs
step = 1 µs

(*) Parameter Values are Board Specific

Xtium-CL MX4 User's Manual Xtium-CL MX4 Refer ence • 79

ACQ Related Parameters

Parameter Values

CORACQ_PRM_LABEL

80B Packed Bi-Color

CORACQ_PRM_EVENT_TYPE
CORACQ_PRM_EVENT_TYPE_EX

CORACQ_PRM_SIGNAL_STATUS CORACQ_VAL_SIGNAL_HSYNC_PRESENT

CORACQ_PRM_FLAT_FIELD_ENA
BLE

80B Packed Bi-Color

CORACQ_CAP_FLAT_FIELD_OFFSET

Base Mono

Base Color RGB

Base Bayer

Full mono

Medium Color RGB

Full Packed RGB

Full Bayer

Full Packed RGBY

8T10B
10T8B

80B Packed RGB

10T8B Bayer
8T10B Bayer

Base Mono

Full Mono

8T10B
10T8B

Base Color RGB

Base Bayer

Medium Color RGB

Full Packed RGB

Full Packed RGBY

Full Bayer

80B Packed RGB

10T8B Bayer
8T10B Bayer

8-bit Mon o

10-bit Mono

12-bit Mono

14-bit Mono

16-bit Mono

Camera Link Base Mono
Camera Link Base Color RGB
Camera Link Base Bayer
Camera Link Full Mono
Camera Link Medium Color RGB
Camera Link Full Packed RGB
Camera Link Full Bayer
Camera Link Full Packed RGBY
Camera Link 8-Tap/10-Bit Mono
Camera Link 10-Tap/8-Bit Mono
Camera Link 80-Bit Packed RGB
Camera Link 80-Bit Packed/8-Bit Bi-Color
Camera Link 10-Tap/8-Bit Bayer
Camera Link 8-Tap/10-Bit Bayer

CORACQ_VAL_EVENT_TYPE_START_OF_FRAME
CORACQ_VAL_EVENT_TYPE_END_OF_FRAME
CORACQ_VAL_EVENT_TYPE_EXTERNAL_TRIGGER
CORACQ_VAL_EVENT_TYPE_VERTICAL_SYNC
CORACQ_VAL_EVENT_TYPE_NO_PIXEL_CLK
CORACQ_VAL_EVENT_TYPE_PIXEL_CLK
CORACQ_VAL_EVENT_TYPE_FRAME_LOST
CORACQ_VAL_EVENT_TYPE_DATA_OVERFLOW
CORACQ_VAL_EVENT_TYPE_EXTERNAL_TRIGGER_IGNORED
CORACQ_VAL_EVENT_TYPE_EXT_LINE_TRIGGER_TOO_SLOW
CORACQ_VAL_EVENT_TYPE_SHAFT_ENCODER_REVERSE_COUNT_OVERFLOW
CORACQ_VAL_EVENT_TYPE_LINE_TRIGGER_TOO_FAST

CORACQ_VAL_SIGNAL_VSYNC_PRESENT
CORACQ_VAL_SIGNAL_PIXEL_CLK_1_PRESENT
CORACQ_VAL_SIGNAL_PIXEL_CLK_2_PRESENT
CORACQ_VAL_SIGNAL_PIXEL_CLK_3_PRESENT
CORACQ_VAL_SIGNAL_PIXEL_CLK_ALL_PRESENT
CORACQ_VAL_SIGNAL_POWER_PRESENT
CORACQ_VAL_SIGNAL_POCL_ACTIVE
CORACQ_VAL_SIGNAL_POCL_ACTIVE_2

TRUE / FALSE

Not Available

min = 0
max = 255
step = 1

min = 0
max = 4095
step = 1

min = 0
max = 16383
step = 1

min = 0
max = 65535
step = 1

Not Available

80 • Xtium-CL MX4 Reference Xtium-CL MX4 User's Manual

CORACQ_CAP_FLAT_FIELD_GAIN

CORACQ_CAP_FLAT_FIELD_GAIN_DIVISOR

CORACQ_PRM_FLAT_FIELD_PIXEL_REPLACEMENT
_METHOD

CORACQ_PRM_FLAT_FIELD_SET_SELECT

CORACQ_PRM_TIME_STAMP Available
CORACQ_PRM_IMAGE_FILTER_ENABLE Not Available
CORACQ_PRM_SHAFT_ENCODER_REVERSE_COUNT Max = 65536 ticks
CORACQ_PRM_META_DATA CORACQ_VAL_META_DATA_PER_LINE_RIGHT (0x2)
CORACQ_CAP_SERIAL_PORT_INDEX Supported

8-bit Mon o

10-bit Mono

12-bit Mono

14-bit Mono

16-bit Mono

8-bit Mon o
10-bit Mono
12-bit Mono
14-bit Mono
16-bit Mono

min = 0
max = 255
step = 1

min = 0
max = 4095
step = 1

min = 0
max = 16383
step = 1

min = 0
max = 65535
step = 1

Not Available
128
512
2048
8192
Not Available
CORACQ_VAL_FLAT_FIELD_PIXEL_REPLACEMENT_METHOD_2

(Pixel replacement is done by averaging the 2 neighborhood pixels. When one
of the neighbors is not available (border image pixels, the pixel is simply
replaced with the available neighbor)

CORACQ_VAL_FLAT_FIELD_PIXEL_REPLACEMENT_METHOD_3
(Pixel replacement is done by averaging neighborhood pixels using a 3x2
kernel)

min = 0
max = 16
step = 1

Transfer Related Capabilities

Capability Values

CORXFER_CAP_NB_INT_BUFFERS CORXFER_V A L_NB_INT_BUFFERS_AUTO (0x2)
CORXFER_CAP_MAX_XFER_SIZE 4294967040 Bytes
CORXFER_CAP_MAX_FRAME_COUNT 16777215 Frames
CORXFER_CAP_COUNTER_STAMP_AVAILABLE FALSE

Xtium-CL MX4 User's Manual Xtium-CL MX4 Refer ence • 81

Transfer Related Parameters

Parameter Values

CORXFER_PRM_EVENT_TYPE
CORXFER_PRM_EVENT_TYPE_EX

CORXFER_PRM_START_MODE

CORXFER_PRM_CYCLE_MODE

CORXFER_PRM_FLIP CORXFER_VAL_FLIP_OFF (0x0)

CORXFER_PRM_INT_BUFFERS * Depends on acquired image size.

CORXFER_PRM_EVENT_COUNT_SOURCE

CORXFER_PRM_BUFFER_TIMESTAMP_MODULE

CORXFER_PRM_BUFFER_TIMESTAMP_EVENT (ACQ
Related)

CORXFER_PRM_BUFFER_TIMESTAMP_EVENT (XFER
Related)

CORXFER_PRM_LINE_MERGING

CORXFER_VAL_EVENT_TYPE_START_OF_FRAME
CORXFER_VAL_EVENT_TYPE_END_OF_FRAME
CORXFER_VAL_EVENT_TYPE_END_OF_TRANSFER
CORXFER_VAL_EVENT_TYPE_END_OF_LINE
CORXFER_VAL_EVENT_TYPE_END_OF_NLINES

CORXFER_VAL_START_MODE_ASYNCHRONOUS (0x0)
CORXFER_VAL_START_MODE_SYNCHRONOUS (0x1)
CORXFER_VAL_START_MODE_HALF_ASYNCHRONOUS (0x2)
CORXFER_VAL_START_MODE_SEQUENTIAL (0x3)

CORXFER_VAL_CYCLE_MODE_ASYNCHRONOUS (0x0)
CORXFER_VAL_CYCLE_MODE_SYNCHRONOUS_WITH_TRASH (0x2)
CORXFER_VAL_CYCLE_MODE_OFF (0x3)
CORXFER_VAL_CYCLE_MODE_SYNCHRONOUS_NEXT_EMP TY_WITH_TRASH (0x5)

CORXFER_VAL _ F LIP _V ERT (0x2)

By default driver will optimize the number of on-board buffers.
CORXFER_VAL_EVENT_COUNT_SOURCE_DST (0x1)

CORXFER_VAL_EVENT_COUNT_SOURCE_SRC (0x2)
CORXFER_VAL_BUFFER_TIMESTAMP_MODULE_ACQ ( 0x1)

CORXFER_VAL_BUFFER_TIMESTAMP_MODULE_XFER (0x13)
CORACQ_VAL_EVENT_TYPE_START_OF_FRAME (0x80000)

CORACQ_VAL_EVENT_TYPE_EXTERNAL_TRIGGER (0x1000000)
CORXFER_VAL_EVENT_TYPE_END_OF_FRAME (0x800000)

CORXFER_VAL_LINE_MERGING_AUTO (0x0)
CORXFER_VAL_LINE_MERGING_OFF (0x2)

General Outputs #1: Related Capabilities (GIO Module #0)

These are the User Interface Outputs available on connector J1 and J4.

Capability Values

CORGIO_CAP_IO_COUNT Rev A1: 4 I/Os, Rev A2: 8 I/Os
CORGIO_CAP_DIR_OUTPUT 0xf
CORGIO_CAP_DIR_TRISTATE 0xf
CORGIO_CAP_EVENT_TYPE Not Available
CORGIO_CAP_READ_ONLY 0x03 (* depends on strobe outputs reserved for acquisition device)

General Outputs #1: Relate d Par amet e rs (GIO Module #0)

Parameter Values

CORGIO_PRM_LABEL General Outputs #1
CORGIO_PRM_DEVICE_ID 0
CORGIO_PRM_OUTPUT_TYPE CORGIO_VAL_OUTPUT_TYPE_LVTTL (0x20)
CORGIO_PRM_CONNECTOR CORGIO_VAL_ CONN ECTOR _ 1 (0x1)

82 • Xtium-CL MX4 Reference Xtium-CL MX4 User's Manual

General Inputs #1: Related Capabilities ( GIO Module #1)

These are the User Interface Inputs available on connector J1 and J4.

Capability Values

CORGIO_CAP_IO_COUNT 4 I/Os
CORGIO_CAP_DIR_OUTPUT 0x0
CORGIO_CAP_DIR_TRISTATE 0x0
CORGIO_CAP_EVENT_TYPE

CORGIO_CAP_READ_ONLY 0x03 (* depends on external trigger inputs reserved for acquisition device)

CORGIO_VAL_EVENT_TYPE_RISING_EDGE (0x1)
CORGIO_VAL_EVENT_TYPE_FALLING_EDGE (0x2)

General Inputs #1: Related Parameters (GIO Module #1)

Parameter Values

CORGIO_PRM_LABEL General Inputs #1
CORGIO_PRM_DEVICE_ID 1
CORGIO_PRM_INPUT_LEVEL CORGIO_VAL_INPUT_LEVEL_TTL (0x1)

CORGIO_PRM_CONNECTOR CORGIO_VAL_ CONN ECTOR _ 1 (0x1)

CORGIO_VAL_INPUT_LEVEL_422 (0x2)
CORGIO_VAL_INPUT_LEVEL_24VOLTS (0x8)
CORGIO_VAL_INPUT_LEVEL_12VOLTS (0x40)

Bidirectional General I/Os: Related Capabilities (GIO Module #2)

These are the Op en Interface I/Os available on connector J5.

Capability Values

CORGIO_CAP_IO_COUNT 8 I/Os
CORGIO_CAP_DIR_OUTPUT 0xff
CORGIO_CAP_DIR_TRISTATE 0xff
CORGIO_CAP_EVENT_TYPE Not Available
CORGIO_CAP_READ_ONLY 0x03 (* depends on board syncs reserved for acquisition device)

Bidirectional General I/Os: Related Parameters (GIO Module #2)

Parameter Values

CORGIO_PRM_LABEL Bidirectional General I/Os #1
CORGIO_PRM_DEVICE_ID 2
CORGIO_PRM_OUTPUT_TYPE CORGIO_VAL_OUTPUT_TYPE_LVTTL (0x20)
CORGIO_PRM_INPUT_LEVEL CORGIO_VAL_INPUT_LEVEL_LVTTL (0x20)
CORGIO_PRM_CONNECTOR CORGIO_VAL_CONNECTOR_2 (0x2)

Xtium-CL MX4 User's Manual Xtium-CL MX4 Refer ence • 83

Sapera Servers & Resources

Servers and Resources

The following table describes services and resources available for the Xtium-CL MX4 board.

Servers Resources

Name Type Name Index Description

Xtium-CL_MX4_1

(Full firmware)

Xtium-CL_MX4_1

(Dual firmware)

Xtium-CL_MX4_1

(80-bit firmware)

All GIO General Outputs #1

Acquisition

Acquisition Camera Link Base Mono #1

Acquisition Camera Link 10-Tap/8-Bit

Camera Link Full Mono

Camera Link Medium

Color RGB

Camera Link Full Packed

RGB

Camera Link Full Bayer

Camera Link Full Packed

RGBY

Camera Link Base Mono #2

Camera Link Base Color

RGB #1

Camera Link Base Color

RGB #2
Camera Link Base Bayer #1
Camera Link Base Bayer #2

Mono

Camera Link 8-Tap/10-Bit

Mono

Camera Link 80-Bit

Packed RGB

Camera Link 80-Bit

Packed/8-Bit Bi-Color

Camera Link 10-Tap/8-Bit

Bayer

Camera Link 8-Tap/10-Bit

Bayer

General Inputs #1

Bidirectional General I/Os

#1

0

1

2

3

4

0

1

2

3

4

5
0

1

2

3

4

5

0
1
2

Base, Medium and Full configuration,
Monochrome Camera

Base and Medium configuration,
RGB Camera

Full packed 8-bit R GB Camera

Base, Medium and Full configuration,
Bayer Camera

Full packed 8-bit RGBY Camera

Base Monochrome Camera #1

Base Monochrome Camera #2

Base RGB Camera #1

Base RGB Camera #2

Base Bayer Camera #1

Base Bayer Camera #2
80-bit configuration, Monochrome

10 Taps @ 8 bits Camera
80-bit configuration, Monochrome

8 Taps @ 10 bits Camera
80-bit configuration, RGB

80-bit packed 8/12-bit Camera
80-bit configuration, Bi-Color

80-bit packed 8-bit Camera
80-bit configuration, Bayer

10 Taps @ 8 bits Camera
80-bit configuration, Bayer

8 Taps @ 10 bits Camera

8 General Outputs (4 on Rev A1)
4 General Inputs
8 Bidirectional General I/Os

Xtium-CL MX4 User's Manual Sapera Servers & Resources • 84

Windows Embedded 7 Installation

Windows Embedded 7 is not officially supported by Teledy ne DALSA due to the number of possible
configurations. However, Sapera LT and other Teledyne DALSA products should function properly
on the Windows Embedded 7 platform provided that the require d co m ponents are installed.

Teledyne DALSA provides answer files (.xml) for use during Windows Embedded 7 installation that
install all necessary components for running Sapera LT 32-bit or 64-bit versions (SDK or Runtime),
Sapera Processing 32-bit or 64-bit versions (SDK or Runtime), and Teledyne DALSA frame
grabbers.

For each platform (32 or 64-bit), the answer file provided is:
 SaperaFrameGrabbers.xml:

Configuration for Sapera LT, Sapera Processing and Teledyne DALSA framegrabbers

The file is located in the following directory dependent on the platform used:

<Install Directory>\Sapera\Install\Win7_Embedded\Win32
<Install Directory>\Sapera\Install\Win7_Embedded\Win64

The OS footprint for t hese configurations is less than 1 GB. Alternatively, the Windows Thin Client
configuration template provided by Microsoft in the Windows Embedded 7 installation also provides
the necessary dependencies for Sapera LT, and Teledyne DALSA framegrabbers (with an OS
footprint of approximately 1.5 GB).

If you are installing other applications on the Windows Embedded 7 platform, it is recommended
that you verify which components are required, and if necessary, create a corresponding “Answer
File”.

For more information on performing dependency analysis to enable your application on Windows
Embedded 7, refer to the Microsoft Windows Embedded 7 documentation.

Xtium-CL MX4 User's Manual Sapera Servers & Resources • 85

Technical Specifications

CL

Xtium-CL MX4 Board Specifications

Digital Video Input & Controls

Input Type Camera Link Specifications Rev 2.0 compliant;

2 Base or 1 Full or 1 Medium or 1 80-bit
(using SDR-26 Camera Link connectors — MiniCL)

Supports PoCL cameras in:
Camera Link Base, Medium, Full/80-Bit Configurations

Common Pixel Form a ts Camera Link tap configuration:

8, 10, 12, 14 and 16-bit mon o
8, 10, 12-bit RGB
8, 10, 12-bit Bayer
8-bit Bi-Color

Tap Format Details

Scanning Area scan and Line scan: Progressive, Segmented, Multi-Tap, Tap reversal,

Scanning Dire c tions

Resolution

note: these are Xtium-

MX4 maximums, not

Camera Link

specifications

Pixel Clock Ran g e 20 MHz to 85 MHz

Synchronization

Minimums

Image Buffer Available with 512 MB

Bandwidth to Hos t

System

Serial Port Supports communication speeds from 96 00 to 921600 bps

1 Tap – 8/10/12/14/16-bit m ono
2 Taps – 8/10/12-bit mono
3 Taps – 8/10/12-bit mono
4 Taps – 8/10/12-bit mono
8 Taps – 8-bit mono
8 Taps – 10-bit mono
10 Taps – 8-bit mono

1 Tap – 8/10/12-bit RGB
2 Taps – 8-bit RGB
Full packed 8-bit RGB/BGR
Full packed 8-bit RGBY
80-bit packed 8/12-bit RGB/BGR
80-bit packed 8-bit Bi-Color

Alternate Tap Configuration, Dual Channel
Left to Right, Right to Left, Up-Down,

From Top
Horizontal Minimum:

8 Pixels per tap (8-bits/pixel)
Horizontal Max im um:

8-bits/pixel x 64k Pixels/line
16-bits/pixel x 32k Pixels/line
32-bits/pixel x 16k Pixels/line
64-bits/pixel x 8k Pixels/line

Vertical Minimum :
1 line

Vertical Maximu m :
up to 65536 lines—for area scan sensors
infinite line count—for line scan sensors

Horizontal Sync minimum: 1 pixel
Vertical Sync m inimum: 1 line

Approximately 1.7GB/s (maximum obtain ed is dependent on firmware
loaded and PC characteristics)

Xtium-CL MX4 User's Manual Technical Specificatio ns • 86

Controls Compliant with Teledyne DALSA Trigger-to-Image Reliability framework

Comprehensive e vent notifications
Timing control logic for camera triggers and strobe signals
External trigger la ten c y less than 100 nsec
Supports multi-b oa r d / m ulti-camera synchronization
Quadrature (phase A & B) shaft encoder inputs for extern a l w eb

synchronization: RS-422 input maximum frequ ency is 5 MHz
4 differential opto-coupled general inputs (RS-422/TTL/12V/24V).

Can be used as opto-coupled external trigger inputs program ma ble as
active high or low ( e dg e or level trigger).
(only 1 input can be connected to a differential inpu t sign al on Rev A1)

8 LVTTL general outputs. Can be used a s Strobe outputs. (4 on Rev A1)
I/O available on a DH60-27P connector (J1)

and on 26-pin SHF-113-01-L-D-RA (J4)

Processing

Dependant on user

loaded firmware

configuration

Output Lookup Table
Bayer Mosaic Filter
Bi-Color Conversion ( for TDALSA P4)
Flat Field/Flat L ine Correction

Xtium-CL MX4 User's Manual Technical Specificatio ns • 87

Host System Requirements

Xtium-CL MX4 Dimensions

Approximately 4 in. (10 cm) wide by 4 in. (10 cm) high

General System Requirements for the Xtium-CL MX4

• PCI Express Gen2 x4 slot compatible;
(will work in Gen1 x4 slot with reduced bandwidth to host)

• On some computers the Xtium-CL MX4 may function installed in a x16 slot. The computer
documentation or direct testing by the user is required.

• Xtium-CL MX4 operates correctly when installed in a multi-processor system (including
Hyper-Threading multi-core processors).

Operating System Support

Windows 7, Windows 8 and Windows 10, each in either 32-bit or 64-bit

Environment

Ambient Temperature: 10° to 50°C (operation)

-40° to 75°C (storage)

Relative Humidi ty:

MTBF @40°C 36.4 yea r s

Note: Ensure adequate airflow for proper functioning of the board across the entire tem per ature
range of 10 – 50°C . Airflow mea s uring 80 LFM (linear feet per minute) a c r os s the surface of the
board is recommended.

5% to 90% non-condensing (opera ting)
0% to 95% (storage)

Power Requirements during Acquisitions

PC Voltage Rev A1 Rev A2

+3.3V 0.9A N/A (Regulator used to generate the 3.3V from 12V)

+12V 0.54A 0.80

88 • Technical Specifications Xtium-CL MX4 User's Manual

EMI Certifications

Figure 23: EMI Certifications

Xtium-CL MX4 User's Manual Technical Specificatio ns • 89

Connector and Switch Locations

Xtium-CL MX4 Board Layout Drawing

Figure 24: Board Layout

Connector / LED Description List

The following table lists components on the Xtium-CL MX4 board. Detailed information concerning
the connectors/LEDs follows this summary table.

Location Description Location Description

J1

J2 Camera Link 2 Connector J7

J3 Camera Link 1 Connector D1

P2

J4

External Sign a ls connector
DH60-27P

PCIe x4 computer bus connector
(Gen2 compliant slot prefe r red)

Internal I/O S ig nals connector
(26-pin SHF-113-01-L-D-RA)

J5

Multi Board Sync

PC power to camera interface
and/or J1

Boot-up/PCIe Status LED
(refer to text)

D3, D4

C amera status LEDs

J6, P1 Reserved

90 • Technical Specifications Xtium-CL MX4 User's Manual

Camera Link 2

LED/connector

Xtium-CL MX4

Camera Link 1

LED/connector

I/O – DH60-27P

female connector

Board

Status

LED

Connector and Switch Specifications

Xtium-CL MX4 End Bracket Detail

Figure 25: End Bracket Details

The hardware installation process is completed with the connection of a supported camera to the
Xtium-CL MX4 board using Camera Link cables (see Camera Link Cable).

• The Xtium-CL MX4 board supports a camera with one or two Camera Link connectors (one
Base, one Medium or one Full – see Data Port Summary for information on Camera Link
configurations).

• Connect the camera to the J3 connector with a Camera Link cable. When using a Medium or
Full camera, connec t t h e second camera connect or to J2.

Note: If the camera is powered by th e Xtium-CL MX4, refer to J7: Power Connector for power
connections.

Contact Teledyne DALS A or browse our web site www.teledynedalsa.com/mv
Xtium-CL MX4 supported cameras.

Xtium-CL MX4 User's Manual Technical Specificatio ns • 91

for information on

Status LED Functional Description

D1 Boot-up/PCIe status LED

Color State Description

Red Solid FPGA firmware not loaded

Green Solid Normal FPGA firmware loaded, Gen2 speed, link width x4
Green Flashing Normal FP G A firmware loaded, Gen1 speed, link width x4

Solid Normal FPGA firmware loaded, Gen2 speed, link widt h not x4
Flashing Normal FP G A firmware loaded, Gen1 speed, lin k width not x4

Blue Solid Safe FPGA firmware loaded, Gen2 speed
Blue Flashing Safe F PGA firmware loaded, Gen1 speed

Red Flashing PCIe Training Issue – Board will not be detected by computer

Camera Link LEDs
(D4 = Camera Link connector #1, D3 = Camera Link connector #2)

Color State Description

Red Solid No Camera Link pixel clock detected

Green Solid

Green

Green

Slow Flashing
~1 Hz

Fast Flashing
~8 Hz

Camera Link pixel clock detected. No line valid detect ed.
Note: for D3, when configuring for Full Camera Link, both pixel clock on

nd

the 2
Camera Link pixel clock and line valid signa l detected

Note: for D3, whe n configuring for F ull Camera Link, both line valid on
the 2

Acquisition in progress

cable must be detected.

nd

cable must be detected.

 Notes 1: When using a Full configuration, if the input on CL1 is configured as Camera Link

Base, the D3 (for CL2) will remain RED at all times.

 Note 2: LED D3 and D4 are independent.
 Note 3: Full FPGA def a ults to Camera Link Medium configuration.
 Note 4: For a Pixel Clock and Line Val id to be detected, the following rules apply:

• CL1: Requires 1 clock and 1 LVAL

• CL2: Camera Link Base configuration: N /A

• CL2: Camera Link Medium configuration requires 1 clock and 1 LVAL

• CL2: Camera Link Full/80-bit configurations requires 2 clocks and 2 LVAL

92 • Technical Specifications Xtium-CL MX4 User's Manual

J3: Camera Link Connector 1

Name Pin # Type Description

BASE_X0- 25 Input Neg. Base Data 0

BASE_X0+ 12 Input Pos. Base Data 0

BASE_X1- 24 Input Neg. Base Data 1

BASE_X1+ 11 Input Pos. Base Data 1

BASE_X2- 23 Input Neg. Base Data 2

BASE_X2+ 10 Input Pos. Base Data 2

BASE_X3- 21 Input Neg. Base Data 3

BASE_X3+ 8 Input Pos. Base Data 3

BASE_XCLK- 22 Input Neg. Base Clock

BASE_XCLK+ 9 Input Pos. Base Clock

SERTC+ 20 Output Pos. Serial Data to Camera

SERTC- 7 Output Neg. Serial Data to Camera

SERTFG- 19 Input Neg. Serial Data to Frame Grabber

SERTFG+ 6 Input Pos. Serial Data to Frame Grabber

CC1- 18 Output Neg. Camera Control 1
CC1+ 5 Output Pos. Camera Control 1
CC2+ 17 Output Pos. Camera Control 2

CC2- 4 Output Neg. Camera Control 2

CC3- 16 Output Neg. Camera Control 3
CC3+ 3 Output Pos. Camera Control 3
CC4+ 15 Output Pos. Camera Control 4

CC4- 2 Output Neg. Camera Control 4

PoCL 1,26 +12 V (see note following table)

GND 13, 14 Ground

Notes on PoCL support:
 Refer to Sapera’s parameter CORACQ_PRM_POCL_ENABLE to enable PoCL and

CORACQ_PRM_SIGNAL_STATUS/CORACQ_VAL_SIGNAL_POCL_ACTIVE to verify if the POCL is
active. See also Sapera++ reference parameter SapAcquisition::SignalPoCLActive for the
current state.

 PoCL state is maintained as long as the board is not reset

Xtium-CL MX4 User's Manual Technical Specificatio ns • 93

J2: Camera Link Connector 2

Medium and Full Camera Link sources require cables connected to both J2 and J3.

Name Pin # Type Description

MEDIUM _X0- 25 Input Neg. Medium Data 0

MEDIUM _X0+ 12 Input Pos. Medium Data 0

MEDIUM _X1- 24 Input Neg. Medium Data 1

MEDIUM _X1+ 11 Input Pos. Medium Data 1

MEDIUM _X2- 23 Input Neg. Medium Data 2

MEDIUM _X2+ 10 Input Pos. Medium Data 2

MEDIUM _X3- 21 Input Neg. Medium Data 3

MEDIUM _X3+ 8 Input Pos. Medium Data 3

MEDIUM _XCLK- 22 Input Neg. Medium Clock

MEDIUM _XCLK+ 9 Input Pos. Medium Clock

TERM 20 Term Resistor
TERM 7 Term Resistor

FULL_X0- 19 Input Neg. Full Data 0

FULL _X0+ 6 Input Pos. Full Data 0

FULL _X1- 18 Input Neg. Full Data 1

FULL _X1+ 5 Input Pos. Full Data 1

FULL _X2- 17 Input Neg. Full Data 2

FULL _X2+ 4 Input Pos. Full Data 2

FULL _X3- 15 Input Neg. Full Data 3

FULL _X3+ 2 Input Pos. Full Data 3

FULL _XCLK- 16 Input Neg. Full Clock

FULL _XCLK+ 3 Input Pos. Full Clock

PoCL 1,26 +12 V (see note following table)

GND 13, 14 Ground

Notes on PoCL support:
 Refer to Sapera’s parameter CORACQ_PRM_POCL_ENABLE to enable PoCL and

CORACQ_PRM_SIGNAL_STATUS/CORACQ_VAL_SIGNAL_POCL_ACTIVE_2 to verify if the POCL
is active. See also Sapera++ reference parameter SapAcquisition::SignalPoCLActive for the
current state.

 PoCL state is maintained as long as the board is not reset

94 • Technical Specifications Xtium-CL MX4 User's Manual

Camera Link Camera Contro l Signal Overview

Four LVDS pairs are for general-purpose camera control, defined as camera inputs / frame grabber
outputs by the Camera Link Base camera specification. These controls are on J3 con n e cto r.

• Camera Control 1 (CC1)

• Camera Control 2 (CC2)

• Camera Control 3 (CC3)

• Camera Control 4 (CC4)

Each camera manufact ure is free to define the signals input on any one or all 4 control signals.
These control signals are used either as camera control pulses or as a static logic state. Control
signals not required by the camera are simply assigned as not used. Refer to your camera's user
manual for informat ion on what control signals are required.

Note 1: The Xtium-CL MX4 pulse controller has a m inimum resolution of 20ns.
Note 2: The internal line trigger frequency has a 2µs resolution.

The Xtium-CL MX4 can assign any camera control signal to the appropriate Camera Link control.
The following screen shot shows the Sapera CamExpert dialog where Camera Link controls are
assigned (signals shown are not specific to any camera).

Figure 26: CamExpert - Camera Link Controls

Xtium-CL MX4 User's Manual Technical Specificatio ns • 95

J1: External Signals Connector (Female DH60-27P)

Warning: J1 and J4 have the same pinout a ssignment. Signals are routed to both connectors
directly from th e ir internal circuitr y. Therefore never connect both J1 and J4 to external
devices at the same time.

See DH40-27S Cable to Blunt End (OR-YXCC-27BE2M1, Rev B1) and Cable assemblies for I/O
connector J4 for available cables.

J4: Internal I/O Signals Connector (26-pin SHF-113-01-L-D­RA)

Important: The table below describes the I/O signals available on both J1 and J4.
(applies to Xtium-CL MX4 rev. A2)

Use only one of th e two I/O connectors — never both!

Xtium-CL MX4 rev. A2

Description Pin # Pin # Description

Ground 1 15 General Input 3 (+)

RS-422 Shaft Encoder Phase A (-) 2 16 General Input 4 (+)

RS-422 Shaft Encoder Phase A (+)

(see note 3

RS-422 Shaft Encoder Phase B (-) 5 19 Power Output 5 Volts, 100mA max

RS-422 Shaft Encoder Phase B (+) 6 20

External Trigger Input 1/General Input 1 (-) 7 21 General Output 3

External Trigger Input 1/General Input 1 (+)

External Trigger Input 2/General Input 2 (+) 9 23 General Output 5

Strobe 1 / General Output 1

(See note 2

Strobe 2 / General Output 2

(See note 2

Power Output 12 Volts, 350mA max

(from Aux Power Connector, see J7)

)

Ground 4 18 General Input 3 (-)

Ground 10 24 General Output 6

)

)

Ground 13 27 NC

3 17 General Input 4 (-)

External Trigger Input 2 or
General Input 2 (-)

8 22 General Output 4

11 25 General Output 7

12 26 General Output 8

14

Important: The table below describes the I/O signals available on both J1 and J4.
(applies to Xtium-CL MX4 rev. A1)

Use only one of the two I/O connectors — never both!

96 • Technical Specifications Xtium-CL MX4 User's Manual

Xtium-CL MX4 rev. A1

Description Pin # Pin # Description

RS-422 Shaft Encoder Phase A (-) 2 16 General Input 4

RS-422 Shaft Encoder Phase A (+)

RS-422 Shaft Encoder Phase B (-) 5 19 Reserved

RS-422 Shaft Encoder Phase B (+) 6 20 Reserved

General Inpu t Com m on

External Trigger Input 1 (-)

General Input 1 (-)

External Trigger Input 1 (+)

General Input 1 (+)

(Opto-coupled — see note 1

External Trigger Input 2

General Input 2

General Output 1

General Output 2

Power Output 12 Volts, 350mA m a x

(from Aux Power Connector, see J7

Ground 1 15 General Input 3

3 17 Reserved

(see note 3

Strobe 1

(See note 2

Strobe 2

)

Ground 4 18 Reserved

7 21 General Output 3

8 22 General Output 4

)

9 23 Reserved

Ground 10 24 Reserved

11 25 Reserved

)

12 26 Reserved

Ground 13 27 Reserved

14

below)

Xtium-CL MX4 User's Manual Technical Specifications • 97

V

From User
Interface
Connector

EMI

Filter

Note 1: General Inputs / External Trigger Inputs Specifications

Each of the four General Inputs are opto-coupled and able to connect to differential or single ended
source signals. General Input 1 and 2 can also act as External Trigger Inputs. See “Board
Information” user settings. These inputs generate individual interrupts and are read by the Sapera
application.

• Note: On Re v A1, only General Input 1 can b e connected to a differential source signal.

The following figure is t ypical for each Gener a Input. General Input 1 can be connected to a
diffe r e n t ia l input sig n al. Note that in this specific case, the other 3 General Inputs ca nnot be used.

Figure 27: General Inputs Electrical Diagram

Input Details:

• Maximum input voltage is 26V.

• Maximum input signal frequenc y is 100 KHz.

• Each input has a 649-ohm series resi st or on th e opt o-coupler input.

• The 0.01uF capacitor provides high frequency noise filtering.

• Minimum current is dependent on input voltage applied: I

• The switch point is sof tware programmable to support differential (LVDS/RS422) or single

ended TTL, 12V or 24V input signals.

(min) = (V

optoin

- 0.5)/649Ω

optoin

For External Trigger usage:

• Input signal is “debo unced ” to ensure that no voltage glitch is detected as a valid transition.
This debounce circuit time constant can be programmed from 1
than the programmed value is blocked and therefore not seen by the board. If no debounce
value is specified (value of 0µs), the minimum value of 1µs will be used.

• Refer to Sapera parameters:
CORACQ_PRM_EXT_TRIGGER_SOURCE
CORACQ_PRM_EXT_TRIGGER_ENABLE
CORACQ_PRM_EXT_TRIGGER_LEVEL
CORACQ_PRM_EXT_FRAME_TRIGGER_LEVEL
CORACQ_PRM_EXT_TRIGGER_DETECTION
CORACQ_PRM_EXT_TRIGGER_DURATION

• See also *.cvi file entries:
External Trigger Level, External Frame Trigger Level, External Trigger Enable, External Trigger
Detection.

• External Trigger Input 2 used for two pulse external trigger with variable frame length line scan
acquisition.

µs to 255µs. Any pulse smaller

98 • Technical Specifications Xtium-CL MX4 User's Manual