StreamPix 8 User

Guide

COPYRIGHTS AND DISCLAIMERS
Published Date: Janvier, 2019
This publication contains information proprietary and confidential to NorPix Inc. Any reproduction, disclosure
or unauthorized use of this publication is expressly prohibited except as NorPix Inc. may otherwise authorize
in writing.
NorPix Inc. reserves the right to make changes without notice in product or component design as warranted byevolution in user needs or progress in engineering or manufacturing technology. Changes which affect theoperation of the unit will be documented in the next revision of the manual.
We have made every effort to ensure the accuracy of the information presented in our documentation.
However, NorPix assumes no responsibility for the accuracy of the information published. Productdocumentation is subject to change without notice. Changes, if any, will be incorporated in new editions ofthese documents. NorPix may make improvements or changes in the products or programs described within the
documents at any time without notice. Mention of products or services not manufactured or sold by NorPix is
for informational purposes only and constitutes neither an endorsement nor a recommendation for suchproducts or services.
StreamPix is either a registered trademark or trademark of NorPix Inc. in Canada, the United States ofAmerica, and in other countries.
Windows and Excel are registered trademarks of Microsoft Corporation in the United States and othercountries.
Any other trademarks are the property of their respective companies.

Copyright © 2019 NorPix Inc.
1751 Richardson St., Suite 6117
Montreal (QC) H3K 1G6 Canada
Tel: (514) 846-0009
Fax: (514) 846-0117
Web: www.norpix.com

Introduction ................................................................................................................................................................................... 7
1.1 About this Manual ......................................................................................................................................................... 8
Conventions Used in This Manual ....................................................................................................................................... 9StreamPix 8 Documentation ............................................................................................................................................. 10
Feedback on the Documentation ...................................................................................................................................... 10
1.2 About StreamPix 8 ....................................................................................................................................................... 11
Main features .................................................................................................................................................................... 11
StreamPix 8 Versions ......................................................................................................................................................... 11
Authorization codes .......................................................................................................................................................... 12
Installing StreamPix 8 ........................................................................................................................................................ 12
Minimum System Requirements ....................................................................................................................................... 12
Supported File Formats ..................................................................................................................................................... 13
Audio and DAQ File Types.................................................................................................................................................. 15
1.3 StreamPix 8 Interface .................................................................................................................................................. 16
Application Menu .............................................................................................................................................................. 20
StreamPix 8 Help tab ......................................................................................................................................................... 22
Selected buttons ............................................................................................................................................................... 23
1.4 StreamPix 8 Basic Concepts ......................................................................................................................................... 24
Workspaces ....................................................................................................................................................................... 24
Record, Snap, and Playback Controls ................................................................................................................................ 26
Additional Playback Options ............................................................................................................................................. 28
Sequences ......................................................................................................................................................................... 28
Docking Panel .................................................................................................................................................................... 29
1.5 What’s New in StreamPix 8.......................................................................................................................................... 32
Bug Fixes and Minor Changes in v8.0 ................................................................................................................................ 33
Modules ............................................................................................................................................................................ 33
Getting Started ............................................................................................................................................................................ 38
2.1 Set up Workspace(s) .................................................................................................................................................... 39
2.2 Load Camera(s) ............................................................................................................................................................ 41
2.3 Select Destination File(s) .............................................................................................................................................. 44
2.4 Start/Stop Recording.................................................................................................................................................... 46
2.5 Play Back a Sequence ................................................................................................................................................... 49
HOWTOs ...................................................................................................................................................................................... 51
3.1 HOWTO Manage Multiple Workspaces/Cameras ........................................................................................................ 52
3.2 HOWTO Set Recording Options .................................................................................................................................... 55
To Record in a Loop ........................................................................................................................................................... 55
To Playback a Sequence .................................................................................................................................................... 55
3.3 HOWTO Export a Sequence ......................................................................................................................................... 56
3.4 HOWTO Use Auto Naming Schemes ............................................................................................................................ 57
3.5 HOWTO Configure Output File Formats ....................................................................................................................... 58
3.6 HOWTO Trigger a Software Event from an external input line (I/O Manager) ............................................................. 59
I/O Manager docked dialog ............................................................................................................................................... 59
Camera (Hardware) Trigger ............................................................................................................................................... 61
Audio Trigger ..................................................................................................................................................................... 62
Output Actions .................................................................................................................................................................. 62
3.7 HOWTO Store / Retrieve GPS data as metadata .......................................................................................................... 63
3.8 HOWTO Modify the GUI ............................................................................................................................................... 64
Modifying the Quick Access Toolbar .................................................................................................................................. 64
Saving your Configuration ................................................................................................................................................. 66
3.9 HOW TO Restore Defaults ............................................................................................................................................ 67
Managing Workspaces and Cameras ........................................................................................................................................... 68
4.1 Overview ...................................................................................................................................................................... 69
Workspace Manager ......................................................................................................................................................... 69
4.2 Master Workspace and Select All Workspaces ............................................................................................................ 71
Stand Alone Workspace Control ........................................................................................................................................ 71
4.3 Controlling Workspaces ............................................................................................................................................... 73
Workspace Control ............................................................................................................................................................ 73
Customized Workspace ..................................................................................................................................................... 73
Auto-Naming Tokens ......................................................................................................................................................... 79
Recording Manager ........................................................................................................................................................... 80
4.4 Managing Grabbers and Cameras ................................................................................................................................ 81
Camera/Frame Grabber .................................................................................................................................................... 81
Settings and Adjustments .................................................................................................................................................. 81
Buffers ............................................................................................................................................................................... 82
Miscellaneous ................................................................................................................................................................... 82
Using Audio and DAQ .................................................................................................................................................................. 83
5.1 Audio and DAQ Overview ............................................................................................................................................ 84
File Types ........................................................................................................................................................................... 85

5.2Managing Audio ........................................................................................................................................................... 86
Audio tab ........................................................................................................................................................................... 86
5.3 Managing DAQ ............................................................................................................................................................. 88
Time calibrating video and DAQ data ................................................................................................................................ 88
The DAQ (Data Acquisition) tab ......................................................................................................................................... 89
DAQ Graphs area............................................................................................................................................................... 90
Managing the Display .................................................................................................................................................................. 94
6.1 Display Tools ................................................................................................................................................................ 95
Modifying the GUI ............................................................................................................................................................. 95
Display Tab ........................................................................................................................................................................ 95
Refresh Rates .................................................................................................................................................................... 99
Other Display Controls ...................................................................................................................................................... 99
6.2 Controlling Multiple Cameras .................................................................................................................................... 100
Controlling Light and Color ........................................................................................................................................................ 102
7.1 Bayer Conversion and Color Correction Primer ......................................................................................................... 103
7.2 Applying Processing ................................................................................................................................................... 105
Processing Levels ............................................................................................................................................................ 106
Bayer Pattern .................................................................................................................................................................. 107
Recalculate Lookup Table ................................................................................................................................................ 108
Export LUT ....................................................................................................................................................................... 109
7.3 Non-linear Remapping via ASC CDL Formula .............................................................................................................. 110
Changing the default range values for the ASC CDL remapping parameter .................................................................... 111
Managing Sequences and Markers............................................................................................................................................ 112
8.1 Sequences - Global Settings ....................................................................................................................................... 113
8.2 Sequences - Individual Tools ...................................................................................................................................... 114
The Sequence Tab ........................................................................................................................................................... 115
Manual Playback ............................................................................................................................................................. 116
Manipulation................................................................................................................................................................... 117
Other Tools ...................................................................................................................................................................... 118
Navigating Markers ......................................................................................................................................................... 119
Navigating the Sequence from marked event (docked dialog) ....................................................................................... 120
Home > Selection group .................................................................................................................................................. 120
Managing Settings ..................................................................................................................................................................... 121
9.1 Auto Naming Settings ................................................................................................................................................ 122
9.2 AVI settings ................................................................................................................................................................ 125
9.3 MPEG4/TS settings .................................................................................................................................................... 127
Video ............................................................................................................................................................................... 127
Audio ............................................................................................................................................................................... 127
9.4 Color Processing settings ........................................................................................................................................... 128
Bit Depth Management................................................................................................................................................... 128
Color Processing .............................................................................................................................................................. 128
Color Matrix correction ................................................................................................................................................... 131
Miscellaneous LUT Processing......................................................................................................................................... 132
9.5 DAQ settings .............................................................................................................................................................. 134
General ........................................................................................................................................................................... 134
DAQ Graph ...................................................................................................................................................................... 134
9.6 Displayed Data settings .............................................................................................................................................. 136
9.7 Interface settings ....................................................................................................................................................... 137
General ........................................................................................................................................................................... 137
Zoom ............................................................................................................................................................................... 138
QuickZoom ...................................................................................................................................................................... 138
Docked Dialog ................................................................................................................................................................. 140
Customizing the Application menu .................................................................................................................................. 140
Customizing the Ribbon interface ................................................................................................................................... 140
9.8 Metadata settings ...................................................................................................................................................... 143
9.9 MOV settings ............................................................................................................................................................. 143
9.10
Images settings ..................................................................................................................................................... 145
Images ............................................................................................................................................................................. 145
9.11
Playback settings .................................................................................................................................................. 147
General ........................................................................................................................................................................... 147
Synchronization .............................................................................................................................................................. 147
9.12
Playback Rate settings .......................................................................................................................................... 149
Sequence playback rates ................................................................................................................................................. 149
AVI playback rates ........................................................................................................................................................... 150
9.13
Pre/Post Trigger settings ...................................................................................................................................... 150
9.14
Recording settings ................................................................................................................................................ 152
General ........................................................................................................................................................................... 152
When a recording ends... ................................................................................................................................................ 153

Buffer usage monitoring.................................................................................................................................................. 154
Limits ............................................................................................................................................................................... 154
9.15
Recording Manager settings ................................................................................................................................. 155
While Recording... ........................................................................................................................................................... 155
9.16
Recording Manager Editor .................................................................................................................................... 155
Commands ...................................................................................................................................................................... 156
After the Last Command ................................................................................................................................................. 157
Stop Condition(s) ............................................................................................................................................................. 157
Recording Manager - Script Examples ............................................................................................................................. 158
9.17
Remote Control settings ....................................................................................................................................... 159
9.18
GPU Management ................................................................................................................................................ 161
9.19
Sequence Settings ................................................................................................................................................ 163
General ........................................................................................................................................................................... 163
Markers ........................................................................................................................................................................... 164
RAM Sequence ................................................................................................................................................................ 165
Compression for new and exported Sequences .............................................................................................................. 165
Bayers and Color Processing method.............................................................................................................................. 170
9.20
Session settings .................................................................................................................................................... 171
When Windows starts... .................................................................................................................................................. 171
When StreamPix starts... ................................................................................................................................................. 171
Factory Defaults .............................................................................................................................................................. 172
9.21
Synchronization settings....................................................................................................................................... 172
9.22
Timeshifting settings ............................................................................................................................................ 174
9.23
Workspace(s) settings. ......................................................................................................................................... 175
Default Working Folder ................................................................................................................................................... 175
Default read-ahead buffers ............................................................................................................................................. 175
9.24
More... settings .................................................................................................................................................... 176
General ........................................................................................................................................................................... 176
Notifications .................................................................................................................................................................... 176
Quick Export .................................................................................................................................................................... 177
I/O Settings ..................................................................................................................................................................... 177
Tools .......................................................................................................................................................................................... 182
10.1
Tools Menu ........................................................................................................................................................... 183
Load/Save Configurations ............................................................................................................................................... 183
Metadata Manager ......................................................................................................................................................... 183
Disk Benchmarking .......................................................................................................................................................... 184
Windows Task Manager .................................................................................................................................................. 185
Debug Log ....................................................................................................................................................................... 185
Performance ................................................................................................................................................................... 185
10.3
SendRM Support .................................................................................................................................................. 188
Grabber Adjustments ...................................................................................................................................................... 190
Grabber Settings ............................................................................................................................................................. 190
Export Full Sequence....................................................................................................................................................... 190
10.4Time Stamp Corrector Utility ................................................................................................................................ 192
10.5
Time Source Admin utility .................................................................................................................................... 193
10.6
Editing StreamPix Scripts ...................................................................................................................................... 194
Plugin Modules .......................................................................................................................................................................... 196
Loading & Unloading Plugin Modules .................................................................................................................................. 197
Free Modules ....................................................................................................................................................................... 198
AEC Control ..................................................................................................................................................................... 198
Auto Gain Exposure Iris ................................................................................................................................................... 199
Basler Camera Link .......................................................................................................................................................... 200
Background Correction ................................................................................................................................................... 201
BIRGER Control ................................................................................................................................................................ 202
Bitmap Overlay................................................................................................................................................................ 203
BlackMagic Playout ......................................................................................................................................................... 204
Command Line ................................................................................................................................................................ 205
Crosshair ......................................................................................................................................................................... 205
Command Line ................................................................................................................................................................ 207
Comment overlay ............................................................................................................................................................ 208
Compression Estimator ................................................................................................................................................... 209
Custom Metadata Overlay .............................................................................................................................................. 210
Exposure Time Reader..................................................................................................................................................... 210
File Automatic Deletion ................................................................................................................................................... 211
FLIR Mapping .................................................................................................................................................................. 212
Focus Assist ..................................................................................................................................................................... 213
GRT Header Data ............................................................................................................................................................. 213
HDR Exposure Control ..................................................................................................................................................... 214

HDR Processing ............................................................................................................................................................... 214
Histogram........................................................................................................................................................................ 214
H.264 Decompressor ....................................................................................................................................................... 216
IDT Mx Camera Control Tool............................................................................................................................................ 216
Image Channel Viewer .................................................................................................................................................... 217
Image Alpha Blending ...................................................................................................................................................... 218
Image Resize And Crop .................................................................................................................................................... 219
Image Rolling Averaging .................................................................................................................................................. 220
Image Splitter .................................................................................................................................................................. 220
Image Rotation ................................................................................................................................................................ 221
JVC Image Splitter ........................................................................................................................................................... 221
Image Statistics ............................................................................................................................................................... 222
Kinect .............................................................................................................................................................................. 222
Lens Control .................................................................................................................................................................... 224
Lens Control IOI............................................................................................................................................................... 224
Live Levels ....................................................................................................................................................................... 224
LTC Overlay ...................................................................................................................................................................... 224
Lynx IPX Camera Control ................................................................................................................................................. 225
Matrix Switch .................................................................................................................................................................. 225
Metadata Overlay ........................................................................................................................................................... 226
Metadata Spy .................................................................................................................................................................. 226
Measurements ................................................................................................................................................................ 227
MJPEG Decompressor ..................................................................................................................................................... 227
Mikrotron Control Tool.................................................................................................................................................... 227
Monochrome Conversion ............................................................................................................................................... 228
Object Overlay ................................................................................................................................................................ 228
Optronis Camera Control Tool ......................................................................................................................................... 229
Phantom S990 Banks Merge ........................................................................................................................................... 229
Photon Focus Camera Control Tool ................................................................................................................................. 230
Picture in Picture ............................................................................................................................................................. 230
Pixel Value Exporter ........................................................................................................................................................ 231
Pixel Viewer .................................................................................................................................................................... 232
Point-To-Point Caliper ..................................................................................................................................................... 233
Presets ............................................................................................................................................................................ 235
PTG Overlay .................................................................................................................................................................... 235
Quick Overlay .................................................................................................................................................................. 236
Raptor Photonics Control Tool......................................................................................................................................... 237
Sequence Disk Space ....................................................................................................................................................... 238
Sequence Levels .............................................................................................................................................................. 239
T.S. Sync Monitor ............................................................................................................................................................. 240
Time Stamp Monitor ....................................................................................................................................................... 240
UDP Trigger...................................................................................................................................................................... 241
Video Out ........................................................................................................................................................................ 244
Xenics Cheetah ................................................................................................................................................................ 247
Premium Modules ................................................................................................................................................................ 248
Arduino Pulse Generator................................................................................................................................................. 248
Audio Trigger ................................................................................................................................................................... 249
DAQ Capture ................................................................................................................................................................... 250
Frame Grabber (FG) Pulse Generator ............................................................................................................................. 253
GPS / DMI Positioning ..................................................................................................................................................... 253
GPS Time Card ................................................................................................................................................................. 259
GRT Playout..................................................................................................................................................................... 260
Image Merge ................................................................................................................................................................... 261
LiDAR Logger ................................................................................................................................................................... 262
Line Scan Viewer ............................................................................................................................................................. 264
Line Scan Video Out Module ........................................................................................................................................... 266
MCC Pulse Generator ...................................................................................................................................................... 267
Motion Detection ............................................................................................................................................................ 268
NI Pulse Generator .......................................................................................................................................................... 271
NI-DAQmx Pulse Generator ............................................................................................................................................ 272
NI Pulse Divider ............................................................................................................................................................... 272
ONVIF Pan/Tilt Control.................................................................................................................................................... 273
Second View .................................................................................................................................................................... 273
SimulPix ........................................................................................................................................................................... 273
Video Scopes ................................................................................................................................................................... 279
RTSP Streamer ................................................................................................................................................................ 281
Web Streamer ................................................................................................................................................................. 281
Keyboard Shortcuts ................................................................................................................................................................... 287

Index .......................................................................................................................................................................................... 290

1
Introduction

This chapter provides an overview of StreamPix 8, system requirements, andhow to use this documentation. This chapter contains the following sections:•1.1. About this Manual•

1.2. About StreamPix 8•

1.3. StreamPix 8 Interface•

1.4. StreamPix 8 Basic Concepts•

1.5. What’s New in StreamPix 8

StreamPix 8 User Guide

1.1

About this ManualThis manual includes the following sections:
Chapter

Description

Chapter 1: Introduction

Provides a list of StreamPix 8 features and requirements,
documentation conventions, and an overview of the interface.

Chapter 2: Getting Started

Explains how to get going using StreamPix 8.

Chapter 3: HOWTOs

Detailed procedures for the most common tasks.

Chapter 4: Managing Workspaces and Cameras

Describes how to set up and manage multiple workspaces andcameras and how to work with sound and/or DAQ files.

Chapter 5: Using Audio and DAQ

Describes how to manage Audio and DAQ files.

Chapter 6: Managing the Display

Describes how to use display windows and thumbnails.

Chapter 7: Controlling Light and Color

Adjusting Bayer and color balance at different levels.

Chapter 8: Managing Sequences and Markers

Working with image sequences.

Chapter 9: Managing Settings

Establishing StreamPix 8 preferences.

Chapter 10: Tools

For scheduling recording, saving and loading configurations, working
with scripts, and monitoring your system.

Appendix A: Plugin Modules

Descriptions of all add-on modules.

Appendix B: Keyboard Shortcuts

A list of keyboard shortcuts.

Index

An index of topics and terms.
Table 1-1: StreamPix 8 User Guide organization

How to Use This Manual
If you are new to StreamPix 8, it is recommended that you read this entire manual. If you
are already familiar with StreamPix 8, and just want information on a particular subject,consult the Table of Contents, the PDF Bookmarks, or the Index.
This manual is distributed as an Adobe Acrobat® PDF and contains numerous hyperlinks
that look like this.

TIP: You can use the Adobe Acrobat® previous/next view buttons (Alt+Left arrow

and Alt+Right arrow) to navigate backwards and forward through viewed
topics.

8

NorPix Inc.

Introduction

You can also use the PDF text search option by selecting Edit > Find in the Adobe
Acrobat® menu bar and entering the search term.

NOTE: This manual has offset left and right pages to allow for printing and binding, if

you choose.

Conventions Used in This ManualThis manual uses the following conventions.
• First mention of individual program elements are in bold, like this: Select theHome tab.
• Where appropriate, the toolbutton icon appears in the left margin, like this:Select the Step Forward button.
• Menu and sub-menu choices are separated by an angle bracket, like this:Workspace > Recording Manager.
• Choices are separated by a vertical line, like this:Workspace > Recording Manager > Use the default... | Use a custom... .

Frequently, there may be more than one way to accomplish an individual task, such as byusing a keyboard shortcut or a similar toolbutton on another tab. To avoid possible
confusion, this manual explains the most straightforward approach. See Appendix B:
Keyboard Shortcuts.

TIP:

A tip contains useful information to make using StreamPix 8 easier.

NOTE:

A note contains information pertinent to the current task.
A caution contains an instruction that you must follow in order toprevent loss of data, damage to equipment, or network failure.

CautionThe content of a caution should be read and followed carefully.

Terminology: Grabbers and Cameras
Some cameras may connect directly to the computer, for example through an Ethernet
port, while others may be connected through a “grabber” or acquisition board. For the
purpose of simplicity, this manual uses the term camera to describe any video source, nomatter how it is connected.

NorPix Inc.

9

StreamPix 8 User Guide

Terminology: Sequences and other video formats
You can save captured video in a variety of formats. For the purpose of simplicity, thismanual uses the term Sequence to refer to any recorded video stream.

StreamPix 8 Documentation
All StreamPix 8 documentation is available in PDF format from the Help tab. StreamPix 8
includes the following documents:• StreamPix 8 User Guide, this manual• Camera Installation Guide, a guide to configuring your hardware and cameras• NorPix Sequence File Format, a technical description of the structure ofSequence files (*.seq).
NOTE: See also any documentation provided by your grabber and/or camera

manufacturer.

Feedback on the Documentation
Our Technical Publications group welcomes your feedback. Please help us improve future
releases of this document by sending us your comments and suggestions by email to
docs@norpix.com.

Commenting in documentation
You can add your own comments and notes, and even attach documents, to this PDF
manual in Acrobat ReaderTM by selecting the View > Comment > Annotations toolbar.

10

NorPix Inc.

Introduction

1.2

About StreamPix 8
StreamPix 8 is a specialized application designed to provide real-time digital video
recording to PC memory or hard disk. Providing the hardware is adequate, video may be
streamed from a camera at full frame rate without dropping any frames.
Although StreamPix 8 is a sophisticated program designed for high-speed image
acquisition, the user-interface is designed to be as easy to use as possible, consisting of
VCR-style controls, menus and dialog boxes.

Main features• Real-time digital video recording to PC memory or hard disk in Windows Vista,
7, 8, & 10.
• Acquisition from a huge variety of IEEE 1394, Color RGB, NTSC, RS170, USB,
CameraLink, GigE, 10GigE, USB3 Vision, and CoaxPress high resolution andhigh frame rate cameras.
• Uncompressed and compressed images capture directly to RAM or hard disk
drive(s).
• Compressed image capture using Windows based codecs or StreamPix
compression utilities.
• Capture/Export to common file formats like BMP, JPEG, TIFF, PNG, AVI, MOV
and more.
• Easy browsing of captured sequences with VCR-style controls: Record, Play/
Pause, Rewind, and Fast-Forward buttons
Visit the NorPix Website for a list of all ongoing supported cameras and frame grabbers:
www.NorPix.com.

StreamPix 8 Versions
There are two versions of StreamPix 8: Single Camera and Multi-camera.
• The Single Camera version is suited to applications that require a single camera.
Multiple workspaces are not supported.
• The Multi-camera version can handle multiple Workspaces and cameras.
NOTE: Depending on which version of StreamPix 8, “Single Camera” and/or “Multi-

Camera”, and which Module licenses you purchased, some features orcommands described in this manual may not be present.

NOTE: Audio and/or DAQ recording require additional authorization codes to unlock

the Audio and/or the DAQ Modules.

NorPix Inc.

11

StreamPix 8 User Guide

NOTE: If you recently updated StreamPix to use Audio and/or DAQ modules, andyou do not see the Audio and/or DAQ tabs on the ribbon, you may need to
update the configuration file as follows:
1. Go to Settings > Interface > Customize Ribbons.
2. Select Restore Defaults and OK.
3. Restart StreamPix.

Authorization codes
The authorization code determines which application, feature, module, as well as which
grabber/camera(s) are authorized. You must obtain the appropriate authorization codes bycontacting NorPix sales or support. You will be sent an authorization file (.npx) that
includes the specific authorization codes. Either double-click the .npx file to register it or
do it through the Help > License Information (SysInfo) utility.
See also the How to License guide.pdf document for details on authorizing the software.

Installing StreamPix 8This manual assumes that StreamPix 8 and your hardware configuration are alreadyinstalled and operational. If this is not the case, carefully follow to the installation notes
provided by NorPix for your particular video capture hardware.

CautionWhen StreamPix 8 is installed, several components need to beregistered with the system. If a particular required “DLL” file ismissing, the correspondent StreamPix driver(s) will not be registered.
When attempting to load the hardware driver from within StreamPix, anerror message: “The DLL of the desired hardware is not correctly
registered,” will be displayed.
Typically, re-installing StreamPix 8 after the hardware driver is installed
fixes this issue.

When purchased on a CD-ROM, StreamPix 8 installation is started automatically byinserting the disk into the drive. Otherwise, to install StreamPix 8 from the CD-ROM orfrom a Web file, select streampix8-setup.exe and follow the on-screen instructions.

Minimum System Requirements
The minimum system requirements to run StreamPix successfully depends on how you
will use the program. Therefore, the following guidelines are recommendations only.

12

NorPix Inc.

Introduction

StreamPix has the following minimum system requirements:• Minimum: Intel Core - 2nd generation CPU. Core i3 for single camera, core i7
for multiple camera configuration.
Recommended: Intel core i5 4th generation or higher. AMD based CPU is
supported, but performance is weaker.
• 8GB of RAM or higher.
• A supported IEEE, USB3, or GigE digital or analog camera and compatible
frame grabber board.
• Windows Vista, 7, 8, or 10 in 32- or 64-bit versions.*• Monitor supporting resolution 1024x768 or more.
• A graphic adapter with good 2D performances (PCI Express 16x or better
recommended).
• For recording, from 7200 rpm hard disk(s) optimally with RAID-0 configuration,
depending on the writing speed required,*Sequences in MOV format are supported in the 32-bit version only.
For sequences stored on hard disk, StreamPix 8 will always assume sufficient bandwidthavailability. If you are unsure of the capabilities of your system, contact NorPix technicalsupport.

TIP: The Tools > Disk Benchmarking utility, installed with StreamPix 8, lets you

verify HDD recording capabilities. By default, it is installed in the...\Norpix\Tools folder.

For high speed cameras or multiple camera setups, check with NorPix for complete
computer configurations.

Supported File Formats
StreamPix 8 supports the following image file formats:
Image Format

Norpix Sequence
File (.seq)

Advantage

Disadvantage

The best format to stream to disk without The .seq image format is supported only bylosing any frames at high frame rates.
StreamPix.
Uncompressed, so no image quality loss.
Also supports several compression
algorithms. NorPix Sequence File images
can be exported to any supported format.
Table 1-2: Supported file formats

NorPix Inc.

13

StreamPix 8 User Guide

Image Format

Windows Bitmap(.bmp)

Advantage

Disadvantage

Uncompressed, so no image quality loss. Raw images result in large file sizes.
Format is supported by a vast majority of Supports 8 bit mono and 24 bit color images
image processing applications.
only, resulting in a loss of information forimages using higher bit depth.

Tagged Image File Uses a lossless compression algorithm(.tif)
resulting in relatively smaller file size noloss of information. Supports mono andcolor images at any bit depth.

Compression algorithm is CPU intensive
resulting in longer export times than with the
Bitmap format.

Multipaged
Same as the non-multipaged tiff. Allows a Same as the non-multipaged tiff. Support for
Tagged Image File full sequence of images to be stored in a multipaged .tiff is scarce outside specialized(.tif)
single file.
applications.
Joint Photographic Good image compression. One of theExperts Group
most widespread formats on the Internet,(.jpg)
meaning that almost anybody can view a.jpg image.

Supports 8 bit mono and 24 bit color images
only, resulting in a loss of information forimages using higher bit depth. The
compression will result in image precision
loss.

Lossless JPG
2000 (.jp2)

Moderate compression increases overstandard JPG. Scalable resolution levels
for display.

Complex and system intensive encoders/
decoders. May produce ringing artefacts nearedges.

SMPTE Moving
Picture Exchange(.dpx)

A world-wide standard for storing images Large file size due to uncompressed data.
for later processing, suitable for almost
any raster imaging application. Extensive
metadata capabilities.

Digital Negative(.dng)

Open source lossless format, viewable by Some metadata may be lost when viewed
most imaging software.
from another platform/software. 8, 10, 12
and 16 bit per pixel is supported.
However, the thumbnail included into the
DNG file is always 8 bit.

Flexible Image
Transport System(.fits)Uncompressed, so no image quality loss. Color images are divided into 3 individual
Supports both mono and color images at datafiles: red, green and blue. The color plan
any bit depth. A .fits file is composed of 2 is appended to the file name.
segments: a header, which contains
image format information, and a tableholding the image data. More about fits
file format.

Multipaged
Flexible Image
Transport
System(.fits)

Same as the non-multipaged .fits. A fullSame remarks as for non-multipaged fits.
sequence of images is stored as a single
file. The file contains multiple headersand data tables, one per exported image.

Portable Network
Graphics (.png)

Similar to .gif format. Excellent
compression without any loss of quality.

Compression algorithm is CPU intensive,
resulting in longer export times than withother formats. Supports 8 bit mono and 24 bitcolor images only, resulting in a loss of
information for images using higher bit depth.

Table 1-2: Supported file formats

14

NorPix Inc.

Introduction

Image Format

Advantage

Disadvantage

Movie Clip (.avi)

Wide range of codecs available according The supported image format varies fromto specific needs.
codec to codec. Some trial and error needed
to find the right codec for a specific use. The
same codec needs to be installed on all
systems used for playback. (Except for theuncompressed AVI which comes bundledwith Windows). Time stamp information foreach frame is not available. Concurrent
synchronous playback over multiple AVI
files is not supported.

Quicktime Movie(.mov)

Requires Quicktime Player to be installed Some codecs might not be supported underon the computer. Various codecs
Windows, or might not work or offer reduced
available. Only works on StreamPix 32- functionality without a 3rd party license.
bit.
Requires an external 3rd-party viewer for
StreamPix 32-bit will run on Windows 64-bit.
playback.

MPEG 4 (.mp4)

H.264 or MPEG4 compression, resulting
in small file size.

MPEG2 (.ts)

H.264 compression, resulting in small file Requires an external 3rd party viewer forsize.
playback. High CPU load unless somehardware acceleration is available.

High CPU load during recording unlesssome hardware acceleration is available.
Time stamp information for each frame is notavailable. Concurrent synchronous playback
over multiple MP4 files is not supported.

Table 1-2: Supported file formats

Audio and DAQ File Types
StreamPix 8 supports the following audio and DAQ file formats:
File Type

Description

Audio files (.aud)

A raw audio file supported by StreamPix 8 and including time stamp information
allowing random sync between audio, video and DAQ data.

NorPix DAQ file (.daq)

Data acquisition file for all the DAQ related data. Includes DAQ samples as well assome time stamp information.

DAQ Graph Settings(.display)

The DAQ Graphs settings associated to a specific DAQ file.
Table 1-3: StreamPix Audio and DAQ file types

NorPix Inc.

15

StreamPix 8 User Guide

1.3

StreamPix 8 Interface
StreamPix 8 uses the Microsoft® standard ribbon layout, where each Menu tab displays aribbon with the most commonly associated toolbuttons for that tab. The main features of
the StreamPix 8 interface are illustrated in Figure 1-1 and described in Table 1-4 below. A
popup tooltip explains each feature as you hover the cursor over it.
The contents of the application menu and the ribbons can be fully customized from Home
> StreamPix Settings > Interface > Customize Application Menu... | Customize Ribbons... .
See “Controlling Multiple Cameras”.

Application button Quick Access Toolbar

Style selector

Menu tabs
Toolbutton ribbon
Workspace tabs

Display area

Status icons
Display Info

Sequence Slider
Status bar
Docking panel
Figure 1-1: Main Interface, Home tab selectedFeatureDescription

Application Menu button Lists commands related to Sequence files: creation, opening, saving, closing andexporting. The menu content is different if multiple Workspaces are selected. See
Figure 1-2.
Table 1-4: Interface main features

16

NorPix Inc.

Introduction

FeatureQuick Access Toolbar

Description

A toolbar where you can assign your most used toolbuttons to be accessible
independent of the tab selected. See “Add buttons to the Quick Access Toolbar”.

TIP:The Quick Access Toolbar right-click menu contains an option to relocate thetoolbar bellow the Toolbutton ribbon.

Style selector

The color scheme used for the GUI. The following styles are supported:• Luna Blue• Obsidian Black• Silver• Aqua.

Menu tabs

Selecting a Menu tab displays the ribbon of toolbuttons for that tab. The buttons
on each tab are fully customizable, and you can even add your own tabs. See“Interface settings”.

TIP:You can double-click on any tab to minimize the ribbon display. Whenminimized, the ribbon only appears once a tab is selected and disappears
once a toolbutton on the ribbon is selected. Double-click again on a tab torestore the toolbutton ribbon.

Toolbutton ribbon

Contains the toolbuttons associated with the selected tab.

Workspace tabs

The Workspace is a basic concept in StreamPix 8 and can include a camera, asequence, or an audio or a DAQ file. Every camera or Sequence must beaccessed through a distinct Workspace. You can drag and drop a sequence fileonto a Workspace tab to open it in that workspace. Commands are applied to thecurrently active Workspace, as indicated by the Workspace Status icon and by thehighlighted Workspace tab. See “Workspaces” . Each Workspace also has its
own section in the Docking panel. See Chapter 4: Managing Workspaces andCameras.

Display info

Information about the display in this Workspace, mostly information about thecurrent sequence, the frame rate of the Live feed, the grabber buffer usage. For
the buffer usage, three values are shown: the current buffer usage, the peak buffer
usage for the current session, and the total number of buffers available.
The information to display and when to display it (live, playback or both) can be set
from Home > StreamPix Settings > Displayed Data.
Table 1-4: Interface main features

NorPix Inc.

17

StreamPix 8 User Guide

FeatureQuick Access Toolbar

Description

A toolbar where you can assign your most used toolbuttons to be accessible
independent of the tab selected. See “Add buttons to the Quick Access Toolbar”.

TIP:The Quick Access Toolbar right-click menu contains an option to relocate thetoolbar bellow the Toolbutton ribbon.

Style selector

The color scheme used for the GUI. The following styles are supported:• Luna Blue• Obsidian Black• Silver• Aqua.

Menu tabs

Selecting a Menu tab displays the ribbon of toolbuttons for that tab. The buttons
on each tab are fully customizable, and you can even add your own tabs. See“Interface settings”.

TIP:You can double-click on any tab to minimize the ribbon display. Whenminimized, the ribbon only appears once a tab is selected and disappears
once a toolbutton on the ribbon is selected. Double-click again on a tab torestore the toolbutton ribbon.

Toolbutton ribbon

Contains the toolbuttons associated with the selected tab.

Workspace tabs

The Workspace is a basic concept in StreamPix 8 and can include a camera, asequence, or an audio or a DAQ file. Every camera or Sequence must beaccessed through a distinct Workspace. You can drag and drop a sequence fileonto a Workspace tab to open it in that workspace. Commands are applied to thecurrently active Workspace, as indicated by the Workspace Status icon and by thehighlighted Workspace tab. See “Workspaces”. Each Workspace also has its own
section in the Docking panel. See Chapter 4: Managing Workspaces andCameras.

Display info

Information about the display in this Workspace, mostly information about thecurrent sequence, the frame rate of the Live feed, the grabber buffer usage. For
the buffer usage, three values are shown: the current buffer usage, the peak buffer
usage for the current session, and the total number of buffers available.
The information to display and when to display it (live, playback or both) can be set
from Home > StreamPix Settings > Displayed Data.
Table 1-4: Interface main features

18

NorPix Inc.

Introduction

FeatureDisplay area

Description

The display area is the section of the Workspace where the camera feed or
sequence displays. You can use Display > Toggle Display to turn off the display
and alleviate some CPU load.
You can also zoom the current display in or out by using Display > zoom controls.
The current zooming values appear in the image status bar. Zooming increases
CPU load compared to normal image (1:1) rendering. The color of the display area
can be adjusted by using Display > Set Background Color.

Status icons

Icons showing whether the Workspace is active, if display is from a camera ordisk, etc. See “Workspace Status Icons”.

TIP:Any Workspace can be designated as the active one by clicking within its

frame.

Sequence slider

The sequence slider cursor indicates which image is currently shown in the
playback display. The cursor can be dragged to jump to any frame of thesequence or used to scrub the timeline when a Sequence is paused. A red triangle
appears under the slider to show where the next captured image will be stored in
the sequence, which is normally at its end. See Record, Snap, and Playback
Controls.

NOTE: The oldest frame in a

Slider via this symbol:
recording).

Sequence is highlighted on the Sequence(Useful for looped playback & pre-post

NOTE: The sequence slider is only used when working with sequence files (.seq)

and AVI files (.avi). It is not used with Quicktime movie (.mov) or image
files. StreamPix 8 can record to .mov, but it does not load or playback
Quicktime movie (.mov) or image files.

TIP:The sequence slider can be placed at the top or bottom of the window from
StreamPix Settings > Interface.
Table 1-4: Interface main features

NorPix Inc.

19

StreamPix 8 User Guide

FeatureStatus area

Description

Along the bottom of the StreamPix 8 window, the Status area displays information
about the image in the currently active Workspace. The parameters are, in order:• Resolution, in pixels, shown as Width x Height• Image size in bytes• Image format (mono, color, bayer, etc)
• Bit depth per channel / Total bit depth• Image offset in the display area (not the same as the offset on the camera CCD)
• Image zoom in X and Y. Used to zoom the image in and out.
• Pixel coordinates of the mouse cursor on the image.
• RGB color value of the pixel at mouse cursor position.

Docking panel

An area where frequently used dialog boxes are displayed. See “Docking
Panel”.

TIP:You can increase the Workspace display area by toggling off the Docking
Panel display through Home > Show Docking Panel.

Table 1-4: Interface main features

Application Menu

Figure 1-2: Application Menu contents

20

NorPix Inc.

Introduction

OptionDescription

New Sequence on Disk This creates a new sequence on disk. By default, the sequences on disk are notcompressed and the frames are saved directly as they are received from thecamera. This, may require special configurations for high frame rates orsimultaneous use of multiple cameras (RAID, etc).
New Sequence in RAM This creates a new sequence in RAM. Useful for short sequences with fast frame
rates, as it allows for an higher transfer rate than a sequence on disk.
New AVI...

Creates an empty AVI that will be used to capture images. Once the AVI is closed,
the generated AVI file can be played back using MediaPlayer or any compatible
AVI player. You can also playback the recorded AVI directly in StreamPix (SeeOpen AVI).

New Quicktime movie... Creates an empty MOV that will be used to capture images. Once the MOV isclosed, the generated MOV file can be played using Quicktime player. This is only
available on StreamPix 8 32-bit.
New MP4 movie...

Creates an empty MP4 that will be used to capture images. Once the MP4 isclosed, the generated MP4 file can be played back using MediaPlayer or any
compatible MP4 player. No audio supported.

New MPEG2 TS
movie...

Creates an empty *.ts that will be used to capture images. Once the *.ts is closed,
the generated *.ts file can be played back using any compatible player. You canalso playback the recorded AVI directly in StreamPix. No audio supported.

New Image Sequence

Creates an empty Sequence file that will be used to capture images.

Open Sequence

Opens a previously saved Sequence file. Any currently active Sequence is closed
in consequence. In the “Open” file dialog, there is also an option to load thesequence in RAM for faster playback/browsing.
NOTE: If there is not enough RAM available, the sequence will only be partiallyloaded. Changes made to a sequence loaded in RAM aren't mirrored on
the source sequence on disk.
Reopen Last Sequence Reloads the last sequence used by the current workspace.
Open Sequence(s) in
temporary workspaces

Allows you to open multiple sequence files at once. Each sequence will be loaded
in a temporary workspace.

Open AVI

Opens an existing AVI file in playback mode. Recording can't be done in an AVI in
playback mode. AVI files that were not created by StreamPix might not play.
Clicking Play after an AVI has been recorded will save & close the AVI, then will
reopen it for playback.

Open MP4

Opens an existing MP4 file in playback mode. Recording can't be done in an MP4
in playback mode. MP4 files that were not created by StreamPix might not play
because of codec dependencies. Clicking Play after an MP4 has been recorded
will save & close the MP4, then will reopen it for playback..

Save & Close

Closes the active project, sequence, movie or image sequence. RAM sequences
are discarded when closed. As such, saving a RAM sequence is done byexporting it to a file on disk prior to closing it. There is also an option in StreamPix
Settings > Sequence to prompt to save a RAM sequence upon closing it.

NorPix Inc.

21

StreamPix 8 User Guide
OptionDescription

Export ...

While the .seq file format is very convenient within the StreamPix application, it is
not widely supported by 3rd party software, and often needs to be converted to amore common format. Once the sequence is loaded, it can be exported to AVI
movies, separate .tif images or any other standard file format.
Sequence files and AVI files are the only exportable formats. The File formats
available for export are as follows:• Sequence file format (.seq)• AVI Movie Clip (.avi)• Quicktime Movie (.mov)• BMP format (.bmp)• JPEG format (.jpg)• TIFF format (.tif)• PNG format (.png)• Flexible Image Transport System (.fit)• Lossless JPEG2000 (.jp2)• Digital Negative format (.dng)• Windows Media Photo (.wdp)
Current Image to..: Exports the image aligned with the sequence cursor.
Current Selection to..: Exports all images in the current selection. All images will be
named based on the filename typed in the Save As... dialog box.
Full Sequence to..: Exports all images of the sequence. All images will be named
based on the filename typed in the Save As... dialog box.
Multi-Display area ..: Same as the default action but applied to the current content

of the image display area. (Not available in the Single-Camera version)
Sequence History

Allows you to reload previous recording sessions. Sessions are sorted by dates
and hours. Select the desired hour and the Workspaces/Sequences that were
loaded at that time will be shown. From there, you can either reload all thosesequences or a specific one using the corresponding button. If the Sequence can't
be found because it was moved or deleted, an error message will be shown. You
should delete older or obsolete entries from the history from time to time (toreduce loading times).

Settings

Show the StreamPix Settings dialog.

Exit

Close StreamPix.
Table 1-5: Application Menu options

StreamPix 8 Help tab
The StreamPix 8 Help tab contains the following:• StreamPix 8 User Manual, this manual.

22

NorPix Inc.

Introduction• Camera Installation Manual with detailed instruction on how to setup every
camera supported by StreamPix.
• Sequence File Format Manual provides information on the NorPix Sequence Fileformat, useful if you want to extract image/data from a sequence file to process ina third party application such as Matcad.
• License Information displays all the authorization codes that are registered on thesystem for the current user.
• About StreamPix accesses the Technical Support contact information and shows
the credits for StreamPix. The Enable DLL Registration button sets the fileassociation for DLL files to regsvr32.exe as the default application used to''open” them. It is sometimes used in tech support procedures but should not beneeded otherwise.
• Check for Updates connects to the Norpix FTP to download a small version file.
The newest available version number will be compared to the version number ofthe installed software, calling a prompt indicating if a new version of StreamPix
is available for download.
• Send Feedback to NorPix to report a bug, make suggestions, or request specificfeatures.

Selected buttons
When a toolbutton toggles an action, such as turning the display on or off, its color ishighlighted when it is selected, as shown in Figure 1-3.

Figure 1-3: Toolbutton toggled On and Off

NorPix Inc.

23

StreamPix 8 User Guide

1.4

StreamPix 8 Basic Concepts
Before you begin using StreamPix 8, you should become familiar with some StreamPix 8
basic concepts.

Workspaces
Workspaces allow you to control multiple cameras. Every camera must be in a distinct
Workspace, and a Workspace can contain only a single camera.
To view a captured sequence, it must also be loaded into a Workspace. A Sequence may
be loaded into a separate Workspace or into the Workspace connected to the camera thatgenerated the Sequence. See “Sequences”.
Only one Workspace can be active at a time. The Active workspace is the one containing
the Active Status icon. Click in any Workspace to make it the active one. See “Set up
Workspace(s)”.

NOTE: In the StreamPix 8 Single Camera version, only one Workspace is possible.

Multiple Workspaces
Multiple Workspaces allow you to load multiple cameras and Sequences in a single
instance of StreamPix 8. Every camera must belong to a distinct Workspace; however, thesame camera may be assigned to different Workspaces, each with its own settings. Camera
settings are saved and loaded in the Workspace to which the camera is connected. Thisway, when a Workspace is opened, the camera settings will be reloaded according to thesettings.
Having multiple workspace configuration can be useful, even when running a single
camera. For instance, if a camera is used to grab images both in a room with normal lightand in a dark room, the exposure time can be adjusted from one condition to another.
To avoid having to adjust the exposure every time the camera is moved from one room tothe other, the Workspaces can be used to save “presets”. This can be done by first naming
the Workspace “Normal”, loading the camera and setting the camera to normal lighting.
Then create a new Workspace named “Dark”, load the same camera and set the camera forthe dark room.

NOTE: A camera may only be open in one Workspace at a time. In the above

example, you would first close the “Normal” Workspace and then open the“Dark” Workspace.

24

NorPix Inc.

Introduction

As another example, you could create two Workspaces, named “Workspace A” and“Workspace B”. Each Workspace has its own tab. Workspace A would control camera A
and the resulting sequence file A, while Workspace B would control camera B andsequence file B. Select the appropriate tab to make that Workspace active.
To access Workspace management, select Workspace > Workspace Manager.

Master, Linked, and Stand Alone Workspaces
By default, all commands are applied to the active Workspace, but the Home > Select allWorkspaces and Workspace > Master Workspace commands let you control multiple
Workspaces simultaneously.
• Master Workspace: synchronizes all playback and browsing with the Master
Workspace time. Double click on a Workspace tab to set/unset it as the Master.
There can be only one Master Workspace.
• Select all Workspaces: Designates a linked Workspace and applies any command
marked by the Link icon to all selected Workspaces. The Select all Workspaces
command automatically makes the active Workspace the Master.
• Workspace > Stand Alone Workspaces option lets you designate Workspaces toignore when using the Master and Select all Workspaces commands.
See “Master Workspace and Select All Workspaces”.

Workspace Status Icons
The Workspace Status icons provide information about the current Workspace status. Use
Display > Overlays to toggle the display of the Workspace Status icons.
The following table shows the possible Workspace Status icons
Icon

Description

PositionLive view. The camera is streaming flawlessly.

Tab and Overlay

Master workspace (used for synchronized browsing/playback). Shown in Workspace

Tab

Linked Workspace through Home > Select All
Workspaces. Toolbuttons for affected commands also
contain the Link icon.

Tab and toolbar icon

Table 1-6: Status Icons

NorPix Inc.

25

StreamPix 8 User Guide

Icon

Description

When doing a normal playback following the time

Position

Overlaystamps, this icon pops up when there is a lag of 100
ms or more between the timestamp of the frame being
currently shown and the frame that should have beenshown at this time. It indicates that the playback frame
rate is slower than the recording frame rate. This could
be caused by weak reading capabilities of the system.
The camera is dropping frames.

Overlay

The camera streaming is stopped.

Overlay

Recording.

Overlay

Sequence view.

Tab

Playback.

OverlayThis workspace has the focus. The Interface
commands are applied to it.

Overlay

Timeshift mode.

Overlay

The Camera > Watchdog is enabled and its timeout
value was reached.

Overlay

Pre/Post Recording mode.

Overlay

Waiting for I/O trigger. I/O event is an event that can
trigger something, like start or stop recording, or prepost, or something else.

Overlay

Table 1-6: Status Icons

Record, Snap, and Playback Controls
The Record, Snap, and Playback controls are found on the Home tab.

Figure 1-4: Record and Playback controls for Stand Alone and Linked Workspaces

26

NorPix Inc.

Introduction

RecordThe Record button allows you to start/stop recording according to the parameters set in the
Home > StreamPix Settings > Recording > Setting fields.

Snap
The Snap button does the same as the Record button, except that it records a single frame.
Multiple snaps can be done in the same Sequence file. Useful for capturing direct to an
image file, such as .bmp.

Playback Buttons
The Playback buttons use common video control buttons to control playback options. The
Play/Pause button plays back a Sequence according to its timestamps set in the StreamPix
Settings > Playback page. See “Playback settings”.
The Step Back and Step Forward buttons move the display one frame at a time.

NOTE: If the Show Manual playback slider is enabled in Settings | Playback Rate, theappearance of the Step back/Step Forward buttons changes, and selecting the

buttons will increase or decrease the playback speed. See Figure 1-5.

Figure 1-5: Change in Step Forward / Step Back controls

NorPix Inc.

27

StreamPix 8 User Guide

Additional Playback Options
Time Jump
The Sequence > Time Jump buttons jump the display according to the interval set in
Settings > Playback > General > Length of time jumps in MS (milliseconds. The default is1000 ms. See “Playback settings”.

Figure 1-6: Time Jump buttons

Manual Playback Control

Figure 1-7: Manual Playback controls with dropdown menu

When enabled from the StreamPix Settings > Playback page, the Manual Playback control
appears as a secondary slider to the right of the Sequence Slider. The Manual Playback
control dropdown menu allows you to select a fixed frame rate to review the current
sequence/AVI at without regard to the timestamps of each image. Dragging the Manual
Playback control slider to the right will gradually increase forward playback speed,
moving it to the left will increase backward playback speed. See “Playback Rate settings”.
See also the Note above.

Sequences
Before starting to record, you should specify the destination folder where and the captured
images format. StreamPix 8 offers several possible destinations: Sequence files (on disk or
in RAM), image files (bmp, tiff, jpeg, etc.) and movie files (AVI, Quicktime, MP4, or TS).
Sequence Files, files with the ".seq" extension, (a NorPix proprietary format) are theStreamPix 8 native format. Images are stored in their raw format, exactly as they werereceived from the camera, incurring no quality loss. A Sequence file can also include
compressed frames, such as H.264, JPEG or HEVC format. StreamPix 8 can export
image(s) from an existing sequence to any other supported format (image or movie files).
See 1.2.6. Supported File Formats.

28

NorPix Inc.

Introduction

Docking Panel
The Docking Panel displays a box for each Workspace and its currently associated dialog
boxes, including the current camera and sequence, the list of external modules, and any
dialog boxes for currently active modules.
In a multi-display, you can toggle between showing the dialog for either the current
Workspace or All Workspaces through Home > StreamPix Settings > Interface > Docked
Dialogs.

TIP: 1. Select Workspace > Workspace Color to color code Workspaces tabs and theirassociated dialogs.
2. You can increase the Workspace display area by toggling off the Docking
Panel display through Home > Show Docking Panel.

Camera Docked Dialog

Figure 1-8: Camera docked dialog

When the camera is Live, the acquisition speed, in frames per second, is constantly
updated. Clicking on Info will display information about the size and format of images
captured by the camera.
The ROI allows you to define a region of interest for cameras that support this feature.
Coordinate assignment is done by entering the desired offset (in X and in Y), width andheight and clicking on Apply.

NorPix Inc.

29

StreamPix 8 User Guide

The Adjustment button, if supported by the camera, expands the dialog to show theavailable adjustments. (Same as Camera > Live Adjustments). If Broadcast is checked,
changes here will be applied to all associated Workspaces with compatible cameras.
Changes to the Adjustments can also be broadcast to other linked Workspaces running
another camera of the same model.
The Settings button, if available, expands the dialog to show the available settings. If
Broadcast is checked, changes here will be applied to all linked Workspaces withcompatible cameras.

Sequence docked dialog

Figure 1-9: Sequence docked dialog

This docked dialog shows information related to the Sequence. Select Show Sequence
Information to display detailed information such as the number of frames in Sequence, theaverage capture frame rate, and image format. Click on Edit Description to write a shorttext message to be stored in the Sequence header.
The number of frames the Sequence will hold can be adjusted in this dialog to make surethat, according to the chosen option in StreamPix Settings > Recording, recording will
restart from the beginning of the Sequence or stop when recording position reaches thisvalue. Default is ''0'' for standard, unlimited, recording.
Any browsing with the Sequence Slider is reflected in the thumbnails section. Select Show
Event Markers to show each logged event. To avoid clogging the Sequence Slider only thevery first 100 markers are displayed, Events are created by Set Event Marker I/O actions
that can be configured from the I/O Manager Docked Dialog. See “HOWTO Trigger a
Software Event from an external input line (I/O Manager)”.
Select any event to go to the associated frame in the Sequence. Click on Edit... to edit the
selected marker description. You can also delete one or all events using the respective
buttons.
Event Marker information is saved in a separate .xml file named after the Sequence name.
For example, markers for c:\folder\test.seq will be in c:\folder\test.xml.

30

NorPix Inc.

Introduction

Pre/Post Trigger docked dialog
This allows you to set custom pre/post behavior for an individual Workspace. The
behavior is identical to the StreamPix Settings > Pre/Post Trigger page. See “Pre/Post
Trigger settings”.

I/O Manager docked dialog

Figure 1-10: I/O Manager docked dialog

The I/O docked dialog shows information related to Input/Output actions. To create a new
action, double-click on Add new event.... To edit or delete an existing action, double-clickon the line describing that action. In both cases, the Input Action dialog will be shown. See“HOWTO Trigger a Software Event from an external input line (I/O Manager)”.

NorPix Inc.

31

StreamPix 8 User Guide

1.5

What’s New in StreamPix 8
The following enhancements are included in StreamPix 8
FeatureDescription

Multi-language
User Interface

An alternate Language file can be selected for localization through the Settings > General> Language tab. See “General”.

Video and DAQ
recording

Recording video and DAQ can be suspended and resumed into the same DEQ+DAQ
files. See “DAQ settings”.

Time Source dialog A new time source dialog lets you adjust time offset for video, audio and DAQ. See“External Time Source options”.
Audio license

An Audio license is now required for all type of audio recording (to AVI, MP4, AUD). See“Managing Audio”

GPU Manager

The GPU Manager setting page helps you to determine what acceleration capability isavailable from the GPU. See “GPU Management”

MP4 video andaudio recording

MP4 video and audio recording and playback are now possible with the appropriate
license. See “Using Audio and DAQ”.

HEVC

Added HEVC compressed video recording and playback. See “MPEG4/TS settings”
and “Sequence Settings”.

Audio track

Recorded audio sound track can be played back to a different audio output device than
the recording source. See “Managing Audio”.

Audio track

Added audio track selection to allow multichannel recorded audio (more than 2channels) can to be played back on a 2-channel audio output device. See “Managing
Audio”.

New settings• "Press F12 to quit FullScreen Mode" caption can be disabled.
• H.264 compression scheme renamed to H264 Loop (for loop recording) and H264 forregular recording. See“Compression for new and exported Sequences”.
• While recording to H.264 Loop mode, you are advised to set a fixed image size. See“Compression for new and exported Sequences”.
• TurboJPEG or Intel JPEG decompression library can be selected (default:
TurboJPEG). See“Compression for new and exported Sequences”.
• MP4/TS settings page lets you adjust MP4 encoding parmeters. See“MPEG4/TS settings” on page 154.
Table 1-7 StreamPix 8 enhancements

32

NorPix Inc.

Introduction

Bug Fixes and Minor Changes in v8.0
The following bugs and minor issues have been resolved in StreamPix 8
Fix / Change or
FeatureDescription

Fix

Recording directly in TIFF is now possible.

Fix

Fixed memory leak when recording with CUDA JPEG compression mode.

Fix

Fixed sorting a sequence does not move the selection markers.

Fix

In Pre-Post, when a sequence file was renamed after the pre-post event date and time, theassociated xml was also renamed.

Fix

Opening a sequence from Windows Explorer now works when StreamPix is already open.
Table 1-8: StreamPix 8 Bug fixes and minor changes

Modules
The following Modules have been added or modified in StreamPix 8
Fix / Change or
New

DescriptionNew

JVC Image Splitter Module (port from StreamPix revision 3).

ChangeLens Control module: added support for Pleora eBUS driver interface and Matrix Vision.

ChangeSecond View Module: This module now requires a license.

ChangeExposure Time Reader: added support for all the cameras that include an adjustment called
Exposure.

ChangeVideo Out module: added all dependencies to avoid the need to install DirectX runtime.

Change• WebStreamer module: nVidia, AMD or Intel based GPU can now be used to perform realtime H264 compression.
• WebStreamer module: better audio device detection to stream compressed audio.

ChangeGPS module: Added burn to image capability for Photon Focus double rate image format.

ChangeThe Time Overlay module is deprecated and replaced by the Display | Time Overlay button.
Table 1-9: StreamPix 8 Module additions and changes

NorPix Inc.

33

StreamPix 8 User Guide

CodecsNew or Updated

Description

New

DirectX Codec: HEVC (H.265) video codec allows higher compression, running on Intel gen
4 and Higher CPU and GPU (paid codec).

New

DirectX Codec: MPEG4 video codec encoder and decoder (software only) (paid codec).

New

Video codec: GPU accelerated JPEG compression codec, using OpenCL: allow running on
AMD, nVidia and Intel GPU. Resolution up to 4K (paid codec).

New

DirectX Codec: AMD H.264 encoder using AMD GPU for H.264 accelerated image
compression (paid codec).

New

DirectX Codec: nVidia CUDA-based HEVC encoder for H265 accelerated image
compression (paid codec).

New

Audio codec: MP3 audio encoder / decoder (paid codec).

New

Audio code: AAC audio encoder/decoder (paid codec).

UpdatedCUDA JPEG encoder: horizontal and vertical resolution up to 4096 pixels (paid codec).

UpdatedCodec Settings utility application supports new codecs.

Updated

H.264 codec now supports AMD, nVidia, Intel GPU or CPU. Resolution up to 4K is now
supported (paid codec).
Table 1-10 StreamPix 8 Codecs

DAQ
Bug / Change
or New Feature

Description

New

StreamPix Studio is deprecated. Audio and DQ features are now available directly in
StreamPix single camera or multiple camera, depending on your license file.

New

It is now possible to suspend and resume recording into the same SEQ and DAQ files.

New

When exporting video with DAQ data, DAQ can be exported to either a DAQ, XLS, or CSV
file container. Range selection is supported.
Table 1-11 StreamPix 8 DAQ fixes and enhancements

34

NorPix Inc.

Introduction

Time Source
Bug / Change
or New Feature

Description

New

TSync Event Capture Time Source: time capture input on the TSync can be used for frame
time stamping.

New

Emergent Time Source: Emergent-based camera can be IRIG-B synchronized.

New

A new Time Overlay button in the Display tab replaces the Time Overlay Module.
NOTE: The Time Overlay Module is obsoleted.
Table 1-12 StreamPix 8 time source fixes and enhancements

Camera / Frame Grabber Drivers
Camera/Grabber

Description

C-Cam

New driver.

AJA Kona

New driver interface, linked with SDK 12.3.7.85. Support 4 channels 3G-SDI (4K)and AES/EBU digital audio and path-through mode.

Olympus

Added support for DP27 camera

Ximea

Linked with XiB libraries, added focus and zoom control when available fromcameras, added support for compressed image format.

National Instrument• Updated to NIDAQmx revision 15.1.1.
• Added support for USB-6525.

ONVIF

Added ONVIF 1.0 authentication method.

BaslerUpdated to Pylon 5.0.

Emergent• Updated driver to 2.4.2.20.103.
• Multiple cameras can be synchronized using external IRIG-B time source.

IDS

Updated to SDK 4.71.

Matrix Vision GenTL• Updated to mvGenTL_Acquire 2.14.1.
• Fixed memory allocation issues.
• Fixed ROI selection.
• Added "Acquisition Timeout" adjustment.

Silicon Software

Added support for IO and link speed selection for all MicroEnable 4 and 5 frame
grabbers.
Table 1-13 StreamPix 8 Driver fixes and enhancements

NorPix Inc.

35

StreamPix 8 User Guide

Camera/Grabber

Description

BitFlow• Updated to SDK 6.0.
• Added support for ROI selection within CXP cameras.
• Fixed initialization when using multiple boards.

DataPath

Updated to SDK 7.8.0 for VisionRGB frame grabber.

Pixelink• Added camera selector.
• Updated to SDK 9.3.0.8.
• Updated binning and decimation control.
• Fixed trigger mode stability for USB3 devices.

Pleora Ebus

Added support for PvPixelYCbCr422_8_CbYCrY image format.

IDS

Updated to SDK 4.72.

AVT Vimba

Updated to SDK 1.4.1.

Virtual Grabber

Added support for audio source.

PTGreyUpdate to SDK 2.9.3.11.
Table 1-13 StreamPix 8 Driver fixes and enhancements

HERMES
Bug / Change or
New Feature

36

Description

New

Architecture update so that video capture devices can also support audio capture (Kona
AJA, WEB Camera, Video surveillance devices).

ChangeMP4 container: added H.264 hardware acceleration. Added playback capability for video
and audio.

New

JPEG software compression: added a setting to enable/disable multi-threading.

New

MPEG4 compression is now available (CPU based).

New

MPEG4 compressed video can now be stored into SEQ container.

ChangeUpdate H.264 Intel Quick Sync update to version 6.

Bug

Fixed memory leak for some GDI Object related to image overlay classes.

ChangeAudio to AVI: added support for any codecs with or without real time compression.

New

Audio: more audio source and format supported. Add some audio format conversion
utilities.

New

Audio: 24 bit captured audio can be played back to 16 bit compatible devices.

Bug

Audio: Fix Audio quality when exporting SEQ+AUD to AVI.

ChangeUpdated DemoGrab sample code to add support for audio.
NorPix Inc.

Introduction
ChangeImage Pixel Processing (IPP): update to version 7.1

ChangeSentinel - update to the new LDK.

ChangeCUDA JPEG compression: Updated to CUDA version 7.5.

Change

RS232 / com port interface: Updated code to support Windows 10.
Table 1-15 Hermes fixes and enhancements

NorPix Inc.

37

2
Getting Started

This chapter contains procedures to initially setup StreamPix 8 to quickly get up
and running. This chapter contains the following sections:•

2.1 Set up Workspace(s)•2.2 Load Camera(s)•2.3 Select Destination File(s)•2.4 Start/Stop Recording•

2.5 Play Back a SequenceGetting Started

2.1

Set up Workspace(s)See also:• “Workspaces”• “HOWTO Manage Multiple Workspaces/Cameras”• “Managing Workspaces and Cameras”.
Every grabber/camera must be in a distinct Workspace, and each Workspace can contain
only a single grabber/camera.
To display a Sequence, it must be loaded into a Workspace as well. The Sequence
associated with a camera may be loaded into the same Workspace, into a different
Workspace, or into a temporary Workspace.

NOTE: In the StreamPix 8 Single Camera version, only one Workspace is possible.

To Set up Workspaces:
1.

Select Workspace > Workspace Manager.
The Workspace Manager dialog box opens.

Figure 2-1: Workspace Manager

NorPix Inc.

2.

Select New Workspace and name the new Workspace.

3.

The Grabber Selection dialog box opens, from where you can select the grabber/camera to associate with this Workspace. To create a Workspace without a video

39

StreamPix 8 User Guidesource, select Cancel when prompted to load one. See “Load Camera(s)”.

Figure 2-2: Grabber Selection dialog box
4.

Repeat Steps 2 and 3 as necessary. As you create a Workspace, it is automaticallyselected for display.

5.

Optionally, uncheck any Workspaces that you do not want to display currently.

6.

Select Done when finished.
The new Workspaces are created. The selected Workspaces are loaded into thedisplay area and a Workspace Settings dialog box for each Workspace is added to theDocking Panel.

7.

Select Workspace > Workspace Color.
The Workspace color picker opens.
TIP: The assigned Workspace color will be applied to both the Workspace tab and theWorkspace dialog box in the Docking Panel, making identification easier.

8.

40

Assign a unique color to each Workspace.

NorPix Inc.

Getting Started

2.2

Load Camera(s)To get a live feed, you must load a camera driver into a Workspace. When you create a
new Workspace, it automatically asks you to choose a camera. To load a camera into an
existing Workspace, select the Camera > Load button. In either case, StreamPix 8 prompts
you to select the camera.

NOTE: The camera/grabber drivers available are dependent on your authorization

codes from NorPix. For additional drivers, contact support@norpix.com.

StreamPix will check for the appropriate codes authorizing the use of the selected grabberand will attempt to load it. Once successful, the Workspace tab of the current Workspace
will show a new display (a small camera icon) and the Live feed from the camera.
StreamPix supports a wide variety of grabbers and cameras. As many cameras haveproperties and settings that are unique to them, the parameters available are dependent on
your camera manufacturer. However, you can adjust the settings of the loaded camera byaccessing them using the Hardware Properties or Live Adjustments buttons from the Homeor Camera tabs.

NOTE: Loading a camera can fail if it is not connected or if it is currently used byanother application. The camera can be unloaded by clicking on Unload in the
Camera tab.

CautionSome frame grabbers may attempt to load a default configuration fileincompatible with the camera, which could produce an error and mighteven crash StreamPix. To prevent a grabber from starting in Live mode,
uncheck the Start Live box in the Load Grabber dialog box. You can thenaccess the hardware properties and select the appropriate configuration
before launching the LIVE camera streaming.

NOTE: If the keyboard scroll lock key is enabled, it will prevent StreamPix 8 fromstarting a live stream.

Once loaded, the camera will automatically start capturing images, unless the camera is ina triggered mode or Scroll Lock is enabled. To toggle the Live feed on or off, for example
to free some CPU resources for other processes, select Home > LIVE.

NorPix Inc.

41

StreamPix 8 User Guide

To Load a Camera
1.

Select the Workspace tab.

2.

Select Camera > Load.

The Grabber Selection dialog opens

Figure 2-3: Grabber Selection dialog box
3.

Select your camera from the list.

4.

Three options are available, but for now you can accept the defaults.
a. Start in Live, meaning that the camera will start streaming right away.
b. Reset grabber settings, to restore the default settings.
c. Import grabber settings from a file, to import camera settings from a previously
saved file.

5.

Select OK.
The camera loads into the selected Workspace and begins streaming.

6.

Adjust the camera settings as needed. Refer to the documentation for your camera ifnecessary. Camera settings are dependent on your camera manufacturer; however,they can be divided into two groups:
a. Hardware Properties: Require that streaming is suspended while Hardware
Properties are adjusted. For example, changing image format from 8-bit to 16-bit.
b. Live Adjustments: Can be done while the camera continues to operate. For
example, changing exposure time.

To Adjust the display:1.

42

Select Display > Auto-Fill to tile the open Workspaces in the viewing area.

NorPix Inc.

Getting Started

TIP: Alternatively, you can use one of the other Multi-Display Layout buttons to set thedisplay.

2.

If necessary, select Set Background Color and choose a background color to makeviewing easier.
TIP: The default background color is white; however, you can change this to makeviewing easier. Red is often suggested when working in low light or outside atnight.

To Set an ROI:A Region of Interest (ROI) allows you to define a region of interest for grabbers that
support this feature. Coordinate assignment is done by entering the desired offset (in X
and in Y), width and height and clicking on Apply. If Broadcast is checked, the change
will be applied to all currently selected Workspaces.
1.

In the Docking Panel, select the camera dialog, and expand it if necessary.

2.

Select the ROI button
The ROI area opens.

3.

Enter the Offset X and Y values and the Width and Height.

4.

Optionally, select the Center ROI box to center the area.

5.

Optionally, select Broadcast to apply the ROI to all currently selected Workspaces.

6.

Select the Apply button to see the results in the display area.

To Click and Drag an ROI

NOTE: Before you can use the following instructions to set an ROI, the Home > Set
Camera ROI box must be selected.

• Drag toward bottom-right to define an ROI.
• Drag toward top-left to restore full image display.
• Dragging toward the bottom-left or the top-right will abort the current ROI
selection.

NorPix Inc.

43

StreamPix 8 User Guide

2.3

Select Destination File(s)See also:• “Sequences”• “Managing Sequences and Markers”.
Before starting to record, you should specify the destination where and how the captured
images will be stored. StreamPix 8 offers several possible destinations: sequence files (ondisk or in RAM), image files (bmp, tiff, jpeg, etc) and movie files (AVI & Quicktime).
Sequence Files are files with the “.seq” extension, a NorPix proprietary format., are theStreamPix 8 native format. StreamPix uses a high-speed write mode to transfer images to
disk, in real-time, at the maximum speed allowed by the HDD.
Sequence files have several advantages:• The number of images is limited only by available disk space.
• Images are stored in their raw format, exactly as they were received from thecamera, incurring no quality loss.
• Sequences can be played back in StreamPix 8.
• StreamPix 8 can export image(s) from an existing sequence to any othersupported format (image files or AVI). See “Supported File Formats”.
• Each image is time stamped with the precise time at which it was captured. This
allows accurate playback for sequences captured at variable speeds.
• Sequence files can be post-processed with various image processing functions(ex: applying a Bayer conversion) and exported to any other format.
• Extra metadata can be also saved with the Sequence file, such as GPS
positioning, without interfering with image data.
To create a sequence file to disk:
1.

Select Application Button > New Sequence on Disk.

2.

Choose a name for the sequence and the location to save it.

To create a sequence file in RAM:
1.

Select Application Button > New Sequence in RAM.
RAM sequences are limited in size to the amount of system memory currently
available. When the sequences run out of memory, the recording automatically stops.

To create an AVI file

44

1.

Select Application Button > New AVI.

2.

Select the desired codec from the Save As file dialog.

NorPix Inc.

Getting Started

To create a Quicktime file:

NOTE: Available in StreamPix 32-bit versions only.

1.

Select Application Button > New Quicktime movie.

2.

Select the desired codec from the Save As file dialog.

To capture directly to image files:
1.

Select Application Button > New Image Sequence.

2.

Select the desired format.

To close the destination file:1.

NorPix Inc.

Select Application Button > Save & Close command when the destination file is nolonger needed.

45

StreamPix 8 User Guide

2.4

Start/Stop Recording
See also:• “Record, Snap, and Playback Controls”• “HOWTO Set Recording Options”.
Once the your grabber is loaded and the destination file is set up, you can start recording.
You can either record manually or schedule a specific recording time.

NOTE: By default, only the currently selected Workspace records. However, if Home
> Select all Workspaces is selected, then all Workspaces (except those

excluded) will start recording.

Clicking once on Record will start saving frames coming from the grabber to thedestination file (sequence, AVI, images, etc), while clicking a second time on it will stop
recording. If the destination is a Sequence file, the recording will start at the Recording
Position, usually located at the end of the sequence unless modified with the Sequence >Set Recording Position command.
Snap

The Snap button functions the same as Record, except that the recording
will automatically stop after 1 frame has been captured.
To Record a Sequence Manually1.

Select a Workspace to make it the active one.

2.

Select Home > Record to start recording.

3.

Select the Record button again to stop recording.

To Change the Starting Point

While a Sequence file is recording, frames are saved starting at the Recording position.
The default recording position is after the last image of the Sequence.
To change the recording position:46

1.

With the playback paused, for a Sequence file or Sequence file in RAM only, movethe sequence slider to the desired position.

2.

Select Sequence > Set Recording Position.
The new starting position is shown by a red triangle under the Sequence Slider.

NorPix Inc.

Getting Started

To Record Single Images:• To record single-frame snapshots of the live feed manually select Home > Snap.
Scheduling a Recording:

Use the Tools > Recording Scheduler to setup recording sessions which can start and stop
without user intervention. One-time, daily, weekly or monthly recordings are available.

NOTE: The Recording Scheduler uses the Windows Task Manager. Windows may

prompt you for authorization before continuing to set up a recording schedule.

Once the recording mode is chosen, you can also either define a recording duration or tellStreamPix to keep recording until a stop condition is reached.

TIP: Most recording scripts offer various stop conditions. See StreamPix Settings >Recording manager > Use a recording script.

The Recording Scheduler allows one recording task to be defined. If you need more thanone, you can use the Advanced Scheduling option to access the Windows Task Scheduler
directly.
To Schedule a Recording:TIP: Answer Yes to any Windows security prompts.

1.

Select Tools > Recording Scheduler.
The Recording Scheduler dialog opens.

Figure 2-4: Grabber Selection dialog box
2.

NorPix Inc.

Select the time interval and select Next.
47

StreamPix 8 User Guide
3.

Select the Recording Duration or Stop condition and select Next.
The scheduled task is displayed in the Last Action area of the Recording Scheduler
dialog box.
The Recording schedule repeats until the task is completed or deleted, either bycreating a new task or by selecting Delete current recording task.

Time interval choices are:
• One-Time: Configure a recording session that will occur a single time at the given
date and time.
• Daily: Configure a recording session that will occur daily. The first recording will
be done on the given date and repeat every day (or every X days) at the chosen
time.
• Weekly: Configure a recording session that will occur weekly. One or more daysof the week can be selected. The recording will then happen every X weeks after
the selected date.
• Monthly: Configure a recording session that will occur monthly. Select one ofmore months on which recordings have to be made. Finally, select the repeat
mode from the two available options:- On a specific day of the month (ex: 4th).
- On a relative day of the month (ex: second Tuesday).

48

NorPix Inc.

Getting Started

2.5

Play Back a Sequence
See also:• “Sequences”• “Managing Sequences and Markers”.
To open a Sequence

A Sequence must be opened before it can be viewed. To open a previously captured
Sequence, either:• Select the Application Button > Open Sequence menu.
The Sequence is added to the Display area right-click menu, from where it can be
assigned to a Workspace.
• Select Application Button > Open Sequence(s) in temporary workspaces menu.
The Sequence is displayed in a new Temporary Workspace.
• Drag-and-drop a Sequence file from Windows Explorer to a Workspace tab.
To assign a display

There are two ways to assign a display to a multi-display area:• Click on an area to select it, then right-click on a display button in a Workspacetab.
Or,• Right-click in a multi-display area and select the display from the popup list.
NOTE: Multiple displays can be used to show any loaded StreamPix document, suchas a Sequence file, or the output of a grabber, or DAQ file.

See “Multiple Workspaces” and “Managing Workspaces and Cameras”.

NOTE: From the right-click popup list, you can also enable/disable the Enable autoswitch between live and playback option for the selected area. If enabled, thedisplay will automatically switch between live and playback displays. For
example, between grabber display (live) and sequence file display (playback).
To see both live AND playback displays at the same time, disable this option
to avoid auto-switching.

NorPix Inc.

49

StreamPix 8 User Guide

Once a sequence has been opened, you can go back and forth between live and playback
displays by clicking the respective display buttons on the tabs.
Viewing a Sequence

The sequence can be reviewed at a fixed frame rate by using the manual playback
controls. The following playback commands are available from the Home tab:
Icon

Name

Description

First Frame

Moves to the first frame of the sequence.

Step Back

Moves to the frame immediately before the current frame.

Play/Pause

Starts/stops the playback of the sequence, following the time stamp of every image.
For instance, if there is a 5 second interval between two frames time stamps, theplayback mechanism will actually wait 5 seconds before showing the next frame.
This can be inconvenient for triggered captures or appended sequences, as twoconsecutive frames may be separated by a long time interval. In such a case, use theStep One Frame Forward to bypass the “time step”, or use the manual playback
controls to playback at a fixed speed regardless of time stamps.

TIP: You can also use StreamPix Settings > Playback > Maximum Playback
Interval to get around this problem.

TIP: Reading frames from the sequence file consumes as much bandwidth asrecording them. As such, avoiding doing playback while recording isstrongly advised if there are any doubts about the system's performance.
Step
ForwardMoves to the frame immediately following the current frame.

Last Frame

Moves to the last frame of the sequence.
Table 2-1: Status Icons

You can browse the sequence timeline by moving the Sequence Slider. See “Manual
Playback Control”.

50

NorPix Inc.

3
HOWTOsThis chapter contains specific procedures (HOWTOs) for performing the following
more common StreamPix 8 tasks. For more information on any topic, consult the“Table of Contents”, the Index, or follow the links in each topic.

NOTE: For the initial setup, see Chapter 2. Getting Started.

•

3.1 HOWTO Manage Multiple Workspaces/Cameras•

3.2 HOWTO Set Recording Options•

3.3 HOWTO Export a Sequence•

3.4 HOWTO Use Auto Naming Schemes•

3.5 HOWTO Configure Output File Formats•

3.6 HOWTO Trigger a Software Event from an external input line (I/OManager)•

3.7 HOWTO Store / Retrieve GPS data as metadata•

3.8 HOWTO Modify the GUI•

3.9 HOWTO Restore Defaults.

StreamPix 8 User Guide

3.1

HOWTO Manage Multiple Workspaces/Cameras
See also:• “To Set up Workspaces:”• “Workspace Manager”.

To select which Workspaces to display
1.

Select Workspace > Workspace Manager. The Workspace Manager dialog displays.

2.

Select the Workspaces to display.

3.

Select Done.
A tab is created for each selected Workspace, and a dialog for that Workspace isadded to the Docked Dialogs panel.
TIP: When you create a new Workspace, you are prompted to assign a camera or
grabber to it. To bypass this step, select Cancel.

To Select all Workspaces

The Select All Workspaces command lets you control multiple Workspaces
simultaneously. Commands, such as switching between Live and Playback and those
associated with playback and recording, including the working folder, the customtoken
and everything in Workspace > Workspace Settings, or assigning a custom recording script
will be broadcast to all selected Workspaces, except for Workspaces designated as Stand
Alone.
1.

Select Home > Select All Workspaces to control multiple Workspaces simultaneously.
Individual Hardware properties and Live adjustments are not broadcast.
NOTE: When Select All Workspaces is enabled, toolbuttons with actions that apply to
all Workspaces change their icons to show the Select All Workspaces (Link)

icon as part of their icons. The Workspace tab of selected Workspaces also
contains the Link icon.

To designate a Workspace as Stand-Alone

52

1.

Select Workspace > Stand Alone Workspaces. The Stand Alone Workspaces dialog
lists all open Workspaces.

2.

From the Stand Alone Workspaces dialog, select the Workspaces to designate as
standalone.

3.

Close the dialog when done.

NorPix Inc.

HOWTOsTo designate a Master Workspace

NOTE: Designating a Master Workspace forces all Workspaces to synchronize (byeither time stamp or frame index) playback and browsing with the Master
Workspace. When you select Select All Workspaces, the active Workspace
automatically becomes the Master.
1.

Enable StreamPix Settings > Playback > Enable synchronization across workspaces.
See “Playback settings”.

2.

Select Workspace > Master. The currently active Workspace becomes the Master.
TIP: Double click on a Workspace tab to quickly set/unset it as the Master.

To assign a Workspace color
TIP: An assigned Workspace color is applied to both the Workspace tab and theWorkspace dialog box in the Docking Panel, making identification easier.

3.1.1

1.

Select Workspace > Workspace Color.
The Workspace color picker opens.

2.

Assign a unique color to each Workspace.

Loading and Unloading Cameras
Normally you are prompted to load a grabber or camera when the Workspace is created.
Use the procedure below to change the assigned camera, assign a camera to a duplicate
Workspace, to restore the default camera settings, or to assign a saved camera
configuration.

To Load a camera
1.

Select the Workspace in the display area.

2.

If the Workspace already has a camera loaded, select Camera > Unload Camera.

3.

Select Load Camera and select from the Grabber Selection pick list.

To Make Live Adjustments

Live adjustments include things such as exposure, brightness, contrast, etc. They can bedone while the camera is streaming. The video stream may be disrupted momentarily
while the changes are applied.

NorPix Inc.

53

StreamPix 8 User Guide

NOTE: Live Adjustments can also be made from the Docked Dialog box.

1.

Select Camera > Live Adjustments. The Grabber Properties dialog opens.
NOTE: The actual parameters available are dependent on your hardware. See yourhardware documentation for details.
2.

From the Grabber Properties dialog, make the necessary adjustments.

3.

Select Apply.
TIP: Use the Default button to restore the camera default settings.

To Change Hardware Properties

NOTE: Changes to Hardware Properties can also be made from the Docked Dialog

box.

Adjusting hardware properties require that the Live feed be stopped. They include things
such as image size, ROI, bit depth, etc.
1.

Select Camera > Hardware Properties. The Grabber Properties dialog opens and theLive feed is suspended.
NOTE: Parameters available from the Live Adjustments are also available from here.

2.

Make the necessary adjustments.
NOTE: The actual parameters available are dependent on your hardware. See yourhardware documentation for details.
3.

54

Select Apply.

NorPix Inc.

HOWTOs

3.2

HOWTO Set Recording Options

To Simplify the Start Recording Procedure
1.

Go to Home > StreamPix Settings > Auto Naming, and set up you auto-naming scheme.
When enabled, you won’t be prompted to chose a name for the destination file when
doing a New Sequence On Disk, New AVI On Disk (etc). See “Auto Naming
Settings”.

2.

Go to Home > StreamPix Settings > Recording to set your Recording settings. Selectan auto-created file (such as a “sequence file on disk”) and enable the auto creationof the file when the record button is pressed. See “Recording settings”.

3.

Set your recording manager. See “Recording manager settings”.

4.

To Record, select Home > Record.

To Record on Multiple Cameras Simultaneously
1.

Select Home > Select All Workspaces. The active Workspace becomes the Master, andall Workspaces are linked to it.

2.

Select Home > Record. All linked Workspaces record synched to the time stamp of the
Master Workspace. See “Master, Linked, and Stand Alone Workspaces” and“Master Workspace and Select All Workspaces”.

To Use a Recording Script
1.

Select StreamPix Settings > Recording manager > Use a recording script and select
Edit Script. The Recording Manager Editor opens, from where you can develop ascript. See “Recording Manager Editor”.

See also “Scheduling a Recording:”.

To Record in a Loop
1.

Go to StreamPix Settings > Recording > Limits.

2.

Set the Sequence limit to the number of frames to be captured in each loop.

3.

Enable Loop recording when limit is reached. Otherwise, the recording will simply
stop when the given number of frames is reached.

4.

Start recording.

To Playback a Sequence
See “Play Back a Sequence”.

NorPix Inc.

55

StreamPix 8 User Guide

3.3

HOWTO Export a Sequence
See also “Home > Selection group”.
To Export a Sequence
1.

Open the Sequence.

2.

Optionally, to export a part of a Sequence:a. Position the Time Slider at the first image of the part of the Sequence to beexported.
a. Select Home > Set First.
b. Position the Time Slider at the last image in the part of the Sequence to beexported.
c. Select Set Last.

3.

Select Application Menu > Export Selection To...

4.

Select the export format.

5.

Confirm the export format and file location.

6.

If exporting to anything other than a .seq file, set any other parameters required.

7.

Select Save.
The Sequence is exported to the specified location and format.
NOTE: To export the contents of the visible multi-display areas instead of a single

image, follow the procedure above, except in 3., select Export Multi-Display
area and follow the prompts.

56

NorPix Inc.

HOWTOs

3.4

HOWTO Use Auto Naming Schemes
Auto Naming schemes are defined in the StreamPix Settings > Auto Naming page. See“Auto Naming Settings”.

TIP: Enable StreamPix Settings > Recording > Auto-create file to automate file creation

using the Auto naming scheme. See “Recording settings”.

NorPix Inc.

57

StreamPix 8 User Guide

3.5

HOWTO Configure Output File Formats
Output file formats are defined through StreamPix Settings.
• For Sequence files compression settings and more, see “Sequence Settings”.
• For AVI file settings (codec, audio, etc.), see “AVI settings”.
• For .MOV (Quicktime files) see “MOV settings”.
• For image files (bmp, jpg, tif, etc), see .“More... settings”.

58

NorPix Inc.

HOWTOs

3.6

HOWTO Trigger a Software Event from an external
input line (I/O Manager)1.

Select StreamPix Settings > More... > I/O.

2.

Enable Input Control.

3.

Select OK. The I/O Manager dialog opens in the Docked dialogs area.

4.

Set the IO Manager parameters as described below.

I/O Manager docked dialog

Figure 3-1: I/O Manager docked dialog

This docked dialog shows information related to Input/Output actions. To create a new
action, double-click on the [Add new event...] line. To edit or delete an existing action,
double-click on the line describing that action. In both cases, the Input Action dialog isdisplayed.

Figure 3-2: Input Actions dialog

The Input Action dialog displays the settings of a new or existing action. There are several
parameters to set:
• Source: The general device name. All I/O devices detected by StreamPix are
shown in this list. A source can either be related to the grabber (i.e: frame grabberwith input lines) or an external IO device. A virtual I/O device is also available.

NorPix Inc.

59

StreamPix 8 User Guide• Device: Where more than a single Source device exists, the device number.
Typically, the device number is 0 (the first one).
• Line/Key: All available lines for the selected source are shown. Select the input
line to monitor.
• Polling delay: This is the interval at which the input line will get polled. If thevalue is too low, non-stop polling will be implemented, needlessly consuming
system resources. However, a very high value might miss an event. For instance,
if the input signal goes from level-low to level-high and back to level-low
between two polling actions, StreamPix 8 would not notice that an edge occurred.
NOTE: For analog I/O devices that require it, you can set the debounce delay inmilliseconds.

NOTE: Some devices use an interrupt, in which case the polling time is ignored. The

device interrupts the software when a line level change is detected. Interrupt
mode allows a faster response time since no polling is needed.
• Event: This is the event to monitor. The standard Level low, Level high, Risingedge & Falling edge are available. Typically, the software monitors the voltage
on the input line. Input lines have 2 levels, low or high, i.e.: 0 or 1, physicallyusually 0V versus 5V. A rising edge is a transition from 0 to 1, or 0V to 5V. Whena rising edge is required, the software waits for a transition from 0 to 5V, hence it
must read at least once a value of 0V then a value of 5V. A Level low detectionmeans that when reading the input line level, if the level is low the condition will
be immediately asserted as true. It will not wait until a level change.
• Action: This is the action to take once the event occurs. The available actions are:- Start Recording to start recording- Stop Recording to stop recording- Toggle Recording starts recording if it is not currently recording and stops if it
is.
- Line Testing is a dummy action and does nothing unless it is used in combination with the Log Action described below to test the input lines.
- Trigger Pre/Post Event triggers an event when in Pre/Post Trigger mode.
- Set event marker sets a marker on the current frame.
- Take Reference Time. See “Edit Reference Time”.
- Clear Reference Time.
- Snap Frame captures a single frame.

60

NorPix Inc.

HOWTOs- Start/Stop the frame grabber pulse generator. See “Frame Grabber Pulse
Generator”.
- Enable/Disable Live toggles the Live camera display.
NOTE: More actions will be added based on further developments and customer

requests.
• Target: Can either be Self to apply the action to the current Workspace only or All
Workspaces to broadcast the action to all Workspaces. All Workspaces allows
you to synchronize multiple Workspaces without having to configure their I/OManager panels separately.
• Event Name: Event name gives you the option to name a particular event rather
than use the default name made as the name of the device followed by the related
input line. For example, if the line is connected to a sensor that monitors a door,
the event name could be “Front door open”. The event name is used when the Set
Event Marker action is selected. It is not used otherwise.
• Log Action: If this is checked, each time the event is detected, StreamPix sends a
debug output to the system. The output can be displayed using Tools > Debug
Log. Use it with the “Line Testing” action to check that the lines are working
properly.
Select the Delete button to remove an existing action from the list. Select Cancel to abort
action editing. Select OK to accept changes made to an existing action or create a new
action.

Camera (Hardware) Trigger
To setup a camera trigger is different than to setup a software trigger action. A camera
trigger is typically called a hardware trigger to differentiate it from a software trigger.
A camera trigger is typically an input on the camera back panel. This input triggers asingle frame capture. For example, when a part goes in front of the camera, a sensor can
trigger a frame capture, resulting in grabbing an image into the software. No part: no
image.
Camera trigger is usually set via the camera hardware properties level where one candefine the trigger in/out line (a camera may have multiple input lines), trigger level(rising edge, falling edge, etc...) and trigger delay.
For example, if running with multiple cameras, but you want all of them to capture rightat the same time, you could send the same trigger signal to all the camera trigger inputs.

NorPix Inc.

61

StreamPix 8 User Guide

Audio Trigger
An audio trigger can be used to trigger a software event in StreamPix 8. For information
on how to set an audio trigger, see “Audio Trigger”.

Output Actions
For information on defining output actions, see “Enable Output Control”.

62

NorPix Inc.

HOWTOs

3.7

HOWTO Store / Retrieve GPS data as metadataThis section describes how to store and retrieve GPS data as image metadata while
recording or playing back.
To Save GPS data as image metadata
1.

Load the GPS/DMI module in a camera Workspace.

2.

Setup the GPS communication settings, such as USB/RS232 port and speed. When
the GPS delivers information, the decoded NMEA sentences will display in the GPS/DMI docking panel area. Depending the NMEA sentence, not all information may beavailable (e.g. Lat, Long, Alt, Speed, Time, Bearing, etc.)
NOTE: During recording, the GPS data can be displayed in an image overlay orburned into image data, depending on the selected display mode option.
3.

If in the GPS Device tab, you enable Save GPS data to file, a csv file is created during
the video recording. The file is located into the same folder as the sequence file, using
the save base name but with a .csv extension. The CSV file contains current GPS
information for each captured frame, but is not, however, retrieved during playback.

To save GPS data as extra metadata to be retrieved and displayed during playback
1.

Enable Metadata: Tools ribbon | Metadata manager

2.

Select Constant Size Calculator. A dialog will pop up. Select Extended GPS, and OK.

3.

Select Register Norpix Metadata Types to save the metadata information, and thenselect Save and Close.

4.

Open StreamPix Settings | Metadata. Select yes for Save metadata along with sequence
file.
During recording, GPS data will be stored as extra metadata, in a file with the same
name as the sequence file, with a .seq.metadata extension.

To view the recorded metadata during recording or playback
1.

Load Metadata Overlay Module and adjust some of the options. For example:
a. Overlay metadata On displayed frames
b. Check Extended GPS metadatac. In the Text tab, select font and position for the metadata.

For more information about the usage of metadata, see “Metadata settings”.

NorPix Inc.

63

StreamPix 8 User Guide

3.8

HOWTO Modify the GUI
You can modify the StreamPix 8 GUI to suit your work style.
StreamPix 8 lets you modify the GUI to suit the way that is most convenient to how you
work. You can also save different configurations for re-use later. For information on
customizing the default GUI, see “Interface settings”.

Modifying the Quick Access Toolbar
The Quick Access Toolbar can provide one-click access to any command no matter whichribbon is displayed. You can create a shortcut to any command available in either the
Application Button menu or the ribbon toolbars.
Add buttons to the Quick Access Toolbar
1.

Right-click on any toolbutton on any ribbon to display the right-click menu.

2.

Select Add to Quick Access Toolbar.

Remove buttons from the Quick Access Toolbar
1.

Right-click on any toolbutton on the Quick Access Toolbar to display the right-click
menu.

2.

Select Remove From Quick Access Toolbar.

Hide/Show buttons on the Quick Access Toolbar
1.

Select the Customize Quick Access Toolbar button on the Quick Access Toolbar (lastbutton on the right) to display the menu.

2.

Select toolbuttons to have them show, or deselect buttons to hide them.

Customize Quick Access Toolbar
1.

Right-click on any toolbutton on the Quick Access Toolbar to display the right-click
menu.

2.

Select Customize Quick Access Toolbar. The Options dialog opens, from where you
can browse all StreamPix commands.

3.

Browse to the command to add, highlight it, and select Add >>.

4.

Repeat Step 3 for each command to add.

5.

Select an added item and use the Up and Down arrows to order the toolbuttons.

6.

When done, select OK.
TIP: The Reset button restores the StreamPix 8 defaults.

64

NorPix Inc.

HOWTOsShow Quick Access Toolbar below the Ribbon
1.

Right-click on any toolbutton on the Quick Access Toolbar to display the right-click
menu.

2.

Select Show Quick Access Toolbar below the ribbon. The Options dialog opens, from
where you can browse all StreamPix commands.

Customize Keyboard Shortcuts
1.

Right-click on any toolbutton on the Quick Access Toolbar to display the right-click
menu.

2.

Select Customize Quick Access Toolbar. The Options dialog opens.

3.

Select Keyboard Shortcuts > Customize. The Customize Keyboard dialog opens.

4.

Browse the Categories and Commands until you reach the command to which toassign a shortcut. A brief description of each command is displayed when it isselected. If the command has a keyboard shortcut already assigned, it is listed in the
Current Keys field.

5.

Enter a unique value for the new keyboard shortcut. See “Keyboard Shortcuts”.

6.

Select Assign to make the keyboard shortcut assignation.

7.

Repeat Steps 4 to 6 for each assignation.

8.

Select Close when done.

To Remove a Keyboard Shortcut:
1.

Right-click on any toolbutton on the Quick Access Toolbar to display the right-click
menu.

2.

Select Customize Quick Access Toolbar. The Options dialog opens.

3.

Select Keyboard Shortcuts > Customize. The Customize Keyboard dialog opens.

4.

Browse the Categories and Commands until you reach the target command. The
assigned keyboard shortcut is listed in the Current Keys field.

5.

Select Remove to remove the keyboard shortcut assignation.
NOTE: The Reset All tool buton restores the keyboard shortcuts to the StreamPix 8

defaults. See “Keyboard Shortcuts”.

Minimize the Ribbon

NorPix Inc.

1.

Right-click on any toolbutton on any ribbon to display the right-click menu.

2.

Select Minimize the Ribbon.

3.

Alternatively, double-click in any ribbon.

65

StreamPix 8 User Guide

Saving your Configuration
Saving a configuration preserves all of the Workspaces, grabber and camera settings forlater re-use.

TIP: It is a good idea to save the configuration before making dramatic changes tosettings. That way, you can always go back to the saved version if some of yourchanges have unpredictable results.

To save customized configurations for later re-use:3.

Select Tools > Save. A Save As dialog opens to the StreamPix/Configurations folder.

4.

Optionally, browse to a different folder.

5.

Enter a meaningful name for this configuration and select Save.

To re-use a saved configuration1.

Select Tools > Load.

2.

Select the configuration file to use, and select Open.

3.

A Message confirms that the selected configuration will be loaded the next time that
StreamPix 8 starts. Select Yes to restart StreamPix 8.

4.

Answer Yes to any security prompts. StreamPix 8 starts with the selectedconfiguration.
TIP: There is no need to uninstall the software in order to reset the software settings.

Uninstalling would also wipe the registration and licensing information. See“HOWTO Restore Defaults”.

66

NorPix Inc.

HOWTOs

3.9

HOW TO Restore Defaults
When starting the application, it is possible to force StreamPix to reset its settings todefault values. Hold on Ctrl – Shift keys while starting StreamPix. This will pop up
the following dialog:•

Select Wipe all the workspace settings… to clear settings related toworkspaces, but keep all StreamPix related general settings.

•

Select Wipe all the StreamPix … to reload the default configuration.

If, as you work with StreamPix 8, you find that you may have changed some criticalsetting, StreamPix 8 offers several ways to recover settings:• StreamPix Settings > Session > Reset all workspaces... will erase all theWorkspaces while leaving the StreamPix settings intact.
• StreamPix Settings > Session > Reset all StreamPix settings to their default
values... restores StreamPix 8 settings to their default values.
TIP: If you have developed a configuration that suits your needs, then it is a goodpractice to use the Tools > Save Configuration option to protect your settings. To

Save and Reload a Configuration, see “Load/Save Configurations” onpage 208.

NorPix Inc.

67

4
Managing Workspaces and Cameras

This chapter explains how to set up and manage Workspaces and cameras in
StreamPix 8. This chapter contains the following sections:•

4.1 Overview•

4.2 Master Workspace and Select All Workspaces•

4.3 Controlling Workspaces•

4.4 Managing Grabbers and Cameras

Managing Workspaces and Cameras

4.1

Overview
Multiple Workspaces allow you to load multiple cameras and Sequences in a single
instance of StreamPix and to create and save preset settings for future use. Although every
grabber/camera must belong to a distinct Workspace, and a Workspace can contain only asingle grabber/camera, the same grabber/camera may be assigned to different
Workspaces, each with its own settings.
Workspace settings, including the grabber/camera settings, are preserved in theWorkspace from one session to the next. This way, when a Workspace is opened, thepreset grabber/camera settings will be reloaded. See “StreamPix 8 Basic Concepts”.

NOTE: In the StreamPix 8 Single Camera version, only one Workspace is possible.

Workspace Manager
To open the Workspace Manager, do one of the following:• From the Menu bar, select the Workspace tab, and then select the Workspace
Manager buttonOr,• Double-click in an empty space of the Workspace bar.
The Workspace Manager controls which Workspaces are loaded and unloaded by using thecheckboxes. The Workspace Manager lets you create new Workspaces and, after selecting
a Workspace from the list, you can:• Reset it to factory settings• Make a duplicate of it• Rename or delete it.
NOTE: No two Workspaces can have the same name.

NOTE: When you create a new Workspace, you are prompted to assign a camera or
grabber to it. To bypass this step, select Cancel.

NorPix Inc.

69

StreamPix 8 User Guide

4.1.2

Workspaces and Multi-displays
Although multiple Workspaces may be open at any time, only one Workspace can be
active at a time. The active Workspace is the one containing the Active Status icon. Clickin any Workspace to make it the active one. See “Set up Workspace(s)”.
When a workspace is opened, a tab for it is displayed in the Display Area and theassociated Docked Dialogs, including any open modules, are displayed in the Docking
panel.

Caution: Don’t confuse the Workspace with the contents of the Display Area. You
can toggle the display on and off using Display >On/Off, and the display of
the Docking Panel by selecting Home > Show Docking Panel, but theWorkspaces will still remain open. See Chapter 6 Managing the Display.

Parameters set in Home > StreamPix Settings are always global and apply to every
Workspace. Many of these settings can be overridden for the current Workspace (or groupof Workspaces) from the Workspace tab. For example, you can change the working folder,the (customtoken) and everything in Workspace > Workspace Settings, or assign a custom
recording script. If Home > Select All Workspaces is enabled, the command is broadcast to
every Workspace.

To open or close a Workspace
1.

Select Workspace > Workspace Manager.

2.

Select the Workspace(s) to open, or deselect the Workspaces to close.

3.

Select Done.
TIP: Click the X button on the right of a Workspace tab to close the Workspace.

See also “To Set up Workspaces:” and “Managing Grabbers and Cameras”.

70

NorPix Inc.

Managing Workspaces and Cameras

4.2

Master Workspace and Select All Workspaces
StreamPix 8 provides two ways to collectively control multiple Workspaces:• Designating a Master Workspace forces all Workspaces to synchronize playback
and browsing with the Master Workspace, as long as StreamPix Settings >Playback > Enable sychronization across workspaces has been enabled.
Synchronisation is done either on the frame index or on the time stamp,depending on the Playback settings. See “Playback settings”. If no Master isdefined, playback is done independently for each Workspace.
• The Home > Select All Workspaces (CTRL+A) option is used to control multiple
Workspaces simultaneously. Commands, such as switching between Live andPlayback and those associated with playback and recording, including theworking folder, the customtoken and everything in Workspace > Workspace
Settings, or assigning a custom recording script will be broadcast to all selected
Workspaces. Individual Hardware properties & Live adjustments will not be
broadcast.
NOTE: When Select All Workspaces is enabled, toolbuttons with actions that will beapplied to all Workpaces will change their icons to show the Link (Select All
Workspaces) icon as part of their icons.

To set a Master Workspace:1.

Select Workspace > Master Workspace. The currently active Workspace becomes the
Master, and the Master icon is added to its tab.

2.

Double click on a Workspace tab to quickly set/unset it as the Master.

To Select All Workspaces:
1.

Select Home > Select All Workspaces. All available Workspaces are linked, and theactive Workspace becomes the Master.

2.

Optionally, to exclude certain Workspaces from either type of group control, selectWorkspace > Stand Alone Workspace. (See below.)- Select the Workspaces to ignore in Multi-Controlled actions.

Stand Alone Workspace Control
The Workspace > Stand Alone Workspaces dialog lets you specify a list of Workspaces toignore when using both Master and Select all Workspaces options. Regardless of Master
Workspace and Select All Workspaces options, if a Workspace is included in the Stand
Alone list, it will act as a stand-alone Workspace. It will neither respond to broadcast
commands nor broadcast its commands.

NorPix Inc.

71

StreamPix 8 User Guide

For example: If you have Workspace1, Workspace2 and Workspace3, and Workspace 2 isset to Stand Alone, and Select All Workspaces is selected.
• If Workspace 1 is the current Workspace and you press Record, Workspace 1 and3 will record.
• If Workspace 2 is the current Workspace and you press Record, only Workspace
2 will record.

72

NorPix Inc.

Managing Workspaces and Cameras

4.3

Controlling Workspaces
NOTE: References to multiple Workspaces apply only to the StreamPix 8 Multi-

camera version. In this section, toolbuttons that do not apply to StreamPix 8Single Camera version are marked by an asterisk * and are unavailable in the
GUI.

Workspace Control
Previous Workspace *Sets the previous Workspace in the Workspace list as current/active.

Next Workspace *Sets the next Workspace in the Workspace list as current/active.

Close Current Workspace *Closes the current Workspace. This can also be achieved by clicking on the [X] buttonin the Workspace tab.

Customized Workspace
Working Folder *Opens a file explorer dialog from where you can change the default folder used for saving
files created by the current Workspace. If Home > Select All Workspaces has been selected,
the change will affect all connected Workspaces. (See “Workspace(s) settings.” onpage 198).

Recording Manager *When using a Recording Manager lets you specify a custom recording script for thisWorkspace. The default Recording Manager is defined in StreamPix Settings > Recording
Rate > Edit Script. See “Recording Manager Editor”.

Workspace Color *Sets the Workspace tab and Docked Dialog color associated with the currently selected
Workspace to facilitate working with multiple workspaces. The tab font color will either
be white or black depending on the chosen color.

NorPix Inc.

73

StreamPix 8 User Guide

Select Time Source
StreamPix image time stamping is typically performed when the image is received fromthe camera driver API. Because of that, it does not correspond to the exact time at which
the camera sensor is exposed. The delay is typically equal to the sensor read out time plus
the transfer time needed for all pixels to be received inside the computer memory plus thetime the Windows Thread Scheduler needs to notify StreamPix that a new frame is ready.
This total time is dependent on the capture media and some other parameters such as the
pixel clock. At worst, when the media bandwidth is at its maximum, the time stamp can be
off by up to 1/fps. The same time base is shared among each workspace. This allow all
workspaces to work from the same time reference and makes sure all the time informationis consistent.
By default, each captured image is time stamped using the current System Time. However,Streampix supports various other possible time sources, provided you have purchased theExternal Time Source option. You can then change from the default time source to someother supported time source.
You can also specify a time offset to be applied to the time stamp of each frame. If you
capture DAQ data, the DAQ device will also use the Workspace selected time source.

NOTE: If Home > Select All Workspaces has been selected, changes here will affect allconnected Workspaces.

74

NorPix Inc.

Managing Workspaces and Cameras

External Time Source options

Select the Time Source button to open the Time Source dialog.

Figure 4-1: Time Source dialog

NOTE: Besides System Time, all other options require the Accurate Time Stamp

option.

The available time sources are:
System Time: Uses the computer local clock. The software can resynchronize its timereference to the computer clock on a regular basis to avoid time drifting. See“Periodically resynchronize the timebase”.
Linear Time Code (LTC): Used to identify frames individually by a unique frame number.
The value is HH:MM:SS:FF, with FF being a frame number, from 0 to 24, 25 or 30
according current LTC mode with or without drop frame mode. LTC time code is stored inplace of the 4 first 8 bit pixels of the image (top left corner), as well as in extra metadata.
The following 4 time sources are LTC related:• AEC-LTC Clock: Uses system time for image time stamping, and appends for eachframe. Requires an extra LTC reader PCIe card and append LTC.

NorPix Inc.

75

StreamPix 8 User Guide• Audio Input LTC Clock: LTC being an audio signal, it can be fed to the computer
audio input (left line-in or left mic-in). The module decodes the audio signal anduses it to tag each frame with current LTC information.
• Horita TCBTX bluetooth: Uses a Horita bluetooth-capable LTC receiver for
wireless LTC decoding. Because of the Bluetooth latency, the LTC can be off by
a few frames.
• Ambient/MIDI: LTC decoding from a MIDI-capable device.
GPS Time Source: Uses the GPS NMEA (National Marine Electronics Association) string

messages containing time information as a time source. The precision of the referencetime depends on the GPS devices, the type of NMEA string available and thecommunication baud rate.
• For best precision, the module expects the ZDA NMEA string. If no ZDA isavailable, it defaults to RMC, and eventually GGA. RMC and GGA string time
information are less accurate than ZDA.
• Baud rate should also be set to the maximum possible rate to allow fastcommunication speed and better accuracy in between the real GPS time and theframe time stamping.
Information related to the GPS device (COM port, speed…) must be set via the Settings
page.
This time source can be used in conjunction with the GPS/DMI Positioning module. In
which case, both the time source and the module will share the received NMEA string. In
the GPS/DMI module, make sure to select the NMEA Shared GPS device in the device
list. See “GPS / DMI Positioning”.
A 10 Hz ZDA output typically includes 2-digit precision (10 milliseconds), but because it
is sent through RS232 com port, the communication speed is not very fast, and it isasynchronously received at the computer level. Hence, once StreamPix interprets thestring we have measured a possible accuracy jitter of 10 to 50 milliseconds. This meansthat by the time the GPS device outputs the NMEA string with the proper ZDA time
information, the time is already past. The computer continues to pull characters from theserial com port at fairly slow speed. For instance, a 9600 bds takes a few more
milliseconds to transmit each character. All this adds some variability in the accuracy ofthe decoded time.
Once the whole time is decoded, the time source compares the last received time with thecurrent running time received from the previous messages. Two things can happen:• The current running time is ahead of the received time: this time is ignored to
avoid going backward.
• The current running time is late versus the received time: the running time is set
to run at a faster pace to keep up with the received time.

76

NorPix Inc.

Managing Workspaces and Cameras

All this leads to some small variability in the accuracy of the received time, especiallybecause Windows is not a real-time OS and lacks predictable time slices allocated forrunning processes.
Server Time Source: The Server Time Source uses a new utility allowing for time handlingwith a much better accuracy than the previous Server Time Source. Please refer to theproject www.windowstimestamp.com for further details.
When selecting that time source, the G_Kernel.exe utility will be started in the
background when StreamPix starts and stopped when StreamPix quits. Since
G_kernel.exe requires some low-level access, the Windows User Account (UAC) control
dialog may pop up. You may want to lower the warning level of the UAC settings to
avoid the prompt each time.
Server Time Source supports all of the features listed in the Windows Time Stamp
project: NTP sync is possible from any internet NTP server, as well as time based
synchronization. Simply start the G_GUI.exe utility provided from the C:\Program
Files\Common Files\Norpix\Timesources\WindowsTimeStamp folder tobrowse for the various options.
Spectracom TSAT/TPRO/TSYNC: Uses an external PCIe device from Spectracom. The

board can be either genlocked to a GPS signal or IRIG B timebase. Accuracy is within the
microsecond. Upon receiving a new frame, StreamPix reads the time inside the device
registers.
Spectracom TSAT/TPRO Event: Uses an external PCIe device from Spectracom. The time

capture input of the board captures with precision when the frame was captured. External
exposure signal must be provided to the board time capture input.
Meinberg Device: Uses Meinberg time receiver devices: GPS based, or IRIG B base. The

device plugs into the computer as a PCIe card or a USB device. Accuracy is within the
microsecond. Upon receiving a new frame, StreamPix reads the time inside the device
registers.
Meinberg Device Event: Uses Meinberg time receiver devices: GPS based, or IRIG B base.

The devices plug into the computer as PCIe cards. The time capture input of the board
captures with precision when the frame was captured. External exposure signal must be
provided to the board time capture input.
Symetricom Devices: Uses a Symetricom time capture device. The device plugs into thecomputer as a PCIe card. Accuracy is within the microsecond. Upon receiving a newframe, StreamPix reads the time inside the device registers.
Brandywine devices: Uses a Brandywine time capture device. The device plugs into thecomputer as a PCIe card. Accuracy is within the microsecond. Upon receiving a newframe, StreamPix reads the time inside the device registers.
For the latest list of supported time devices, see: http://www.norpix.com/support/
compatibletimesource.php

Use the dropdown list to assign to which stream the offset is applied. You can apply adifferent time offset to each stream (video, audio, DAQ).

Workspace Settings
NorPix Inc.

77

StreamPix 8 User Guide

The Workspace Settings button opens a dialog from where you can override the default
AVI, Color Processing, Recording, and Sequence settings for the currently active
Workspace. The Advanced tab lets you determine StreamPix Quick Save behavior when
all Workspaces are selected.
By default, these settings are defined via StreamPix global settings and apply to all
Workspaces unless they are overridden via this dialog.

78

NorPix Inc.

Managing Workspaces and Cameras

To change the Workspace settings
1.

Select Workspace > Workspace Settings. A dialog opens with tabs for
Workspace_Name Settings > AVI | Color Processing | Recording | Sequence | Advanced.

2.

Select the Override StreamPix Settings box.

3.

Set the parameters that you want to change. See “AVI settings”, “Color Processing
settings”, “Recording settings”, and “Sequence Settings”.

4.

Select OK. The new parameters are applied to the current Workspace(s).

Advanced Workspace settings

The Workspace Settings > Advanced tab lets you set the behavior per Workspace when the
Home > Quick Export button is selected. The options are:• Always QuickSave: The default, the Sequence will always be saved according to
the Settings > More... > Quick Export parameters. See “Quick Export” onpage 201.
• QuickSave if focussed: The Workspace must have the keyboard or mouse focus
for the Quick Export to be performed.
• Never QuickSave: The Quick Export command will be ignored for thisWorkspace.

Auto-Naming Tokens
Increment
Allows you to see and edit the current value of the (increment) token used in some autonaming schemes. If all Workspaces are selected, the change is applied to every
Workspace.

Custom Token
Allows you to set a value for the (customtoken) for the current Workspace. If blank, theWorkspace will use the default token set in StreamPix Settings > Auto Naming. If all
Workspaces are selected, the change is applied to every workspace. See “Auto Naming
Settings”.

NOTE: To be used, the (customtoken) must be included in the auto-naming scheme
defined in StreamPix Settings > Auto Naming.

NorPix Inc.

79

StreamPix 8 User Guide

Edit Default Token
Edit the default (customtoken), as set in StreamPix Settings > Auto Naming. Every
Workspace that uses (customtoken) in its filenaming schemes will use this value.

Recording Manager
If in StreamPix Settings > Recording Manager you enabled Save one frame every x frames,
this slider is used to set how many frames are skipped between each saved frame. For
example, if the camera frame rate is 30 fps, using a value of 1 in 15 will save 2 frames
every second. See “Recording Manager settings”.

80

NorPix Inc.

Managing Workspaces and Cameras

4.4Managing Grabbers and Cameras

Camera/Frame Grabber
Load

Selecting the Load Grabber button lists all supported grabbers/cameras, allowing you toselect the one to be used. You can also use this option to reload the camera with its default
settings or load custom camera settings from an .xml file (created from Export Settings).
Duplicate Camera Stream

This will show a dialog with all Workspaces loaded. Select a Workspace to get a copy of
every frame captured by that Workspace camera. This can be useful if you want to save a
stream to two different formats at the same time. (Not available in the Single-Camera
version.)
UnloadUnloads the current camera (or duplicate), if any.
ReloadReloads the current camera. Use this after changing the buffer count for a camera. (Buffers
are allocated when a camera loads.)

Settings and Adjustments
Hardware Properties

Settings shown in Hardware Properties require the camera to stop streaming, as they cancause modifications in the image format, requiring buffer reallocation and other profoundchanges in StreamPix. For instance, modifying the ROI (region of interest) and capture bit
depth (8 bits / 16 bits) hardware settings will change the image format. As such, accessing
Hardware Properties while the camera is in Live mode will automatically suspend Live toenable setting modifications.
Live Adjustments

Live Adjustments are grabber settings that can be changed while the camera is streaming,as they do not affect image format. For instance on most cameras, exposure, gain andbrightness are adjustable in Live mode. Accessing Live Adjustments while the camera is
not Live will automatically start the Live process. On most cameras, every setting in Liveadjustment will be also available in Hardware Properties, although the opposite is notalways true.

NorPix Inc.

81

StreamPix 8 User Guide

Advanced Settings

Advanced settings are available on some models of GigE cameras.
Export Settings

Export the current camera settings to an .xml file.

Buffers
Buffer count

Changes the number of buffers allocated by the grabbers in this workspace. If 0 is used,
the grabber will use the default value set in Streampix Settings > Workspace(s). See“Default read-ahead buffers”.

NOTE:

Reload the camera after changing the buffer count.

Miscellaneous
Show Image Information

This lists complete information on the format of the frames received from the grabber.
Watchdog

Here you can specify a timeout value in seconds. When the specified length of time
elapses without a new frame being sent by the camera, a yellow warning sign is shown inthe display area. Useful, for example, if you want to get a visual notification when acamera has been disconnected.

82

NorPix Inc.

5
Using Audio and DAQThis chapter contains information on working with Audio and DAQ files. This
chapter contains the following sections:•

5.1 Audio and DAQ Overview•

5.2 Managing Audio•

5.3 Managing DAQ.

NOTE: The Audio and DAQ modules each require a specific license.

StreamPix 8 User Guide

5.1

Audio and DAQ Overview
StreamPix 8 lets you record synchronized audio and/or DAQ data in conjunction with thevideo within a single or multiple Workspace. Recording video and DAQ can be suspended
and resumed into the same DEQ+DAQ files.
StreamPix 8 typically uses a Sequence file (.seq) for the video along with an audio and/or
DAQ file. The audio file extension is .aud, and DAQ is .daq. The Audio and DAQ tabs areadded to the menu bar once you have acquired the appropriate licenses.
Each Workspace can have (or not) Audio, DAQ, and video. The buttons in the Audio &DAQ tabs interact with the audio and DAQ files of the active Workspace.
The following lists the audio and video capabilities of StreamPix 8:• Simultaneously recording video and audio to AVI
Simultaneously playback video and audio from AVI• Recording video to MP4
Recording video to TS• Simultaneously recording video to SEQ and audio to AUD
Simultaneously playback video from SEQ and audio from AUD• Simultaneously recording video to SEQ and audio to WAV/BWAV
Simultaneously playback video from SEQ and audio from WAV/BWAV• Simultaneously recording video to SEQ and audio to AAC
Simultaneously playback video from SEQ and audio from AAC• Simultaneously recording video to SEQ and audio to MP3
Simultaneously playback video from SEQ and audio from MP3
NOTE: If you recently updated StreamPix to use Audio and/or DAQ modules, andyou do not see the Audio and/or DAQ tabs on the ribbon, you may need to
update the configuration file as follows:
1. Go to Settings > Interface > Customize Ribbons.
2. Select Restore Defaults and OK.
3. Restart StreamPix.

84

NorPix Inc.

Using Audio and DAQ

File Types
StreamPix 8 supports the following audio and DAQ file formats:
File Type

Description

Audio files (.aud)

A raw audio file supported by StreamPix 8 and including timestamp information allowing random sync between audio, video
and DAQ data.

NorPix DAQ file (.daq)

Data acquisition file for all the DAQ related data. Includes DAQ
samples as well as some time stamp information

DAQ Graph Settings(.display)

The DAQ Graphs settings associated to a specific DAQ file.
Table 5-1: StreamPix Audio and DAQ file types

Here is an example of the files generated for a Sequence named “Capture” that has bothaudio and DAQ.
• Sequence: Capture.seq• Audio File: Capture.aud• DAQ File: Capture.daq• Graph Settings Files: Capture.daq.display.

NorPix Inc.

85

StreamPix 8 User Guide

5.2

Managing Audio
The Audio tab is added to the menu bar once you have acquired the appropriate license.

Audio tab
The Audio tab contains specific tools to manage audio. The settings in the Audio tab
interact with the audio files of the active Workspace. You can set separate drivers for boththe input (Audio Driver area) and the output audio (Audio Output Driver area). The contentsof the Audio Settings dialog boxes are dependent on the selected driver.

Audio Driver and Audio Output Driver
DriverUse the drop-down list to select the audio driver to use: ASIO, DirectX or Grabber. The
DirectX driver is compatible with almost all sound cards supported by Windows.
The ASIO driver requires an audio input device that is ASIO compatible. The ASIO driveris limited only by the number of inputs on the external audio device. Most devices that
support more than 2 audio inputs simultaneously have an ASIO driver. On the other hand,most devices that have a DirectX input driver can handle only 2 input channels (left andright).
Audio Settings

The Audio Settings dialog box lets you customize the audio format for the recording. In the
dialog box for the DirectX driver you can set the input (recording) and output (playback)devices along with the input and output formats. The #Samples is the number of audio
samples per buffer. Using a larger value may help reduce audible noise and “clicks” during
playback.
By default, you should select the largest #sample available (this may be hardware
dependant).
The audio synchronization with the video is “by buffer”: each buffer includes its timestamp information. Short buffers result in a smaller granularity for synchronization. For
example, when sampling at 44.1kHz, there are 44.1k samples per second. Hence a 4096
buffer size will result in about 44100/4096 = 10 synchronization points per second ofvideo. At 30 fps, that will result in audio synchronization with video at more or less 3
frames.

Recording
Target

Use the drop-down list to select the target file format for recording. The choices are:86

NorPix Inc.

Using Audio and DAQ• None: meaning that no audio file will be recorded.
• AUD: A NorPix proprietary format which stores raw/lossless audio.
•

BWAVE [definition needed]•

MP3 [definition needed]• AAC: Advanced Audio Coding provides lossy digital audio compression similar
to MP3, but with generally better sound quality at similar bit rates.
File Info

This shows some information about the current audio file, if any.

Audio Levels
Input Level

This shows the current volume level of the input device. You can use it to see if yourdevice is hearing anything. You can use the drop-down list to select which channel(s) of
the audio device to monitor.

Audio Output Driver
The Audio Output Driver area lets you select the output driver and hardware device.

Playback Position
The Playback Position displays the start and stop position for the current recording. You
can edit the start position for playback.
Audio buffer usage monitor

When recording, audio buffer usage is monitored and displayed in the Docking panel. If
buffers run out, an Audio Packet Drop event is generated and stored in an XML file and awarning pops up in the Information Bar.

Figure 5-1: Audio buffer usage monitor

VolumeOutput Volume

This slider allows you to adjust the audio volume for playback.

NorPix Inc.

87

StreamPix 8 User Guide

5.3

Managing DAQDAQ stands for Data Acquisition, which is a way of sampling information from the realworld to generate data that can be manipulated by a computer. The DAQ tab is added tothe menu bar once you have acquired the appropriate license.
Within StreamPix 8, DAQ is related to devices that perform analog to digital conversion
for electric signals, like voltage, heat, temperature, pressure, etc.
For example, DAQ will allow you to monitor and collect the temperature of a device while
also video recording it.
DAQ data are typically sampled at high frequency, like 1000 Hz, hence much faster than avideo frame. So, there are multiple DAQ data sets to display per captured frame. Also, atypical DAQ application will sample multiple signals (lines) in parallel. DAQ can be
sampled over 8 bit (256 values), or more typically 16 bit.
Audio is basically a DAQ data, typically sampled at 44.1 kHz, 16 bit. Stereo would be 2lines of data acquired in parallel.
DAQ is typically captured via DAQ frame grabbers, either PCIe boards or via a USB
interface. When exporting video with DAQ data, DAQ can be exported to DAQ/XLS/
CSV file container. Range selection is supported.
The DAQ global settings are set through the Settings > DAQ page.
When exporting, DAQ can be overlaid onto the image by using: File | Export | Display
Area.

Time calibrating video and DAQ data
For aligning the DAQ data to the video, a time calibration must be done. Video frames are
typically time stamped after exposing, readout and refer to the host, typically when theframe is received by the computer driver.
DAQ data are grouped into packets. Packets are also time stamped when received from theDAQ device streaming channel, following the digitization, buffering and streaming tohost. Digitization frequency, number of channels, streaming speed and packet size are all
factors that influence the time it takes for the host to receive the DAQ data.
Since the same time source reference is used for video, audio and DAQ, the latency
between these different data channels may cause the data stream time stamps to be out ofsync. At low fps, it may be unnoticed, however at high fps you might notice an alignmentgap.
As a work around, you need to “time calibrate” one stream to the other by selecting
Workspace | Time Source and adjusting the time offset for either the video or the DAQ
channel.

88

NorPix Inc.

Using Audio and DAQ

Since the DAQ channel is usually the fastest sampling rate, it is recommended to offset theslowest (video) time stamp. For example, running a camera at 50 fps, frame time is 1/
50=20 millisecond. The video time could be up to 20 ms late from the DAQ time stamp.

NOTE: It is important to recalibrate each time the DAQ parameters such as sampling

frequency and video capture rate changes, because latency varies.

DAQ data are received as packets, i.e. a dataset. Each dataset is time stamped upon being
received. Each DAQ sample time stamp is then calculated from its dataset time stamps,
based on sampling frequency and sample position in the dataset.
When exporting video and DAQ, the granularity is based on a whole dataset. As an
example, running a camera a 1000 fps, while the pooling delay is set at 10 millisecond,means a dataset will contain DAQ data for 10 frames. Exporting from frame 5 to 10, will
still result in exporting the whole 10ms dataset. Post data processing will be needed to get
rid of the unneeded DAQ.
When possible, we recommend setting the pooling delay close the camera sampling
duration to allow better matching granularity.

The DAQ (Data Acquisition) tab
The DAQ (Data Acquisition) tab provides the following tools for working with DAQ.

DAQ Driver area
DriverUse the drop-down list to select the DAQ driver to use. The DAQ module option is onlyused by 3rd party modules using DAQ. The NorPix Virtual DAQ driver can be used tosimulate a DAQ device to generate simulated readings.
DeviceUse the drop-down list to select the DAQ device to use. Selecting a different driver willchange this list according.
Lines Configuration

NOTE:

The Lines Configuration dialog is hardware specific.

The Lines Configuration dialog allows you to set up the DAQ device. The list shows one
line for each input channel. Selecting a row in the Acquire column instructs StreamPix to

NorPix Inc.

89

StreamPix 8 User Guide

record data read from this channel. Line is the line ID. Name is an editable string used tolabel each channel. By default, if a channel has not been given a label, it will be labeledafter its line ID value.
Often, the signal from a device will have a value between -1 and 1. StreamPix can apply alinear conversion to each channel to convert the original reading to an accurate value. The
linear conversion use the Ax + b formula, with A/B being values in the “A/B” columns
and “x” being the value read from the device. The unit column is used to specify themeasurement unit (cm, km, kg, etc), this label is only cosmetic.
The dialog may also allow you to change the Analog Range.
The polling interval is the length of a single data set. A long interval will create larger data
sets which reduce overhead while streaming data to disk. A shorter interval will allows
greater granularity when browsing the data sets and a smother flow in the display graphs.
The sample rate of the DAQ device is specified in #reads per second.

NOTE: Some devices have additional settings accessible by selecting More Settings.

For instance, MCC1208HS include a way to use an external clock for defining thesampling frequency. More setting button allows you to enable that operating mode.

Activate DAQThis button toggles the DAQ acquisition on/off. If DAQ acquisition is enabled at the timea recording is started, a DAQ file will be created, and StreamPix will save the data
received from the device to a .daq file.

NOTE: Double-clicking in a DAQ Graph area will open the corresponding Graph

Settings dialog (Live or File).

DAQ Graphs area
Graph Settings (Live)
This dialog allows you to customize the display graph for each acquired channel. If Hide
Disabled Lines is selected, the list will not show the channels which were not selected for
acquisition in the Line Configuration dialog.
Each line of the list shows: the Line ID, the linear conversion it uses, the draw state andthe drawing context. To change the display property of a line, click on it and use thecontrols below the list. To change the properties of several lines at the same time, selectmultiple lines using Ctrl-click (atomic selection) or Shift-click (range selection).

90

NorPix Inc.

Using Audio and DAQ

Draw line

If checked, StreamPix will draw the data line for this channel in the target display area.
Line Color

The color used to draw the line in the graphs.
Time Range (ms)The length of the display graph in milliseconds (X axis). The time range is always sharedby all lines.
If the time range is shorter than the total length of the recording (it usually is), the graphonly show the values around the current position.
Target Display Area

By default, each channel has its own graph display. However, it can be hard to manage/view a lot of displays when several channels are active at the same time. This option
allows the user to regroup channels in a single graph display. To do so, use the drop-down
list to select in which display area you want to plot the channel data.
Selecting multiple curves

CTRL-click in a graph to select another curve.
Left-side scale (Right-side scale)

Use this section to customize the scale of the Y axis. Selecting “Automatic” will let
StreamPix dynamically adjust the scale to show the whole data lines. Selecting “Constantvalues” will allow the user to specify the minimal (bottom) and maximal (top) values for
the Y axis.
There can be a scale on the left side of the graph and a different one on the right side. Thisis useful when you want to plot several data lines that don't share the same data range or
don't use the same measurement units.
Chart Merge Settings

This section allows you to assign the data line to either the left-side or right-side scale of
the graph. If the line uses a different display area than its own, the scale refers to the scales
defined in the target display area. Selecting Scale-free will make the data line use the fullrange of the graph without any regard for the values of its Y-axis scales.

NorPix Inc.

91

StreamPix 8 User Guide

Plot the current image underneath the graph

Selecting this option will draw the sequence image at the current position underneath thegraph. If you select this option, make sure to choose line colors that have a good contrast
with the video images.
Restore default settings for the selected line(s)Click on this to restore the default graph settings for the selected line(s).

Graph Settings (File)
This uses the same dialog as the Graph Settings (Live). When recording from a DAQ
channel, the current Graph Settings (Live) are saved along with the DAQ data file (in a.display file). When reloading a previous DAQ file, its graph settings are reloaded alongwith it. The Graph Settings (File) allows you to modify the existing graph settings. Anychanges made are saved to the display file. Editing this won't change the graph settings offuture DAQ recordings.

Playback Position area
Current Data Set

The index of the current data set. Using the edit box, you can change the current index andStreamPix will update the graphs accordingly. Left-clicking anywhere in a graph itself
will change the current data set to the one located under the current mouse position.
Total Data Sets

The total number of data sets in the .daq file.

Time Range area
A pull-down menu allows you to directly select the wanted range. Or, you can type in thedesired range. Values in the drop-down list are customizable from Settings > DAQ These
will decrease or increase the time range of the currently selected graph by a fixed time
length (see “DAQ settings”).

Export area
Export To .XLS

This allows you to export the content of a DAQ data file in Microsoft Excel® .xls format.

92

NorPix Inc.

Using Audio and DAQ

Export To .CSV

This allows you to export the content of a DAQ data file to a CSV (Comma Separated
Values) text file. CSV files are simple text files that can be opened in Microsoft Excel®,Open Office Calc®, and many other 3rd party applications.
Export with Image

DAQ can be exported overlaid on the image by using: File | Export | Display Area.

NorPix Inc.

93

6
Managing the Display

This chapter explains the display management tools available in StreamPix 8. This
chapter contains the following sections:•

6.1 Display Tools•

6.2 Controlling Multiple Cameras

Managing the Display

6.1

Display Tools
You can use the display settings to customize the look and feel of StreamPix 8 to suit yourneeds. The default display settings are set through the StreamPix 8 Settings > Interface andDisplayed Data pages. See “Interface settings” and “Displayed Data settings”. The Display
tab lets you customize settings for the active Workspace and, if Home > Select All
Workspaces is selected, for any associated Workspaces. Other tools for controlling thedisplay are located on the Home and Workspace tabs.

Modifying the GUI
You can modify the GUI to suit the way you work. You can even save alternate GUI
configurations for re-use later. See “HOWTO Modify the GUI”.

Display Tab
The Display tab contains the following groups of tools:
Display Group
Switch Display

In either single or multiple display mode, the Switch Display button brings to the front
the next display area. A Workspace can have a several display areas:• Live• Sequence / AVI• An audio file
• DAQ
• Other (typically added by an external module like LineScan viewer, SimulPix,
Live Levels, Sequence Levels...
Toggle Display

Toggles the display of images on/off. On slower computers, it is recommended todisable the image display to alleviate some CPU load while recording.
Full Screen

Toggles the Full-screen mode on, causing the display area to cover even the
Windows taskbar. Use the F12 key to toggle back to regular mode.

NorPix Inc.

95

StreamPix 8 User Guide

Overlays

Enables or disables the Workspace Status overlay icons (sequence, live, record, etc.). See“Workspace Status Icons”.
Set Background ColorThis allows you to change the color of the display area in which images are displayed. The
display area is white by default, so if the captured images have white borders, changing
the background color will help to clearly see the borders. For low light conditions, a dark
red color is often preferred.
Time Overlay

The Time Overlay button pops up the time overlay dialog in the docking panel, replacing
the old Time Overlay Module.
The Time Overlay allows you to “burn” the time stamp associated with each image
directly on the image itself or have it overlay (no damage to the image data). This can be
useful when capturing/exporting to AVI or image files because those formats don't havetime stamp support.

The time can be written as absolute or relative to the first frame of the sequence. Various
schemes can be selected for formatting the time stamp. Contact NorPix if a specificscheme is required. It can easily be added.
In the Font & Position tab, you can specify the font type and size. For best results, use
fixed width fonts such as Terminal or Courier.
Use Change Font Color and Change Background Color to set the text overlay colors. If
the text background color is the same as the font color, no background color will be used
resulting in a transparent background. When working with monochrome images, nocolor is available.
The image location can be one of the 9 pre-defined positions or a custom position can be
set by specifying a precise horizontal & vertical offset.
Zoom Group

The Zoom group of tools let you enlarge or reduce the display of the active image.
Individual Zoom tools let you zoom on the XY axes, X axis or Y axis only, and fit image
to window or window to image. Mouse over an icon to see a description of what that tool
does. The Zoom tools work by increments of 10%. Reset Zoom to 100% will reset theimage size to 1:1 ratio. As having the zoom set higher or lower than 100% will use a bit ofCPU, it is recommended to leave the zoom at 100% while recording, to free as much CPU
96

NorPix Inc.

Managing the Display

as possible

for the recording process.

NOTE: Not all grabbers/cameras support all of the zoom features. If tools areunavailable, it is due to hardware limitations.

Multi-Display Layout

The Multi-Display Layout buttons allow to configure the multi-display rows and columns.
The choices are 2x1, 1x2, 2x2, Custom, and Auto-Fill. Once the layout is done, you canassign a display to each area by right-clicking in each and selecting from the dropdown
list.
The Custom button lets you click-and-drag to specify a specific number of rows andcolumns. It also contains a Complex Layout option where you can click-and-drag to draw
your own custom layout.
The Auto-Fill button creates enough rows and columns to show the active display of every
Workspace and automatically fills the areas.
• To add a Workspace, see “Set up Workspace(s)”.
• To add a camera to a Workspace, see “Load Camera(s)”.

NorPix Inc.

97

StreamPix 8 User Guide

Hybrid Mode

The Hybrid Mode lets you toggle the Hybrid display which is a mix of single & multidisplays. In Hybrid mode, the display area is split in two. One side is the regular multidisplay area, and the other side shows the currently selected display. The number ofcolumns and rows in the hybrid multi-display area can be customized with the usual
controls. You can also change the position and size of the hybrid display area. The multidisplay area will be resized accordingly.
Thumbnails View

Thumbnails View lets you see the individual frames in a Sequence as thumbnail images.
Select Enable to toggle Thumbnail View while the Sequence is in playback mode. The
Plus and Minus buttons increase or decrease thumbnail image size. The table below
describes Thumbnails View toolbuttons.
Toolbutton

Description

Toggle Thumbnail View on/off. The dropdown list contains options
to number the images in the Sequence and set a sub-sampling
rate.
Scroll thumbnail display one page up.
Scroll thumbnail display one page down.
Scroll thumbnail display one line up.
Scroll thumbnail display one line down.
Increase thumbnail image size.
Decrease thumbnail image size.
Table 6-1: Thumbnails View toolbuttons

Select a thumbnail to move the playback position in the Sequence Slider to that image.
Double-click a thumbnail to change the display back.

NOTE: Toggling between normal and thumbnail view may takes a bit of time,

because the software must read a significant amount of data to generate thethumbnails before displaying them.

98

NorPix Inc.

Managing the Display

Refresh Rates
The Single Display and Multi-Display Refresh Rate let you adjust the refresh rates for the
display areas. These sliders only affect the display refresh speed, meaning that there is noeffect on the camera frame rate or the capture rate. If the StreamPix 8 window has trouble
redrawing itself, or if there is a noticeable command input lag, lowering the refresh rateshould help responsiveness by reducing the CPU usage.

Other Display Controls
Not all of the display controls are on the Display tab. There are also the following tools.
Home > Show Docking PanelShow or hide the Docking panel in which the docked dialogs appear.
Home > Multi-Display(Not available in the Single-Camera version) Toggles between single and multi-display
modes. Multi-display allows you to see multiple displays simultaneously. For example,
you could display both the live feed and a sequence playback at the same time or see all ofa Workspace sequences at the same time.
The Home > Multi-Display dropdown list contains the same display tools described in“Multi-Display Layout”.
Workspace > Workspace Color

Sets the Workspace tab and Docked Dialog color associated with the currently selected
Workspace to facilitate working with multiple workspaces. The tab font color will either
be white or black depending on the chosen color.

NOTE: Do not confuse this with the Display > Background Color option. See “Set

Background Color”.

Home > StreamPix Settings > Displayed Data

Used to determine the image information data to be displayed in overlays. See “Displayed
Data settings”.

NorPix Inc.

99

StreamPix 8 User Guide

6.2

Controlling Multiple Cameras

Figure 6-1: Multiple camera display

NOTE: Available in Multi-camera version only.

To control multiple cameras at once, a separate Workspace needs to exist for each one.
Once your cameras are loaded, StreamPix 8 Multi-Display capabilities can display
multiple feeds simultaneously. Multi-Display mode is toggled from Home > Multi-Display(which also has a drop-down menu for the most common Multi-Display options).
There are two options for viewing the Live feed and the associated Sequence file:• Live feed and Sequence share a display area: If, from the display area right-clickmenu you select Enable Auto-switch between Live and Playback, you can selecteither the Live or Sequence icon from the Workspace tab to toggle between the100

NorPix Inc.

Managing the Display

two modes. If both the Camera and Sequence have been loaded, the Display >Switch Display toolbutton has the same effect.
• Live feed and Sequence use separate Workspaces: If, from the display area rightclick menu you deselect Enable Auto-switch between Live and Playback, you cansee both the Live feed and the Sequence at the same time in separate viewing
areas.

NOTE: If, while using two separate Workspaces, you select the Display > Switch
Display toolbutton, both displays toggle in the same Workspace.

NOTE:

Two areas can not show the same display at the same.

To color-code the Workspace tab and the associated docked dialogs, see “Workspace >Workspace Color”.

NorPix Inc.

101

7
Controlling Light and ColorThis chapter describes how to control light and color in StreamPix 8. This chapter
contains the following sections:•

7.1 Bayer Conversion and Color Correction Primer•

7.2 Applying Processing•

7.3 Non-linear Remapping via ASC CDL Formula

Controlling Light and Color

7.1

Bayer Conversion and Color Correction Primer
A Bayer filter mosaic is a color filter array for arranging RGB color filters on a square gridof photo sensors. The term derives from the name of its inventor, Dr. Bryce E. Bayer ofEastman Kodak, and refers to a particular arrangement of color filters used in most singlechip digital image sensors used in digital cameras, camcorders, and scanners to create acolor image.
Bayer conversion is the process by which raw images from a Bayer camera are colorconverted using a Bayer interpolation algorithm. Some cameras equipped with a Bayerfilter will perform the color interpolation process before images are sent to output.
However, most cameras do not do this, leaving interpolation to applications like
StreamPix 8.
The filter pattern is 50% green, 25% red and 25% blue, and hence is also called BGGR,
GBRG, GRBG or RGGB depending on the color of the first pixel in a 2x2-pixel square.
Bayer's patent called the green photo sensors luminance-sensitive elements and the redand blue ones chrominance-sensitive elements. He used twice as many green elements as
red or blue to mimic the human eye's greater resolving power with green light.

Figure 7-1: Bayer Color Remapping

The raw output of Bayer-filter cameras is referred to as a Bayer pattern image. Since eachpixel is filtered to record only one of three colors, two-thirds of the color data is missing
from each. To obtain a full-color image, various demosaicing algorithms are used tointerpolate a set of complete red, green, and blue values for each pixel. Different
algorithms requiring various amounts of computing power result in final images ofvarying quality.
StreamPix 8 includes Bayer conversion functionality as well as strong color balancing andgrading. Color balance can be applied independently to any supported image format, i.e.
raw images, color YUV or RGB. Changes to the color balance, saturation and contrast,plus specific adjustments to shadows and highlights can all be performed using thesevarious tools.

NorPix Inc.

103

StreamPix 8 User Guide

Since a raw image contains all of the color information, StreamPix typically records
images from cameras as raw data. Because of the computational requirements, Bayerconversion and color grading is normally performed only when needed, namely when an
image is being displayed, exported to an AVI movie or exported to an individual image
file.
This has two advantages: raw image size is 3 times smaller than color images, and CPU
resources are conserved (Bayer rendering and color grading are quite computationintensive).

104

NorPix Inc.

Controlling Light and Color

7.2

Applying Processing
StreamPix 8 provides both Bayer Color Conversion and Color Correction settings that
may be applied separately, or used in conjunction. Bayer and Color Correction settings areautomatically saved and restored when reloading.
• Bayer Conversion Settings must always be done on an individual Workspacebasis, and based on the camera type. Different types of cameras may requiredifferent Bayer patterns.
• Color Processing settings may be set through either:- Home > StreamPix Settings > Color Processing page for settings that will apply
globally,or,- Workspace > Workspace Settings > Color Processing and Sequence pages forsettings that will apply to the current Workspace. You must select theOverride StreamPix Settings option for local changes to become effective.
NOTE: If All Workspaces are selected (CTRL+A), Bayer and Color balance will

apply to all Workspaces.
If all Workspaces are not selected, Bayer and Color balance will apply tocurrent Workspace only.

The Color Processing and Sequence parameters available are identical in either case. See“Color Processing settings” and “Sequence Settings”.

NOTE: Although it may be possible, there is no need to set the Bayer Conversion

format at the hardware level. Best results are achieved by making sure that thecamera delivers a raw image.

TIP: Multiple identical cameras may still require individual Color Processing settings

to compensate for local conditions, etc.

NOTE: Changing the camera ROI may change the Bayer pattern, depending where

the top left corner of the image is set.

NorPix Inc.

105

StreamPix 8 User Guide

Processing Levels
Both Bayer Conversion and Color Processing can be applied at the following levels:
At Grab Level: The selected processing will be applied on images as they are received fromthe camera. As this is the earliest time at which image processing can be done, the frames
will already be processed before being streamed to disk, displayed or exported. Thismethod requires significant processing power and typically triples the required streaming
bandwidth. All incoming frames from the video source are processed.
On Displayed Frames: the selected processing will be applied on images before they are

drawn in the display area. The processing will only be done if the frame is actually drawn
on screen. This process takes place at the end of the process chain and thus, doesn't affectframes before they have been recorded. Checking this will have no effect if At Grab Level
or On Exported Frames is also selected because the processing won't be done twice.
On Exported Frames: the selected processing will be applied on images before they areexported to another format. The source images remain unchanged.

106

NorPix Inc.

Controlling Light and Color

Bayer Pattern
Chose the Bayer pattern corresponding to your camera. Consult your camera
documentation if necessary.

NOTE: The Cayer Bayer pattern specified in StreamPix Settings > Sequence >Compression must match the Bayer pattern set in Bayer/Colors > Bayer
Pattern.

Accuracy

The Bayer conversion accuracy algorithm is only used when applying Bayer conversion
on exported frames. By default, StreamPix 8 always uses the Accurate mode. Fast is used
for all sample factors other than 1:1.
• Fast: bilinear forward interpolation (quickest, less accurate).
• Accurate (IPP): full bilinear algorithm using Intel IPP library. Somewhat slower,
but more accurate.
• Adaptive HDDA: Adaptive Homogeneity-Directed Demosaicing Algorithm(images with bit depth greater than 8 bit will first be converted down to 8 bit inorder to apply this interpolation). Takes a lot of computing power, hence it is theslowest, but also produces the best results.
Sample Factor

Only affects Bayer conversion done on displayed frames. Choosing 1:2, 1:4 and 1:8 will
reduce the CPU usage required for display at the cost of a smaller rendered image. For
example, this could safely be used when working with multiple cameras and where theimage resolution is much larger than the actual monitor resolution.
For example, using 4 HD 1920x1080 cameras and a single HD monitor in a 2x2 quadrant
display mode, the software would have to Bayer process 4 full images then shrink themdown to match the screen resolution. Using a 1:2 sampling will reduce the Bayer
Processing and final image size without impacting the display quality.

NorPix Inc.

107

StreamPix 8 User Guide

Recalculate Lookup Table
Recalculates the Lookup Table based on the next frame that will be processed using thecurrently defined color balance algorithm. This command should be run following
enabling a LUT file in the Color Grading Processing > 1D | 3D LUT setup areas or whenlighting conditions of the image area have changed.

108

NorPix Inc.

Controlling Light and Color

Export LUT
Lets you save the current LUT to a file so that it can be re-used later. By default, it is savedin the same folder as the files for this Workspace.

TIP: Current Bayer and Color Processing settings are automatically saved andreloaded from session to session.

NorPix Inc.

109

StreamPix 8 User Guide

7.3

Non-linear Remapping via ASC CDL Formula
The American Society of Cinematographers Color Decision List (ASC CDL) has defineda format for the exchange of basic primary color grading information. A 3 parameters
formula can be used to define most possible remapping and color correction.
The formula for ASC CDL color correction is:where:• out is the color graded pixel code value.
• i is the input pixel code value (0=black, 1=white).
• s is slope (any number 0 or greater, nominal value is 1.0).
• o is offset (any number, nominal value is 0).
• p is power (any number greater than 0, nominal value is 1.0).
The formula is applied to the three color values for each pixel using the corresponding
slope, offset, and power (gamma) for each color channel.
When ASC CDL is enabled, the Color Remapping dialog opens in the Docked dialog
panel, from where you can adjust the color balance in real time.
1.

Select All Channels to apply the same formula to all 3 channels, or select each color
in turn.

2.

Use the sliders to adjust the Gamma, Offset, and Gain.
NOTE: The Reset button resets the default values: Gamma(1), Offset(0), Gain(1).

Figure 7-2: Color Remapping dialog

110

NorPix Inc.

Controlling Light and Color

Changing the default range values for the ASC CDL remapping parameter
A registry key can be set to change color ranges:
All key type are DWORD
key path: HKEY_CURRENT_USER\Software\Norpix\Streampix\Admin
Key name: GainRange: Set Gain range, default value: 8
Key name: GammaRange: Set Gamma range, default 8 (0,8)
Key name: OffsetRange: Set Offset range, default 2 (-2,2)
Key name: RealOffset = 1: Enable display real pixel intensity offset value, default: 0

NorPix Inc.

111

8
Managing Sequences and Markers

This chapter contains information the following sections on working withsequences:•

8.1 Sequences - Global Settings•

8.2 Sequences - Individual Tools

Managing Sequences and Markers

8.1

Sequences - Global Settings
A number of StreamPix Settings control how Sequences are captured and displayed. For
best results, it is a good idea to familiarize yourself with the following topics before
setting up to record Sequences:• StreamPix Settings > Autonaming: See “Auto Naming Settings” to see how to
set up automatic naming for captured files.
• StreamPix Settings > Sequence: See “Sequence Settings” for Sequence
behavior and compression settings.
• StreamPix Settings > Recording: See “Recording settings” for information on
how to use automated files, set Sequence limits, and record in a loop.
• StreamPix Settings > Recording Manager: See “Recording Manager settings” to
set recording manager levels.
• StreamPix Settings > Playback: See “Playback settings” to set playback
and synchronization options.

NorPix Inc.

113

StreamPix 8 User Guide

8.2

Sequences - Individual Tools
As well as the global settings, StreamPix 8 also has the following tools for working withindividual Sequences.
Application Menu > Sequence History

The Sequence History allows you to reload previous recording sessions. Sequences are
sorted by date and time.

Figure 8-1: Sequence History dialog

The time stamp shown in the Sequence History dialog is the actual time that the Sequence
file was created. Select the desired time stamp on the left, and all Workspaces/Sequencesthat were loaded at that time will be shown. From there, you can either reload all
Sequences or a specific one using the corresponding button. If the sequence can't be foundbecause it was moved or deleted, an error message is shown. An option lets you select toclose all open Workspaces before proceeding.

TIP: It is recommended to delete older or obsolete entries from the history from time

to time (to reduce loading times and clutter).

114

NorPix Inc.

Managing Sequences and Markers

The Sequence Tab
Go toGoto Frame #Allows you to input a frame number (index in the Sequence file) to jump to a specificimage. Also works with AVI files.
Goto Time Stamp

Allows you to input a time stamp in order to jump to the frame closest to it. The dialog
either asks for an absolute or relative time depending of the time mode selected in
StreamPix Settings > Playback. Also works with AVI files.
Goto Reference Frame

The Goto Reference Frame button moves the playback position to the Reference Frame.
The Sequence reference frame can be set by various actions, such as the Set Reference
Frame buttons, or by a Trigger pre/post event command.
Goto Reference Time

Moves the display to the Reference Time, if any.

Reference Frame
Set at Recording Position

This will set the current recording position as the reference frame. The reference frame
time stamp is used to deduce the relative time of every other image. By default, the first
frame of a Sequence is used if no reference frame is chosen.
Set at Playback Position

This will set the current playback position as the reference frame. The reference frame
time stamp is used to deduce the relative time of every other image. By default, the first
frame of a Sequence is used if no reference frame is chosen.

Reference Time
Take Reference Time

Read the current system time and set this time as the reference time of the current
Sequence. The relative time of each image of the Sequence will be computed using thistime instead. This can be useful to set a reference time occurring before a recording starts.
Using a reference time overrides the current reference frame (if any). It is also possible to

NorPix Inc.

115

StreamPix 8 User Guide

do this automatically. See “Recording settings”.

NOTE: The Take Reference Time action is a software event that can be triggered also

via the I/O Manager. See “HOWTO Trigger a Software Event from an external input line (I/O Manager)”.

Edit Reference Time

Lets you edit the reference time associated with the current Sequence. The new referencetime will be applied to the first frame of the Sequence. Set the desired time in the
HH:MM:SS:MS:MS format. A calendar picker lets you set the date.

Figure 8-2: Edit Reference Time dialog

Clear Reference Time

Remove the reference time associated with the current Sequence. The time of theSequence first frame will become the new reference.

Manual Playback
Time Jump
The Sequence > Time Jump buttons jump the display according to the interval set in
Settings > Playback > General > Length of time jumps in MS (milliseconds. The default is1000 ms. See “Playback settings”.

Figure 8-3: Time Jump buttons

116

NorPix Inc.

Managing Sequences and Markers

Step by Step
The Step Back and Step Forward buttons move the display one frame at a time.

Decrease or Increase Playback Speed
If the Show Manual playback slider is enabled in Settings | Playback Rate, the appearance of
the Step back/Step Forward buttons changes, and selecting the buttons will increase or
decrease the playback speed. See Figure 8-4. and “Playback settings”.

Figure 8-4: Change in Step Forward / Step Back controls

See “Playback Rate settings”

Time Jump
The Sequence > Time Jump buttons jump the display according to the interval set in
Settings > Playback > General > Length of time jumps in MS (milliseconds. The default is1000 ms. See “Playback settings”.

Figure 8-5: Time Jump buttons

Manipulation
Trim SequenceThis will trim (cut out or edit) the active sequence, keeping only the current selection.
This operation can take a long time for big sequences as StreamPix exports theselection to a new Sequence file, deletes the original Sequence, and finally renames
and reopens the new Sequence file.

Append a Sequence
A file-open dialog will allow to select a Sequence of frames to append at the end of thecurrent Sequence. Both Sequences must share the same image format (resolution,
bitdepth, etc).

NorPix Inc.

117

StreamPix 8 User Guide

Sort Images in Chronological Order
When StreamPix is recording in a loop, the resulting Sequence frame order might not beproperly arranged. For instance, the oldest frame might not be at position 1 in the
Sequence. The sort action will fix that by creating a new Sequence file in which the frames
are sorted according to their respective time stamps.

NOTE: Sequence Sort can be a lengthy operation on large Sequence files.

Other Tools
Trigger Pre/Post Event
If the Pre/Post Trigger is enabled, it will trigger the related event. See “Pre/Post Trigger
settings”.

Set Recording Position
This will set the current playback frame position as the recording position, causing thenext frame recorded to overwrite this frame. By default, the recording position is one
frame past the last frame of the Sequence.

Toggle Timeshifted Playback
Activate or deactivate the timeshifted playback mode. See “Timeshifting settings”.

Copy Image to Clipboard
Copies the current image to the Windows clipboard, from where is can be pasted into athird-party application.

Export Timestamps
Export the selection or full sequence time stamp metadata into an Excel compatible .CSV
file. The time stamp information is formatted according the current setting of the timestamp overlay. User will be prompted for entering a file name.

Trigger Module
Some modules can be triggered by clicking on this button instead of using their docking
panel interface. Refer to the module help to see if it supports this trigger button. Thisbutton is used only in some custom applications.

Focus Slider
Sets the keyboard/mouse wheel focus back to the main Sequence Slider. For instance to
use the arrow keys to browse in between images.
118

NorPix Inc.

Managing Sequences and Markers

Show Sequence Information
Shows various information on the currently loaded Sequence or AVI file.

Navigating Markers
The Markers tab provides the following specific tools for navigating within Sequences:

Goto
Previous Marker

The Goto Previous Marker button moves the playback position to the previous marker
relative to the current playback position.
Next Marker

The Goto Next Marker button moves the playback position to the next marker relative tothe current playback position.

BrowseMarker List

Displays a dropdown list of all Markers. Select an item to move to that Marker.
Edit Marker...

Select to add or edit a Marker, including a Marker description.

Add Marker at
Current Recording Position

This will add an event marker on the last frame captured. This command is typically used
to mark a frame while a recording is taking place. A blue arrow will be displayed on thesequence bar to show the locations of the marked frames. The bottom of the display area
also shows a marker icon overlay when a marked image is shown. You can use the event
markers viewer in the Sequence docked dialog to manage or quickly browse the marked
frames.
NOTE: Only the first 100 markers will be display on the Sequence Slider, this to avoid

clogging the user interface.

NorPix Inc.

119

StreamPix 8 User Guide
Current Playback Position

This will add an event marker on the frame at the current playback position. This
command is typically used to mark a frame while reviewing a recorded Sequence. A blue
arrow will be displayed on the Sequence bar to show the locations of the marked frames.

Navigating the Sequence from marked event (docked dialog)
To navigate markers from the Sequence docked dialog
1.

Select Show Event Markers and select a marker to move the Sequence display to that
position.

2.

Optionally, select Show Event Markers > Edit to annotate a marker.

Home > Selection group
The Home > Selection group contains the following tools for preparing a Sequence forexport:Set First: Sets the first frame to be exported.
Set Last: Sets the last frame to be exported.
Goto First: Moves the display to the first frame to be exported.
Goto Last: Moves the display to the last frame to be exported.
Clear Selection: Clears all export markers. Other markers, if any, remain.

To Export a Sequence see “HOWTO Export a Sequence”.

120

NorPix Inc.

9
Managing Settings

This chapter explains how to manage StreamPix 8 settings. The following Settings
control StreamPix 8 default behaviors.

9.1 Auto Naming Settings

9.9 MOV settings

9.17 Remote Control
settings

9.2 AVI settings

9.10 Image settings

9.18 GPU Management

9.3 MPEG4/TS settings

9.11 Playback settings

9.19 Sequence Settings

9.4 Color Processing
settings
9.5 DAQ settings

9.12 Playback Ratesettings
9.13 Pre/Post Trigger
settings
9.14 Recording settings

9.20 Session settings

9.15 Recording Manager
settings
9.16 Recording Manager
Editor

9.23 Workspace(s)settings
9.24 More... settings

9.6 Displayed Data settings
9.7 Interface settings
9.8 Metadata settings

9.21 Synchronization
settings.
9.22 Timeshifting
settings

StreamPix 8 User Guide

9.1

Auto Naming Settings
Auto Naming allows StreamPix 8 to generate file names without requiring user input eachand every time a file is created. Automatic File Naming can be enabled for recording/exporting movies and images files. The Reset buttons restores the default naming scheme.

Figure 9-1: Auto Naming settings

The RECORDING schemes are used when directly recording from the live stream, while the
EXPORTING are used when exporting from a Sequence file. “Movies” are .seq, .avi and.mov. “Images” are .bmp, .jpg, .tif, etc.
As two Sequences can not be saved in the same file, make sure that every Sequencecreated has a unique name. With successive recordings, using the (time) token will preventthe “samefilename” overwriting problem. A good scheme could be:(workingfolder)\(workspace)\(date) at (time), as this could generate a sequence filename
like this one: “C:\Camera 1\12-31-05 at 23-59- 59.999.seq”. This means that a folder
would be created for each workspace and that every sequence from this workspace would
be uniquely identified by the date/time part. It is recommended that you test each naming
scheme on a short recording before applying it to a complete recording session.
When creating a new image sequence (BMP, TIFF, etc), it is possible that the automaticnaming scheme may not contain enough dynamic tokens (i.e. tokens that can help prevent
generating the same file name twice). In which case, select the Append an image index
checkbox. When this is checked, a base name will be generated for the first image, andStreamPix will automatically reuse the same name for every other image, appending an
index value to differentiate them (-1, -2, -3, -4, etc...).

122

NorPix Inc.

Managing Settings

The following is a description of all available tokens. Some are not available in every
scheme.
• Insert Path button: can be used to browse the computer hard disk to
select the full path of a specific folder into the auto-naming scheme.
• workingfolder: This token will be replaced by the working folder of eachWorkspace.
• pictures: This token will use the User Pictures default folder as defined byWindows.
• videos: This token will use the User Videos default folder as defined byWindows.
• workspace: This token will be replaced by name of the Workspace.
• prompt: This will prompt for a specific string to use for each file created. This
string will then replace the (prompt) token.
• customtoken: This token will be replaced by a user-defined string value.
• increment: This token will be replaced by an incremental numerical value.
• time: This token will be replaced by the current system time.
• date: This token will be replaced by the current system date.
• YYYY, MM, DD, HH, MIN, SEC, MSEC: These tokens will be replaced by the
related time parts extracted from the timestamp of the current image. Mostly used
for image files, they can also be used when creating sequences, AVI and MOV. In
which case, the current system time will be used.
• input-line: This token can use when an input line triggers an event. The inputline # will be used as part of the naming scheme.
• input-event: This token can use when an input line triggers an event. The inputevent will be used as part of the naming scheme.
• output-line: This token can use when an output line is driven following an
event. The output-line # will be used as part of the naming scheme.
• LTC: The Linear Time Code token will be replaced by the LTC time code in theimage (if any).
• index: This token will be replaced by the image index in the sequence (whenexporting from sequence to image files).
• pindex: Same as the “index” token, but the value will be padded using thepadding specified in the “Images” settings page.
• firstframetime: This token is mostly used when working with RAM sequences
saved to disk (or exported). The token will be replaced with the time of the first
frame of the sequence.
• sourcepath: The path of the source file.
• sourcename: The name of the source file (without the extension)• AB: Alternate between “A” and “B” for each image. Mostly used with PIV-styleacquisition. In a PIV application, frames are typically captured by group of 2 in avery short interval, then this is repeated after a short interval, for example: frame
NorPix Inc.

123

StreamPix 8 User Guide

1 and 2, wait, frame 3 and 4, wait... So when using a PIV naming scheme, frames
are exported with the A-B suffix to highlight the fact they are grouped together:- frame1-A- frame2-B- frame3-A- frame4-, etc.
NOTE: When using auto-naming, the default settings for each format are used.
The default settings are set in the following Settings pages: AVI, Sequence andMore... > Images.

To set an auto naming scheme
1.

Select a Scheme by checking the check box.

2.

Select the Edit button to open the list of available tokens.
a. Double-click on a token to append it to the current naming scheme.
Each token gets replaced by an actual value at the time a file is created.
b. Select OK to accept the new Scheme definition and return to the Auto Naming
settings dialog.

3.

Optionally, if you have included (customtoken) in the naming scheme, enter a Default
value of the (customtoken) to specify a custom token.

4.

Optionally, select Edit (increment) token settings... to define how to increment token
values. .

Figure 9-2: Edit (increment) token settings... dialog

a. Specify when the increment is to take place, either after each new file and/or after
each recording, select the appropriate checkbox. The default is After creating a newtarget file, which should cover most needs. After each recording is convenient for
certain recording scenarios.
b. Enter a Starting Value. This value is normally reset every time the workspace isreopened (ex: every time StreamPix launches).
c. Optionally, deselect the Reset the increment...is reopened checkbox to have thestarting value be the last value used in the previous session.
124

NorPix Inc.

Managing Settings

d. Optionally, select the Reset the increment... (customtoken) value is changed
checkbox to have the starting value restarted when the custom token value ischanged.
e. Optionally, specify the increment Padding (in digits).
f. Select OK when done to return to the Auto Naming settings dialog.
5.

Optionally, for image files and exporting files, select the Append ... file namecheckboxes.

6.

Select OK to accept your Auto Naming schemes.
TIP: Enable StreamPix Settings > Recording > Auto-create file to automate file creation

using the Auto naming scheme. See “Recording settings”.

9.2

AVI settings
AVI Settings page is used to set the codec options used when creating a new AVI file.
Available Video and Audio Codecs and audio sources are listed on a dropdown list. The
Settings button will show any associated Codec or Source parameters in a dialog box.

Figure 9-3: AVI settings

The AVI Settings page is where all the AVI default values can be set. These settings canalways be overwritten via the Save As dialog, provided this dialog pops up (usually notbecause of the autonaming scheme).
The Override Playback Rate option allows you to override the frame rate of the capture.
This means that the AVI can be made to play slower or faster than the actual capture rate.

NOTE: The Override Playback Rate option does not alter the camera’s capture rate. The

file header is overwritten with the playback frame rate. The recording manager
is still using the incoming frame rate from the camera.

The playback output format can be converted from Native to BGR if needed. (Someexternal modules require the BGR format).
NorPix Inc.

125

StreamPix 8 User Guide

The AVI settings here (as well as the Auto Naming settings) are used when a new AVI iscreated using the Application Button > New AVI dialog.

126

NorPix Inc.

Managing Settings

9.3

MPEG4/TS settings

Video
MP4 / TS offers the following Codecs and options for recording or exporting:
MPEG4: A container with 2 types of compression available: H.264 or MPEG4.
MPEG2 ts: an older container, designed for MPEG2 video encoding. Since MPEG2 is an

obsolete compression scheme, frames stored in a .ts container are H.264 compressed andcompatible with all media players.

NOTE: Playback of .TS video are not supported by StreamPix 8.

MP4 Video Codec• H.264: to H.264 encode (software or hardware accelerated)• MPEG4: to MPEG4 encode (software only).
Video codec GOP size

Same Group Of Frame as in Settings | Sequence | H.264 GOP.
Video codec Bit Rate (bps)Same bit rate as in Settings | Sequence | H.264 bit rate.
MPEG2 ts Video Codec

Codec selection for now is limited to H.264
H.264 acceleration• None: (runs on the CPU).
• List of installed and supported GPUs that can provide acceleration: either Intel,
nVidia, or AMD.

Audio
When recording to MP4 or TS container and audio is also recorded, the audio track can beeither uncompressed or AAC encoded. You can adjust the AAC quality by defining thebitrate.

NorPix Inc.

127

StreamPix 8 User Guide

9.4

Color Processing settings
This page allows you to manage the global parameters applied during color processing.

NOTE: For general information about color processing and Bayer conversion, see“Controlling Light and Color”.

StreamPix Settings > Color Processing parameters set global parameters for all

Workspaces. To set Color Processing parameters per Workspace, see “Workspace
Settings”.
As you select an option, a description of it appears in the information panel at the bottomof the Color Processing page.

Bit Depth Management
Image bit depth while exporting: By default, 10, 12, 14 or 16-bit images are forced to an 8bit image. Select Maintain image bit depth to maintain the original bit depth.

NOTE: Make sure the export image format can handle the image bit depth. For

example, BMP handles only 8-bit.

NOTE: The Bayer Accuracy “Adaptive HDDA” ignores this feature since it only

supports 8 bit.

Color Processing
Look-up table type: The choice is either a 1D or 3D LUT. This defines the type of look-up

table (LUT) applied during color processing. 3D LUT requires significantly more RAM
and initialization time, but allows better rendering. Selecting a 1D or 3D LUT has noprocessing overload (except when exporting 10-bit images with a 3D LUT).
Look-up table calculation: To speed up the color grading, Bayer interpolation, and whitebalancing image rendering, a global look-up table taking into account all the parameters is
calculated and saved to an XML file. By default, this LUT is recalculated each time
StreamPix is restarted. To avoid the recalculation on start-up select Reload look-up table(from file).

128

NorPix Inc.

Managing Settings

Color Balance

Color balance is the adjustment of the RGB channels intensity of an image to match thecolor temperature of the illumination present at capture time. As it changes the overall
mixture of colors in an image, color balance is used for generalized color correction.
Color balance (also referred as white balance) can be adjusted and applied to real time
(Live) display and when exporting. Color balance can be manually adjusted or
automatically calculated on any captured color image, either RGB or YUV format. Colorbalance algorithms can be applied in conjunction with the Bayer rendering.
In Automatic mode, one of six color balancing algorithms can be selected:• Mean equalization: calculates the mean value of each channel and then adjusts
each so that the mean value of the blue and red channels are equal to the green
channel.
• Gray world: the sum of the red, green and blue channels is calculated and thenadjusted so that the sum of the blue and red channel equals the green channel.
• Standard deviation: calculates the standard deviation of each color channel andthen readjusts each to be 70 (on a 256 value scale).
• Mean & standard deviation (Slowest): Adjusts the mean value of each channel tobe 128, and sets the standard deviation of each channel to be roughly 70 (on a256 value scale).
• White World: Will search for the whitest area in the image and assume this is real
white to recalculate the WB by normalizing each channel and set the maximum
value to “white”. To get good results, make sure there are no saturated pixels on
the image. (Use short exposure time for instance.)• Scale by max: calculates the max value of each channel and then rescale eachchannel to the maximum dynamic range.
Mean equalization, Gray World, Standard Deviation, Mean & Standard Deviation, WhiteWorld and Scale by Max algorithms use the first incoming image to calculate the balancecoefficient. This is a one time operation that is not redone for each incoming image. To
force a recalculation, use the shortcut ALT+R or select Bayer/Color > Recalculate look-up
table.
In manual mode, you can enter red, green and blue offset values to be applied to each color
channel. The correction factor will be added (or subtracted) for each pixel intensity. The
parameter value is in percent of the total dynamic range: a +10% will add a constant of 25
grey level for an 8-bit (256 levels) image.
Color Grading Processing

Image color grading can either be performed using 1D or 3D look-up table. These tables
are calculated via 3rd party software and can be loaded within StreamPix 8. All the fileformats are supported, both 1D or 3D. Check each section for further details.

NorPix Inc.

129

StreamPix 8 User Guide

1D look-up table setup
1D Look up table mode: Enable the usage of a 1D LUT for color grading. Beside the ability

to load a LUT file, a predefined transform LUT is also available to apply a negative
conversion.
1D look-up table File: Specifies the 1D look-up table file that can be loaded for processing.

Current supported formats:• Norpix 1D Text 1D LUT file(*.txt,*.nlt)• Flame and lustre(*.3ld)file• ColorCorrection(*.cc)• ColorCorrectionCollection(*ccc)• Cinespace file(*.csp)• Houdini file(*.lut)• Iridas_cube file(*.cube)• Iridas_itx file(*.itx)• Iridas_look file(*.look)• Spi1d file(*.spi1d)• Truelight(*.spi1d)
A NorPix 1D LUT file can be generated manually for basic correction and grading by
creating a CSV text file, say in Excel®. In the text file, syntax is: Each line contains 4
entries, Level value to be remapped, followed with corresponding Blue, Green and Red
values.
• There is no need to specify all the LUT values and entries. Only the needed value
must be specified. All missing values will be interpreted as “Leave as is”• Level can be specified as range using [ - ] characters• # comment a line
• Out bound values are ignored.
Example#Index, Blue, Green, Red Remapping value
0, 255, 0, 0: gray level 0 will be remapping as pure blue,
1, 10, 10, ,: gray level 1 will be remapping as Blue =10, Green =10, Red default (1),[200-255], 255, 255, 255: gray levels 200 to 255 are remapped to pure white.

130

NorPix Inc.

Managing Settings

3D Lookup table setup
3D lookup table mode: Enable the usage of a 3D LUT for color grading. Only a 3

rd

party

LUT file can be imported.
3D lookup table File: Current supported file formats:• Flame and lustre(*.3ld) file
• ColorCorrection(*.cc)• ColorCorrectionCollection(*ccc)• Cinespace file(*.csp)• Houdini file(*.lut)• Iridas_cube file(*.cube)• Iridas_itx file(*.itx)• Iridas_look file(*.look)• Pandora_mga(*.mga)
ASC CDL adjustment: Enable the American Society of Cinematographers Color Decision

List (ASC CDL) basic primary color grading adjustment. This can be used to apply basic
gain, offset and gamma connections. See “Non-linear Remapping via ASC CDL
Formula”.

Color Matrix correction
The color filter arrays used on all image sensors do not exactly match the response of thehuman eye. As such, a final level of tuning known as color correction or color saturation
correction is required. The most commonly used form of color correction is a 3 X 4 matrix
operation.
Without correction, coefficients are:B=

[100%][0%][0%][0.00%]

Bo

G=

[0%]

[100%][0%][0.00%]

Go

R=

[0%]

[0%]

[100%][0.00%]

Ro

Commonly, the sum of coefficients for a channel equals 100%. You should refer to thesensor color transfer function to determine the right coefficients to use.
See the following example:

NorPix Inc.

B=

[142%][-32%][-10%][0.00%]

Bo

G=[-15%][140%][-25%][0.00%]

Go

R=[-14%][-22%][136%][0.00%]

Ro

131

StreamPix 8 User Guide

Miscellaneous LUT Processing
Pseudo Color: This can be used for remapping monochrome images to pseudo color.

Currently, six predefined look up table functions are available. Contact Norpix if you feel
more LUTs should be added.

NOTE: Pseudo-color cannot be used with true color RGB or YUV images.

Available predefined LUTs are:
• Rainbow• Inverted rainbow• Hot• Cold• Saturated 3 level• Saturated 5 level.
Saturated level LUTs are used to help figure out the camera exposure and gain settings.
Those LUTs display in false color saturated pixels (red) and under exposed pixels (green):
Saturated 3 level (256 colors):• Grey level from 0 to 3 are display as green• Grey level from 252 to 255 are display as red
Saturated 5 level (256 colors):• Grey level from 0 to 5 are display as green• Grey level from 250 to 255 are display as red
Monochrome image processing: Depending on the need for data integrity, one may need tomaintain across the 1D LUT processing the monochrome image format (default) or accept
the image to be converted first as a color RGB image.
By default, all monochrome images are converted first to an RGB 24-bit color images
before a LUT can be applied, since the LUT include components for RGB channels.
However, when working with a 10 or 12 or 16-bit monochrome images, the conversion
will downgrade the pixel resolution down to 8 bit. This is something that sometimes is notsuitable.
By selecting the Monochrome image processing option, you can make sure the true bit
depth is maintained, with only a single 10, 12 or 16-bit channel being processed

132

NorPix Inc.

Managing Settings

Window leveling: Linear window leveling can be performed for pixel depth greater that 8
bits. By default, StreamPix always displays the 8 most significant bits of captured images.
Window leveling can highlight specific bit ranges on the images.

As an example, a 10-bit image can be leveled in 3 ways:• 8 most significant bits (bit 2 to 10, default StreamPix 8 setting)• 8 middle significant bits (bit 1 to 9)• 8 least significant bits (bit 0 to 7).

NorPix Inc.

133

StreamPix 8 User Guide

9.5

DAQ settings
NOTE:

You must have a specific license to enable the DAQ module.

This page is used to change the various settings related to DAQ Graphs.

Figure 9-4: DAQ settings

GeneralAuto-export DAQ data to: Allows you to automatically export the DAQ data whenexporting a video file. The destination choices are: None, *.xls, or *.csv.

DAQ Graph
Value precision: This is the number of decimal places used when displaying DAQ values.
Time range increment/decrement steps (ms): This is the value used when incrementing or

decrementing the time range of a graph.
Draw the '0' line: If the 0 value is in the range of the Y axis of the graph, the graph will trace

a full horizontal line on it.

134

NorPix Inc.

Managing Settings

DAQ Graph colors
Image's time range highlight color: the color used to highlight the time range occupied

taken by the current sequence image.
Axis & Text color: The color used to draw the graphs axis and text.
Inner line color: The color used to draw the step lines inside the graph.
Current Position color: The color used to draw current position lines in DAQ graphs.

Information shown in LIVE graph header
Most recent timestamp: Show the time stamp of the last data set received from the DAQ

device.
Total Data Sets: Show the total number of data sets captured.
Most recent value: Show the most recent value read by the DAQ device.

Information shown in the FILE graph header
Current timestamp: Show the time stamp at the current position in the DAQ Graph.
Total DataSets: Show the total numbers of data sets in the DAQ file.
Current DataSet: Show the current data set index.
Current value: Show the value at the current position in the DAQ Graph.

NorPix Inc.

135

StreamPix 8 User Guide

9.6

Displayed Data settings
This page allows you to customize the information displayed in the colored band above
the image in a Workspace. You can select which information to show when in single
display or in multi-display, in live or in playback.

Figure 9-5: Displayed data settings

You can also choose the font type and size used. Only fixed-width fonts are available as it
keeps the text easy to read even when being updated. Using a larger font size will maketext easier to read at the expense of having a smaller area left to display the image itself.

136

NorPix Inc.

Managing Settings

9.7

Interface settings

Figure 9-7: Interface settings

General
NOTE: StreamPix may need to be restarted for some changes to take effect. If it does,

you will receive a prompt with the option to restart immediately or later.

Language File: Allows you to change the default language used in the display. The

language file is an XML file located at:
C:\Users\[username]\AppData\Roaming\Norpix\StreamPix\Languages.

NOTE: Language files are XML text editable files. Should you find the translations

are incorrect, do not hesitate to forward your changes tosupport@norpix.com.

Sequence Slider Position: Allows you to change the default placement of the Sequence

Slider bar, either at the top (just below the ribbon bar) or at the bottom of the window(default).
Time stamps display format: The time format used in the interface. It can either show the

relative time (relative to the first frame of the sequence) or the absolute time (actual date +time).
Show microseconds: Display the timestamp's microseconds in the interface, although it

should only be used with a precise hardware time source. Default timestamping uses theOS time, which has a precision of ~ 1 millisecond. You can select a different time source
than the default system clock provided you have a supported device. Use Select Time
NorPix Inc.

137

StreamPix 8 User Guide

Source from the Workspace tab to select a different time source.
Show live fps decimals: display the fps in real time. The fps is always displayed, but thisoption shows it with 2 decimal places, instead of being rounded to the nearest integer.
Show time in UTC format: Make the absolute time stamps appear in Greenwich standard.

(No time zone adjustment)
Apply Full Screen Mode across multiple monitors: Does what it says.
Show Information bar in full screen: when disabled, while in full screen mode, theinformation bar will not pop up. Messages that are posted to this dialog will be buffered,and when exiting full screen mode, the messages will be displayed.
Show the F12 notification overlay in full screen mode: when disabled, the F12 text message

will not by display while in full screen mode.
Status Overlay Position: Select where the status overlay will be drawn. Default is bottom

left.
Resizing algorithm for displayed images: different algorithm can be used for calculating theimage to be displayed. Nearest-neighbor is allowing the fastest rendering and lower CPU
load. On very large images, this algorithm may generate artefact. In such a case selectother options. This will result in increased CPU load.

Zoom
Minimum zoom factor (%): The minimum zoom factor allowed when zooming out.
Maximum zoom factor (%): The maximum zoom factor allowed when zooming in.
Zoom in/out steps (%): The zooming steps. For example, 10 means that each zoom in/out

action, will change the zoom by 10%. Zoom steps are achieved using numeric + and –keypad.
Only ‘Fit Image to Window’ if image too large: Fit image to window mode will only beapplied if the image is too large to fit the display area. Otherwise, a zoom factor of 1:1
will be applied.

QuickZoom
QuickZoom allows you to quickly browse image content. Two different zoom levels canbe preset to zoom in or out of the image. Set the Full View value to the zoom factor atwhich the whole image is visible in the display area.
QuickZoom Level 1: Set the zoom factor to a specific value when holding “Ctrl” while

clicking in a display. The zoom will be centered on the pixel under the mouse.
QuickZoom Level 2: Set the zoom factor to a specific value when holding “Ctrl-Shift”

while clicking in a display. The zoom will be centered on the pixel under the mouse.
QuickZoom Full View: Set the zoom factor to a specific value when using the “Ctrl-*” key

combination. The zoom will be centered on the pixel under the mouse.
138

NorPix Inc.

Managing Settings

ROI QuickZoom minimum size: Set the minimum size allowed for the Zoom ROI. The ROI

QuickZoom allows you to make a zone of the image or use the full display area. If it issmaller than the minimum size, the ROI size will be increased accordingly.

NOTE:

NorPix Inc.

If the ROI is smaller than 4x4 pixels, the ROI action will be ignored.

139

StreamPix 8 User Guide

Docked Dialog
NOTE:(Not available in the Single Camera version)

Automatically show/hide the docking panel: When selected: When enabled, shows thedocking panel when the mouse moves to the right-most part of the StreamPix window(when maximized) and hides it when the mouse move elsewhere.
When clicking on a docked dialog, select the matching workspace: Toggles the selection of

the matching Workspace when a docked dialog is selected.
Docked Dialog shown (Single/Multi Display): Determines which Workspaces are shown inthe docking panel for each mode, Single or Multi-Display. The choices are Current
Workspace, or All Workspaces.

Customizing the Application menu
Settings > Interface > Customize the Application menu ... opens a dialog from where you canselect which items to include in the Application menu. Uncheck items to hide them. By
default, the menu uses small icons. On a HD screen (> 1024x768) you might want toselect Show large icons in the application menu for better visibility.

NOTE: StreamPix 8 will have to be restarted for changes to take effect.

Customizing the Ribbon interface
Settings > Interface > Customize Ribbons... opens a dialog from where you can change thelayout and content of the ribbon toolbars and design your own custom toolbars.

140

NorPix Inc.

Managing Settings

NOTE: StreamPix 8 will have to be started for changes to take effect.

Figure 9-7: Customize Ribbon settings

The Current Ribbon Layout is on the left, and all the Available commands are on the right.
Dark blue represents categories (“tabs”), light blue the panels (“groups”) and white theindividual controls. All items are displayed in dark green when selected.
To add an item to an existing tab or group1.

Double-click (or click Add to Current Ribbon) on an item in the Available commands
list to insert it in the Current Ribbon Layout list.

2.

Use the Move Up and Move Down buttons to reorder the items in the list.

3.

Delete item removes the item.

TIP: As an item is selected in either list, a brief description is displayed in theinformation area below.

To create a new item

NorPix Inc.

1.

Use the Insert Category, Panel, Label and Separator buttons to define your own custom
tabs, groups, and buttons.

2.

Enter a name for the new item in the Label edit field.

141

StreamPix 8 User Guide

3.

Use the Move Up and Move Down buttons to reorder the items in the list.

4.

Select OK to save your changes. They will take effect the next time that StreamPix 8
is launched.
TIP: You can save/load your ribbon configuration in case you need to switch between

different layouts.

TIP: Restore Default restores the default ribbons.

See also “HOWTO Modify the GUI”.

142

NorPix Inc.

Managing Settings

9.8

Metadata settings

Figure 9-8: Metadata settings
Save metadata along with sequence file: If enabled, when streaming to a Sequence file,

Streampix will also save the metadata bundled with the saved frames. The metadata is
saved in the same folder as the Sequence in a file with the same name as the Sequencewith an added “.metadata” extension. Ex: “Capture123.seq.metadata”
To view the metadata, use the Metadata Spy module and/or the Metadata Overlay module.
See “Metadata Spy” and “Metadata Overlay”.
Metadata constant size: If 0, the metadata will be stored with a dynamic size for optimal

file usage. However, if you require recording in loops, or pre/post (i.e. rewriting over old
images & metadata), then you need to set a constant value for the size. This value can becomputed using the Metadata Spy Module which will monitor the live feed to estimate theminimum size needed. You can also use Tools > Metadata Manager.
Metadata info size: If you use a 3rd party module that uses a custom metadata type,StreamPix 8 needs to save some information about this custom type to the metadata file.
Use the Metadata Manager to compute the required metadata info size.

9.9

MOV settings
NOTE: The MOV format is only available on StreamPix 32-bit. Apple has stated thatthey will stop supporting the MOV format for all Windows platforms startingfrom Q1 2016. Therefore, we do not recommend using MOV within
StreamPix on the long term. MOV support in StreamPix also eventually will
be discontinued.

NorPix Inc.

143

StreamPix 8 User Guide

Figure 9-9: MOV settings

This page is used to set the default options used when exporting to a MOV file. If
Automatic File Naming is enabled, those settings will be used. If the selected codec offers
additional settings, clicking on Codec Settings displays a dialog with custom settings forthat codec.

TIP: For most codecs, a higher Video Compression Quality will result in a larger file.

To get an uncompressed Quicktime file, choose “Apple None” as the Video
Codec.

NOTE: Some codecs will put watermark on the images (or simply won't work) if you

don't have the required license.

You can Create an SMPTE timecode track if you have an external LTC time source. This
timecode track will be selectable in the Quicktime Player by clicking on the current time
(ex: “00:00:00”) and selecting “Timecode: Non-Drop-Frame” from the drop-down menu.

144

NorPix Inc.

Managing Settings

9.10 Images settings
Images
NOTE: Settings changed in the Save As dialog will override these settings.

JPEG Quality: Quality for the JPEG files. Higher quality results bigger files and higher

CPU usage.
TIFF Format: Normal or multi-paged (i.e. all images are saved in a single file).
TIFF Date Time Tag content: chose the format of the DateTime tag in the tiff file.

• Standard Time [YYYY:MM:DD HH:MM:SS]: the tiff specification format.
• Full Time [YYMMDD HHMMSSmmmuuu]: includes milliseconds and microseconds.
• Raw Time [time_t.mmmuuu]: include the standard UNIX 32-bit time_t value andthe milliseconds/microseconds.
• LTC Time [HH:MM:SS-FF]: The source frames must have been captured with thesupport of an LTC timing device.
•
JPEG EXIF: When enabled, EXIF metadata will be inserted into the JPEG header. If

GPS data are available via metadata, they will be included within the EXIF header.
TIFF EXIF Support: When enabled, EXIF metadata will be inserted into the TIFF

header. If GPS data are available via metadata, they will be included within the EXIF
header.
NOTE: Artist, Copyright, Aperture and Focal Length metadata can be inserted into the

EXIF header. Some registry keys must be set properly to document those fields:
Key Path: HKEY_CURRENT_USER\Software\Norpix:
Key Type: String values
Key Name: EXIFArtist, EXIFCopyright, EXIFAperture, EXIFFocalLength
Key value: These they are created when Streampix or any other Hermes
based application runs for the first time. They are empty by default.
EXIFAperture and EXIFFocalLength values will only be used if there is no
information about the aperture and focal length in the CameraInfo
metadata.

DNG Bayer Pattern: Enter the image Bayer pattern to be stored in the image file header.
DNG Camera Profile: Enter the camera profile file name if available. When no profile isprovided, default values are used for light settings and an identity matrix correction isapplied. Use for instance Adobe's DNG Profile Editor (http://www.adobe.com) to create aprofile file.
NorPix Inc.

145

StreamPix 8 User Guide

The default source light settings (21) can be changed by editing the following registry key:
Key Path: HKEY_CURRENT_USER\Software\Norpix
Key name: DefaultDNGSourceLight
Key Type: DWORD
Key Value: 21 (default)
Other possible recommended values are:
0 = Unknown
1 = Daylight
2 = Fluorescent
3 = Tungsten (incandescent light)
4 = Flash
9 = Fine weather
10 = Cloudy weather
11 = Shade
12 = Daylight fluorescent (D 5700 - 7100K)
13 = Day white fluorescent (N 4600 - 5400K)
14 = Cool white fluorescent (W 3900 - 4500K)
15 = White fluorescent (WW 3200 - 3700K)
17 = Standard light A
18 = Standard light B
19 = Standard light C
20 = D55
21 = D65 (Default-Neutral Sun Light)
22 = D75
23 = D50
24 = ISO studio tungsten
File Name Padding: Useful to facilitate browsing the image files, as sorting themalphabetically will show them in capture order. Without padding, “image12.bmp” would
be shown before “image2.bmp”. Type the minimum number of digits to include in the filename.
Do Bayer conversion on snapped images: allows you to do a Bayer conversion only onsnapped images (Snap button) and leave the other images in raw (B&W) format.
Separator character: The character to use to separate elements in a file naming scheme.

The default is a hyphen “-”.

NOTE: StreamPix Settings > Image settings apply globally. To set Image parameters

for individual or linked Workspaces, see “Workspace Settings”.

146

NorPix Inc.

Managing Settings

9.11 Playback settings

Figure 9-10: Playback settings

GeneralFirst Frame / Last Frame behavior: Configure the way the |< and >| playback buttons

behave.
Normally, they will move to the first and last frame of the Sequence file. However, you
can have them move to the oldest or most recent frame (according to their time stamps).
The second option is useful if you do loop recording or pre/post triggering.
Auto-Rewind: If enabled, StreamPix will continue playback from the start when the end of

the sequence is reached (instead of stopping).
Switch to Full Screen mode during playback: If enabled, StreamPix will make the display

area extend to the full screen while playing back a Sequence or .avi.
Maximum playback interval: During playback, the display follows the time stamps. So if

two successive images are 10 seconds apart, StreamPix will wait 10 seconds between
showing each image. This can be a problem if the recording is not continuous, forexample, if you start a recording, stop it, then restart it later. To work around this problem,
StreamPix uses a maximum playback interval value. For example, if you set this value to1000 ms, the playback will proceed with, at most, a one second interval between eachsuccessive frame. Default value is 5000 ms.
#Frames moved on PageUp/PageDown on slider: When the Sequence Slider is selected, thePageUp/PageDown buttons can be used to move X frames forward or backward.
Length of the time jumps in MS: Sets the time interval that the Sequence > Time Jump

buttons jump the display in milliseconds. The default is 1000 ms.

Synchronization
NOTE: The following features are not available in the Single Camera version.

Enable Synchronization across Workspaces: Allows you to customize the behavior of the

NorPix Inc.

147

StreamPix 8 User Guide

slider's cursor when moved while StreamPix is in Select All Workspaces mode. It is only
relevant if every Sequence in each Workspace was captured at the same time. A Master
Workspace must also be defined for the synchronization to be maintained.
Auto-select master workspace: When enabled, allows StreamPix to automatically choose aworkspace to be the master when all Workspaces are selected. If no Workspace has been
designated, then the left-most Workspace becomes the default Master. The master canalways be changed manually by double-clicking on the desired Workspace tab.
Synchronize on master frame > index. Used if all used cameras have the same frame rateand started recording at the same time, as in hardware-triggered recording. For instance,
moving one sequence to frame # 45 will bring every other sequence to frame #45.
Synchronize on master frame > timestamp. The linked sequences will show the frames thatwere captured at the same time as the current frame. If a frame with the exact same timestamp cannot be found, the sequence will show the frame captured before the requested
time.
Always use local stream’s reference time to calculate relative time: If No, then the masterstream reference time will be used to calculate the relative times.

148

NorPix Inc.

Managing Settings

9.12 Playback Rate settings

Figure 9-11: Playback settings
Show Manual Playback Slider: allows you to playback sequences and AVI files at variable

speeds (slower & faster, forward & backward). See “Manual Playback Control”.

Sequence playback rates
Sequence playback rates control the speed steps used by the Manual Playback Slider.

To add a new value
1.

Deselect the Use automatic values checkbox.

2.

Select Add to add a new fps value to the list.

3.

Enter a new value in the Enter a fps value dialog, and select OK.
• A negative FPS value indicates a backward playback and a positive value is aforward playback.
• Remove selected erases the currently selected value.
• Reset default values returns the list to default values.
• Mirror Values duplicate the values in the opposite direction. For example, if yourlist consists of 0, 10, -20, 30, Mirror will add -10, 20 and -30.

The zero (0.00 FPS) value is mandatory and is used as the Paused value and will be
automatically added when the OK button is selected.

NorPix Inc.

149

StreamPix 8 User Guide

If Use automatic values is selected, StreamPix will dynamically build a custom list of FPS
values based on the “Suggested frame rate” specified in the current Sequence header.

AVI playback rates
AVI playback is handled differently as the values are percentages of the AVI normal
speed. Compared to the regular playback speed, 50% will playback at half-speed and200% will playback twice as fast.
• Selecting Add allow you to add a new % value to the list.
• Remove selected erases the currently selected value• Reset default values returns the list to default values.
The zero (0% speed) and normal (100% speed) values are mandatory. New values will be
automatically added (as needed) when the OK button is selected.

9.13 Pre/Post Trigger settings

Figure 9-12: Pre/Post Trigger settings
Pre/Post Trigger is a special recording mode used only with sequence files (on disk or in

RAM), as the other formats (AVI, bmp, tiff, etc) do not support loop recording.

150

NorPix Inc.

Managing Settings

The Pre/Post Trigger ignores the loop settings and always loops. Pre/Post Trigger also
ignores any sequence limit.
First define a duration for the “Pre” and the “Post” length.
In Use time controlled mode, when record is initiated, StreamPix will sum the two
durations and factor in the current capture fps of the grabber, to compute the maximum
number of frames in the sequence. When the maximum number of frames is reached, therecording will continue from the beginning, overwriting the oldest images.
In Use frame controlled mode, you specify how many frames must be kept before the eventand how many after. When the Pre/Post event is triggered, either from an IO action (see “I/
O Manager docked dialog”) or from the Trigger Pre/Post Event command, StreamPix willcontinue recording for the “after” duration and stop automatically once that preset time
has elapsed. The resulting sequence will include what happened before and after the
event.
When the Pre/Post event occurs, the next frame to be captured is marked as the reference
frame. This means that when browsing the sequence and displaying the time stamps as
relative instead of absolute, each frame's time will be relative to that reference frame
instead of the first frame of the sequence. Since the frame ''Event'' will be marked as time
0, frames captured before it will present a negative time and those captured after will beidentified by a positive time.
Settings
Automatic Rearm: The current target file (the Sequence file) will automatically be saved
and closed before StreamPix restarts recording. Using this with the Settings > Recording
Auto-Create file option will automatically create a new sequence file every time the Pre/

Post Trigger event occurs.
Rename Pre/Post file: The Sequence file will be renamed with the absolute time stamp of

the reference frame. The file will be in the same location, but renamed to something like“Fri May 09 14-03-47.22.seq” which show the date and time of the reference frame.
Extended Post: Ensures that if another pre-post event is triggered while recording a post

duration, the post duration is extended, using the last pre-post event as the new zero. All
Pre/Post events are still marked for easy retrieval.
Automatically sort the sequence: At the end of recording, automatically sort the images

according to their time stamps.
If Don’t overwrite the ‘before’ section if more than one event are triggered is selected,
multiple triggered events that overlap will generate a single Sequence file containing both
events.
Use Individual Configurations: The Pre/Post triggers must be defined per Workspace in theassociated I/O Manager docked dialog. See “Pre/Post Trigger settings”.

NorPix Inc.

151

StreamPix 8 User Guide

9.14 Recording settings

Figure 9-13: Recording settings

GeneralAuto-Create File: Define StreamPix behavior when a recording or snap is initiated.

• Never Won't create anything when the record button is pressed.
• If no current file will automatically create a file if there are none. If a sequence fileis already open (from “New/Open Sequence on Disk” action or from a previous
recording), the recording will be done in that file.
• Always will close the current Workspace file (if any) and create a new target filefor the recording. The created files are named using the auto-naming scheme
defined in Settings > Auto Naming. The naming scheme is applied for all auto
created files.
Auto-created file type (on record): Set what type of file is created when a recording triggers

the auto creation of a target file.
Auto-created file type (on snap): Set what type of file is created when a snap triggers theauto creation of a target file.
Snap and Prompt mode: If enabled, user will be prompted for a file name after eachsnapped image file.
Use 'Recording start' as reference time: The default is No, StreamPix uses the first captured
frame timestamp as the reference time. Selecting Yes means that when a recording starts,
the current time that the Record operation starts is used as the Sequence reference time.
This can be useful to get accurate relative times where you need the reference time to be

152

NorPix Inc.

Managing Settingsexactly the time at which the recording started, for example when the recording is
manually started, but the image capture is controlled by a hardware trigger.
Start Recording Delay (ms): Allows you to specify a wait period in millisecond between

the time the Record button is pressed and the time at which the recording will actually
start. Start Recording Delay reads the current time when the record button is pushed,
and then adds the delay value to calculate a “future start time”. This new start time isthen compared with each incoming image time stamp to figure out if the frame must be
kept or discarded.
Stop Recording Delay (ms): Allows you to specify a wait period in millisecond between

the time the Record button is pressed (to stop the recording) and the time at which therecording will actually be stopped. Stop Recording Delay reads the current time when therecord button is pushed to stop recording, and then adds the delay value to calculate a“future stop time”. This new stop time is then compared with each incoming image timestamp to figure out if the frame must be kept or discarded.

NOTE: Start and Stop Recording Delay allow a better start and stop recording

synchronization between multiple cameras.

Wait for late frames before stopping the recording: If enabled, the recording continues on acamera until late frames are captured, to match the timestamp.
Force same number of frames in all workspaces: If enabled when recording from multiple

cameras at the same frame rate, recording continues until the same number of frames arecaptured from all cameras so that the number of frames synchronize. This setting will
override any stop recording delay.
Synch Start/Stop Recording on LTC: special mode to synchronize start/stop recording on

current time code received from an LTC reader board. If enabled, the current time code isrounded up to the second 0-frame time code (up to 2 seconds delay) and used to determine
the exact time code value in the future when start/stop recording will occur. The samevalue is provided for all workspaces to ensure time and number of frames synchronize.
Use a common time frame for sync recordings: If enabled, the current time code is rounded

up to the second 0-frame time code (up to 2 seconds delay) and used to determine theexact time code value in the future when start/stop recording will occur. The same value isprovided for all workspaces to ensure time and number of frames synchronize.

When a recording ends...
Switch to playback mode: The Workspace display(s) will automatically switch to theplayback mode. The Playback position is set to the last frame recorded.
Auto-sort the Sequence: Automatically sort the images according to their timestamps.

NorPix Inc.

153

StreamPix 8 User Guide

Auto-export sequence to...: Choose a format (SEQ, AVI, BMP, JPG, etc) to export toaccording to the naming scheme defined in Settings > Auto Naming.
Use multi-threaded auto-export/auto sort: When recording from multiple Workspaces,

StreamPix will post-process all Sequences simultaneously.

CautionWhen Use multi-threaded auto-export/auto sort with some codecs forframe compression (AVI, MP4...), make sure the selected codec
supports concurrent instances. Failure to do so may result to some
software and/or system instability. In which case, disable this option.

Prompt for a file name (sequence & avi files): Lets you set whether or not to be prompted fora file name.
Auto-close file: Automatically close the current file when the recording stops.

NOTE: When Auto-close file is enabled, if the recording was to a RAM sequence, andneither Auto-export Sequence to... nor Save Using autonaming on close has

been set, the file is discarded. Otherwise, RAM sequences are saved
according to the auto-naming set for exported files.

Buffer usage monitoring
Maximum buffer usage allowed (%): StreamPix can trigger an action if the buffer usage getstoo high. Too high buffer usage can result in dropped frames.
If maximum buffer usage is reached: StreamPix can either do nothing or stop the recording

on the current Workspace (or on all Workspaces).

LimitsLimit sequence on disk/RAM to X frames: Specify the default number of frames to be

captured in a sequence on disk or in RAM.
Loop recording when limit is reached: Define StreamPix behavior when the frame limit isreached. If the Loop option is enabled, the Sequence will continue recording from thestart. Otherwise, the recording will stop when the limit is reached. These settings can beoverridden at the Workspace level, in the Sequence docked dialogs.

154

NorPix Inc.

Managing Settings

9.15 Recording Manager settings

Figure 9-14: Recording manager settings

While Recording...
While recording... offers the following options:• Save all frames is the default behavior. Every acquired frame is saved to the target
file (Sequence, AVI, etc.).
• Save one frame every X frames lets you reduce the recording manager. Enter anupper range, in fps, for your camera. The Workspace > Recording manager slider
range field lets you specify the actual capture rate.
• Use a recording script offers an even finer control of the recording process. Withit, clicking on the record button will start running a predefined recording script.
Select Edit Script to open the Recording Manager Editor, described below.
TIP: You can also access the Recording Manager Editor through the Workspace >Recording Manager button for the current or all selected Workspaces.

9.16 Recording Manager Editor
The Recording Manager Editor allows you to build your own recording scripts. When
opened from a Workspace tab, the script applies only to the current workspace. If opened
from StreamPix Settings, the script will be used by every Workspace (except the ones that
use their own).
NOTE: This dialog can be brought up from either Settings > Recording manager > Edit
script or Workspace > Recording Manager.

NorPix Inc.

155

StreamPix 8 User Guide

Figure 9-15: Recording Manager Editor

The current script (if any) is shown. Save to file prompts you to save the current script toan XML-format file.
Reset clears the current recording script.
Load from file allows you to reload script from a previously saved script file.

Each recording script is made of one or more steps. Each step can be made of any numberof commands and/or substeps. The script is always run sequentially starting when arecording begins.
Understanding how to make a complex script can be a steep learning curve, but once you
grasp the mechanics, the flexibility of the Recording Manager engine can cover mostrecording needs.
Click on a step in the tree on the left hand side to show/edit this step. To delete a sub-step,
delete the associated 'Call Sub-Step' command in its parent step. Don't forget that you canalways ask support@norpix.com if you ever need help building a script.

Commands
Commands are instructions given to StreamPix. Whenever StreamPix acquires a newframe, the Recording Manager is queried to know what to do with it.
Grab Frame: This command instructs StreamPix to save the frame to the current target file(sequence, etc). When encountering this command, the script execution will stop until aquery is made by StreamPix.

156

NorPix Inc.

Managing Settings

Skip Frame: This command instructs StreamPix to discard the frame. It will not be saved.
When encountering this command, the script execution will stop until a query is made by
StreamPix.
Loop Recording: This command will loop the current sequence. i.e. The next saved frame

will overwrite the first frame of the sequence and recording will continue from there.
New Sequence: Close the current sequence and create a new one based on the settings in
StreamPix Settings > Auto Naming.
New AVI: Close the current sequence and create a new AVI file based on the settings in
StreamPix Settings > Auto Naming.
New Images: Close the current sequence and create a new image sequence based on thesettings in StreamPix Settings > Auto Naming.
Wait For Query: This will stall the execution of the script until a new query is made by

StreamPix.
Call Sub-Step: Will create a new sub-step which will be ran. Once the sub-step completes,

execution of the script will resume.
Execute: Will run a shell command line instruction of your choice.

After the Last Command
Once the last command of a step as been processed, you can define what will happen using
this section.
Restart immediately: Will immediately continue running the step from it's first command
Restart every X frames: The step will loop every X frames acquired.
Restart at specified interval: The step will loop at the specified time interval.

Stop Condition(s)A step will continue running indefinitely until one of its stop conditions occurs. Every step
will also stop when the recording stops (For example, you click on the Record button asecond time to stop the recording). Most of the time, every sub-step should have at least
one stop condition, otherwise the control will never be passed back to its parent step.
When a step reaches one of its stop conditions, the step terminates and control is passed
back to its parent step. If the Main Step reaches one of its stop conditions, the recording
automatically stops.
Every stop condition also has a property named Can Interrupt. If it is enabled, the stop
condition(s) will be evaluated after each command. If it is disabled, the stop condition(s)are only evaluated when the step reaches its end.

NorPix Inc.

157

StreamPix 8 User Guide

Do X Times: The step will stop after it has been run X times.
Until X Frames: The step will stop once X frames have been captured by the step (and childsteps).
For Time X: The step will stop after a certain time.
Until Time X: The step will stop when the system time reaches a predefined time.
Until IO: The step will stop when a specific IO event occurs (ex: Rising Edge).
Until Timed IO: The step will stop after the input level has been high or low for the

specified amount of time.

Recording Manager - Script Examples
To grab at half the frame rate (Complexity: low)

* Main Step *Commands: Grab Frame, Skip Frame.
After the Last Command: Loop Immediately.
Stop Conditions: None
Capture one minute every hour (Complexity: medium)* Main Step *Commands: Call SubStep "GrabFor1Min".
After the Last Command: Loop Every 1:00:00 (1 hour).
Stop Conditions: None.
* GrabFor1Min Step *Commands: Grab Frame.
After the Last Command: Loop Immediately
Stop Conditions: For Time X = 1:00 (1 minute)
Pre/Post recording - Create a new sequence, capture in a 1 minute loop until Rising
Edge, then capture for 10 seconds, then start anew. Stop after 10 sequences havebeen captured this way (Complexity: High)* Main Step *Commands: New Sequence, Call SubStep "Pre", Call SubStep"Post".
After the Last Command: Loop immediately.

158

NorPix Inc.

Managing Settings

Stop Conditions: Do 10 Times.
* Pre Step *Commands: Call SubStep "GrabFor1MinLoop", Loop.
After the Last Command: Loop immediately.
Stop Conditions: Until Rising Edge on IO device (caninterrupt).
* GrabFor1MinLoop Step *Commands: Grab Frame.
After the Last Command: Loop immediately.
Stop Conditions: Do For 1 minute.
* Post Step *Commands: Grab Frame.
After the Last Command: Loop immediately.
Stop Conditions: Do For 10 seconds.

9.17 Remote Control settings
This page is used to connect Workspace(s) to the StreamPix Remote software.

Figure 9-16: Remote Control settings

NorPix Inc.

159

StreamPix 8 User Guide

StreamPix Remote is an external application that allows the user to remotely view, control
and monitor multiple workspaces running on one or more computers on the local network.
It is distributed separately from StreamPix.
To configure StreamPix 8 to connect to StreamPix Remote:1.

Select Home > StreamPix Settings > Remote Control.

2.

Select the Enable remote control check box to enable network communication.

3.

Optionally, select Make StreamPix Bonjour discoverable on the network to allow
StreamPix Remote to discover StreamPix 8 computers on the network.

4.

Optionally, select Allow workspaces to automatically connect to remote server when
loaded.

5.

Enable Compress images before transfer and set the compression quality. This is therecommended setting. Compression increases the local CPU load somewhat, but thetransmitted image to StreamPix Remote is of small size, saving network bandwidth.
When the network bandwidth usage is high, this option can reduce the network traffic
considerably.

6.

To get connected select a local IP address and supply the same IP address and port
number you specified when you configured StreamPix Remote to accept newconnections. The connection will be possible only if both IP addresses are reachable.

7.

If more control over a remote computer is needed, select Run StreamPix Agent at
system startup to enable StreamPix Agent. This tool will allow StreamPix Remote to:- Shutdown or restart computer- Log off user
- Launch StreamPix 8- Forcibly quit StreamPix 8 (in case of crash or frozen GUI).
NOTE: StreamPix Agent is a separate application that runs in the background. Onceenabled and running, it launches at user login time. A small icon displays inthe system tray.
8.

Select OK to save the changes and close the StreamPix Settings dialog.

When remote control is enabled. a new dialog will show up on the StreamPix 8 docking
panel interface for each workspace.

Figure 9-17: Remote Control docked dialog

NOTE: Make sure you configure the firewall to allow StreamPix 8 to access the

network.

Select the Connect or Disconnect buttons to manually connect or disconnect the current
workspace to StreamPix Remote. Selecting the Broadcast check box will send the160

NorPix Inc.

Managing Settingscommand to all other Workspaces so you won't have to click Connect or Disconnect foreach Workspace. See also the StreamPix Remote Manual.
A connection may fail if:• StreamPix Remote is not running or accepting new connections.
• The address and port number are not the same as those StreamPix Remote islistening to.
• A firewall blocks the port that StreamPix Remote is listening to.

9.18 GPU Management
Depending on GPU brand and capability, GPU Management Settings give a betteroverview of the GPU capabilities for video compression. Supported GPU are Nvidia,
AMD, and Intel. This interface allows you to enable or disable GPU acceleration.
Changing these settings requires a StreamPix restart.
List capabilities for:• H264 (AVC)• H265 (HEVC)• JPEG compression.

Figure 9-18: GPU management settings for Intel, Nvidia, and AMD GPUs

NorPix Inc.

161

StreamPix 8 User Guide

9.18.1

Special Registry Keys
Single versus multi-threaded JPEG compression:

On some rare occasions when using real time JPEG compression, for images larger than 3
Mpx size, the multithreaded algorithm will return a corrupted image. To avoid that, force asingle threaded operation.
To ENABLE or DISABLE multithreading processing while software JPEG compressing:Path: HkEY_CURRENT_USER\Software\Norpix
Key type: DWORD
Key name: JTModeDefault value: 0: multi-thread mode, 1: single thread mode.
MSB or LSB Alignment into TIFF container:

Most 3rd party software properly handles 16-bit tiff images provided the bits are MSBaligned. However, some 3rd party software requires the bits to be LSB aligned.
Path: HKEY_CURRENT_USER\Software\Norpix
Key type: DWORD
Key name: MSB
Default value: 0: aligned on the most significant bit, 1: aligned on the lesssignificant bit.

Launching an application upon StreamPix crash:

It is sometime desirable to launch a specific application following a StreamPix crash, forinstance to reset a camera to a known state. The following registry key allows to document
the application to be launched after the crash report dialog is closed.
Path: HKEY_CURRENT_USER\Software\Norpix
Key Type: string
Key Name: CrashExecute
Key Value: full path and file name to be executed (exe)162

NorPix Inc.

Managing Settings

9.19 Sequence Settings
Sequence Settings allow you to set the default behaviors for Sequences saved to the hard
drive or to Ram, and to set the compression parameters for new and exported Sequences.

Figure 9-19: Sequence settings

General
NOTE: StreamPix Settings > Sequence settings apply globally. To set Sequenceparameters for individual or linked Workspaces, see “Workspace Settings”.

Override Playback Rate: Override the calculated frame rate of recorded sequence by a fixedvalue.

NOTE: The Override Playback Rate option does not alter the camera’s capture rate.

The file header is overwritten with the playback frame rate. The recording
manager is still the incoming frame rate from the camera. To set therecording manager, see “Recording manager settings”.

Forced frame rate value: the fps value used if Override Playback Rate is enabled.

NorPix Inc.

163

StreamPix 8 User Guide

Sort frames before exporting: If you do loop recording or use the pre-post trigger, you

might want to enable this. This will make sure that the frames in the sequence will be
exported in their chronological order. This is especially important when exporting to AVI
or MOV.
Use nearest frame for goto and synch: When disabled (default), StreamPix 8 uses the last

frame to have been captured at the requested time. Enabling it will seek the closest frame(in time).
Bypass system caching: For uncompressed sequences, when bypassing is enabled(default), StreamPix 8 sends the buffers directly to the HDD, bypassing the system cache.
For most disks, this mode offers the best performance, especially when using external
storage devices, like USB 3.0 disks. However, some disks perform better with systemcaching.
Only take a single reference time: When enabled, StreamPix 8 uses the reference time when

the first recording begins. When disabled, each sequence begins with a new reference
time. The default is disabled.
Export subsampling (1/X): When enabled, exports onf frame per N frames. The default is 1,

or every frame.
Write StreamPix version in the sequence description: When enabled, the StreamPix version

number is included in the sequence meta-data.
When opening a sequence, show the oldest frame: When enabled, StreamPix 8 displays theoldest frame first. When disabled, the sequence opens with the last recorded frame.
Open exported sequences in a temp workspace: If you want to automatically open

sequences exported in a new temporary workspace for immediate viewing. This applies toevery Export (current image, current selection & full Sequence) to a Sequence file (.seq).

Markers
Show the Marker list: Show the list of Markers. The default is No.
Show Edit Marker dialog when adding a marker: Show the Edit Marker dialog when adding

a marker. The default is No.
When recording, put the mark on ...: Places the marker on either the Latest frame captured,or on the Next frame captured.
Delete Markers associated with overwritten frames: Automatically delete markers when aframe is overwritten. The default is No.
Update the Marker file every time a marker is added: Automatically update the Marker filewhen adding a marker. The default is No.

164

NorPix Inc.

Managing Settings

NOTE: By default, markers are kept in RAM until the recording ends. Then an XML

marker file is saved. When large number of markers are set, it isrecommended to enable this option, to avoid clogging the memory.

RAM Sequence
When closing a RAM sequence: to set what happen when a RAM sequence is closing. The

choices are:
• Discard the sequence• Ask if the sequence is to be saved• Automatically save the sequence using the auto-naming scheme for exports. See“Auto Naming Settings”.
Pre-allocated RAM frames: Pre-allocate the memory for uncompressed RAM sequences.
Try this if the normal capture to RAM drops frames (burst recording).
Stop recording if available RAM is < (MB): When recording to a RAM sequence, StreamPix

8 can become unresponsive if the system runs out of RAM. To avoid this, every second or
so, StreamPix will check the amount of RAM available and if it reaches the critical value
specified here, the recording will automatically be stopped.

Compression for new and exported Sequences
By default, Sequence files don't use compression, images are captured and recorded as isfrom the camera delivery pixel format, resulting in lossless quality and superior
recording performance. You may choose to use compression if you have the computing
power and if disk space is a concern.

NOTE: Index information for compressed sequence files is saved as a separate .idx

file. For all recording to a Sequence file with compression on, a new index
stream file is created (with the .idx extension) in the same folder and with thesame name as the Sequence file. This index stream file speeds up the readingand playback process. It can be deleted, but it will be rebuilt the next time theSequence file is accessed. On large file, the rebuild process will take time.

There are two sections: one Compression for new Sequences (i.e. Sequence files used for
direct recording) and Compression for exported Sequences. Both sections offer the same
parameters. This allows you, for example, to record in uncompressed format, then later,
export the Sequence to a compressed format for archiving or distribution purposes.

NorPix Inc.

165

StreamPix 8 User Guide

Compression Types

NOTE: Compression settings can be set globally or per individual Workspace. From
the Settings > Sequence tab, the settings are global. When done from theWorkspace ribbon, they are per Workspace.

Compression algorithms can be divided into “Lossless” and “Lossy”. With Losslesscompression, all of the original data are preserved, but with lower compression rates,
typically about 3:1. Lossy compression results in greater compression ratios, typicallyfrom 10:1 or greater, resulting in much smaller file sizes, but with a loss of data, and apotential loss of image quality. The challenge with lossy compression is to find a balance
between maximum compression while maintaining acceptable image quality.

TIP: Lossy compression doesn’t work well with raw Bayer images, as the color

pattern tends to get damaged. The workaround is to first convert the images tocolor RGB, then compress.

Lossy compression algorithms can further be divided between Temporal and Spacial. In
Temporal compression, the algorithm is calculated and applied individually to every
frame.
Spacial compression uses the principle of a key frame and then encodes the difference
between each frame and the key frame. Frames are grouped together. The first, or key,frame, is temporal encoded, and then every other frame in the group is encoded based on
its difference with the key frame. For example, in a group of 30 frames (GOP=30, default),frame 0 is temporal and 2 to 29 are spacial compressed. You need to reconstruct all theframes to get access to frame 29. This is much more CPU intensive but allows better
compression.
The type of compression to use is dependent on both your hardware and on your expected
results. The parameters that are available depend on which compression type that you
choose. StreamPix 8 provides the following compression types:
Compression Type

Comments

No compression (raw) Best data preservation, lowest processing overhead. Images are recorded
unchanged from the camera output format.
Lossless JPEG

Works on all images, Temporal, CPU-intensive, low compression (2:1), compression
level dependent on image texture.
Table 9-1: Supported compression options

166

NorPix Inc.

Managing Settings

Compression Type

Comments

Works on all images, Temporal, CPU-intensive, compression level dependent on
image texture, compression adjusted as a quality percentage, or using the slider. Can
use GPU acceleration. The following compression factors are provided for
information only. To get an accurate estimate, you should do some benchmarking.
Typical compression factors:
Lossy JPEG

• Very light compression (95%)• Light compression (80%)• Medium compression (65%)• Heavy compression (40%)
Related parameters: JPEG Quality, Use fixed image size, Fixed image size in byte, GPU
Lossy JPEG Encoding, Bayer and Color Processing method.
NOTE: The default is 75%, which is usually considered as visually lossless, with acompression of about 20:1.
Note: External module Compression Estimator can be used to determine thecompression factor.
Lossless RLE

Works on all images, Temporal, CPU-intensive, compression level maximum 3:1. If
image texture is very complex, compressed image size may actually be larger thanuncompressed. Works well for images with a lot of identical constant pixel intensity.

Lossless Huffman

Works on all images, Temporal, CPU-intensive, compression level maximum 3:1.

Lossless LZ

Works on all images, Temporal, CPU-intensive, compression level maximum 3:1.
Works on most images and pixel format. Compression performed by the CPU or GPU.
Image horizontal must be multiple of 16 and vertical size must be multiple of 8.
Related parameters: Video Codec GOP Size, Video Codec Bit Rate, H.264 Acceleration• Intel Quick Sync: If present, an Intel Quick Sync enabled GPU is used forcompression. Image size limited to 4k. Larger image will switch to CPU mode.

H.264• NVIDIA GPU: If an NVIDIA® series 7 or higher GPU is detected, the NVIDIA® GPU
will be used to H.264 compress the video in real time. Maximum of 2 workspaces
can use the GPU for compression simultaneously on consumer based GPU. Some
Quadro model have no limitation related to the number of workspace. Image size
limited to 4k.
• AMD GPU: If an AMD series 9 GPU or higher device is detected, the AMD GPU
will be used to accelerate the compression. Image size limit is 4K resolution.
NOTE: See also “H.264 Decompressor”.

H.264 Loop

H.264 compression, with same functionalities as above plus loop recording. File size
may be a bit larger.
Looping can only occurs on the boundary of the GOP size.
Related parameters: Video Codec GOP Size, Video Codec Bit Rate, H.264 Acceleration,
Use Fixed image size, Fixed Image size in bytes.

Note: In order to determine the right value for Fixed Image size in bytes, use theexternal module Compression Estimator

NorPix Inc.

167

StreamPix 8 User Guide

Compression Type

Comments

Used exclusively on Bayer images.
Codec optimized to compress raw Bayer non-interpolated image without degrading
the Bayer pattern. Can be set as lossy or lossless. Compression rate goes from 3:1 to
8:1 depending on setting.
Cayer Compressor

HEVC

Note: The Cayer codec provided with StreamPix is a demo version, single threaded(compression speed is limited). Compressed image are watermarked. Contact Norpix
to purchase a complete codec license (About $150.00).
Related parameters: Cayer Compressor (lossy, 10:1, lossless, 3:1), Bayer andColor Processing method.
HEVC (h.265) is supported on nVidia GPU generation 9, and Intel generation 4 orhigher CPU/GPUs. HEVC does not support loop (overwrite in place) recording.
Related parameters: HEVC Acceleration, Video Codec Bitrate, Video Codec GOP
size.

MPEG4

MPEG4 compression equivalent to DIVX.
Related parameters: Video Codec Bitrate, Video Codec GOP size.

No Compression(async mode)

Same as uncompressed raw. Expect that the write process to the disk is performed
asynchronously to allow a slight gain of performance on certain type of SSD. Whenselecting this mode, no simultaneous playback is possible.
Table 9-1: Supported compression options

NOTE: GPU-accelerated JPEG compression is license-based and uses the GPU forprocessing. Current GPU support is for AMD, Intel, and NVIDIA®. Whencompressing a raw Bayer image using the accelerated GPU based algorithm, aBayer interpolation and white balancing are performed first by the GPU.
Make sure to set the proper Bayer pattern.

NOTE: The Cayer Bayer pattern specified in StreamPix Settings > Sequence >Compression must match the Bayer pattern set in Bayer/Colors > Bayer
Pattern.

Fast Compression Using IPP: Enable the usage of Intel Pixel processing Library toaccelerate the compression while using RLE, Huffman and LZ compression
Use Fixed Image Type: during loop recording, each image (JPEG) or group of images(H.264) will use a fixed size in bytes, allowing being overwritten. This will result in slightly
larger file size than when using non loop mode.
Fixed Image Size In Bytes: Define the size for each image (JPEG) or group of images(H.264) during loop recording. Use External Module Compression Estimator to help
determine what should be the ideal image size.
168

NorPix Inc.

Managing Settings

Video Codec GOP Size: H.264 / H.265 / MPEG4 related. Determines the number offrames grouped together. A large GOP size will tend to reduce file size, as there will be
fewer key frames. However, decompression during playback and frame seeking will be
slower.
Video Codec Bit Rate: H.264 / H.265 / MPEG4 related. The codec output bit rate.
H.264 Acceleration: Enable or disable the usage of GPU for accelerating compression.
List of available GPU.
HEVC Acceleration: Enable or disable the usage of GPU for accelerating compression.
List of available GPU.
GPU Lossy JPEG Encoding: Enable or disable the usage of GPU for accelerating
compression. List of available GPU.
JPEG Decoding: Preferred library / GPU for decompression JPEG frame duringexport/playback.
•••Intel IPP: (default) will use Intel Pixel Processing library. Fast, but there may besome rare cases where the decompression will return an image with a few
corrupted pixels.
JPEG Turbo: software decoding. Somewhat slower than IPP, but safe.
QuickSync: If present, an Intel Quick Sync enabled GPU is used fordecompressing each JPEG frame. Fastest, but there may be some rare cases
where the decompression will return an image with a few corrupted pixels.

Index: For all recording to a SEQ file with compression, an index stream file is created(with idx extension) in the same folder and with the same name as the Sequence file.
This index stream file speeds up the reading and playback process. It can be deleted, but
it will be rebuilt the next time the Sequence file is accessed. On large file, the rebuild
process will take time.
•

The index by default is saved as a separate file•

NTFS Stream: the index is stored in a sub section of the name file as a NTFS
stream. During copy to some external disk, depending on formatting, thesecondary stream may be lost.

Cayer Compression: select compression quality when using CAYER compression.
Bayer And Color Processing Method: The Bayer and Color Processing
method can be either set to Auto or Manual.
•Auto: the current settings defined in the Bayer/Colors ribbon are used•

Manual: defined with Parameters for manual Bayers and Color
Processing method (see below)

NorPix Inc.

169

StreamPix 8 User Guide

Bayers and Color Processing method
When working with raw Bayer images, both Cayer compression and GPU-based JPEG
compression require some extra parameters be defined: JPEG and Cayer must be awareof the Bayer pattern. Furthermore, for the JPEG compression, since images must be firstBayer interpolated before being compressed, the color balancing settings must be defined.

The Bayer and Color Processing method can be either set to Auto or Manual.
Auto: the current settings defined in the Bayer/Colors ribbon are used (Default):• Enable/Disable Bayer interpolation (JPEG Only)• Enable/Disable the Color Balancing (JPEG only)• Defines the Bayer pattern to use (JPEG and Cayer).
Manual: the settings are taken from the Parameters for manual Bayer and Color Processing
method:• Enable/Disable Bayer interpolation on the GPU (JPEG Only)• Enable/Disable the Color Balancing (JPEG Only)• Select the Bayer pattern to use (JPEG and Cayer).

170

NorPix Inc.

Managing Settings

9.20 Session settings
This page lets you set the default behavior on start-up.

Figure 9-21: Session settings

When Windows starts...
Start StreamPix: Lets you specify whether to start StreamPix 8 automatically when thesystem starts.

When StreamPix starts...
Check for updates: Automatically check if a new release of StreamPix 8 is available. The

check is done once per month.
Load external plugin modules: If you don't use any modules, skipping loading them will

make StreamPix 8 launch faster.
Load I/O device drivers: If you don't use the I/O manager, skipping loading the IO drivers

will make StreamPix 8 launch faster.
Reload grabber(s): Automatically reload the camera / frame grabbers used in the lastsession.
Reload sequence(s): Automatically reload sequences that were open in the last session.
Reload saved script: Reload the saved script. Don't enable this option unless needed.

NorPix Inc.

171

StreamPix 8 User GuideShow 'Reload Options' dialog: If a crash occurs, the reload dialog will allows you to selectwhich grabber/sequence to reload (or none at all). If disabled, everything will be reloaded
as if nothing happened.
Initial window state: Initial window state when StreamPix 8 is launched (Normal,

Minimized, Maximixed, Full Screen (F12 to toggle)).
Run NpxDebug in background: Run the NorPix debug utility in the background, typicallyminimized in the system tray.

Factory Defaults
In general, there is no need to un-install the software to get everything reset. The Reset All
options let you restore default values:• Reset all workspaces will erase all the Workspaces while leaving the StreamPix
settings intact.
• Reset all StreamPix settings to their default values... after confirmation, will doexactly what it says.

NOTE: It is also possible to get a prompt to reset StreamPix to its default configuration
by holding down both SHIFT + CTRL keys while double click on the software
to start the application:

The popup dialog will allow you to select the level or reset needed:- Select Wipe all the workspace settings to erase information related toworkspaces and cameras settings- Select Wipe All the StreamPix and workspace settings to reset completely thesoftware to factory settings.

9.21 Synchronization settings
Synchronization Settings let you set the priority used to synchronize Audio, Video, and/or
DAQ streams. Streams are listed with the highest priority at the top of the list.

172

NorPix Inc.

Managing Settings
Figure 9-22: Synchronization settings

NorPix Inc.

173

StreamPix 8 User Guide

9.22 Timeshifting settings
This page is used to configure the timeshifted playback function. You can specify thetimeshift mode to be either based on a time delay or on a frame delay.

Figure 9-23: Timeshifting settings

With timeshift enabled, StreamPix stores information about the antecedents to each frame
captured. Every time a frame is captured, the Sequence display is updated with the framethat was captured X time or X frames before it. Then, you can use Sequence > Toggle
Timeshifted Playback to start/stop the playback.

Caution: Timeshifted playback requires twice as much bandwidth as a standard

recording (because StreamPix has to fetch the old frames from the Sequencefile). If StreamPix drops frames, the computer might not have sufficient
bandwidth to perform the simultaneous read/write operations.

TIP: One way to reduce bandwidth usage is to do a loop recording in a RAM

sequence. See “Recording settings”.

NOTE: Regular playback actions do not work while a timeshifted playback is inprogress.

174

NorPix Inc.

Managing Settings

9.23 Workspace(s) settings.

Figure 9-24: Workspace settings

Default Working Folder
This page is where you set the default Working Folder to use for newly createdworkspaces. The default is “my Documents\Sequence\”, but it can be set to any valid path.
It is also possible to automatically append the Workspace name to the working folder path,making it easy to store files related to each Workspace in its own folder.
By default, file dialogs (Save As / Open) start in the Working Folder. To override this andstart in the last used folder instead, deselect Save File dialogs use the working folder as thedefault location.

TIP: To assign a custom working folder to an individual workspace, select Workspace> Working Folder.

Default read-ahead buffers
The Default Read-ahead Buffers is the buffer count that will be used by each grabber. For
example, if the camera runs at 30 fps, using 150 buffers means that you have a 5 seconds
buffer in case the system experiences a lag at some point. Having enough buffers meansthat the system will be less likely to drop frames when CPU or disk usage peaks; however,
too many buffers only eats up an excessive amount of memory.
Recommended value is to allocate about 1 second of incoming frames. So at 30 fps, 30
buffers is typically enough. Lower values can be set for RAM recording.

NorPix Inc.

175

StreamPix 8 User Guide

NOTE:

Reload the camera after changing the buffer count.

9.24 More... settings
GeneralAutomatically open folder after exports

If enabled, this will automatically open the folder in Window Explorer where the files
were exported.
Automatically close current file when needed

If disabled, you are prompted every time the current sequence, avi, etc is closed.
Prompt before overwriting an existing fileIf enabled, when a file name generated from an autonaming scheme would overwrite an
existing file, StreamPix will show a prompt to confirm that the user wants to overwrite. Of
course, it is recommended to avoid using this setting if files are automatically created
when the record button is clicked as it would delay the recording start time.
Periodically resynchronize the timebase

When using system time as the time source, StreamPix reference time if read during
camera initialization. Then an internal high-performance counter is used to calculate
elapsed time between frames.
If enabled, StreamPix will resync its internal time base with the computer clock on aregular basis. This feature is useful when the computer clock is updated by an external
application or service, since by default StreamPix will not be aware of that. By default, theresync is performed every 5 minutes. A registry key can be defined to overwrite the default
update interval:
Key path: H_KEY_CURRENT_USER\Software\Norpix\StreamPix\General
Key Type: DWORD
Key name: "SynchInterval".
Key value: 300 (default). The value is the synchronizationinterval in seconds. Default is equivalent to 5 minutes.

During recording, the reference time will be updated only if it is a forward update in time.
Backward update is not possible because of the risk of getting a negative time stamp offset
between 2 consecutive frames, a NO GO in StreamPix. When not recording, backward andforward updates are possible.

Notifications
Frame drop / Audio drop notifications: Disable the notification shown in the notification bar

when frame drop or audio packets drop is detected. You can still see if there were frames
dropped by looking in the grabber docked dialog.
176

NorPix Inc.

Managing Settings

Quick Export
The parameters described here affect the behavior of the Home > Quick Export button. See“Advanced Workspace settings”.
Source: What to export, i.e. the current image, selection, Full Sequence, or Automatic

Range.
Destination format: The output format. Select from the list.

Automatic Range parameters
Mode: Frame count or timestamp.
Number of frames before / after: Leading and trailing frames to include.
Time length before / after (ms): Leading and trailing length to include by timestamp value.

I/O Settings
The Settings > More > I/O options toggle the display of the Input Control and Output Control
panels in the docked IO Manager dialog.
See also “HOWTO Trigger a Software Event from an external input line (I/O Manager)”.
Enable Input Control

When Enable Input Control is enabled, the IO Manager > Input Control docked dialog isshown in each Workspace allowing you to monitor various input lines to trigger arecording, add a marker, etc.
To create a new action, double-click on the [Add new event...] line. To edit or delete an
existing action, double-click on the line describing that action. In both cases, the Input
Action dialog opens.

Figure 9-25: Input Action dialog

NorPix Inc.

177

StreamPix 8 User Guide

The Input Action dialog fields are:
• Source: The general device name. All I/O devices detected by StreamPix are
shown in this list. A source can either be related to the grabber (i.e: frame grabberwith input lines), an external IO device, or a Virtual IO.
• Device: Where more than a single Source device exists, the device number.
Typically, the device number is 0 (the first one). If a Virtual IO was selected as
the source, the Device is automatically selected as Virtual IO.
• Line/Key: All available lines for the selected source are shown. Select the input
line to monitor.
• Polling delay: This is the interval at which the input line is polled. If the value is
too low, non-stop polling will be implemented, needlessly consuming system
resources. However, a very high value might miss an event. For instance, if the
input signal goes from level-low to level-high and back to level-low between two
polling actions, StreamPix 8 would not notice that an edge occurred.
NOTES:- Some devices may require under the very first usage to be initialized via theirproprietary application first. Then, they will be properly detected by the IO
Manager.
- Some devices use an interrupt, in which case the polling time is ignored. The
device interrupts the software when a line level change is detected. Interrupt
mode allows a faster response time since no polling is needed.
- When using National Instruments devices with change detection
notification (interrupt) the rate of interrupt notification may be toohigh for the operating system to cope with the number of request,
resulting in incorrect IO event management. For NI devices
supporting change detection, an extra registry key can be used to turnoff the change detection operating mode and rather use a moreconventional polling mode:
Key Path: H_KEY_CURRENT_USER\Software\Norpix
Key Name: ForcePolling
Key Type: DWORD
Key Value: 1 to force polling operation, 0 touse change detection mode if hardware
supported.
• Event: This is the event to monitor. The standard Level low, Level high, Risingedge & Falling edge are available. Typically, the software monitors the voltage
on the input line. Input lines have 2 levels, low or high, i.e.: 0 or 1, physicallyusually 0V versus 5V. A rising edge is a transition from 0 to 1, or 0V to 5V. Whena rising edge is required, the software waits for a transition from 0 to 5V, hence it
must read at least once a value of 0V then a value of 5V. A Level low detectionmeans that when reading the input line level, if the level is low the condition will
be immediately asserted as true. It will not wait until a level change.
• Action: This is the action to take once the event occurs. The available actions are:- Start Recording to start recording
178

NorPix Inc.

Managing Settings- Stop Recording to stop recording- Toggle Recording starts recording if it is not currently recording and stops if itis.
- Snap Frame to save a single frame- Line Testing is a dummy action and does nothing unless it is used in combination with the Log Action described below to test the input lines.
- Trigger Pre/Post Event triggers an event when in Pre/Post Trigger mode.
- Set event marker sets a marker on the current frame.
- Take Reference Time. See “Edit Reference Time”.
- Clear Reference Time.
- Start / Stop Pulse will control the pulse generator using an Arduino or a frame
grabber pulse generator module- Enable / Disable Live will control the image capture from the grabbing device
NOTE: More actions will be added based on further developments and customer

requests.
• Target: Can either be Self to apply the action to the current Workspace only or All
Workspaces to broadcast the action to all Workspaces. All Workspaces allows you
to synchronize multiple Workspaces without having to configure their I/OManager panels separately.
• Event Name: Event name gives you the option to name a particular event rather
than use the default name made as the name of the device followed by the related
input line. For example, if the line is connected to a sensor that monitors a door,
the event name could be “Front door open”. The event name is used when the Set
Event Marker action is selected. It is not used otherwise.
• Log Action: If this is checked, each time the event is detected, StreamPix sends a
debug output to the system. The output can be displayed using Tools > Debug
Log. Use it with the “Line Testing” action to check that the lines are working
properly.
Select the Delete button to remove an existing action from the list. Select Cancel to abort
action editing. Select OK to accept changes made to an existing action or create a new
action.
Enable Output Control

When Enable Output Control is enabled, the IO Manager > Output Control docked dialog isshown in each Workspace allowing you to send out signals in reaction to various events.
Double click on an event to modify it. The Output Action dialog opens.

NorPix Inc.

179

StreamPix 8 User Guide

Figure 9-26: Output Control Manager dialog

The Output Action dialog fields are:
• Source: The general device name. All I/O devices detected by StreamPix are
shown in this list. A source can either be related to the grabber (i.e: frame grabberwith input lines) or an external IO device.
• Device: Where more than a single Source device exists, the device number.
Typically, the device number is 0 (the first one).
• Line/Key: All available lines for the selected output are shown. Select the output
line to use.
• Event: Select the event which will trigger the output action. More than 18 different
events have been predefined. More event can be added upon customer request.
• Action: Level High: when the output condition is reached, the specified output
line is set to a level high. Level Low: when the output condition is reached,
the specified output line will be set to a level low.
• Reset Mode: Select the output trigger reset mode. The choices are:- Never: The output line level will be set to the pre-defined level and will holdthat state.
- Normal: The output line level will be set to the pre-defined level for a shorttime and will return to the default initialization level.
- Auto-Reset: the line level will toggle to the default initialization level after auser programmable delay. A pop up dialog to enter the delay value will open
when selecting this option.
- Toggle: When the condition is true, the output line will toggle its level (high tolow, or low to high).
• Event Name: Event name lets you name a particular event rather than use thedefault name, which is the name of the device followed by the related output line.
• Log Action: If this is checked, each time the event is detected, StreamPix sends a
debug output to the system. The output can be displayed using Tools > Debug
Log. Use it with the “Line Testing” action to check that the lines are working
properly.
Select the Delete button to remove a selected existing action. Select Cancel to abort action
editing. Select OK to accept changes made to an existing action or to create a new action.
180

NorPix Inc.

Managing Settings
Event Markers

I/O markers are stored in an XML file with, for each event, in the following fields:• Name: The name of the I/O event as named when the I/O was configured.
• Description: The event that occurred (rising edge, falling edge, etc) and thedevice & line on which it occurred.
• FrameIndex: The index of the last frame to have been recorded when the event
occurred.
• Timestamp: The timestamp in seconds (in time_t format) of the last frame.
• TimestampMS: The millisecond part of the timestamps.
• TimeString: The timestamp, formatted in a readable string.
• Valid: 1 for valid, 0 for invalid. When loop recording, if a marked frame gets
overwritten, the associated event will still be kept but will be marked as invalid
because the related frame no longer exists.

NorPix Inc.

181

10
Tools

This chapter describes the following tools available in StreamPix 8:•10.1 Tools Menu•

10.2 Command Line Arguments•

10.3 SendRM Support•

10.4 Time Stamp Corrector Utility•

10.5 Time Source Admin utility•

10.6 Editing StreamPix Scripts.

Tools10.1 Tools Menu
Recording Scheduler, see “Recording Manager Editor”.

Load/Save Configurations
All StreamPix settings are saved in the Windows Registry. When you save a configuration,a Registry file (.reg) is created that holds all current content of the StreamPix registrybranch. The Save Configurations option can be used to save a specific setup to be reusedlater, or to alternate between different setups.
Reloading a configuration requires a StreamPix restart. You will need Administrator
privileges, as Windows will ask for permission to write the file content to the Registry.
StreamPix can be started and forced to always load the same configuration file. See“Command Line Arguments”.

Metadata Manager
The Metadata Manager toolbutton launches the NorPix Metadata Manager utility thatcomes bundled with StreamPix 8. This tool is used to configure the metadata allocation in
Sequence files. You will need to restart StreamPix for the new settings to be applied.

NorPix Inc.

183

StreamPix 8 User Guide

Disk Benchmarking
The Disk Benchmarking tool button launches the NorPix Disk Bench utility thatcomes bundled with StreamPix 8. Use this tool to evaluate your system capacity forstreaming frames to the Sequence file format.

Figure 10-1: Disk Benchmark utility

To Evaluate System Capacity
1.

Select the Disk Benchmarking tool button. The utility dialog opens. See Figure 10-1.

2.

Select the drive(s) to test, and optionally the RAM.

3.

Specify either Test selected destinations simultaneously or sequentially.

4.

Set the File I/O configuration and Transfer sizes to test. If in doubt, accept the defaults.

5.

Set the Image Size and # of images to stream. If in doubt, accept the defaults.

6.

Select the Reports to generate.

7.

Select Run Test.

8.

The results are displayed in the utility dialog Log tab.

NOTE: Results provided with this utility should be considered as the best possible

case.

184

NorPix Inc.

ToolsWindows Task Manager
This launches the standard Windows Task Manager. The Performance tab can be used tomonitor CPU usage in order to analyze any frame drop that might occur.

Debug Log
The Debug Log allows you to see the internal status messages. This can be useful forsolving various types of crashes. For instance, if StreamPix 8 is unable to load the desired
grabber, reviewing the log as StreamPix 8 attempts to load the grabber might give an
indication about the cause of the problem.

Performance
Tools > Performance shows an estimate of the:• CPU Usage: as a percentage used by StreamPix 8 of overall capability.
• Memory Usage: Memory used by StreamPix 8 as a percentage of memory
available for this process.
• Network Usage: as a percentage of capability used by StreamPix 8 whencommunicating with StreamPix Remote.

NorPix Inc.

185

StreamPix 8 User Guide

10.2 Command Line Arguments
StreamPix 8 supports a few command line arguments.
StreamPix8.exe -r

Starts a recording as soon as StreamPix finishes launching. If all Workspaces wereselected last time StreamPix 8 was closed, every Workspace will start recording.
Configure StreamPix Settings > Recording and Auto Naming settings to setup thedestination files.
StreamPix8.exe -config "C:\Users\User\Documents\StreamPix8\Configurations\config.reg"

Will overwrite the current configuration with the configuration in the specified file. You
can save your current configuration from Tools > Save Configuration.
StreamPix8.exe "C:\temp\sequence.seq"

Will load the specified sequence file in a temporary workspace.

10.2.1

Audio Exporting utilities
There are 2 audio exporting tools available.
•

Exporting to WAV media container: use audioexport.exe utility.

•

Exporting to MP3 or AAC media container: use Audio2mpa.exe utility.

AudioExport.exe is a command line utility to export a .AUD file to .WAV uncompressedaudio format.
**************************
Command Line Audio Export Copyright 2013 (C) NorPix inc.
**************************
Synthax: AudioExport -X -Y -Z-i
Input wav or aud file. Ex : -i "c:\Program Files\test\audio.aud"-oOutput wave file name. Ex : -o c:\test\audio_out.wav-rRemove bwav specific header information. Output file is wav
compatible only.
-dPrint out audio file header and content infomation (informative
only, input file only).
-coSpecify the number of audio track in the destination file.
If it is Specified, -ch# ## must also be defined.
-ch# ## Specify the audio track mapping: # input track position, ##output track position

186

NorPix Inc.

ToolsAudio2mpa.exe is a command line utility to export .AUD file into either .MP3 or .AAC
compressed audio file. It supports any bitrate, and up to 2 channels (stereo). When
exporting to MP3, the maximum input bit rate is CD quality, 44.1kHz.
**************************
AAC and MP3 audio Export Copyright 2014 (C) NorPix inc.
**************************
Syntax: Audio2Mpa -X -Y -Z-i Input wave file. Ex: -i "c:\Program Files\test\audio.wav-o Output audio file name. Ex: -o c:\test\audio_out-aac Output aac audio.
-mp3 Output mp3 audio(default).
-b Bitrate. default 128000-d Printout audio file header and content information (informative only,
input file only).
-co Specify the number of audio track in the destination file.
If it is Specified, -ch# ## must also be defined:-ch# ##: Specify the audio track mapping: # input track position, ##output track position.

NorPix Inc.

187

StreamPix 8 User Guide

10.3 SendRM Support
SendRM.exe (Send Registered Message) is a command line application that allows you tosend registered messages to any application.
The command line syntax is: SendRM “Window Name” “Message”
The first parameter of the SendRM is the Windows title of the application which will
receive the message. SendRM must use the windows title of the StreamPix 8 instance thatis currently running, usually “StreamPix 8”.
StreamPix 8 is able to process external messages that will start recordings, stop
recordings, etc. More messages will be added with time and as users request.
You can call SendRM directly from the command line, the "Run" prompt, the Windows
Scheduler, etc.

NOTE: StreamPix 8 must be running at the time the messages are sent.

Here is the syntax for StreamPix 8 messages currently supported.
SendRM.exe "StreamPix 8" "WM_CLOSE"
SendRM.exe "StreamPix 8" "STREAMPIX_MESSAGE_START_RECORDING"
SendRM.exe "StreamPix 8" "STREAMPIX_MESSAGE_STOP_RECORDING"
SendRM.exe "StreamPix 8" "STREAMPIX_MESSAGE_SNAP_FRAME"
SendRM.exe "StreamPix 8" "STREAMPIX_MESSAGE_SAVE_AND_CLOSE"
SendRM.exe "StreamPix 8" "WM_COPYDATA" "..."

The following commands can be used to change camera settings:
Here is some C++/Win32 code in case you want send messages directly from yourapplication.
HWND targetWindow = FindWindow(NULL, _T("StreamPix 8"));if(targetWindow){//Do a snap in workspace 3
UINT registeredMessage =RegisterWindowMessage(_T("STREAMPIX_MESSAGE_SNAP_FRAME"));
SendMessage(targetWindow, registeredMessage, 3, NULL);}188

NorPix Inc.

ToolsSTREAMPIX_MESSAGE_START_RECORDING, STREAMPIX_MESSAGE_STOP_RECORDING and
STREAMPIX_MESSAGE_SNAP_FRAME also has an optional argument identifying the target

workspace index. For example, this command will start the recording in the thirdworkspace:
SendRM.exe "StreamPix 8" "STREAMPIX_MESSAGE_START_RECORDING" 3

The WM_COPYDATA is used for more complex messages. Its string consists of several
values, separated by the # character.
Here are the supported commands and their syntax. NorPix can add more commands onrequest.

10.3.1

Recording Format
Syntax:#recording_format#(ID)#The format parameter specifies the target format. Use this table to find the desired format
value.
FormatID for StreamPix 32-bit

ID for StreamPix64-bit

Sequence on disk00Sequence in RAM

1

1

AVI

2

2

MOV

3

(Not available)

BMP

4

3

JPG

5

4

TIFF

6

5

PNG

7

6

FITS

8

7

JPEG 2K

9

8

DPX

10

9

Table 10-1: Recording Formats IDs

Example:SendRM.exe "StreamPix 8" "WM_COPYDATA" #recording_format#3#

NorPix Inc.

189

StreamPix 8 User Guide

Grabber Adjustments
Grabber Adjustments change a specific value for a grabber adjustment. You can see thelist of every adjustment supported by the grabber by clicking on the [Adjustments] buttonin the grabber Docked Dialog.
The first syntax example sends the command to every Workspace. The second form sends
the command to a specific Workspace.
Syntax:#grabber_adjustment#(AdjustmentName)#(value)#or#grabber_adjustment#(AdjustmentName)#(value)#(Workspace Name)#

Example:SendRM.exe "StreamPix 8" "WM_COPYDATA" #grabber_adjustment#Frame rate#10.0#

Will set the frame rate of the virtual grabbers in every workspace to 10 fps. (works
because the virtual grabber has an adjustment named "Frame rate").

Grabber Settings
Grabber settings use a similar syntax to Grabber Adjustments.
Syntax:#grabber_setting#Format#BGR#
Or#grabber_setting#Format#BGR#Workspace1#

Export Full Sequence
Syntax:#export_full#(ID)##export_full#(ID)#Workspace1##export_full_to#(ID)#Workspace1#FilePath#

The first does an "export full sequence" on every Workspace.
The second does an "export full sequence" on a specific Workspace only.
The third one does an "export full sequence" on a specific Workspace using the provided
file path as the target destination.

190

NorPix Inc.

ToolsThe (ID) parameter specifies the target format. Use the following table to find the desired
format value.
0 = Project (StreamPix Studio Only) NOTE: Obsoleted in StreamPix 8.
1 = Seq
2 = Avi
3 = Mov (StreamPix 32-bit only)
4 = Bmp
5 = Jpeg
6 = Png
7 = Tiff
8 = Dpx
9 = Fits
10 = JP2K
11 = Dng
12 = JpegXR
Example:SendRM.exe "StreamPix 8" "WM_COPYDATA" #export_full#2#

NorPix Inc.

191

StreamPix 8 User Guide

10.4 Time Stamp Corrector Utility
This utility can be used to fix possible corrupted or incorrect time stamp on a sequence
file. It updates some information in the file header as well as fixing each frame time stamp
information.
For example, this utility could be used to fix backward time stamping created when usinga GPS time source and travelling west to east in between time zones while recording
images. At some point, when recording with local time zone settings, time will change
backwards.
This command line utility sets the sequence file header frame rate to a value of yourchoice, reads the time stamp for the first frame and calculates from there the time stampfor each following frame based on the set frame rate. It will replace broken or corrupted
time stamps with the calculated one based on the specified frame rate.
Syntax> tscorrector -i -r-i Input sequence file full path name. Ex : -I "c:\test\sequence.seq"-r Frame rate for Input sequence. Ex for 29.97 fps: -r 2997

For example:
tscorrector -i E:\test.seq -r 4000

NOTE: If the acquisition frame rate is not constant, this utility will not fix time stamps

properly.

NOTE: This utility does not currently support compressed sequences.

192

NorPix Inc.

Tools10.5 Time Source Admin utility
The Time Source Admin utility (found at C:\Program Files\Common
Files\NorPix\TimeSourceAdmin.exe) allows selecting the source for:• LTC time source when using audio input• GPS configuration when using a GPS device as a time source,

Figure 10-2: Time Source Admin utility dialog

NorPix Inc.

193

StreamPix 8 User Guide

10.6 Editing StreamPix Scripts
Caution: Editing StreamPix 8 internal scripts will change StreamPix 8 behavior and isreserved for very specific cases.
FOR EXPERIENCED USERS ONLY

Tools > Script Engine > Reload Saved Scripts: Loads the most recently saved scripts fromthe registry (if any).
Tools > Script Engine > Save Current Scripts: Saves the current scripts, including any

modification to the scripts made from Edit StreamPix Scripts. The saved script can then be
reloaded from Reload Saved Scripts or using the Tools > StreamPix Settings > Session >Reload Scripts option.
Tools > Script Engine > Edit Scripts: Lets you edit the internal StreamPix 8 scripts.

StreamPix 8 scripts control the internal StreamPix 8 workflow and the interaction between
StreamPix 8 and any loaded plugin modules. This is the main dialog used to browse andedit events by Workspace. Each workspace has at least one module, the StreamPixCore
module, and may include additional modules if any plugins have been loaded in it.
Once a Workspace and sub-module are selected, the list box in the middle of the dialog
will show all events for the module.
Clicking on an event displays detailed information in the Event Description box and also
lists all parameters available to the submodule.
You can save your current scripts with Tools > Save Current Scripts. Next time you launchStreamPix 8, reload them using Tools > Reload Saved Scripts.
When an event is selected, the bottom box shows what actions are taken when it is called,each line of a script calling a specific command. Using the buttons to customize the script
for an event:• Insert New Command: Will make the Select a command dialog pop-up. The
selected command is automatically appended at the end of the script.
• Remove Command: This will remove the currently selected command.
• Reset to Default: Should an event differ from its original behavior, clicking on
this button will reset it to the default script.
• Move Up / Move Down: Use this to change the order in which commands are called
when the event occurs.
• Indent Command / Unindent Command: If one of the commands is a conditional
statement, the line(s) that are indented below it will be called if the parameter
becomes true. When the parameter is false, the script will simply jump to the next

194

NorPix Inc.

Toolsunindented line. Thus, indenting a script command line will make it conditional
to its related event.
Double-clicking on a script line shows the current script command and its parameters.
This dialog allows you to select a command to add to the script of the event selected in the
Customize StreamPix dialog. Normally, the command should only be chosen from thecommands available to a module of the current workspace. It is possible to select acommand from another Workspace, although it will fail if the other Workspace is notloaded.
Selecting a command from the list will show the command description along with theparameters required by the command. Once a command is selected, select Insert New
Command.
Select a command dialog allows you to allocate parameters for the command. A

description of the parameter in the dialog title and a list of the variables compatible with itis displayed. Selecting a variable will also display a description of its contents.
The Local Variables tab displays the list of compatible variables local to the event, which
are only accessible while the event is being executed. Clicking on the Global Variables
will display variables that are always available, regardless of what event is being called.
Finally, the User-creates Variables panel is used to create your own variable, for example:
a constant for a function that requires a numerical value. Such as ScriptControl's “Sleep”
command.
This dialog works in the same way as the Local Variables tab, displaying the compatible
variables available on a global scale and not only for a specific event. The Workspace andModule drop-down lists allow to access the global variables of any loaded workspace.
This dialog is similar to the last two. You can select an existing variable or create a newone, edit its value or delete it. Not all types of variable can be user-created. For example,
the VarImage can't be user-created. However, VarBool and VarUINT can. If the buttons
are disabled, then the requested type can't be created.

NorPix Inc.

195

A
Plugin Modules

This appendix lists the available StreamPix 8 modules. StreamPix 8 modules are
divided into two groups:•

Free Modules, which contain plugins available to any StreamPix 8 user•

Premium modules, which require a specific license from NorPix Inc.

All modules are a part of StreamPix 8. If a module is unavailable to you, it isbecause your system lacks the specific license. Contact NorPix Technical Support
for authorization.
This Appendix contains the following sections:•A.1. Loading & Unloading Plugin Modules•

A.2. Free Modules•

A.3. Premium Modules

Plugin Modules

Loading & Unloading Plugin Modules
This docked dialog is used to load and unload external modules named or plugins.

Figure 1-1: External Modules dialog box

Captured or playback images can be processed by modules. Various processing is applied,depending on the module.
If multiple modules are loaded simultaneously, it is important to understand that images
will go through each module sequentially. The module order may have some importance,
for example, you may want to apply an image rotation before adding a text overlay.
A module can be loaded multiple times. For instance, to apply 2 text areas, load the module
twice.
To load a plugin:1.

Select a plugin from the Available list on the left and click on Load.
The module is added to the Active list on the right.

To unload a plugin:1.

To close an external module, select its entry in the Active list and click Unload.
TIP:

Double-clicking also works to load/unload.

TIP: The two buttons at the bottom allow you to load/unload a module to/from all

Workspaces in a single click.

NorPix Inc.

197

StreamPix 8 User Guide

Free Modules
AEC Control
The AEC Control Module (AEC LTC time code generator or reader) provides the ability
to configure and control an AEC (Adrienne Electronics Corporation) time code generator
board. The module can also be used to read and display the current time code from a boardthat doesn't have time code generation capability.
The time code reader is enabled automatically each time the module is loaded. The current
time code is displayed in the Reader field along with Drop Frame (DF) state, as shown
below.

Figure 1-2: AEC Control dialog box

To enable the time code generator, select the Enable LTC Generator check box. Generated
time code is displayed in the Time field along with Drop Frame (DF) state. The time code
generator can be configured to:• Generate a NTSC (with or without frame drop), PAL or FILM time code
• Start from a specified time (using computer clock)• Reset time.
To run the time code generator, select the START button. To turn it off, select the STOP
button, as shown below. To leave the time code running but temporary disable the output
select Disable Output.

Figure 1-3: AEC Control dialog box usage

The Model status box on the bottom of the module window displays information about the
AEC hardware and driver version.

198

NorPix Inc.

Plugin Modules

Auto Gain Exposure Iris
The Auto Gain Exposure Iris module monitors image grey level intensity and compares it
to your defined target value. It then tries to adjust camera gain and/or exposure and/or iris
(if available) to maintain the image grey average level within the target value.

Figure 1-4: Auto Gain Exposure Iris dialog

Gain and Exposure changes increase or decrease by automatically calculated step values(Default Step).
Sometime, on cameras with a very wide range of gain or exposure, the auto calculated stepis too large and prevents the algorithm from convergence. In which case, you canoverwrite the step value by entering a different (typically smaller) step value.
The module gives priority to gain, then exposure, and finally the iris. Minimum andmaximum gain and exposure ranges can be set, to keep things within values.
This module requires incoming frames to be able to operate. On cameras with a low frame
rate, the response time for the module may be slow, since it needs new frames to perform
its calculations.
This module tries to maintain an average grey level based on a target value by adjusting
either camera gain, exposure or iris. Gain and exposure are usually camera parameters,
while iris will require a motorized lens with remote control capabilities for the iris. The
module can either operate with all 3 controls when available or only a subset.
The module calculates some image statistics (minimum, maximum and average grey
level) over the whole image area for all pixels (raw pixel directly out of the sensor withno color interpolation).
The module will adjust gain/exposure/iris so that image average grey level is kept arounda target value.
Target value is true pixels average value. For an 8-bit image, dynamic range goes from 0
to 255. Mid grey would mean a target value of 128.
For each of the control, a minimum and maximum range can be set, so that for instance,large exposure value would not reduce camera frame rate.
NorPix Inc.

199

StreamPix 8 User Guide

The module works individually per workspace. So, when using multiple cameras, themodule must be loaded within each workspace.
By default, the module calculates a new analysis every 100 millisecond (10 times per
second, or a 30 fps every 3 frames). A registry key can be set to set the elapse time
between 2 calculation for instance to reduce system load.
Key Path: H_KEY_CURRENT_USER\Software\Norpix\StreamPix\Setup\[workspacename]\Auto Gain Exposure Iris\
Key Name: WaitTime
Key type: DWORD
Key Value: the interval duration between each calculation in millisecond(default 100)

The module correction algorithm may need a few runs to reach the right exposure value,
since the step increment is constant. So, a large lighting change may request 2 or 3 steps.

Basler Camera Link
This module allows accessing and controlling Basler Camera Link based camera
parameters. The camera must be GenIcam compatible. Parameters such as exposure time,
gain, trigger mode can be adjusted. In order for the module to be loaded, the latest Basler
Pylon driver and viewer must be installed.
The module can control a single camera, or if multiple Basler cameras are connected, thesame command can be set simultaneously to all connected cameras.

200

NorPix Inc.

Plugin Modules

Background Correction
This module is still under development. Not all feature may be available nor properly
functional.

This module performs image background correction using a reference image. The module
supports any image size, monochrome only, 8, 12 and 16 bits.
Once a reference image has been captured or loaded, the module will provide thecapability to run the background correction processing either:- At grab level (on all captured frame),- At display level (on all frame display on screen),- Apply correction while exporting frame.
A reference image use for the background correction can be captured and then saved or
reload.
Frames: Enter the number of frames to be captured and average together to generate thebackground image
Capture: Click capture to begin the capture process of the reference images. At the end of
the capture the Frames are average together.
Save: Click Save to be prompt for a file name when saving the reference image to disk.
Image is saved with the .ftd extension.
Load: Click Load to reload an already saved image.
Background processing: (the same processing is applied whatever the bit resolution is
8/12/16 bit):
1- Reference image is float converted and normalized between 0 and 1, performed by adivision by 255/4096/65535.
2- Captured image is normalized between 0 and 1 for each pixel: Output = (float) Input /255.0 (Pixels with intensity at 0 will be set to 1 before normalization)
3- Corrected Image = Output / Reference (floating operation)
4- Corrected Image is converted back to 8/12/16 bit after the dynamic range is computed,
and where minimum pixel intensity level is remapped to 0, and maximum pixel level
intensity is remapped to 255/4096/65535, other pixels intensity levels are linearly
NorPix Inc.

201

StreamPix 8 User Guide

remapped in between.

When the correction is applied at display level, correction parameters can be adjusted to
select the pixel intensity range to be corrected. The ranges of max and min are from 0 to
255/4095/65535. max is always larger than min.
Min and Max parameters are used to define the remapping:(L-min)/(max-min)*255 for 8-bit(L-min)/(max-min)*4095 for 12-bit(L-min)/(max-min)*65535 for 16-bit
where L is the pixel value.
If L < min, then set L = min; If L > max, then set L = max.

BIRGER Control
The BIRGER Control Module allows lens control via a BIRGER unit.
Adjustments Tab

Figure 1-5: Birger Adjustments tab

This page allows changing the focus and the aperture. Also, you can save/load focus andaperture presets. When the zoom changes, the aperture and aperture range values are
updated. Also, when the focus changes, the focal distance is updated.
Auto Update Lens Status

You can enable or disable auto updates on the lens status. Monitoring the lens status
requires sending and receiving status information to the lens control unit, which adds
traffic between the computer and the camera. Under certain conditions, this added traffic
can lead to dropped frames. In which case, it is highly recommended to disable thecontinuous status update. When status is needed, select Read Lens Status to retrieve
current lens parameters.

202

NorPix Inc.

Plugin Modules

Settings Tab

Figure 1-6: Birger Settings tab

This tab is used to set up the communication with the BIRGER unit. If the unit isconnected directly to the camera, the Grabber Interface should be used. For this, the serial
communication should be already set up in the camera settings. If the unit is connected toa COM port, then the Serial COM option should be selected. If the module established asuccessful connection, it will display some information about the lens and the BIRGER
unit.

Bitmap Overlay
The Bitmap Overlay Module provides the ability to “burn” a bitmap file (*.bmp) into each
captured image. It supports all bitmap file formats (monochrome, 16 color, 256 color, 24bit color). The bitmap file can be applied to all StreamPix 8 supported image formats. The
Bitmap Overlay Module can be used, for instance, when some constant information needs
to be applied on images, such as a logo or reticule.
General Tab

Figure 1-7: Bitmap Overlay tab

This includes general settings for the module.
• Bitmap: Specify the bitmap File to be used.
• Burn to Image on Capture: Bitmap is burned in place of image pixels for each
image at capture time.
• Burn to Image on Export: Bitmap is burned in place of image pixels for each
image while exporting.

NorPix Inc.

203

StreamPix 8 User Guide

Generally, it is not necessary to check both options. For instance, if Burn to Image On
Capture is selected, the resulting image will include the bitmap. Upon export, there is noneed to re-process the images again.
Color & Position Tab

Figure 1-8: Bitmap Color and Position tab

This tab can be used to define the transparency color as well as the position where thebitmap will be burned to the image.
• Transparency: All .bmp files must include either a white or black backgroundcolor. That background color is used as a transparency color to display normal
image pixels. All the colors, except the transparency color in the bitmap, will be
displayed in the captured image.
• Change Display Color for Binary bitmap: Set display color for binary bitmap.
• Position: Select a position to overlay the bitmap on the captured image.

BlackMagic Playout
This module will use the video output available on certain Black Magic Design frame
grabber to output captured or playback video from StreamPix.

Video Mode: Depending on the frame grabber different output resolution can beselected.
Enable Playout: By default the playout if disabled. Select Enable to turn it on.

204

NorPix Inc.

Plugin Modules

Command LineThe command line module allows to execute via a shell command line operation a 3rdparty application or batch file following a specific event in StreamPix. Many event
notifications are available from StreamPix machine state event notifier.
Select Asynchronous if you do not want the module to wait for the end of the executionof the 3rd party application before continuous.
A single action can be applied per event.

Crosshair
The crosshair module allows you to burn a crosshair on your images.

Figure 1-9: Crosshair module

Draw Crosshair...

This section determines when the crosshair burning happens.
• At grab level the crosshair will be written on the images as soon as they arereceived from the camera.
• On displayed frames will show the crosshair on image received from the camera
but after any saving process occurs. It will also show a crosshair on images readfrom a sequence file.

NorPix Inc.

205

StreamPix 8 User Guide• On exported frames applies the crosshair to any images exported from asequence, regardless of the destination format (seq, avi, bmp, jpg, etc.)
Crosshair
Crosshair shows the current X and Y pixel coordinates of the crosshair in the image.

To move the crosshair, enter in new values, or use the mouse to place the crosshair on thecurrent image by left-clicking anywhere on it (dragging is also supported).

NOTE: Moving the crosshair with the mouse cannot be done while in multi-display

mode.

Selecting Lock Position will prevent accidentally changing the crosshair position. While
locked, mouse control of the crosshair is disabled, and the X and Y boxes are read-only.
The Size is the number of pixels shown on each side of the center pixel. For example,
selecting 5 will result in a crosshair made of two 11-pixel lines. Thickness allows you tochange the crosshair thickness, as specified in pixels.
Crosshair Color lets you to change the color of the crosshair. Default color is grey.
Center moves the crosshair position to the exact center of the current image.

To burn the Crosshair pixel coordinates:

NOTE: The coordinates are shown as an (X,Y) string.

1.

Select the coordinates Position on the image. Choose from: None, Topleft, Top, Topright, Bottom-left, Bottom, Bottom-right.

2.

Select the overlay colors: Text for the text color, Background for the text backgroundcolor. If the text background color is the same as the text color, no background color
will be used resulting in a transparent background.

3.

Select the “Font” and “Font Size” to use to draw the string. For best results, use fixedwidth fonts such as Terminal or Courier.

Broadcast

If Broadcast crosshair position changes to other workspaces is checked, changing thecrosshair position in this workspace will also change the crosshair position in every otherworkspace which also has the crosshair module loaded.

206

NorPix Inc.

Plugin Modules

Selecting Broadcast settings changes to the other workspaces will broadcast any changes
made to the module settings (except for the crosshair position) to every other workspace
which also has the crosshair module loaded.

Command Line
The Command Line module allows you to trigger external commands when a given event
happens in StreamPix. The module displays a list of every event available to which themodule can react.

Figure 1-10: Command Line module

Select an event from the list and then type a line to be executed in the Command field. If
the Asynchronous checkbox is checked, the command execution will be done in parallel.
If the box is unchecked, the Workspace will wait for the command execution to complete
before going on.

WARNING: When not in Asynchronous mode, StreamPix may drop frames while recording if

the response and execution times are significant.

Select Apply to save and enable the currently selected event. Select Clear to disable thecurrently selected event.
The Command Line module is mostly intended to trigger .exe, bat or similar files.
However, any type of file is supported. Command line parameters are also supported.
Don't forget to use the complete file path (not just a file name) and use "" to enclose thepath if there are any spaces in it.

NOTE: Make sure your Command runs correctly if pasted in a DOS commandprompt (cmd).

NorPix Inc.

207

StreamPix 8 User Guide

Comment overlay
The Comment Overlay Module allows users to overlay or burn directly to the image data
multiple lines of text. The module settings are performed via 2 separate tabs described
below.
General Tab.

Figure 1-11: Comment Overlay moduleThis includes general settings for the module.
• Overlay: text is overlaid within the image viewer area.
• Burn to Image on Capture: text is burned in place of image pixels for each imageat capture time.
• Burn to Image on Export: text is burned in place of image pixels for each image
while exporting.
• Comment: Type multi-line text to be overlaid or burned.
Font & Position Tab

This tab can be used to adjust font and position for comments in an image.

Figure 1-12: Comment Position

The font and position rendering may be different for overlay mode versus burn mode:• Overlay mode: font and position are applied only on the final image render bitmap
for display. Hence, zoom factor has no effect.
• Burn to image: font and position are applied directly to the image pixels. Hence,zoom factor applied for display purpose may change the way the image and text
are rendered.
The Font & Position tab contains the following fields:

208

NorPix Inc.

Plugin Modules• Font: Select what font to use.
• Size: Select what font size to use.
• Overlay Position (OffsetX and offsetY): Set where to overlay Text.
• Change Font Color: Set overlay text color.
• Change background Color: Set overlay text background cover.

Compression Estimator
This module can be used to tweak image compression parameters in StreamPix Settings |Sequence.

Figure 1-13: Compression Estimator module

When analyzing frames, the module uses StreamPix current compression settings(StreamPix Settings | Sequence | Compression for new sequence). It then reports thefollowing:• The size of resulted compressed image• The number of frames per second that can be compressed• An estimated compression factor (ratio between the compressed size versus thefull uncompressed image size).
• For JPEG compression, it reports the average size in bytes of each compressedframe.
• For H.264 compression, it reports the average size in bytes for each Group Of
Frames (GOP). Typically, a GOP contains 30 frames.
This tool is useful to determine the needed buffer size when doing loop recording into a
Sequence file. During loop recording, the ring image buffers will be over-written during
the loop process. Choosing a buffer size too short will not allow the software to store all
the frames as compressed frames may be too large to be stored in place.
Select Start to begin analyzing incoming frames.
Select Update StreamPix Settings once the analysis is done to see the recommended values
to be used for updating StreamPix current compression settings (StreamPix Settings >Sequence > Compression for new sequence).

NorPix Inc.

209

StreamPix 8 User Guide

Custom Metadata Overlay
Custom metadata overlay is a module that can interpreted some pixels values stored in theimage buffer as metadata. Certain cameras replace a few lines of pixels by extra
information related to the camera status. The modules allow to overlay those metadata asclear text on top of the image.

Overlay font and font size can be defined as well as the XY offset coordinate of theoverlay into the image.
An XML file can be used to specify exactly the nature and position of the metadata andthe way it can be interpreted.
Contact Norpix support for further details on how to fill in the XML file.

Exposure Time Reader
The Exposure Time Reader module can be used to read the current exposure time value
directly from the camera registers and display it in the image as a text overlay message.

Figure 1-14: Exposure Time Reader

In order to use the module, the related camera must include an exposure register which isaccessible from StreamPix 8 Home > Hardware Properties dialog.
Exposure time values can be displayed on Live and/or Playback streams and can become apermanent part of the images or stored in a .CSV file. Text overlay settings (font, position,
background color) are also configurable.

NOTE: Upon receiving an image from the camera, the module reads the current

camera exposure value and overwrites the first 4 pixels of the image with thebinary coded value of the exposure.

210

NorPix Inc.

Plugin Modules

File Automatic Deletion
The File Automatic Deletion module can automatically delete old files, making it a great
tool for unattended systems, where disk space must be monitored and maintained properly.
The module monitors a predefined computer file folder. Two criteria are used to monitor
disk space and delete outdated files:• A maximum number of files can be defined (oldest file is deleted).
• A Time out (in hours) can be defined so that all older files will be removed.

Figure 1-15: File Automatic Deletion module

The File Automatic Deletion dialog box contains the following fields:

NorPix Inc.

211

StreamPix 8 User Guide• Folder to Manage: The folder that will be monitored.
• Deletion Rule: The operating mode for removing old files:• Time Out: Delete files older than “XXX” Hours.
• Number of file: Delete oldest file to keep only latest “XXX” Files.
• File Type: File type to monitor. It is possible to specify a file type extension to bemonitored.
- Sequence: Sequence file only
- Movies: .avi or .mov
- All Files: any files.

FLIR MappingThis module is used to remap, in real time, high dynamic range images (10, 12 14 or 16 bit
per pixel) into an 8 bit dynamic range suitable for image display.
The module will analyze, in real time, the image dynamic range and determine theminimum and maximum pixel intensity. It will then calculate a remapping table (LUT) sothat each pixel within the dynamic range is linearly remapped into an 8 bit image
between 0 and 255.
That 8 bit image is then displayed by StreamPix. The remapping process is only applied on
displayed images. The captured video data out from the camera is recorded unchanged.

Figure 1-16a: Non remapped 16 bit
image from a hermal camera where
only the 8 SB are displayed:

Figure 1-16b: Same image, remapped for
display:

Note: This module has no user dialog into the docking panel.

212

NorPix Inc.

Plugin Modules

Focus Assist
The Focus Assist module provides a quick means to adjust focus. A red curve appears on
the image upon loading the module.
The line represents the average sharpness per pixel column. A flat line means the image isout of focus. A line marked with spikes means the image is in focus. Adjust the camera
focus to have the steepest spikes:

Figure 1-17: Focus Assist image

An ROI can increase efficiency. The ROI can be set either manually, through the ROIDefine field, or using the Interactively click and drag to define ROI button.

Figure 1-18: Focus Assist dialog

GRT Header Data
This module displays in real time the header data captured via Great River Technology
Matrix frame grabber.
Header data are transmitted along with the images.
This module supports various display templates, depending on the header format
transmitted with the images.
To select the template, browse the header format file template (.hfd extension) needed.
Press the Show Header Data button, which opens a dialog that displays the header dataaccording the template format.

Figure 1-20: GRT Header Data module

NorPix Inc.

213

StreamPix 8 User Guide

HDR Exposure Control
High Dynamic Range Exposure control. This module controls an Arduino UNO
microcontroller. The micro-controller is receiving a single trigger pulse and will output adouble exposure signal to drive camera exposure. The Arduino controller will output 2
trigger pulses each with pre-programmed duration to allow capturing consecutively 2
different images at 2 different exposure. This allows performing High Dynamic Range
exposure, as both exposure duration can be precisely pre-programmed.

Duration for both exposure time are in microsecond.
Contact Norpix support to acquiring the firmware needed to program the Arduino UNO
microcontroller.
Captured frames can then be rendered using the HDR Processing module

HDR Processing
High Dynamic image processing: This module can be used in conjunction with the HDR
Exposure Control Module. Once a Sequence file has been captured with double exposure,
captured images can be post processed by the module.
The module processes each pair of frame, combining a low exposure (high intensity areasof the image) with a long exposure (low intensity areas of the images) to render a perfect
dynamic. The module can process 8, 10 or 12 bit pixel resolution. A maximum clipping
intensity can be defined.

HistogramThis module computes the image histogram in real time. It supports monochrome, raw
Bayer and color image format.
• For monochrome and raw Bayer images, only the red channel is relevant.
• For color images, the red, green and blue channels are calculated.
The X-axis represents the intensity of each channel while the Y-axis shows the percentageof pixels in the image that have this intensity.
The Histogram module works on images, live stream, or a sequence.

214

NorPix Inc.

Plugin Modules

Figure 1-19: Histogram module
Histogram > Settings lets you:

• Display only specific channels (ex: only green).
• Show the histogram as a series of lines or a bar graph.
• Ignore extreme intensities.
• Plot the histogram using a logarithmic vertical scale.
• Plot only within a specific intensity range for better rendering.
The histogram is a powerful tool to adjust the brightness, contrast, offset, gain or exposureof the image to help obtain the best image quality for post-processing.

TIP: To conserve CPU resources for time-critical operations, unload the Histogramplugin when recording.

NorPix Inc.

215

StreamPix 8 User Guide

H.264 Decompressor

Figure 1-60: H.264 Compressor module

When capturing an H.264 compressed stream from a camera or a Web video source, theH.264 decoding can make heavy demands on the CPU. When multiple H.264 streams areprocessed simultaneously, the CPU load can be overwhelming, resulting is inconsistentbehavior.
Since decoding is mostly used for image display, this module allows you to reduce theCPU load with a few options for frame decoding and display. The module can be loaded
and the decompression rate set per Workspace. The options are:
• Do nothing: No frames are decoded. StreamPix will display a black frame. Can beused when recording is needed without display.
• Decompress key frames only: The key frame for each H.264 group of frames isdecompressed. Typically, this will allow the display of 1 frame every 30 frames,with a moderate CPU load, and the ability to serve multiple Workspaces.
• Decompress all frames: All received frames are decompressed (CPU intensive)
and are made available for display.
This module processes received frames at the grabber level as well as during export. It
reduces the CPU load since frames received from the frame grabber do not need to be all
decoded earlier in the pipeline.

IDT Mx Camera Control Tool
This module allows you to control and adjust some of the most important IDT M3 camerafeatures by sending specific commands to the camera using the MVX SDK, the camera
API. Therefore, before loading the module, the communication with the camera must be
set up properly and tested in the MVX Control application. For this module, the frame
grabber that connects to the IDT M3 camera must disable the serial communication.
Otherwise, the module will not be able to connect to the communication port.

Figure 1-21: IDT Mx Camera Control module

216

NorPix Inc.

Plugin Modules

The Image page of the interface lets you adjust the ROI (on X only), Sync In, Gain,
Exposure Time, Frame Rate. Setting the ROI defines a new range for available frame
rates. Changing the Frame Rate sets a new range for available shutter times.
The Settings page allows you to open the camera you want to use. The available cameras
are displayed in the list only after choosing the proper Baud Rate. Then, select the cameraand press Open camera.

NOTE: When the camera is configured in 10 taps, use the STP4Admin application(found in the same folder as StreamPix.exe) to set the IDT M3 Control Tool
module: 10 taps mode setting to Yes.

Image Channel Viewer
This module can extract a specific channel from an RGB color image for display.

Select the color channel that you want to be display in place of a regular color RGB 24 bit
image.

NorPix Inc.

217

StreamPix 8 User Guide

Image Alpha Blending
The Image Alpha Blending module is used to blend the image from the current workspacewith either:
A. The image from a secondary workspace,or,
B. A reference frame from the current workspace.
When the first option is used, the secondary workspace has to be loaded before the Image
Alpha Blending module. The secondary workspace can then be selected from the drop
down list.

Figure 1-22: Image Alpha Blending module

When the second option is used, a reference frame is taken from the current workspace by
default when the module is loaded, if there is a live image. The reference frame can bechanged at any time by selecting the Take Reference button.
The level of blending transparency can be adjusted between 0 and 100 percent.
The current blended image can be saved as a JPEG using the Save to JPEG button. There isalso an info field that indicates the status of the file saving.

NOTE:

218

For now only monochrome and BGR packed image formats are supported.
Contact Norpix technical support if other image formats are needed.

NorPix Inc.

Plugin Modules

Image Resize And Crop
The Image Resize And Crop module provides the ability to resize or crop the images from acamera to any desired size. This module is not supported in StreamPix 8 single camera
version.
The module needs to be loaded into a separate workspace, since it produces a different
image stream. It can be used while recording or during live display.

TIP: To crop or resize a Sequence, use the Batch Processor utility.

Figure 1-23: Resize and Crop module• Source: Enter the Workspace name from the corresponding video stream you
want to resize.
• Interpolation: Select the interpolation scheme to use when resizing. Schemes are
sorted by inverted speed and quality. Nearest Neighbor is the fastest algorithm,
lowest quality.
• Full Image: Check if you want to resize the complete source image.
• Keep aspect ratio: Check if you want the maintain the original image aspect ratio.
• Source ROI: The Full Image box must be unchecked to define a Source ROI. Thiscan be used to crop an original image.
• Destination Size: Allows to set the destination image size.
• The Apply button instantly apply the ROI changes to the destination resizedimages.
• The Start button enable the resizing process.

NOTE: When resizing a raw Bayer image, the Bayer interpolation will be applied

before the resizing to make sure the bayer pattern is not damaged during theresizing process. Also the image will be converter to color BGR 24 bit. Bayersettings are applied according the current workspace settings. Click the Start/
Stop button to get the parameter reloaded.

NorPix Inc.

219

StreamPix 8 User Guide

Image Rolling Averaging
The Image Rolling Averaging module can be applied on live captured frames from acamera or grabber device. It supports all image formats with the exception of pixel pack,
BGR555 and 565.
The module can be used 2 ways:• Rolling average mode: When loaded in the same Workspace as the grabberdevice, the calculations are performed and applied “in place” to the images
received from the grabber device. A rolling average is performed over the
specific number of frames received last. The input and output frame rate are
identical.
• When the module is loaded into a separate Workspace than the grabber device,
the operating mode can either be a rolling average or a standard frame averaging.
In standard frame averaging mode, the output frame rate is the input rate divided
by the number of frames to be averaged.

Figure 1-23: Image Rolling Average module• Workspace: The Workspace of the video source or grabber device from where theimage will be processed.
• Number of frames to average: The depth size for the averaging calculation.
• Mode: The available mode are automatically determined by the module,
depending on its loading context.
• Clear Buffers: Empty the average buffer. Any accumulated frames are lost.
During rolling average, output frames are unchanged until the module average buffer isfilled.

Image Splitter
When capturing at very high frame rate, frame grabber can combine a series a frame
together into a single image buffer. This reduce the number of interrupt and event to beprocessed per frame. For instance, with capturing an image with a small vertical size suchas 16 pixels, very high frame rate can be achieved such as 20000 frames per second. Thisis usually generating too much events for being reliably processed by the operating
system. Combining 10 frames into a single image buffer will reduce the event rate to 2000
per second, something easily manageable.
This module allows exporting the captured buffer into a new sequence file, where theoriginal captured buffer is split into individual frames.

New Image Height: The module will use that information to split the captured buffer into

220

NorPix Inc.

Plugin Modules

images of that size.
Export: Select export to begin the export process.

Image Rotation
This module can be used to rotate the image shown in the display area in real time. Pixels
in the destination image that do not have any corresponding pixels in the source image are
zeroed. Rotated pixels that do not fit in the destination image are clipped.
The module has the following parameters:• X and Y Position of the center of rotation point (COR). The COR can be definedoutside of the image boundary. By default, COR is the image center point.
• Rotation angle, from 0 to 360 degrees, with decimal increments.
• Destination image size: The rotated image can keep the same image size as thesource, or you can specify the X and Y size. Useful for 90 degree rotation. Bydefault, image size is identical.
• Interpolation algorithm: Nearest pixel (faster), bilinear or bicubic (slower, more
CPU intensive).
• Because edges are typically degraded during image rotation, one can enable edgesmoothing.
• By default, the module uses the camera/grabber as the image source, but can be
configured to perform a rotation using a source image, a playback sequence, or adisplayed image.
Most image formats are supported with the exception of all compressed image formats andpixel packed image formats as well as a few color image formats such as RGB555 and
RGB565.

JVC Image Splitter
The JVC Image Splitter module has been ported from StreamPix 3.n. The JVC camera has
2 modes of operation when outputting video:• 640x480 @ 30 fps• 320x240 @ 120 fps.
The 320x240@120 is a custom output: 4 images 320x240 packed together into a 2x2
quadrant delivering a 640x480 images @ 30 fps. The module splits the four quadrant
images from the 640x480 into four 320x240 images, making it 120 fps. This module
works only for color RGB24-bit format.

NorPix Inc.

221

StreamPix 8 User Guide

Image Statistics
The Image Statistics module shows the Minimum, Mean, and Maximum per image
channel in real time. The Settings tab lets you display the statistics, including Standard
Deviation, as an image overlay. The ROI lets you retrieve statistics for an ROI by either
entering the coordinates or by clicking and dragging in the image. The Font & Position tab
lets you define the appearance of the overlay.

Figure 1-24: Image Statistics module

The module can be applied to a Live display, a Sequence, or to an image. When applied toa Live display and then recorded, the overlay information is saved in the Sequence.
Once the module is loaded, the docked dialog stays open until unloaded. If the minimum
and maximum for one channel reads as 0 or 255, this could mean that one or more pixelsof the image are underexposed or saturated.
The module usefulness is reduced when working with a high-contrast image and, as thecolor levels are remapped for each image, it should be unloaded to lower CPU usage.

KinectThe Kinect for Windows sensor includes cameras that deliver depth information,color data, and skeleton tracking data.
The Kinect module is designed for Kinect for Windows devices (Kinect for
XBOX360 devices are not supported) and renders depth, video and skeleton data,
presenting the result as image overlay. It can be configured to trigger various actionsin StreamPix, based on data received from the Depth stream.

Figure 1-24: Kinect module
When you load the module, you can see the following:• Red-green-blue (RGB) color image from the Kinect sensor, if the color stream is
222

NorPix Inc.

Plugin Modules

selected in current Workspace.
• Background in gray scale and different people in different colors, if the depth
stream is selected in current Workspace. Darker colors indicate objects that are
farther from the camera.
• Tracked skeletons of up to two people who have been detected within the frame.
If moving figures are too close to the camera, unreliable or odd images might appear in theskeleton and depth views. The optimal range is 2.6 to 13.12 feet (0.8 to 4 meters). The
module detects people only if the entire body fits within the captured frame.

NOTE: Enabling any image processing on a Depth stream image will alter depth

information as each pixel within the image contains depth data.

The following events can be detected on the color stream:• On Skeleton Detected - when Kinect starts tracking at least one skeleton• On Skeleton Lost - when Kinect stops tracking all skeletons
The following events can be detected on the depth stream:• On Skeleton Detected - when Kinect starts tracking at least one skeleton• On Skeleton Lost - when Kinect stops tracking all skeletons• On Distance Closer Than - when depth is less than a certain value• On Distance Farther Than - when depth is greater than a certain value• On Distance Within - when depth is within a certain range
The following actions can be triggered:• None (testing mode) - outputs a message in debug log• Start Recording - starts recording if possible• Stop Recording - stops recording if possible• Pre/Post - triggers a Pre/Post event (to be used with the Pre/Post module)• Mark Frame - marks current frame• Set Reference Time - sets current time as “reference time”
Additionally the module provides the ability to display some useful data as an image
overlay:• Tracking Skeleton - shows current tracking state• Color Timestamp - shows current Color frame timestamp• Depth Timestamp - shows current Depth frame timestamp• Skeleton Timestamp - shows current Skeleton frame timestamp• Closest/Farthest Depth - show the minimum and maximum depth values within aframe for all tracked skeletons.
NorPix Inc.

223

StreamPix 8 User Guide

For a complete documentation for the Kinect for Windows device, visit
http://www.microsoft.com/en-us/kinectforwindows/

Lens Control
The Lens Control module allows controlling some lens parameters as Iris, Focus andZoom. The sent command will execute the function for the value of the Duration
adjustment. Only one command can be sent at a time.

NOTE: The module is supported only for some AVT Prosilica GigE, GigE Visioncompatible, and Dalsa Genie TS, Pleora eBUS driver interface, and Matrix
Vision cameras.

Lens Control IOIThe Lens Control IOI module allows controlling some lens parameters such as Iris andFocus when using a Birger lens adapter with IOI Flares CXP cameras.
This module behaves the same ways as the BIRGER_Control module but does not need
information regarding the RS232 control channels as it will be using the CXP frame
grabber communication channel with the camera.

Live Levels
The Live Levels histogram monitors every frame captured by the grabber, computes thegrey level averages and plots them in real time. The radio boxes enable selection of thehistogram display, either in the docked dialog, in a new display in the Workspace, or both.

Figure 1-25: Live Levels module

TIP: Use a multi-display configuration with the Show in a Display to allow viewingof the image and histogram at the same time.

LTC Overlay
The LTC Overlay module shows the LTC value stored in the first 32 bits of each image(requires an supported LTC source device). The module has no docked dialog when
loaded. However, it has a few settings that can be changed through the STP4Admin
application (found in the same folder as StreamPix.exe).
The settings are: “LTC Overlay Module show frame number” and “LTC Overlay Module
224

NorPix Inc.

Plugin Modules

font size”.

Lynx IPX Camera Control
This module allows you to control and adjust the Shutter Time (also known as exposuretime), Gain and Frame Rate of some Lynx ImperX cameras by sending specific commands
via serial communication. An ImperX camera must be loaded and the serial
communication must be enabled before loading the module into the current Workspace.

Figure 1-26: Lynx IPX Camera Control

Optionally, the exposure time reader can be used to read the current exposure time value
directly from the camera and display it as an image overlay. Exposure time values can beshown on Live and/or Playback streams with the possibility to permanently write thevalues on the images or store them in a .CSV file.
Text overlay settings (font, position, background color) are also configurable.

Matrix Switch
The Matrix Switch module allows you to program a Smart-AVI 4x4 DVI Router device towork on two different modes:• Capture mode:- Set video INPUT1 to OUTPUT1 and OUTPUT3- Set video INPUT2 to OUTPUT2 and OUTPUT4• Playback mode:- Set video INPUT3 to OUTPUT3- Set video INPUT4 to OUTPUT4.

NOTE:

NorPix Inc.

another DVI matrix configuration can be added at the user's request.

225

StreamPix 8 User Guide

Metadata Overlay
The Metadata Overlay module can be used to display the metadata of an image as a string
overlaid on the image. The first tab allows you to set which metadata types to display, if
present. Some metadata types might not show if they can't be represented as a string (i.e.
some metadata are stored in binary formats).

Figure 1-27: Metadata Overlay module

The Overlay tab is used to tell the module at which point(s) the metadata strings should beburned on the image.
The second tab allows you to configure the text appearance. The text position, font, sizeand color can be set from here. If the text and background color are the same, the text
background will be transparent.

Metadata Spy
The Metadata Spy module can be used to setup metadata acquisition in StreamPix 8.
Monitor > Monitor Live metadata monitors the metadata of the live feed, useful to set the
metadata size when using the constant metadata size mode. The largest metadata size seen
will be shown as the Recommended Metadata Size. Once the largest size is determined, you
can select -> to copy this value to the edit box, then select Set new size to write the value tothe registry.
The Current Metadata Size is the maximum amount that can be stored after each image in asequence file. It needs to be large enough to accommodate the largest metadata size that
could come with an image. If you set the size to '0', the metadata will be stored with adynamic size.

Caution: Keep in mind that you can't record in a loop when using dynamic storage.

The Inspect tab displays the metadata information for the currently shown image (either
from the Live or from the current Sequence).
In both tabs, the lists display the metadata name, the space (in bytes) required to store it,
and its content (if formatable to a string). Each metadata value, regardless of its length
comes with an 8-byte header. (This is why storing a single byte of metadata takes 9 bytes.)

226

NorPix Inc.

Plugin Modules

Measurements
This module allows quick measurements on an image by drawing some small overlays.
Once loaded, this module does not have any user interface on the docking panel. Rather, a seriesof buttons are added into the Modules ribbon area.

Use Calibration to define a specific scale for the measurements. Multiple scale and calibration
an be definided,• Use Point-to-Point tools to measure the distance in between 2 points in the image,• Use Area to measure and estimate a rectangular shaped area
• Use Ellipe to measure and estimate an ellipsoid shaped area,• Use Freehand tool to measure and estimate any custom area shaped area,• Use Angle to measure angle in between 3 points defining an angular segment,• Settings can be use to define various parameters for the overlays, such as color, font,
and text size.

MJPEG Decompressor
When capturing an JPEG or MJPEG compressed stream from a camera or a Web video
source, the MJEG decoding can make heavy demands on the CPU. When multiple
MJPEG streams are processed simultaneously, the CPU load can be overwhelming,
resulting is inconsistent behavior.

Since decoding is mostly used for image display, this module allows you to reduce theCPU load for frame decoding and display. The module can be loaded and thedecompression rate set per Workspace.
• Decompression Every: Enter the skip rate for frames to be decompressed.
• Broadcast: Since this module can be loaded for each workspace, parameters
settings can be broadcasted to all workspaces in a single step.

Mikrotron Control Tool
This module allows you to control and adjust some of the most important Mikrotron
camera features by sending specific commands to the camera via serial communication.
The frame grabber that connects to the Mikrotron camera must be loaded and the serial
communication must be enabled before loading the module into the current workspace.

NorPix Inc.

227

StreamPix 8 User Guide

Figure 1-28: Mikrotron Control Tool module

The Image page of the interface lets you adjust the ROI, Digital Gain, Black Level,
Shutter Time, Frame Rate. Setting the ROI defines a new range for available frame rates.
Changing the Frame Rate sets a new range for available shutter times.
On the Settings page, the available features are: Shutter Mode (Free Run, PWC, Timer),
Shutter Polarity (Positive or Negative Edge), Mirror Mode (OFF, X Only, Y Only, X andY) and FPN correction (enabled or disabled).
NOTE: When the camera is configured in 10 taps, use the STP4Admin application(found in the same folder as StreamPix.exe) to set the Mikrotron Control Tool
module: 10 taps mode setting to Yes.

Monochrome Conversion
This module allows to convert a color image or 16 bit monochrome image into an 8 bit
monochrome image.

Figure 1-29: Monochrome Conversion module

YUV Color images are first converted to RGB. A monochrome component is thencalculated from the RGB as an average of red, green and blue component: M =(R+G+B)/3.
This process can be applied real time if CPU permitting.

Object Overlay
This module is deprecated. It is now replaced by Quick Overlay Module.
228

NorPix Inc.

Plugin Modules

Optronis Camera Control Tool
This module allows to control and adjust some of the most important Optronis camerafeatures by sending specific commands to the camera via serial communication. The
frame grabber that connects to the Optronis camera must be loaded and the serial
communication must be enabled before loading the module into the current workspace.
The Image tab of the interface lets you adjust the ROI, Sensitivity (Gain), Black Level,
Shutter Time, Frame Rate. Setting the ROI defines a new range for available frame rates.
Changing the Frame Rate sets a new range for available shutter times.

Figure 1-29: Optonis Camera Control Tool module

On the Settings tab, the available features are: External Sync (OFF, ON), Sync Source(Cable, Grabber), Sync Polarity (Low, High), Sync Mode (Edge, Level), Mirror Mode
(OFF, X Only, Y Only, X and Y) and FPN correction (enabled or disabled).

Phantom S990 Banks Merge
This module allows merging real time multiple video streams generated from a Phantom
S990 camera. As this camera is controlled via 2 to 4 frame grabbers, it delivers either a 2
half or 4 quarter images (2 banks mode or 4 banks mode). Each banks stream can bemerged together using this module for either a live preview or generating a merged fileduring an export process.

Output format are SEQ, AVI, MP4, or a series of individual images, stored into JPEG,
TIFF or another supported file container.
NorPix Inc.

229

StreamPix 8 User Guide

Photon Focus Camera Control Tool
This module lets you adjust the Photon Focus camera features via serial communication,using the PFRemote API. Before loading the module, the communication with the camera
must be set up properly and tested in the PFRemote application. For this module, theframe grabber that connects to the Photon Focus camera must disable the serial
communication. Otherwise, the module will not be able to connect to the communication
port.

Figure 1-30: Photon Focus Camera Control Tool module

After a valid communication port has been selected in the Settings tab, the moduleconnects to the camera and Image, Exposure and Adjustments tabs become available,
depending on the features supported by the camera model. If a feature is not visible or notaccessible, it means that it's not supported. The adjustable features might include ROI,
Shutter Time, Frame Time, Trigger Mode, Correction, Simultaneous Readout.

Picture in Picture
The Picture in Picture module provides the ability to combine image from a video source
into another video source live display. This module is not supported in StreamPix 8 single
camera version.
The module needs to be loaded into the workspace where the picture must be
extracted. It can be used while recording or during live display.

Picture in Picture module• Target workspace: Select the target workspace where the picture will be
send.
230

NorPix Inc.

Plugin Modules• Target Offset X: Horizontal offset in pixels for the position of the picture
into the target workspace.
• Target Offset X: Vertical offset in pixels for the position of the picture into
the target workspace.
• Source ROI: The Full Image box must be unchecked to define a Source ROI. Thiscan be used to crop an original image.
• The Apply button instantly apply the ROI changes to the destination resizedimages.

Pixel Value Exporter
Pixel Value Exporter module can be used to export pixel intensity values of captured
images into a series of CSV Excel compatible files.

A default base file name is extracted from the current loaded sequence file. Whenmultiple images are exported, each CSV file includes the base file name and an index
corresponding to the image position into the sequence file.
Single image, a range selection or the full sequence can be processed.
Pixel intensity values can be exported with a decimal or hexadecimal formatting.
Click Export to generate the CSV files. On very large files, this process can takesignificant time.

NorPix Inc.

231

StreamPix 8 User Guide

Pixel Viewer
The Pixel Viewer module allows the user to print out the pixel intensity values. Press
the Show Pixel Viewer button to open a new dialog with the printout data. Pixel
intensity values are updated real time.
The displayed values can be either formatted as integer or hexadecimal numbers. This
module can be applied to both live and recorded images.

An ROI can be selected to narrow the area of interest. Mouse area selection is also
supported directly into the image viewer area. On a very large ROI, the refresh rate canbe significantly slower because of the large number of information to be printed.
The module supports the following image formats: BGR, BGRx, RGB, YUV,
monochrome (8, 10, 12, 14 and 16 bits). Pixel packed image formats are not supported.

232

NorPix Inc.

Plugin Modules

Point-To-Point Caliper
The Point-To-Point Caliper module lets you make point to point measurements on thecurrent image. To find the distance between two points, left-click on the first point anddrag the cursor to the second point. The module will draw a line between them, and themeasured length will be shown. The line will remain visible until a new measurement ismade, you click without dragging, or click the Clear button.

TIP: For measurements to mean anything, you must of course calibrate the module

first, as explained below.

Measure tab

In the Measure tab, the options under Draw Overlays determine the circumstances inwhich overlays are drawn:• Select At grab level for overlays to be drawn on images as they are received fromthe camera.
• Select On displayed frames for overlays to be shown regardless of image source(camera or sequence file) and regardless of whether overlays will be saved.
Select On exported frames to apply overlays to images exported from a sequence,in all file formats (seq, avi, bmp, jpg, etc.).
• Select Lock Overlay to make the module ignore mouse actions.

Figure 1-31: Point-to-Point Caliper module

In the Units box, enter the unit of measurement desired (pixels, mm, m, cm, km, %, etc.).
In the Decimals box, enter the number of digits to show after the decimal point.
Select the Clear button to erase the current measurement line.
Calibrate tab

When you switch to the Calibrate tab the module enters calibration mode, which is used to
set reference values. When you subsequently draw a measurement line, those values will
be used to compute the line's real length. Switching to any other tab puts the module out ofcalibration mode.
To calibrate, start by selecting one of the three calibration methods available:• Inter-pixel is the simplest method. It assumes that you know the exact distance
between adjacent pixels on the image. To calibrate, enter that distance under
NorPix Inc.

233

StreamPix 8 User Guide

Calibrated Length. The current calibrated length will appear as an overlay at thebottom of the image.
• Between 2 points is the standard method. This method requires you to left-click
and drag the calibration line's handles to make a line of known length on theimage. Enter that length under Calibrated Length. Note that if you subsequently
redraw or remove the calibration line you will have to adjust the Calibrated
Length value accordingly. For the best accuracy, use a longer calibration line.
• Between 2 points (Horizontal & Vertical) is an advanced method. It is only used forcameras that do not have square pixels, i.e. where the CCD inter-cell distance is
not the same horizontally and vertically. The calibration procedure is the same as
for the previous method, except that you have to do it twice, once with ahorizontal line and once with a vertical line. Both must be done formeasurements to be accurate.
When calibration is completed, switch to the Measure tab and do a couple of test
measurement lines to see if everything is correctly calibrated. If not, return to Calibrate andreadjust the calibration.
Overlay Settings tab

This tab controls how the various overlays are drawn.
Style lets you select between two ways of displaying a measurement line: as a Simple line,with a T at each end or with Handles. T-end lines are the default.
InfoText lets you determine where and how to display the text indicating the length of themeasurement line. You can position it to any corner of the image and select the font andfont size. For best results, use a fixed-width font such as Terminal or Courier..

Figure 1-32: Point-to-Point Caliper Overlay Settings

In the Colors box, select Text to change the color of text overlays (default is white on
black). Select Line to change the color of the measurement line (default is pink). Under
Text Background, if you select the same color as that used for text the background will betransparent to the image.
In the Scale box, enter the Length of the scale using the unit of measurement you selectedin the Measure tab. From the pull-down list, select the corner of the image in which toposition the scale, along with its orientation (H = horizontal, V = vertical). To hide thescale, select “None”.

234

NorPix Inc.

Plugin Modules
NOTE: When working with a line with “Handles”, the line is moved by dragging its

handles (the small circles at each extremity). At any time, double-clicking on
any part of the image will move the handles near the mouse pointer. The
precise start and end points of the line are in the exact middle of each handle.

Configurations tab

This tab allows you to switch between various configurations (i.e. calibrations).

Figure 1-33: Point-to-Point Caliper Configuration tab

To create a new configuration, first define a calibration in the Calibrate tab. Then, click on
Save current settings to a new configuration. The module will prompt you for a namewhich will then be shown in the list of available configurations. Repeat for as many
configurations as needed.
Once you have created different configurations, you can switch from one to another onthe-fly by double-clicking on the required configuration from the list. You can also
overwrite an existing configuration with Save current settings to the selectedconfiguration. Delete unneeded configuration with Delete selected configuration. For bothof these, the “selected configuration” refers to the configuration highlighted in the list andnot the one currently loaded.

Presets
This module can be used to store and restore a series of camera presets. Camera frame
rate, camera gain and camera exposure are query, saved and can be reloaded. The camera
must be genIcam compatible, and exposure its adjustments with the specific gain,
exposure and frame rate name. Up to 4 different group of preset can be stored.

Select the tab Save in order to first save some presets.
Select the tab Load to restore into the camera registers the saved presets.

PTG Overlay(This module is specific to Point Grey cameras)
NorPix Inc.

235

StreamPix 8 User Guide

Point Grey cameras include some specific time stamp information that can be added witheach captured image. The PTG Time Overlay module allows you to decode that
information and have it properly overlaid when the captured image is displayed.
It includes the support for the following 2 extra meta information fields provided by the
Point Grey camera API:•PC system clock•

Embedded image timestamp.

To enable the feature on the camera, open hardware properties, select Settings tab, and set“Time Stamp” to ON (default is OFF).
When the feature is on, the embedded image timestamp will overwrite the first 4 pixels ofan 8-bit image (32 bit). The same mechanism is used for the PC system clock: next 4
pixels (32 bit) includes the epoch time in second, and next 4 pixels (32 bit) include theepoch microseconds.
.

Figure 1-34: PTG Time Overlay Module

The PTG Time Overlay Module allows you to “burn” or “overlay” the time stamp
associated with each image directly on the image itself. You can specify the font type,size, position and location on the image. The overlay information can include Cycle time(embedded image timestamp) and/or Epoch time. This can be useful when capturing/
exporting to AVI or image files, because those formats don't have time stamp support.

Quick Overlay
This module allows drawing various overlays into an image.
When loading the module, a new Modules ribbon is inserted at the end of the ribbon bar:

Select Modules | Quick Overlays to access the object controls:

236

NorPix Inc.

Plugin Modules

Figure 1-35: Quick Overlay Ribbon

Ellipse, Rectangle, Arrow, Crosshair, Freehand and Text are available.
Each object drawn as an overlay is merged and overwrites pixel values into the image
data. Object thickness, as well as its drawing color, can be adjusted by selecting Edit
selected overlay.
Select Delete selected overlay to delete the overlay.
Handles around object edges are available to select, resize and drag each object.
There is no persistence of the quick overlays when quitting the application.
Note: When using multiple workspaces, the Quick Overlays module must be loaded into
every workspace where its usage is requested.

Raptor Photonics Control Tool
This module works with both OWL 640 and OWL 320 Near IR and IR cameras from
Raptor Photonics.
By default the module displays the interface for the OWL 640 camera. To switch between
the 2 supported camera models, in the module dialog, select to the Info tab, then select thedesired camera, and then press the Initialize button.
To communicate with the camera, a Camera Link frame grabber has to be loaded in thecurrent Workspace and the serial communication needs to be set up under Hardware
properties->Settings.
These are the settings for the OWL cameras:• Data Length -8 bit• Stop Bits -2• Parity -None• End Character -None• Text Mode -Hexadecimal• Communication Type can be set either via clserxxx.dll (select CLSER Port andalso set CLSER Baud Rate to 115200) or via COM Port.
• To set the Communication Type via COM Port, the COM Port has to be selected
first. Also, for COM Port, the UART Baud Rate setting has to be set to 115200.
Various camera specific parameters can be adjusted via the module tabs:.

NorPix Inc.

237

StreamPix 8 User Guide

Figure 1-36: Raptor Photronics module Image tab

Figure 1-37: Raptor Photronics module Settings tab.Figure 1-38: Raptor Photronics module Info tab

Sequence Disk SpaceThe Sequence Disk Space module calculates the available space for recording on a disk or
in RAM. The module uses the disk selected by the working folder option.

Figure 1-39: Sequence Disk Space module

238

NorPix Inc.

Plugin Modules

Sequence Levels
The Sequence Levels histogram monitors every frame in a Sequence, computes the grey
level averages and plots them in real time. The radio boxes enable selection of thehistogram display, either in the docked dialog, in a new display in the Workspace, or both.

Figure 1-40: Sequence Levels module

TIP: Use a multi-display configuration with the Show in a Display to allow viewingof the image and histogram at the same time.

TIP: Browsing through the Sequence with the Sequence Slider provides a quick sur-vey of general levels, while pressing Play will read each frame in the Sequence.

TOF Viewer
The TOF Viewer module provides the ability to display range and confidence data captured froma Basler Time Of Flight (TOF) camera. It can be used while playback a recording or during
live display.

The module can display current selected pixel intensity, range data and confidence
data. Double click in any displayed item to change current selected pixel. Current
selected pixel is highlited as a red crosshair in all image displayed area.

Figure 1-41: TOF Viewer module

Video source: target source to use for seking data to be displayed. This can be applied

onto the live feed or an already recorded sequence file.
Range Data Pseudo Color: allows to select the false color rendering LUT method.

NorPix Inc.

239

StreamPix 8 User Guide
Range Float mix value: Scaling minimum factor when using a floating-point type for therange data.
Range Float max value: Scaling maximum factor when using a floating-point type for therange data.
Point clound viewer: When enabled, an extra viewing dialog pops up, offering a 3D

display renderring of the point cloud data. This option only works when thecamera is setup to provide floating-point range data.

T.S. Sync Monitor
The Time Source Sync Monitor Module can be used in conjunction with StreamPix
accurate time source devices. The module monitors the time source receiver devices andreports in real time synchronization status information. Supported hardware devices are:
• Meinberg (GPS and IRIG)• Spectracom (GPS and IRIG)• Myricom 10GigE network adapter with Emergent technologies cameras.
Description of the various status modes:
1) The current time source does not implement sync status.
2) An error occurs while querying sync status from the time receiver.
3) The time source receiver is in sync with the reference time source (IRIG B or GPS
world time).
4) The time source receiver is not in sync with the reference time source (IRIG B or GPS
world time).
5) The time source receiver is no longer in sync with the reference time source (IRIG B
disconnected or GPS satellite tracking lost), but the board internal clock is still accurateenough to deliver good time information.

Time Stamp Monitor
This is a watch dog utility that can be used to monitor in real time the incoming frames
time stamp. It computes the difference between 2 consecutive incoming frames andcompares the value with an expected reference value + or - a tolerance.
As an example, at 10 fps, a new frame is expected every 100ms. if the difference is 150ms,
the module will flag the frame assuring tolerance is below 50ms (or 50%).
Flagging is achieved by either marking the frame, outputting debug information or both.
This module is useful for detecting and troubleshooting possible dropped frame issues.
LTC-based Time Source

If an LTC based time source is in use, the module will also display an LTC check box.

240

NorPix Inc.

Plugin Modules

Figure 1-41: Time Stamp Monitor module

When selecting the LTC option, this module will monitor the frame Linear Time Code(LTC) increment.
Select the time code timing via the LTC Time Type, either NTSC or PAL (drop frame mode
is not supported).
Select the camera triggering rate: Depending on your hardware configuration, frames may
be captured at the same time code increment rate, at twice the rate, or 4 times the rate.
The module will monitor time code increment. If the time code increment continuum isbroken, the module will output and/or mark suspicious frames.

UDP Trigger
This module can be used to send notifications to StreamPix, using Ethernet UDP
messages. These messages will be decoded by the module and trigger various StreamPix
actions.
In conjunction with the UDP Trigger Module, a .NET C# sample application is provided.
It can be used to generate and send messages to the module. The sample files and code are
installed with StreamPix in the folder:
C:\Program Files\Norpix\Streampix8\UDPTrigSender.
This module can only be loaded once. Hence, when used in a context of multiple
Workspaces, the module is loaded only once, but can forward messages to specificWorkspaces.
If the module is used for receiving text to be overlaid into the images, it must be used inconjunction with the UDP Overlay module.
The current number of decoded messages is limited. Upon demand, we can add moremessages and implement further functionality. Contact support@norpix.com.
The message is formatted as a string with the following tokens:
Action#Number#[EventName(Workspace)]:User defined message
Action: Keyword. The module always checks messages by searching for this keyword.
#Number#: This is a number that can take any value. It will be retrieved by the module into

a 32-bit integer and is currently reserved for future usage.
EventName: The StreamPix event you want the module to trigger.

Possible values are (without the quotes):“Pre/post”

NorPix Inc.

241

StreamPix 8 User Guide“Start Record”“Stop Record”“Start Playback”“Stop Playback”“Mark Frame”“create new sequence”“create new image sequence”“create new avi”
“create new mp4”
“create new ts”“create new sequence and start recording”“create new image sequence and start recording”“create new avi and start recording”“create new mp4 and start recording”“create new ts and start recording”“create new sequence and start pulse trigger recording”“stop recording, close sequence and export”“Set customToken”“start pulse”“stop pulse”“close video file”“Overlay” -> Load UDP Overlay Module“Test”

Arguments are explained on the sample code project. Have a look at the action.xml file,close to the end of the file.
Workspace: The target workspace name. If workspace name is empty, target is current

workspace or, if Selected All Workspace is active, target will be all workspaces.
User defined message: Any string the user wants to send. It can be retrieved by specific themodule for some specific usage.

IP address: The IP address that the module will be listening from. This must be one of thecomputer network IP address.
Port: The port number the module will be listening from.
Trigger Event: Enable/disable the module. When enabled, the module will forward

received events to StreamPix and workspaces.
242

NorPix Inc.

Plugin Modules
Log UDP message: All received messages will be log to a file, located in %AppData%\Norpix\UDPTrigger
Start/Stop monitoring: Turn on/off monitoring and listening of the UDP messages from the

network adapter.
Auto Monitor when start: When checked, upon loading and StreamPix starting, the module

will automatically begin listening for messages.
When text is needed to be Overlay, adjust overlay style via the Overlay and
Font&Position tabs. Make sure also to load the UDP Overlay module in every workspacethat needs to overlay test into the images. UDP Overlay module has no user interface, butmust be loaded for overlays to operate.

NorPix Inc.

243

StreamPix 8 User Guide

Video OutThe Video Out module allows you to view multiple StreamPix real time camera feeds orstored video sequences simultaneously. The module can send video to any monitor output
from a VGA adapter, meaning that the only limit to the number of concurrent video
displays is the number of monitors available.

NOTE:

For a single camera video out, see “Second View”.

This module supports multiple VGA adapters, making it possible to use one VGA output
per workspace for image display in addition to the standard display found in the main
StreamPix user interface.
Each of the devices and monitor(s) driven by the module are labeled Video Out, in orderto help differentiate them from the main display area where StreamPix is running.
The module can also be loaded using a single monitor configuration. The Video Out
window will appear on top of the main StreamPix display area. Double click the image
area to return to the main StreamPix window.
The Video Out module makes use of accelerated Microsoft DirectX 3D routines. Becauseof the usage of DirectX routines, the module has a low impact on the main CPU. Instead, it
draws extensively from the GPU processing and display capabilities of the computer it isinstalled on.
By default, the module will push a new frame to be displayed every 25 ms, or 40 times asecond. A faster frame rate can be set if needed. Frame display can also be synced with themonitor refresh rate to avoid possible frame tearing effect.
A Registry key can be set to adjust the refresh rate:
Key Path:
HKEY_CURRENT_USER\Software\Norpix\Streampix8\Setups\[Workspace]\TVOut\
Key Type: DWORDKey Name: RefreshDurationTime
Value: refresh interval in millisecond. Default value:25ms

The Video Out module includes several configuration tabs.
General Tab: Basic Settings

Figure 1-42: Color Processing tab• Display Adapter: Select which Video Out monitor to drive. The monitor number
corresponds to the identified display detected by the graphic adapter driver.
• Image Source: Select which video source to display, which can be either a live
camera or a video sequence.
244

NorPix Inc.

Plugin Modules• Stretch Full Window: Stretch the displayed image so that it fits the entire VideoOut monitor area. When source image resolution is larger than monitor
resolution, the aspect ratio is maintained on output monitor.
• Center Display: Center the displayed image on the monitor (image is displayed in
the top left corner when left unchecked).
• Multiple Workspaces: Enable/Disable Multiple Workspaces mode. If Multiple
Workspaces mode is enabled, a Workspace tab is added. Enabling Multiple
Workspace allows for the display of more than one workspace’s content on thesecondary monitor.
• Display: Check this option to activate the secondary display.
• Change Background Color: Opens a color picker so that you can assign a specificbackground color to the secondary display.
• Initialize color rendering LUT from main screen: By default, the module
calculates its own white balance tables. When this is enabled, the Video Out
module will rather retrieve color balancing look up table (LUT) from StreamPix
settings. If white balance settings are set to automatic, then the module will use
what has been calculated within StreamPix main display area. If the whitebalance settings require to load a LUT from a file, then the file content is also
used by the Video Out Module. Using a file allows consistent operation
between sessions.
Bayer Conversion Tab

Use the GPU to Compute the Bayer Rendering

Figure 1-43: Color Processing tab• Bayer Conversion: Enable/Disable conversion. Only useful if displaying a raw
Bayer image.
• Bayer Pattern: Select the Bayer pattern matching your sensor.
• Algorithm: Select the Bayer conversion algorithm (Fast or Accurate).
Color Processing Tab

Use the GPU to White Balance or ASC CDL Color Correct Images

NorPix Inc.

245

StreamPix 8 User Guide
Figure 1-44: Color Processing tab• White Balance: Enable/Disable auto white balance.
• Algorithm: Select the auto white balance algorithm:
Mean Equalization
Gray Word
Standard Deviation
Mean and Standard Deviation
When an algorithm is selected, the Video Out module recalculates white balance with thenext incoming frame.
• Recalculate: Force the software to recalculate white balance using the next frame.
• The Video Out module supports ASC CDL grading color correction with revised
contrast.
The Channel pull down menu allows you to select which color channel to control. SelectAll Channels to apply the same formula for all 3 channels, or select each individual color

plan you want to work with.
The Reset button allows you to reset the default values: Gamma (1), Brightness (0), Gain
(1) and Contrast (0).
Rotation Tab:

The display image on the secondary monitor(s) can be rotated before being displayed. 90, 90 and 180 degrees rotation is possible.
Workspaces Tab: Working with Multiple Workspaces

This tab is available only when the Multiple Workspaces check box is selected on the
General tab. The Video Out display area can then be shared amongst selected Workspaces.
• Two display modes are available:- Hybrid: Where one Workspace is displayed full screen and others are displayed as thumbnails.
- Equally Split: Where the Video Out area is equally split among the various
Workspaces. In split mode, the layout is defined using Video Layout X and Y
parameters.

Figure 1-45: Video Out Workspaces tab• Video Layout X or Y: Set row and column count.
• Display Mode: Select between the available display modes:- Hybrid with thumbnails on the right.
- Hybrid with thumbnails on the bottom.
246

NorPix Inc.

Plugin Modules- Equally Split between Workspaces.
• Main Hybrid: Select the main Workspace source to display.
• Apply Bayer & Color Process to All Workspaces: Set to apply Bayer settings orcolor processing settings to all Workspaces or the main video.

Xenics Cheetah
This module allows real time merging of multiple video streams generated from a Xenics
Cheetah camera. As this camera is controlled via 2 frame grabbers, it delivers 2 half
images. Each image stream can be merged together using this module for either a live
preview or generating a merged file during an export process.

Output format are SEQ, AVI, MP4, or a series of individual images, stored into JPEG,
TIFF or another supported file container.

NorPix Inc.

247

StreamPix 8 User Guide

Premium Modules
Arduino Pulse Generator
Each Norpix DSA (Digital Signal Amplifier) box includes an Arduino microcontroller
which is typically used to generate synchronization trigger pulses at a predefined
frequency to synchronize exposure over multiple cameras.
The cameras have to be configured in external trigger mode, using either StreamPix via
Hardware Properties or their own software, to receive the exposure trigger from theArduino device.
When there are multiple Arduino devices connected, you can select from the Device tab
via the COM port the device that is needed to be controlled. Only one module is needed
per DSA.

Figure 1-46: Arduino Pulse Generator dialog

GeneralEnter the desired pulse frequency and use the Turn ON button to toggle the pulse generator
on and off. Since the pulse train triggers the camera exposure, the pulse frequency will
determine the exact camera frame rate. The frequency precision can be set up to 2
decimals.
You can also specify a Start Delay (generator will start X ms after clicking the Turn ON
button) and a Stop Delay (generator will stop X ms after clicking the “Turn OFF” button).
By default, the duty cycle is 50%. By adjusting the duty cycle, all connected cameras canhave their exposure controlled by the shape of the trigger signal out of the DSA. Cameras
must support pulse width exposure control mode. The duty cycle applies on the level highsection of the generated pulse signal.

248

NorPix Inc.

Plugin Modules

Audio Trigger
This plugin monitors an audio input line and notifies StreamPix when the audio level ishigher than a certain value (threshold).

Figure 1-47: Audio Trigger dialog

To set an audio trigger:
1.

Select the capture audio device and sound format.

2.

Set a threshold value and start monitoring the audio line.

3.

Watch the audio level indicators and adjust the threshold value.

4.

Select an action to be executed by StreamPix when noise is detected. Available
actions are:• None (Testing Mode)• Start Recording• Stop Recording• Pre/Post• Mark Frame• Set Reference Time.

5.

NorPix Inc.

When done, click on the Arm button to arm the trigger. If the Auto Rearm option ischecked the trigger will rearm itself automatically.

249

StreamPix 8 User Guide

DAQ Capture

NOTE: This module is provided for backwards compatibility with StreamPix 5. It is

not recommended to use this module with StreamPix 8. With the appropriate
license, StreamPix 8 already contains everything necessary for DAQ capture.

The DAQ Capture Module allows you to capture analog and digital data from various A/D
converters and TTL input devices. This kind of data is generally described as one
dimension data type (1D) in opposition to images that are two dimension data (2D).
Each 1D data reading is defined as a dataset. Each dataset includes one reading from asingle or multiple A/D converter and/or single or multiple digital input.
1D dataset are recorded and stored into separate files (with a .daq file extension) from theimage Sequence file. The module supports reading from multiple A/D converters anddigital inputs at once, provided this is from the same adapter. A single dataset is performed
per received image.
Only one module can be loaded per workspace. Each module requires full and exclusive
access to the A/D adapter. When using multiple cameras, if A/D reading needs to be
separated per camera, multiple adapters are required.
Each dataset can be displayed on the image by either overlaying or burning to image.

Figure 1-48: DAQ Capture tab

Module features include:• Per Workspace implementation - one DAQ device per Workspace.
• Auto DAQ file naming and generation while recording (.daq file is created withthe same name as the video sequence file).
• Synchronization with start / stop recording event.
• Synchronous playback with video.
• Automatic integration with file handling commands:• File | Sequence Close will close both video and .daq files.
• File | Sequence Open will open the sequence file and the corresponding .daq file
if it exists (provided the module is loaded into the Workspace).

250

NorPix Inc.

Plugin Modules

General Tab

This includes general settings for the module.

Figure 1-49: DAQ General tab• Capture: Enables dataset capture. By default, when loaded, the module does not
perform capture until fully configured. During capture, the configuration cannot
be changed. Maximum capture rate is one dataset per image; however, you canreduce the capture rate.
• Overlay: Enables overlay of the DAQ dataset on the screen.
• Burn to Image on Capture: DAQ dataset is burned in place of image pixels foreach image. Useful when exporting images to other file formats where the .daq
file cannot be reloaded for simultaneous playback.
• Analog DAQ data are printed as decimal numbers. Click the precision dialog tospecify the number of digits to be printed.
• Export Data to CSV File: The .daq file contains binary information. You canexport current .daq files to an Excel compatible comma separated text file (.CSV
file).
Device Tab

The device tab allows you to select a DAQ device to be used, and configure its hardware
properties, and overwrite the destination folder for the dataset .daq file.

Figure 1-50: DAQ Device tab• Destination File: By default, the .daq file is stored in the same folder as the video
seq file. However, if disk bandwidth is not sufficient to handle it, an alternate
storage path can be specified.
• Manufacture: Select a device provider which is supported by StreamPix.

NorPix Inc.

251

StreamPix 8 User Guide• Device: Select what device will be used.
• Analog Range: select what analog range will be used. It's only available foranalog line (this is hardware dependent, and may not exist for all supported
modules).
Analog Tab

This tab allows you to configure each A/D reading and conversion. Only first degree
linear conversion is possible: Y = A X + B:

Figure 1-51: DAQ Analog tab

Where:• Y = printout value• A = conversion slope• X= A/D reading• B= possible offset• Line: Analog line name from device, read only.
• Name: Printed display name.
• ParamA: Type to set conversion function parameter A.
• ParamB: Type to set conversion function parameter B.
• Unit: Unit name to be printed.
Font&Position Tab

This tab can be used to adjust the font and position when overlaying or burning to theimage.

Figure 1-52: DAQ Font & Position tab

252

NorPix Inc.

Plugin Modules• Font: Select what font to use.
• Size: Select what font size to use.
• Overlay layout: Set how to overlay DAQ data horizontal or vertical mode. In
horizontal mode, all analog readings are displayed on a single horizontal line. In
vertical mode, all analog readings are displayed one per line. Digital data isdisplayed on a separate column.
• Overlay Position (OffsetX and offsetY): Set where to overlay DAQ data.
• Change Font Color: Set overlay text color.
• Change background Color: Set overlay text background color.

Frame Grabber (FG) Pulse Generator
This module is used to set up the internal timing generator, available on certain frame
grabbers, to trigger camera exposure at a specified frequency. The cameras have to be
configured, using their own software, to receive the exposure trigger from the frame
grabber and not from another external source.

Figure 1-53: Pulse Generator dialog

Enter the desired pulse frequency and use the Turn ON button to toggle the pulse generator
on and off. The frequency precision can be set up to 2 decimals.
You can also specify a Start Delay (generator will start X ms after clicking the Turn ON
button) and a Stop Delay (generator will stop X ms after clicking the “Turn OFF” button).

NOTE: Please check with Norpix for the up-to-date list of frame grabbers that support

this feature.

GPS / DMI Positioning
This module can be used to decode external GPS device messages and tag captured andrecorded images with the GPS information as metadata.
When the DMI (Distance Measuring Interval) mode is activated, travel distanceinformation from a Pulse Distance Interval (PDI) device can be taken into account tocontrol when cameras need to capture a frame. Image capture is then driven by a travel
distance rather than a periodic capture rate. Multiple cameras can be controlled together
via a single GPS+DMI module.

NorPix Inc.

253

StreamPix 8 User Guide

Besides the current GPS readings, current milepost information can also be gathered
during the image capture and embedded with each image metadata.
Depending on your authorization codes, either the GPS, DMI, or both sections of themodule will be available in the user interface. Once loaded, the module needs to be set up.
Configuring for usage with a GPS device

GPS related information is setup via the GPS Device tab. Selection of collected GPS
information is made via the GPS tab. Overlay information, font and position in the image
are setup via the Font & Position tab.
Configuring the Module
6.

Select the GPS Device tab to configure information related to the GPS device.

Figure 1-54: GPS Device tab
7.

Select connection port USB or COM(rs232) as well as COM port parameters. Check
with your GPS device for adjusting the parameters.

8.

Select the GPS Device Type. Choices are: None, NMEA, NMEA Shared, Garmin Serial
or USB, SIRF, or TSIP.

NOTE: If no GPS device is currently available, selecting None prevents the modulefrom searching for a device.

NOTE: NMEA Shared makes sure the GPS received NMEA strings can be shared

between the GPS module as well as the GPS Time Source.

NOTE: The current NMEA Strings decoded by the module for Glonass, Beidou, orGPS satellite constellation are the following: RMC, GGA, ZDA, SHR (pitch
and roll). More strings can be added on request. The module does not
currently perform any speed nor bearing calculations. Therefore, if the RMC
string is not complete, i.e.: missing the speed and bearing information, that
information will not be available.

254

NorPix Inc.

Plugin Modules

NOTE: When there is redundancy on the sentences, there is a hierarchy order. Duringinitialization, the module will wait until 20 sentences have been received todecide which sentence to use.
For time stamping:
1- ZDA, if not available
2- RMC, then3- GGA.
For Pitch and roll: SHR
For Positioning:
1RMC, then
2GGA.

9.

To forward the GPS data to UDP, select Send GPS Data to UDP, enter the IP address
and port number.

10.

To create a comma separated text file (.csv) that stores the selected GPS information
along with the index of each image during recording, select Save GPS data to file.
The file is created in the same folder as the recorded sequence, AVI, MOV or image
files and uses the recorded file name with a _gps.txt extension. If the destination
media for recording is RAM rather than disk, the file is created in the C:\temp folder
and is called RAM sequence_gps.txt. If a File Name Padding value is specified in the
StreamPix settings > More...> Images page, then that padding will be applied to theimage index in the GPS text file.

11.

Once the GPS communication related parameters are properly configured, switch to
the GPS tab, where the latest received GPS information will be displayed.

Figure 1-55: GPS tab
12.

NorPix Inc.

The GPS tab lets you choose which information will be decoded and stored from the
NMEA string sent by the GPS device. Latitude, longitude, altitude, speed, bearing
and time can be decoded. Depending on the GPS device, not all information may betransmitted. Check with your GPS provider in case some information cannot be
displayed.

255

StreamPix 8 User Guide

NOTE: Overlay data panel is refreshed with new GPS information in real time.

Hence, a 10 Hz GPS will refresh about 10 times per second. As aconsequence, all frames received between 2 messages will be stamped withthe same information. When using high frame rate cameras, a couple ofconsecutive frames can have the same GPS information.

13.

Use the Font & Position tab to specify the font type, size, position and location in theimage. The data can be “burned” on each image or overlaid (no damage to the imagedata).

NOTE: The font size may look different when using the Overlay mode versus theburn to image mode. In overlay mode, zoom factor applied on the image
display has no effect on the display font.

NOTE: When the module is loaded, 2 additional naming scheme tokens areavailable:- If the naming scheme includes the token {GPSData}, the module will
replace this token by the current overlaid data.
- If the naming scheme includes the token {GPSTime}, the module will
replace this token with current GPS time scheme.

User Data tab

The User Data tab includes 3 lines where extra text can be entered. The information isstored in the *.csv log file with the GPS related coordinates.
DMI (Distance Measurement) functionalities

The DMI option includes additional hardware components:• An electronic counter device (usually plugged into the image recording
computer) or via a USB link
• A Synchronization box that allows connecting various input and output signals• An external Pulse Distance Interval signal usually provided by wheel motion
encoder (not provided).
DMI Synchronization Box:The DMI (Distance Measure Interval) module requires the usage of some internal
electronic counter devices directly plugged into the computer. Supported devices are theMeasurement and Computing 4301LS, the National Instruments NI6601 or NI6320
devices and USB Arduino Uno microcontroller which includes some counters and IO
control.
256

NorPix Inc.

Plugin Modules

The synchronization box needs to be connected to the host computer via the provided
cable. The box also includes some output, typically a Hirose 4 pin output connector to
power the cameras and forward the synchronization exposure pulses to each camera.
DMI sync box includes 2 BNC connectors:• DMI Input: That connector must receive the PDI (Pulse Distance Interval) signal
from the wheel encoder. The PDI signal must be a TTL (0-5V) square wave
signal. Pulse rates depend on the motion speed of the vehicle.
• Camera Sync Output: That auxiliary output can be used as a repeater signal toprovide a similar pulse that is used to trigger the cameras.
DMI sync Box includes LEDs that can be used as tools for testing the behavior of thedevice:• Green PC Link LED: When on, that indicates the sync box receives appropriate
power from the computer.
• Red DMI LED: The LED will be flashing at the rate of the PDI. No motion will
generate no pulse.

NOTE: For the pulse to be visible, you may need to adjust the duration of the pulse

via the configuration of your DMI device. The LED is directly connected tothe input line. If the PDI pulse duration is very short (a few milliseconds for
instance) you may not see the pulses: PDI pulse duration may be too short for
the naked eye. However, the counting devices are still able to properly handle
pulses with durations as short as 100 nanoseconds.

• RED Camera LED: The LED will be flashing each time a capture signal is sent toeach camera. When the LED is off, no image is captured.
Setup for the DMI control and camera synchronisation is set via the DMI Device tab.
Current DMI information is reported via the DMI tab, and to a log file if you select that
option on the DMI tab.
DMI device tab

Figure 1-56: DMI Device tab
Input device: Select the device used to count PDI pulse and manage camera

synchronization. Depending on your hardware configuration, various devices may belisted:NorPix Inc.

257

StreamPix 8 User Guide• MCC4301 (USB, supported but obsolete)• NI6601 or 6320 (PCI/PCIe)• Ardiuno Uno (USB).
Edge: This defines the edge sensitivity of the counting device: Typically, the device will

increment the pulse count every rising edge. It can also be set to falling edge.
COM port and Baud rate: These two parameters are only for the Ardiuno Uno device.

Usually Ardiuno devices are installed over a virtual COM / USB port to communicate
with the host computer.
Trigger camera from DMI pulse: Synchronize camera exposure with the PDI pulses. Selectthe number of required pulses between each captured image. This is depending on yourinstallation, number of pulse per revolution your encoder delivers and other parameterslike the wheel diameter.
Trigger camera by time: Alternatively. image capture can be driven by a time base. inwhich case, images will be captured every such time (in milliseconds), independently
from the travel distance. No PDI signal is needed for this setup. This mode can be used totrouble shoot the camera control circuitry interdependent from the PDI circuitry. By
setting a time mode, frames from the camera should be delivered based on that period.
Update mile post on Frame trigger: By default, mile post is updated when an image is

received from the camera driver. Enabling this mode makes the frame tagging with mile
post and GPS information more accurate since the tag information is stored at the camera
exposure time rather than when the frame is received by the computer (delay is typically
exposure time + camera read out time). This feature is only supported with AVT Gigecamera for now.
Delay 2nd pulse: Define the pulse delay for the 2nd pulse should you need to trigger

exposure for a different rig or cameras, for instance, between a front and a back truck
camera rig.
DMI tab: This tab presents current DMI information.
Initial Miles: This allows you to define the initial mileage position when the campaign

starts. At the beginning of a data logging campaign, an initial mile post value can beentered. MilePost will increment / decrement according to the received DMI pulses
starting from that initial value.
Miles per Pulse: parameter defines the PDI incremental distance between each pulse. Referto your wheel encoder or DMI device documentation to enter the right value. An incorrect
value will affect the MilePost calculation.
Increase: Miles Post value will increment when this is checked (default). Uncheck to get

the mileage decreasing.
DMI pulses are directly linked to the travel distance of the vehicle. Image capture issynchronized with DMI pulses. Adjusting the Trigger camera every N Pulses value allows
to define the camera capture rate according to travel distance. Make sure to enter a proper

258

NorPix Inc.

Plugin Modules

value, compatible with the campaign image sample rate, maximum vehicle speed andmaximum camera capture rate.

Figure 1-57: DMI tab
Log to file: Append the current mile post to the GPS .csv file for each captured image.
Reset: At any time, the MilePost value can be reset to the initial mile.

Although the Module can store GPS and mile post data to a .csv file during a recording,that data can also be stored in a metadata file. See “Metadata settings”.

GPS Time Card
This module is useful for displaying GPS data received from certain time source boards
that have also GPS positioning capabilities.
The module allows you to choose which information will be decoded (latitude, longitude,
altitude). Depending on the board, not all information may be transmitted.

Figure 1-58: GPS Time Card dialog

Since GPS boards usually deliver a new message every second, this information isrefreshed every second. As a consequence, all frames received between 2 messages will bestamped with the same information.
The GPS data can be “burnt” on each image or be overlaid (no damage to the image data).
You can specify the font type, size and position on the image.

NorPix Inc.

259

StreamPix 8 User Guide

The Save GPS data to file can be used during recording. It will create a comma separated
text file that stores the selected GPS information along with the index of each image. The
file is created in the same folder as the recorded sequence, AVI, MOV or image files and isusing the recorded file name with a “_gps.txt” extension. If the destination media forrecording is RAM rather than disk, the file is created in the working folder and is called“RAM sequence_gps.txt”.

NOTE: Check with Norpix for the up-to-date list of time source boards that support

this feature.

GRT Playout
The GRT Playout module provides the ability to drive the play-out capability forsupported Great River Technology frame grabbers.

Figure 1-59: H.264 Compressor module

Using this module, you can playback a recorded sequence to both StreamPix Image
Display Area as well as sending the frame back to the frame grabber play out buffers.

NOTE:

This module requires a GRT Play-out license.

The GRT frame grabber has to be loaded in StreamPix to be able to use the GRT Play-out
module.
Also, a sequence file has to be loaded in the same Workspace as the module.
To enable the play-out, start the sequence playback and press the Enable Play-out button.
The board will be automatically configured to transmit images currently played-out.
The module is compatible with all the playback functions of StreamPix: Pause, frame-byframe, go to a certain frame. Drag the playback slider, and it will always transmit thecurrent playback image.
To set the board back to receiving mode, press Disable Playout or unload the module.

NOTE: This module replaces the GRT Play-out Reader utility.

260

NorPix Inc.

Plugin Modules

Image Merge

NOTE: This module requires a specific license. Contact Sales@NorPix.com.

This module is typically loaded into its own workspace, with no grabber device for better
flexibility. This module can combine multiple video sources to create a larger image. It
can be applied while live, recording or exporting images.
During recording, merge stream is recorded according the recording settings.
By default, there is no alignment check, nor frame time stamp synchronization. The
module only waits to receive all frames from each source and then combines images intoa single new image. Sources should be the same image format, but can have a different
image size.

NOTE: Current implementation does not support all image formats. Image formats

hat includes pixel pack are not supported. For other image formats, contact
Norpix tech support for an updated module.

Figure 1-61: Image Merge module• Source image layout: set output image layout. Maximum is an array of 4x4.
• Keep input Format: by default, output image format will be BGR. You cancheck this option to force output image format to be the same as the source
format.
• Camera list: Select the different Workspace names containing the source video
streams. The quadrants are populated based on the index order, from top left tobottom right.
• Merge On: Enable / Disable the merge processing. The module can also be used tomerge pre-recorded sequences.
• Output Format: The result is then exported to various output formats, such
as SEQ, AVI, series of images...
During live or recording operation, the frame rate for the merged sequence is defined by
the frame rate of the last item in the list. When merging frames from cameras running
NorPix Inc.

261

StreamPix 8 User Guide

different frame rates, it is recommended to list the workspace with the fastest frame rate
last.
• Sync frame on time stamp: (export only) This will merge and export

frames from multiple workspace using time stamp forsynchronization: This feature is useful when recording from different
cameras that have different frame rate, and you want to generate a merge
composite video by keeping the frame and time stamp synchronized. The
synchronization is performed according a master workspace. If there is nomaster workspace, then the first workspace will be considered as themaster. The Merged frame is using every frame of the Master workspace
as a time reference and for other merged Workspaces the module uses theframe from each source that is closest in time to the current time stamp of
current frame of the Master workspace. That way, the module willautomatically drop frame (if the other camera is faster) or duplicate frames(if the other camera is slower).

LiDAR Logger
This module connects to a Sick Bulkscan LMS 511 device. It allows you to configuresome of its parameters and to retrieve the data sent by the device.
First, you need to establish the connection with the device by filling in the corresponding
IP address and port in the IP Connection tab. These settings should be previously
configured with the Sick SOPAS Engineering Tool available on the manufacturer's
Website. The connection can be initialized manually, by pressing the Connect button or
automatically, if the Reconnect at Startup option is selected.

Figure 1-62: LiDAR Logger module

Then, in the Measurements page, several parameters can be adjusted: Angular Sweep, Scan
Rate and Angular Resolution. Each time one of these parameters is changed, the new
configuration is sent automatically to the device. Sometimes, reconfiguring the device
262

NorPix Inc.

Plugin Modules

might take a few seconds.
The data captured from the device can be saved separately in a log file and/or as metadata,
embedded in each recorded image.
When saving to a log file, the module creates a text file in the same folder as the recorded
sequence, AVI, MOV or image files and is using the recorded file name with a “_lidar.txt”
extension. If the destination media for recording is RAM rather than disk, the file iscreated in the working folder and is called “RAM sequence_lidar.txt”.
The Mounting Angles tab allows you to fill in the angles at which the device is mounted.
These parameters are also saved along with the data received from the device.
The data structure of the LiDAR output is detailed below.
Sample entry:

1|2012/07/05 16:53:50 314|30,20, 35|DATA_PKT_DISTANCE1_MEAS,
3500,23826,1|2500,0.000000,4294917296,761|405,3058,...

NorPix Inc.

Image index in the sequence

1(group delimiter)

|

Date

2012/07/05

Time

16:53:50

Milliseconds

314(group delimiter)|

X orientation

30 degY orientation

20 degZ orientation

35 deg(group delimiter)|

Measurement type

DATA_PKT_DISTANCE1_MEAS (Distancemeasurement)

Scan Rate

35 Hz

Scan Count

23826 (unique scan line index for this device, will always
increase by 1 with each scan line)

Scale Factor

1(group delimiter)|

Angular Step Width

2500 = 0.25 deg (in 1/10,000 deg units)

Scale Offset

0Start Angle

4294917296 = -5 degrees = (2^32 - 50000) = max longvalue - 50000 (in 1/10,000 deg units)

Number of Data Points

761 (190 deg sweep / 0.25 deg step + 1)

(group delimiter)

|

Data

< 761 Data Values ...> in millimeters from unit

263

StreamPix 8 User Guide

Line Scan Viewer
This module has been designed to display and export to various format images from a line
scan source. Contrary to area scan sources, line scan sources deliver a single line of pixels.
Viewing a single line image where the line is replaced at a high rate is too challenging andof little interest. The Line scan display module allows a waterfall like display, where newlines to be displayed are appended to the previously displayed ones. Older lines eventually
get removed.
Line scan cameras are used to capture web-type data and can be seen as one-dimension
devices, delivering one-dimension images. The typical output of these cameras
implements displaying multiple lines at the same time so that the viewer can picture what
is happening under the camera. Also, line scrolling is required as the older scanned lines
need to be discarded to make room for the newer ones.
Some line scan camera devices or frame grabbers can combine a set of lines together tobuild a kind of area scan line image. The line scan viewer module can also accommodate
those devices, and still present a waterfall like image display.
Page size and image size:

For line scan cameras, we define a page as the number of lines delivered by the camera
within a single image. So a page is basically equivalent to an image. Except that theviewer will combine multiple pages to generate an image for display. Usually, the page
size is 1 line. However, the line rate can be very high, sometimes delivering 20 000 lines
per second, or 20 000 pages/images per second.
Managing 20 000 lines a second could be challenging for most software. However,combining those lines within, for instance, a single page made of 100 lines, allows
StreamPix to deal with more sedate 200 images per second.
The line scan viewer module can also be used to export acquired lines into various
formats:• Combine consecutive lines into a single area scan like image (export to still
images).
• Convert to an equivalent area scan movie.
Once the module is loaded, you will notice a new tab in the workspace display area. Thistab gives access to the linescan viewing pad, while you can still access the usual live
camera pad and sequence pad.

Figure 1-63: Line Scan Workspace icon

The module includes 3 tabs to allow configuring various display and referring options.
General tab: display options

The line scan pad can display images from 2 sources: Direct from the camera or from therecorded sequence file.
When Number of lines is set to Automatic, the number of lines in the waterfall display isadjusted to the viewer window size. When set to Manual, one can define how many lines
264

NorPix Inc.

Plugin Modules

will be simultaneously displayed.
Depending on the scan direction of the web in front of the camera, adjust image
orientation: Forward (most recent page is added at the end of the current set of lines) or
Backward (most recent page is added at the beginning of current set of lines).

Figure 1-64: Line Scan dialog

Depending on camera orientation, it is also possible to have the waterfall display vertically(0 or 180 degrees), or horizontally (90 or -90 degrees).
Below is a one-page 100 line display of a rotated Pepsi® pop can in front of a
monochrome linescan sensor:

Figure 1-65: Typical Line Scan view

Figure 1-66: Waterfall view, vertically and horizontally oriented

The module also includes an option to overlay a captured time stamp for each page. Whendisplaying an image from the camera source, the module will overlay the timestamp of thelast page. In playback mode, three timestamps are overlaid: The oldest page, the middle ofthe view page and the newest page. The overlay position depends on the image
orientation.
Several timestamp display schemes are available. Also, time can be overlaid as absolute or
relative to the first captured page. You can also overlay the page index.

NorPix Inc.

265

StreamPix 8 User Guide

Font & Position tab

This allows customization of the timestamp overlay (position, font, text size, color andbackground color).
Export tab

Exporting line scan pages can be done via the regular StreamPix export command.
However, the module can be used to export the waterfall like display images.

Figure 1-67: Export tab

Consecutive lines in a page can be exported as an area scan-like image. Set the number oflines to the desired size of the image to be either identical to the display area or to yourown choice.
Supported export formats can be one of the following: BMP, JPG, TIFF, PNG, FIT, JP2,
DPX, for still images, or AVI, MOV (32 bit only) and SEQ for movie-like rendering.
When exporting to a movie format, a custom frame rate can be set. By default, the frame
rate of the original sequence will be applied.

Line Scan Video Out Module
Line scan video out module allows controlling a secondary monitor and have a water fallviewing of linescan video captured images.

LineScan Pages entry allows to define how many pages are used to build the waterfall
images.
A page correspond to the number of lines combined together into a frame. When selecting
a number for the Line Scan Pages, make sure that (number of lines per page) * (number ofpages) is not larger than the monitor resolution for optimum performance.
Refer to the Video Out module documentation for further details.

266

NorPix Inc.

Plugin Modules

MCC Pulse Generator
The MCC Pulse Generator module allows to control the image acquisition speed of yourcamera or frame grabber and synchronize the acquisition between multiple workspaces.
The cameras have to be configured to receive the exposure trigger from an external source(i.e. the MCC device).

Figure 1-68: MCC Pulse Generator dialog

To get started, enter the pulse frequency to be generated. Since the pulse train triggers thecamera exposure, the pulse frequency will determine the exact camera frame rate.
The MCC board can be programmed to generate a single pulse train by selecting a single
channel, or multiple synchronized pulse trains if all channels (counters) are used.

NorPix Inc.

267

StreamPix 8 User Guide

Optionally, the MCC board can be programmed to start the pulse(s) with a certain delay.
Use the Pulse ON button to toggle the pulse train on and off.

Motion Detection
The Motion Detection module is designed to perform real time image processing (IP) on
incoming images and upon detecting significant motion or change in the image, it cangenerate an event to StreamPix.

Figure 1-69: Motion Detection module

At load time, the module does not perform any detection. Push the Detect On/Off button toturn on/off the monitoring.
The Module can perform the analysis on the whole image area, or on a defined region ofinterest (ROI).
Three different image processing algorithms are available, depending on the nature of thescene or image to be monitored:• Mean Gray Value: The module will calculate the average gray level in the defined
ROI and upon a change from a reference value, will trigger the event.
• Absolute Difference: The module will calculate the pixel to pixel difference froma reference image and trigger the event when the difference reaches above acertain threshold.
• Max absolute Difference: The module will calculate the pixel to pixel difference
from a reference image, search for the maximum difference value and trigger the
event when the difference reaches above a certain threshold.
The Module can generate any of the six following StreamPix action event, whether thecondition is asserted true or false:• Start Recording.
• Stop Recording.
• Pre/Post Continuous: Continuously generate pre/post events until the condition
resets.
• Pre/Post Reset: While waiting until the condition resets before generating a new
pre/post event.
• Snap 1 frame.
• Mark Frame.

268

NorPix Inc.

Plugin Modules

Configuring Motion Detection Module:

The following parameters must be configured:
Image Source: The module can be applied on an incoming stream of images from a camera

or for tune up purposes, it can be applied while playing back a sequence. During playback,no events are generated since there is no point in managing recording status while playing
back.
Algorithm: Choose among three available algorithms, according to what you think will

best suit your needs. Depending on the algorithm selection, some extra specific parametersneed to be adjusted.
• Mean Gray level: Set the conditions for when the event should be triggered:- Above Threshold,- Below Threshold.
- Adjust the threshold value..

Figure 1-70: Mean Gray Value•

Absolute Difference:- The percentage Mean Gray defines the minimum value in pixel intensity thatmust be encountered before an event is triggered.
- The percentage ROI specifies a minimum number of pixels where the changemust occur.
- Since Absolute Difference performs an image subtraction between the lastreceived image and a reference image, you need to define the reference
image. It can be the previous captured image or an image that is defined as the

NorPix Inc.

269

StreamPix 8 User Guidereference. Use the capture button to capture and save the reference image to
disk.

Figure 1-71: Absolute Difference• Max absolute Difference:- The percentage grey defines the minimum value difference in pixel intensitythat must be encountered before an event is triggered.
- The difference can be calculated between the current and last image or with areference image (constant) that you need to define. Use the capture button tocapture and save the reference image to disk..

Figure 1-72: Max Absolute Difference
Select StreamPix event to be triggered: There are five possible StreamPix events that themodule can trigger:• Start Recording• Stop Recording• Pre/Post Continuous• Pre/Post Reset• Mark Frame.

270

NorPix Inc.

Plugin Modules

To make the module less sensitive to false detection, it is also possible to enable event
triggering only after the condition was detected continuously for a specific number ofconsecutive frames.

Figure 1-73: Event trigger

Select ROI

Motion Analysis can be performed either on a full image size, or using a specified regionof interest (ROI). ROI can be defined by either manually entering the coordinate of theregion in the image, or by interactively clicking and dragging an ROI on the display area.
If multiple ROIs are needed, load the module multiple times.

Caution: Beware of the added CPU load, since this module is performing extended

image processing.

If the total processing time takes longer than the frame time, the module will not process
the next incoming frame. It will finish processing the current frame, then wait for the nextone.

NI Pulse Generator
This module can be used to trigger camera connected to a National Instruments Legacy
device. The module is quite simplistic. Enter the desired pulse frequency and use the [TurnON] button to toggle the pulse generation on and off.

Figure 1-74: Ni Pulse Generator

You can also specify a Start Delay (generator will start X ms after clicking the Turn ON
button) and a Stop Delay (generator will stop X ms after clicking the Turn OFF button).

NorPix Inc.

271

StreamPix 8 User Guide

NI-DAQmx Pulse Generator
Similar to the NI Pulse Generator plugin, the NI-DAQmx Pulse Generator module is used
to program a National Instruments board to generate continuous pulses with a specified
frequency. The I/O board must be compatible with NI-DAQmx drivers and support pulse
generation.

Figure 1-75: NI-DAQmx Pulse Generator

Simply enter the pulse frequency and use the “Pulse ON” button to toggle the pulse
train(s) on or off.
If multiple channels are selected, the pulse trains will start/stop in synch.
The pulse train triggers the camera exposure and so, it controls the camera frame rate.
Assuming the board is programmed to generate multiple pulse trains having the same
frequency, all the cameras will be synchronized, since the pulse trains are synchronized.
You can also specify a Start Delay (generator will start X ms after clicking the “Pulse ON”
button).

NI Pulse Divider
The NI Pulse Divider module provides a way to divide a pulse train frequency. The
National
Instruments I/O board must be compatible with NI-DAQmx drivers and support pulse
generation.

Figure 1-76: NI Pulse Divider
14.

Specify the terminal where the input pulse that needs to be divided is present.

15.

Select the output channel and enter a divisor.

16.

Use the Start and Stop buttons to start or stop the pulse train respectively.

Limitation: the divisor must be greater than 4.

272

NorPix Inc.

Plugin Modules

ONVIF Pan/Tilt Control
The ONVIF PAN/Tilt/Zoom control module provides a way to remotely control a camera
PTZ unit. The camera must support ONVIF and the PTZ unit connected to the camera (orbuilt in).

This module requires that an ONVIF Compatible IP Camera is loaded as the video source(See Grabber Selection).

Second View
The Second View module is similar to the Video Out module, but displays a single
Workspace and automatically switches the display to the Workspace that has the current
mouse focus. You can zoom, pan and scroll using mouse gestures. See “Video Out”.

SimulPix
The SimulPix module provides the ability to combine the output of two cameras into asingle image. The resulting image looks like the 2 images are superimposed. Currently,
two algorithms can be applied for combining the 2 images:• Merge 2 images together from the 2 separate sources (Alpha blending)• Image division: any source can be divided by the other source.
The module provides registration functionality: the 2 images can be horizontally andvertically offset or rotated. In Alpha blending mode, each source image can be displayedwith a separate color. The module performs the calculation in real time (less than 10 mswith an Intel Core 2 duo processor T7200), providing real-time visual feedback in single
or multiple display mode.
The SimulPix module works with cameras that acquire synchronously or not. SimulPix
will wait until it receives an image from each camera before performing the rendering. If
the 2 cameras are not capturing at the same time (synchronized or Genlock), this may
result in a short delay.

NorPix Inc.

273

StreamPix 8 User Guide
Figure 1-77: SimulPIx module

Each camera can have a different image size and ROI, but must have the same bit depth.
Image format should be monochrome, 8, 10, or 12 bit.
All parameters except source cameras can be changed during runtime and are saved
automatically. If you want to change the source cameras, you should stop the merging
process.

274

NorPix Inc.

Plugin Modules

The SimuPix Module can operate either on a live feed from 2 cameras, or it can also
operate on a set of Sequence files. Use the Capture From parameter to select the operating
mode. To record the resulting image into a Sequence, make sure to select all Workspaces(CTRL+A), and from the file menu, select “In Every WorkSpace, New Sequence...”Configuring the SimulPix Module.
17.

Select the Operating Mode (Merge or Division).

18.

Select the Capture source, either Camera or Sequence.

19.

Select the Color Mode you want to be applied. Depending on the Color Mode selected,
different coloring schemes are available:• Channel Map: Each camera image is represented with gray levels from back towhite. Individual image intensities can be adjusted using the sliders. The
Transparent option lets you assign which image will appear as a transparent layer.
The Transparent Color option lets you assign a color to the transparency.
• Primary Color: Only the basic primary color of the color wheel are available: red,green, blue, and combination of those like magenta, cyan and yellow.
• Any Color: Any color can be used, (more CPU demanding). Select the color bar to
the right of the camera to choose from a color picker. Use the sliders to adjust theintensities.

20.

Optionally, select the Transparency source, either Disable, No. 1 (for camera 1), or No.
2 (for camera 2) and the transparent color to be used.

NOTE: Transparency can be applied on color or monochrome images. For color thetransparency color is the corresponding RGB triplet, on monochrome, only
the red channel of the color RGB triplet is used.
Transparency can only be applied when operating the module in Merge Modewith Channel Map color mode.
For example, when No.1 is selected, all pixels of the image issues from thesource No.1 that have the specific transparency color intensity will beprocessed as transparent.

21.

Select the two Workspace sources within the Cameras area.

Once the parameters are selected, you can turn on the processing by selecting the Live on
or Snapshot button.

NOTE: On a slower computer, since the calculation requires significant CPU, theoverall computer response time may become slower. If this is the case,possible work arounds are:-Reduce image ROI of the process-Reduce camera frame rate
-Turn off merge mode when not needed-Disable rotation mode if not needed (see below).

NorPix Inc.

275

StreamPix 8 User Guide
Fine tuning SimulPix registration parameters

Select the Settings (green arrow) button to access the Registration and Resize parameters.
Registration parameters• Mirror allows second source to be either vertically or horizontally mirrored.
• Rotation allows for optical geometric correction. The center of the rotation point
can be overlaid into the merge image to allow better tune up. Center point color
can be selected by double clicking the color pad.
• Alignment: second source image can be horizontally or vertically offset.

Figure 1-78: SimulPix registration parameters

Resize parameters

Figure 1-79: SimulPix resize settings

You can resize either camera image. To resize an image, select the Resize Camera
checkbox and enter the new size in pixels.

276

NorPix Inc.

Plugin Modules

Using SimulPix module in image division mode

Figure 1-80: SimulPix Division Settings

When running with image division mode, the following calculations is performed:
SimulPix = (Image camera1 - background) / [registration correction (Image camera2 background)]Background images can be acquired any time, by enabling and clicking the corresponding
button. Background images are saved to disk and are always used when Apply is checked.
SimulPix includes an extra setting tab that allows the selection of various pseudo-coloring
display to allow better representing the calculation result.
Result image can be pseudo colored with 2 different pseudo coloring LUT (rainbow orinvert rainbow) and two scaling scheme can be applied.
Frame dropping issues:

By default, the SimulPix module is assuming both cameras deliver images at a constantrate and identical frame rate. It will monitor the incoming image rate to make sure none of
the cameras are dropping frames. Frame dropping from one camera would result in misssynchronization of the 2-captured series of images, and incorrect image superimposition.
When an expected incoming frame timed out, the module will suspect a dropped frame
and will make its best to drop an equivalent frame from the other camera. Monitoring is
performed based on the time stamp given to each incoming frame at the image capturelevel.
When dropped frames are detected, SimulPix will log a message in the general log dialog.
Dropped frames imply the removing of a corresponding frame from the other camera on

NorPix Inc.

277

StreamPix 8 User Guide

the SimulPix stream Sequence file. The 2 sequence files from both cameras areunchanged. Hence, the number of images in each sequence may not be identical.
Example:• Recording of a 100 frames sequence:• Camera 1 dropped frame #25 and 76• Camera 2 dropped frame #50
Sequence file from camera 1 will include 98 frames. Time stamp difference between
frame 24 and 25, as well as 75 and 76 will show twice the expected duration, Sequence filefrom camera 2 will include 99 frames. Time stamp difference between frame 49 and 50,
will show twice the expected duration, Sequence file from SimulPix will include 97
frames. Time stamp difference between frame 24, 25, as well as 48, 49 and 73, 74 willshow twice the expected duration.
When the 2 cameras do not run at the same frame rate, the monitoring function will
prevent the module from operating. A registry key can be set to disable the frame drop
monitoring process (default if no key exists: frame drop monitoring is on):
Key Path: HKEY_CURRENT_USER\Software\Norpix\Streampix\Admin
Key Name: SyncChecking
Key Type: DWORD
Key Value: 1 enable, 0 disable monitoring

The Export button lets you export selected alarm data to a CSV (Comma Separated
Values) text file, from where it can be imported into a spreadsheet program, such as
Microsoft Excel®.

278

NorPix Inc.

Plugin Modules

Video Scopes
When digitizing film stock, color rendering can shift over time, resulting in less realistic
output requiring further color correction downstream. The Video Scopes module candramatically improve workflow by providing real-time feedback on the color space during
the conversion process, reducing the need for further color correction later.
The Video Scopes module includes a Waveform Monitor, Vector scope, Histogram and
YUV/RGB parade.

Figure 1-81: Video Scopes module

The Waveform Monitor is an industry-standard video calibration instrument thatmeasures video luminance and chroma components. For SD and HD video displays, theRGB values are converted to YCrCb for display.
The Vector scope shows Hue and Saturation levels. It is a great tool for indicating whitebalance, as shifts in hue are readily visible when offset from the white (255) and black (0)center of the scope. Layout rings help the visualization, with mini-targets are at 2.5 IRE
and at 2.5 degrees, and outer targets are at 20 IRE and 10 degrees. Chrominance may beisolated by converting the RGB color space to YCrCb, and using the CrCb component tocalculate the necessary vector (angle and magnitude) from the color data. Rendered data
can be displayed as Percent, IRE or RGB values.
The Histogram displays pixel depth from 0 to 255 is on the X axis, with the number ofoccurrences per pixel on the Y axis.
RGB parade shows individual RGB color values and intensities. There are two settings:
RGB (Tri-mode) or luminance and RGB (Quad-Mode). The YUV parade shows theluminance and chrominance values. Data display for both is in Percent, IRE or RGB.
The color space conversion for each instrument follows industry video standards of
BT.610 for SD and BT.709 for HD. Originating color space is pure 24-bit RGB with fullgamut and converted to limited gamut YUV or YCrCb depending on the instrument
setting, with appropriate 8-bit scaling and IRE level limits. Settings can be saved and reused.
NorPix Inc.

279

StreamPix 8 User Guide

Video Scope Settings

The Settings tab lets you set the display parameters for each Scope. Changes made to theparameters exist for the current session only. Tool buttons let you save any changes to a
Scope as the default, or restore the factory defaults.

Figure 1-82: Video Scopes Settings tab

The Settings > Layout tab let you decide which Scopes and to display and how..

Figure 1-83: Video Scopes Settings > Layout tab

280

NorPix Inc.

Plugin Modules

RTSP Streamer
The RTPS Streamer module can stream in real time video and audio captured with any
StreamPix supported grabber/camera to a LAN or WAN (Internet). A wired or WIFI
connection can be used. Video stream is real time H.264 compressed and streamed toclients viewer application. Latency is minimized.
This module behaves the same way as the Web Streamer module but include a few specificfeatures to improve performance when used with multiple workspaces simultaneously.
Specific features:•

No support for HLS or HTTP Live Streaming•

Usage of a specific and different port number for each workspace/instance.

•

Individual streaming threading implementation for each workspace compared to
the Web Streamer Module that uses a common streaming thread for all
workspaces. Therefore, this module is recommended for usage with setups using alarge number of workspaces that requires simultaneous streaming output.

Refer to the Web Streamer module documentation for general information.

Web Streamer
The Web Streamer module can stream in real time video and audio captured with any
StreamPix supported grabber/camera to a LAN or WAN (Internet). A wired or WIFI
connection can be used. Video stream is real time H.264 compressed, and streamed toclients. Clients receive the video stream using one of two different protocols:• HTTP Live Stream (HLS)• Real Time Streaming Protocol (RTSP).
The protocol choice is automatic and depends on the client’s media player. HLS isrequested for all Apple based product, while RTSP is supported by a wider range of media
player, such as Android devices, Window’s Media Player, VLC, etc.
Mobile Devices and smart phones can receive a live video stream anywhere they have aconnection.
This module must be loaded into every Workspace where video streaming is required.
The module will allow streaming video and audio from multiple workspaces. The Start
button launches all configured Workspace streams simultaneously, or you can select Auto
Start when StreamPix Launches. The Copy URL button copies the URL to the clipboard.

NOTE: Audio is possible from RTSP streams only. HLS audio is not yet supported.

The module will real time H.264 compress the video, which is demanding on the CPU.
Nvidia, AMD or Intel based GPU can be used to perform real time H264 compression.
Otherwise, it is recommended to use an Intel Quick Sync capable CPU. In which case, thevideo can be compressed using the GPU, freeing the CPU. Maximum image resolution
NorPix Inc.

281

StreamPix 8 User Guide

supported by the module for GPU compression is HD (1920x1080). Larger resolution will
require the CPU for compressing each frame. The compression codec can be selectedindividually for each Workspace, allowing for load balancing.
In order for the module to operate, a live stream must be received from the camera.
The module can also be used to stream an already locally recorded video. Make sure
StreamPix is playing back the video before any client connects to the playback stream.
The module supports an unlimited number of clients. Limitation comes from the available
output bandwidth provided by the network adapter and infrastructure. Each stream
bandwidth can be estimated as the stream bitrate multiplied by the number ofsimultaneous clients.

282

NorPix Inc.

Plugin Modules

General tab

Figure 1-84: Web Streamer General tab
IP Address: This allows you to select the network interface to be used for streaming thevideo. The selection is made via the NIC IP address.
Start: Enable the video streaming service. Until the service is started, the module will not

listen to clients’ connection requests.
Auto Start when StreamPix Launches: Automatically starts Web Streamer when StreamPix

starts.
Streaming Current Display: This is the default selection. By default, the module will stream

the content of the display screen. This allows to stream either the live feed or the playback
feed continuously over the same URL. Typically: http:// [computer NIC IP
Address]/[Workspace Name].
Streaming Live: Select for Live streaming the camera video feed. This defines the live

streaming URL address for the live stream. Read Only. The client uses this URL to stream
video. Typically: http:// [computer NIC IP Address]/[Workspace Name]/streaming/live.
Streaming Playback: Select for streaming in Playback mode. This defines the streaming

URL address for the playback stream. Read Only. The client uses this URL to access thevideo under playback. Typically: http://[computer NIC IP Address]/[Workspace Name]/
streaming/playback.
RTSP: By default, the module streams using RTSP. Apple HLS protocol is optional.

Enable RTSP Server to also include RTSP streaming, should you use an RTSP compatible
media player client.
Port: RTSP default streaming port number is 554.
Http Live Streaming: The streaming port number used for streaming the video.
Http port: Default port is the Web port interface, 8080.
Copy URL to clipboard and Send by Email: Copies the URL to the clipboard. This is

the URL for the broadcast stream. It multiple stream have been selected, all URL
addresses will be copied, you can paste it to any compatible media player. For
example, in a VLC Player, select Media > Open Network Stream and paste the URL.
To verify that the Web Streamer module is operating correctly:
NorPix Inc.

283

StreamPix 8 User Guide
1.

Select Copy URL for the RTSP stream.

2.

Create a new workspace, naming it for example “WebStreamerCheck”.

3.

When prompted for grabber selection, select Web Ip Compatible Cameras.

4.

Select Hardware properties | Ip Camera Settings.

5.

Select ADD URL and paste the copied URL.
A live stream should appear in the selected display area for the Workspace.

Video tabFigure 1-85: Web Streamer Video tabCompression: The compression codec can be selected individually for each Workspace.
This allows you to select whether the CPU or GPU will perform the compression.
Software uses the CPU, while selecting QuickSync will use the Intel GPU. For CPU/GPU
load optimization, it is possible to select for each Workspace either using the GPU or theCPU.

• Software: This will use the CPU for compressing the video.
• Quick Sync: If listed, the CPU is Quick Sync capable, and compression can be
accelerated via the Intel GPU.
• nVidia [#]: If listed, an nVidia GPU is available for accelerated compression. EachGPU can compress up to 2 streams. Multiple GPUs are supported.
• AMD [#]: If listed, an AMD GPU is available for accelerated compression. Thereis no limit on the number of streams that can be processed simultaneously.
Performance will degrade when there are too many frames to be processed.
Muliple GPUs are supported.
Sampling: It is possible to reduce the image resolution before this one is encoded, which

reduces the CPU/GPU load and the required streaming bandwidth. Sub-sample the video
1:2 is half the resolution, 1:4 is one quarter of the resolution, while 1:1 is full resolution.
Apply StreamPix color Processing: The settings set in Bayer / Color ribbon for display will

be applied. This is useful for raw Bayer images that need to be color interpolated and color
balanced before being compressed.
Streaming Every: Most media players are not able to handle video rates higher than 30

frames per second. When using high frame rate cameras, the module will by default
stream at 30 fps. This setting allows you to override the default behavior. Select either
Frames or Milliseconds.

284

NorPix Inc.

Plugin Modules• Every X frames: A new frame is pushed every specified number of received
frames. Use a value of 0 for pushing all the frames.
• Every X milliseconds: A new frame will be pushed to the encoder every specified
number of milliseconds. Use 0 for pushing all frames.
Bitrate: This defines the output bit rate in bits per second. This defines a maximum output

bitrate, assuming 30 frames per second rate and a GOP size of 30. If you force the module
to push for instance 60 frames per second, the bit rate per second will be twice the set
value. For an HD image (1920x1080 @ 30 fps) a typical bit rate for good quality is 4 to 5
megabits per second, or 4000000. For other resolutions and frame rates, a good rule ofthumb is to start with a calculated equivalent value. For example, for VGA resolution, 640
x 480 @ 30 fps: Estimate the compression factor for HD and apply to the resolution:(1920x1080x30x8)/4000000 = 125. (640x480x30x8)/125 = 590000 bps.
GOP: This defines the size for each group of frames (GOP). H.264 compressed streams are

made of a combination of key/A frame and D frame. A GOP of a size set to 30 means eachgroup is made of 30 frames, 1 key frame and 29 D frames. A smaller GOP size increases
bandwidth, but makes the quality and decoding easier.
Audio tabFigure 1-86: Web Streamer Audio tab

Stereo audio is streamed compressed using Advance Audio Codec (AAC) and is only
available for RTSP streams (not supported for any HLS stream).
When using a multichannel audio source, left and right channel can be user selected.
Bitrate allows you to define audio quality.
Credential

Some credential can be added to the URL. Without the right user name and password, the
web Streamer module will not access a new client.
The new URL must include the credential information. A typical URL where user isdefinded as root and password as pass will be:
rtsp://root:pass@[IP address]/[workspace name]
Possible error messages• Workspace name contains a space character (i.e. "Camera 1"). Rename
the Workspace to a name without any spaces (i.e.: "Camera1").
NorPix Inc.

285

StreamPix 8 User Guide• RTSP port in use: Port #554 is the default streaming port for RTSP streams. Even
if no program is running on your computer, some background process might still
be using the current RTSP port (Citrix, NI web server, etc.). Enter a different port
# within the [1024:49151] range.

286

NorPix Inc.

B
Keyboard Shortcuts

This Appendix describes the default keyboard shortcuts available in StreamPix 8.

TIP: You can define your own custom keyboard shortcuts through the Quick Access >Customize Quick Access Toolbar option. See “Customize Keyboard Shortcuts”.

Command

Keyboard shortcut

Toggle Bayer conversion on displayed frames

Ctrl-B

Bayer conversion Sample Factor 1:1

Ctrl-1Bayer conversion Sample Factor 1:2

Ctrl-2Bayer conversion Sample Factor 1:4

Ctrl-4Bayer conversion Sample Factor 1:8

Ctrl-8Close current workspace

Ctrl-F4

Toggle Display

Ctrl-D

Full-screen mode

F12

Go to Frame #Ctrl-G

Select all workspaces

Ctrl-A

Next Workspace

Ctrl-Tab

Toggle Recording

Ctrl-R
Table A-1: Keyboard shortcuts

StreamPix 8 User Guide

Command288

Keyboard shortcut

Snap a single frame

Ctrl-SpaceReset Zoom level(numpad *)Zoom in(numpad +)Zoom in (X axis only)

Ctrl - (numpad +)Zoom in (Y axis only)

Alt - (numpad +)Zoom out(numpad -)Zoom out (X axis only)

Ctrl - (numpad -)Zoom out (Y axis only)

Alt - (numpad -)Trigger Pre/Post event

Ctrl-P

Show/Hide docking panel

Alt-P

Show Window Task Manager

Ctrl-Alt-T

Help

F1

Clear Markers

Ctrl – F9

Close Current Workspace

Ctrl – F4

Bring Keyboard focus the sequencesliderCtrl – Arrow Down

Goto End Selection

Ctrl – F8

Goto Begin Selection

Ctrl – F7

Mark As Selection Start

Ctrl – F5

Mark As Selection End

Ctrl – F6

Toggle single versus multi-display

Ctrl – M

Next Workspace

Ctrl – Tab

Previous Workspace

Ctrl- Shift – Tab

Quick Save

Ctrl – S

Reset Quick Zoom

Ctrl - *(numeric keypad)

Reset Zoom*(numeric keypad)

Snap

Ctrl – SPACE

Zoom IN+ (numeric keypad)

Zoom IN X direction

Ctrl - + (numeric keypad)

Zoom IN Y direction

Alt - + (numeric keypad)

NorPix Inc.

StreamPix 8 User Guide
Zoom Out-(numeric keypad)

Zoom Out X direction

Ctrl - -Zoom Out Y direction

Alt - Table A-1: Keyboard shortcuts

289

NorPix Inc.

IndexSymbols*.avi 17, 18, 69*.bmp 17, 69*.dng 18*.dpx 18*.fits 18*.jp2 18*.jpg 17, 69*.mov 17, 19, 69*.png 18*.seq 17, 69*.tif 17, 69
A

A/V Streamer Module 305
About StreamPix 8.0 15
About this Manual 20
Action Log 87, 203
AEC Control 223
Application Button 69
Application Menu 24
Application menu
Customizing 166
ASC CDL 137
ASC CDL adjustment 158
ASIO 112
Audio
Files 112
Input Level 113
Output Volume 113
Settings 112
Audio buffer usage monitor 113
Audio in/Out Module 305
Audio Input/Output 305
Audio Trigger 88, 261
Audio2mpa.exe utility 211
Authorization codes 16
Auto Gain Exposure Iris Module 224
Auto Naming 81
Auto Naming Settings 150
Auto-Fill 67
Autonaming Files 83
Auto-switch between live and playback 74
Averaging 238
AVI
file 69
playback rates 174
Settings 153
B

Background Color 68, 123
Basic Concepts 28
Basler Camera Link module 224
Bayer
Pattern 134
Bayer Conversion 132
Bayer conversion 130

Bayer Conversion Settings 132
Benchmarking 209
BIRGER Control 225
Bit Depth Management 155
Bitmap Overlay 226
Bluetooth 103
Brandywine devices 104
Buffer usage 178
Buffers 198
BWAVE 113
C

CameraLoad 66
Camera (Hardware) Trigger 87
Camera Selection 64
Camera Stream
Duplicate 107
Camera triggering 85
CamerasLoading and Unloading 79
Multiple 78
Cayer Compressor 192
Channel Map 287
Chart Merge 117
Chronological Order 145
Clear Selection 147
Clipboard
Copy image to 145
Codec
MP4 / TS 154
Codes
Authorization 16
Color
Background 68, 123
Balance 156
Matrix correction 158
Workspace 125
Color balance 132
Color correction
ASC CDL 137
Color Processing 132, 155
Color Processing settings 155
Command Line Arguments 211
Command Line module 229
Comment overlay 230
Compression
Sequence 189
Compression Estimator Module 231
Configuration
Load/Save 208
Save 93
Saving 92
Configure
Output Files 84
Copy Image to Clipboard 145
Crop 237

Crosshair Module 227
CSV
Export to 118, 119
CUDA JPEG compression 192
Customize Keyboard Shortcuts 91
customtoken 105
D

DAQ
Graph Settings 116
Graph Settings (File) 118
Graphs 161

DAQ (Data Acquisition) 115
DAQ Export to .xls 57
DAQ graph
Selecting multiple curves 117
DAQ Module 305
Data Acquisition (DAQ) 115
Debug Log 210
Defaults
Factory 196
Restore 93
Destination Files 69
DirectX 112
Disk Benchmarking 209
Display
assign 74
Auto-Fill 67
Switch 122
Toggle 122
Display Tools 122
Displayed Data 125
Displayed Data settings 163
Docked Dialog 166
Docking Panel 33
Show/Hide 125
Documentation 14
Duplicate Camera Stream 107
E

Edge
Rising/Falling 86, 203
Enable Input Control 202
Enable Output Control 204
Event 86, 203
Export LUT 136
Export Settings 108
Export To .CSV 118, 119
Exposure 224
Exposure Time Reader 232
F

Factory Defaults 196
Falling edge 86
Feedback 14
File Automatic Deletion 232
File Formats 17291

File Types 111
Files
Autonaming 83
Destination 69
First Frame 75
Focus Assist 233
Focus Slider 145
Formats
Supported 17
Frame
Reference 142
Frame #
Goto 142
Frame Grabber Pulse Generator 265
FramesSort before exporting 188
Free Modules 223
Full Screen 122
GGain 224
GenIcam 224
Goto
Frame # 142
Time stamp 142
Goto Buttons 146
Goto First 147
Goto Last 147
GPS / DMI Positioning 265
GPS data as image metadata 89
GPS Time Card 272
Grabber
Load 66, 107
Grabber Adjustments 215
Grabber Properties dialog 80
Grabber Selection dialog box 64
Gray world 156
GRT Header Data module 235
GRT Playout module 273
GUI 20Modify 90
H

H.264 191
H.264 Decompressor 274
H.264 Decompressor Module 56
H.264 loop recording 193
Hardware Properties 67, 80, 107
Histogram 234, 291
History
Sequence 141
Horita TCBTX 103
Huffman 191
Hybrid Mode 124
I

I/O 201, 202

NorPix Inc.

Event Markers 205
I/O Manager 85
I/O Manager docked dialog 35, 85
IDT Mx Camera Control 235
IDT Mx Camera Control Tool 235
Image
Single 72
Image Alpha Blending 236
Image files 70
Image Information 108
Image Merge 237
Image Resize 237
Image Rotation 238
Images 199
increment 105
Input Action dialog 85, 202
Input Control 202
Enable 202
Input/Output Trigger 201
Installing 16
Interface 20
Modify 90
Interface settings 164
Inverted rainbow 159
Iris 224
J

JPEG
Lossless 190
Lossy 191
K

Kalman filter 57
Keyboard Shortcut
Remove 91
Keyboard Shorts
Customize 91
Kinect 239
L

Language File 164
Last Frame 75
Lens Control 241
Level low/high 86, 203
Levels 242
LiDAR Logger 242
Limit sequence 178
Line Scan Viewer 277
Linear Time Code 102
Live Adjustments 67, 79, 107
Live Levels 242
Live/Playback Auto switch 74
Load Camera/Grabber 66
Load Grabber 107
Log
Debug 210
Log Action 87, 203

292

Lookup Table
Recalculate 135
Loop recording 178
Looped Recording 81
Looping 44
Lossless JPEG 190
Lossless RLE 191
Lossy JPEG 191
LSB Alignment 186
LTC 102
LTC Overlay 242
LTC-based Time Source 254
LUT 155
Export 136
LUT Processing 159
Lynx IPX Camera Control 242
LZ 191M

Main features 15
ManualAbout 12
Conventions 13
Manual Playback Control 32
Manual Playback Slider 173
Marker
Add 146
Markers in a Sequence 188
Master Workspace 29, 79, 98
Matrix Switch 243
MCC Pulse Generator 280
Mean & standard deviation 156
Mean equalization 156
Meinberg Device 104
Metadata Manager 208
Metadata Overlay 243
Metadata settings 169
Metadata Spy 244
Mikrotron Control 245
Minimize the Ribbon 91
Modules
Free 223
Loading and Unloading 222
Monochrome image processing 159
More... settings 199
Motion Detection 281
MOV settings 169
Move Reference Frame 142
MP4 25
mp4 57
MP4 / TS Codec 154
MPEG2 25
MPEG4/TS setting 154
MSB or LSB Alignment into TIFF container 186
Multi-cameras version 15
Multi-Display 126
Toggle 125

NorPix Inc.

Multi-Display Layout 123
Multi-Display Layout buttons 68
multiple curves
Selecting in a DAQ graph 117
Multiple Workspace 78
Multiple Workspaces 96
Multithreading
Enable/Disable 186
N

Next Marker
Goto 146
NI Pulse Divider 285
NI Pulse Generator 284
NI-DAQmx Pulse Generator 284
Notifications 199
NpxDebug 44, 196

Premium Modules 260
Prepost settings 174
Previous Marker
Goto 146
Processing Levels 133
Properties
Hardware 80
Pseudo Color 159
PTG Overlay 250
Pylon driver 224
Q

Quick Access Toolbar
Hide/Show buttons 90
Modify 90
Move 91
Quicktime 70
QuickZoom 165

O

Object Overlay 281
Offset 68
Optronis Camera Control 245
Output Actions 88
Output Control
Enable 204
Output Files
Configure 84
Output files 69
Overlays 123
P

Performance 210
Photon Focus Camera Control 246
Play/Pause 75
Playback
Timeshifted 145
Playback Buttons 31
Playback Control
Manual 32
Playback Position
Current 146
Playback Rate
Override 187
Playback Rate settings 173
Playback Sequence 81
Playback settings 171
Playback Slider 173
Playback Speed
Decrease 144
Increase 144
Plugins
Loading and Unloading 222
Point-To-Point Caliper 247
Polling delay 86, 202
Pre/Post Event Trigger 145
Pre/Post Trigger docked dialog 35
Pre/Post Trigger settings 174

293

R

Rainbow 159
RAM
Pre-allocate 44
Sequence in 69

RAM Sequence 188, 189
Raptor Photonics Control 251
RAW 190
Record button 31
RecordingInterval 73
Looped 81
Manual 71
Options 81
Scheduling 72
Recording Duration 73
Recording Manager 100
Recording Position
Current 146
Set 145
Recording manager 106
Recording manager settings
179 Recording settings 176
Reference Frame 142
Goto 142
Move 142
Reference Time 142, 143
Refresh Rates 125
Region of Interest (ROI) 68
Registry Keys
Special 186
Remote Control settings 183
Remove a Keyboard Shortcut 91
Restore Defaults 93
RGB parade 291
RibbonMinimize 91
Ribbon interface

NorPix Inc.

Customizing 166
Rising/Falling edge 86, 203
RLE 191
ROI 68Rolling Averaging 238
Rotation 238

Playback 171
Playback Rate 173
Pre/Post 174
Recording 176
Recording manager 179
Remote Control 183
Sequence 187
Session 195
Timeshifting 197
Workspace 198

S

Saturated
3 level 159
5 level 159
Save Configuration 93
Scale by max 156
Script Engine 219
Script Examples 182
Scripts
Editing 219
Second View module 286
Selection Grabber/Camera 64
SendRM 213
SendRM Support 213
Sequence
Append 144
Compression 189
History 141
Individual Tools 141
Markers 188
Navigating from docked dialog 147
New 69open 74
Playback 81
playback rates 173
RAM 69, 188
Trim Edit Cut 144
Viewing 75
Sequence Disk Space 252
Sequence Docked Dialog 34
Sequence Files 69
Sequence in RAM 69
Sequence Information 146
Sequence Levels 253
Sequence Settings 187
Sequence Slider 164
Sequences 32
Session settings 195
Set First 147
Set Last 147
Settings
Auto Naming 150
AVI 153
Color Processing 155
Displayed Data 163
Export 108
Interface 164
Metadata 169
More... 199
MOV 169294

Shortcut
Remove 91

Shortcuts
Customize 91
SimulPix 286
Single Camera version 15
Single Image 72
Snap button 31, 71
Sort Images 145
Spectracom 104
Stand Alone Workspace 78
Standard deviation 156
Statistics 241
Status Icons
Workspace 29
Step
Back 75
Forward 75
Stop condition 73
Stop Condition(s) 181
Store / Retrieve GPS 89
StreamPix 32-bit 169
StreamPix 8.0 Versions 15
StreamPix Scripts
Editing 219
Studio Project 305
Studio version 305
Switch Display 122
Symetricom Devices 104
Synchronization 172
System Requirements 16
T

T.S. Sync Monitor 253
Task Manager 210
Terminology 13, 14
Thumbnails View 124
Time Overlay 95
Time Source 101
Time Source dialog 102
Time Stamp
Goto 142
Time Stamp Corrector Utility 217
Time Stamp Monitor 254
Time stamps display 164
Timeshifted Playback 145
Timeshifting settings 197

NorPix Inc.

Timestamp Corrector Utility 56
Toggle Display 122
Tokens 151
Tools tab 208
Transparency 287
Transparent Color 287
Trigger
Audio 88
Input/Output 201
Trigger Module button 145
Trigger Pre/Post Event 145
Triggering 85
TS 25, 154
ts 57
U

UDP Trigger 254
UTC 165
V

Vector scope 291
Video Codec
MP4 / TS 154
Video Out 256
Video Scopes module 290
W

Watchdog 108
Waveform Monitor 291
Web Streamer module 292

295

When a recording ends... 177
When StreamPix starts 195
White World 156
Window leveling 160
Windows security prompts 72
Windows Task Manager 210
Windows Thread Scheduler 101
Working Folder 100
Default 198
Workspace
Color 79, 100
Controlling 100
Master 29, 79, 98
Select All 98
Setup 64
Stand Alone 78, 98
Workspace Color 65, 79, 125Workspace Manager 64, 96
Workspace Status Icons 29
Workspace(s) settings 198
Workspaces 28
Multiple 28, 78, 96
Select all 78
Y

YUV parade 291
Z

Zoom 165
Zoom tools 123

NorPix Inc.

306

NorPix Inc.