ResearchIR 4
User’s Guide

Document Number: 29354-000
Revision: 11
Issue Date: January 26, 2018

Copyright© FLIR Systems, Inc., 2001-2018. All rights reserved worldwide. No parts of the software
including source code may be reproduced, transmitted, transcribed or translated into any
language or computer language in any form or by any means, electronic, magnetic, optical,
manual or otherwise, without the prior written permission of FLIR Systems.
This manual must not, in whole or part, be copied, photocopied, reproduced, translated ortransmitted to any electronic medium or machine readable form without prior consent, in writing,from FLIR Systems.
Names and marks appearing on the products herein are either registered trademarks ortrademarks of FLIR Systems and/or its subsidiaries. All other trademarks, trade names orcompany names referenced herein are used for identification only and are the property of theirrespective owners.

FLIR Systems, Inc.
Customer Support: 800-GO-INFRA (464-6372)
flir.custhelp.com
Service: 866-FLIR-911 (354-7911)
www.flir.com

ResearchIR User’s Guide

2

Table of Contents
Revision History .............................................................................................................. 7
1

Introduction .............................................................................................................. 82

Installation .............................................................................................................. 10
2.1

Software and GigE Driver Installation .............................................................. 10

2.2

Camera Link and CoaXPress (CXP) frame grabbers ...................................... 13

2.3

Software License Activation ............................................................................ 14

2.3.1

2.4

3

4

License Activation Process ...................................................................... 14

2.3.1.1

Online Activation ............................................................................... 14

2.3.1.2

30-day Trial (Evaluation) ................................................................... 14

Installation Issues............................................................................................ 14

2.4.1

Activation Issues ...................................................................................... 14

2.4.2

Using the RIR 4 “RUS” license tool .......................................................... 16

2.4.2.1

Offline Activation ............................................................................... 16

2.4.2.2

Transferring a license from one PC to another .................................. 17

2.4.3

Firewalls ................................................................................................... 18

2.4.4

Adding Firewall Exceptions ...................................................................... 18

2.4.5

Troubleshooting steps for USB-Video cameras ........................................ 20

2.5

Configuring Pleora Drivers .............................................................................. 20

2.6

PC’s with multiple network interfaces .............................................................. 21

Getting Started ....................................................................................................... 22
3.1

Connecting to a camera .................................................................................. 22

3.2

Recording a file ............................................................................................... 23

3.3

Playing back the recorded file ......................................................................... 24

User Interface ........................................................................................................ 26
4.1

Title Bar .......................................................................................................... 27

4.2

Main Image Window........................................................................................ 27

4.3

Image Enhancement Tool ............................................................................... 28

4.3.1

Scaling Mode ........................................................................................... 28

4.3.2

AGC Modes ............................................................................................. 29

4.4

Color Bar ......................................................................................................... 29

4.4.1

Isotherm ROIs .......................................................................................... 30

4.5

Analysis Toolbar ............................................................................................. 31

4.6

Units and display controls ............................................................................... 32

4.6.1

Units Selector........................................................................................... 32

4.6.2“Info” Button ............................................................................................. 33

ResearchIR User’s Guide3

4.6.3

Image Invert/Revert [Max] ........................................................................ 33

4.6.4

Saturation/Clipping On/Off ....................................................................... 33

4.7

Plot and Acquisition Toolbar ............................................................................ 34

4.7.1

Plot Tools ................................................................................................. 35

4.7.1.1
4.7.1.1.1
4.7.1.1.2
4.7.1.1.3
4.7.1.1.4

Statistics Viewer ................................................................................ 36
Stats Toolbar ..............................................................................................................36
Stats Table .................................................................................................................37
Measurement Functions [Max] ...................................................................................38
Adding and Editing Measurement functions ...............................................................39

4.7.1.2

Profile Plot [Max] ............................................................................... 39

4.7.1.3

Temporal Plot.................................................................................... 40

4.7.1.4

Histogram Plot [Max] ......................................................................... 41

4.7.1.5

Oscilloscope Plot [Max] ..................................................................... 41

4.7.1.6

Opening a plot................................................................................... 42

4.7.1.7

Managing docked plots ..................................................................... 44

4.7.1.8

Plot Toolbar ...................................................................................... 44

4.7.1.8.1
4.7.1.8.2

4.7.1.9

Plot Cursors [Max] ......................................................................................................46
Plot Legend ................................................................................................................46

Plot Properties .................................................................................. 47

4.7.2

Bad Pixel Tool [Max] ................................................................................ 47

4.7.3

Acquisition Tools ...................................................................................... 48

4.7.3.1

Record Settings ................................................................................ 48

4.7.3.2

Record Mode .................................................................................... 49

4.7.3.2.1
4.7.3.2.2
4.7.3.2.3

4.7.3.3

Record Options ................................................................................. 50

4.7.3.4

Pre-Trigger Recording Options [Max] ................................................ 51

4.7.3.5

Record Conditions ............................................................................ 51

4.7.3.6

File Naming Options.......................................................................... 51

4.7.4
4.8

Record to Memory Mode [Max] ..................................................................................49
Record to Disk Mode ..................................................................................................50
Periodic Recording .....................................................................................................50

Preset Selector [Max] ............................................................................... 52

Toolboxes [Max] .............................................................................................. 53

4.8.1

Object Parameters Toolbox...................................................................... 54

4.8.2

Camera Control Toolbox .......................................................................... 54

4.8.3

Source Information Toolbox ..................................................................... 54

4.8.4

Minimap Toolbox ...................................................................................... 54

4.8.5

Segmentation Toolbox [Max] .................................................................... 54

4.8.6

Filters Toolbox [Max] ................................................................................ 55

4.8.6.1

MATLAB Filter................................................................................... 56

4.8.6.2

Passing metadata between ResearchIR and MATLAB ..................... 57

ResearchIR User’s Guide4

4.8.74.8.7.1

First-time Setup................................................................................. 57

4.8.7.2

Pairing............................................................................................... 58

4.8.7.3

HSDR Triggered recording (DVR express Core only) ........................ 58

4.8.7.4

Movie Recording ............................................................................... 58

4.8.7.5

Movie Playback ................................................................................. 59

4.8.7.6

Movie Extraction ............................................................................... 59

4.8.8
4.9

HSDR Toolbox [Max+] ............................................................................. 57

File Toolbox ............................................................................................. 59

Main Menu Bar ................................................................................................ 60

4.9.1

File Menu ................................................................................................. 60

4.9.1.1

Export Dialog .................................................................................... 61

4.9.1.2

Extract Dialog [Max+] ........................................................................ 66

4.9.1.3

Batch Extract Dialog [Max+] .............................................................. 67

4.9.2

Edit Menu ................................................................................................. 67

4.9.2.1

Spatial Calibration [Max] ................................................................... 67

4.9.2.2

Preferences Dialog ........................................................................... 68

4.9.3

Camera Menu .......................................................................................... 71

4.9.3.1

Camera Selector ............................................................................... 72

4.9.3.2

Camera Control................................................................................. 73

4.9.3.3

User Calibration [Max] ....................................................................... 73

4.9.3.3.1 Load Calibration .........................................................................................................73
4.9.3.3.2 Save Calibration .........................................................................................................74
4.9.3.3.3 Perform Calibration ....................................................................................................74
4.9.3.3.3.1 Wizard Modes .....................................................................................................74
4.9.3.3.3.2 Standard Calibration Wizard ...............................................................................75
4.9.3.3.3.3 Review Calibration Coefficients ..........................................................................84
4.9.3.3.3.4 Calibration Plots ..................................................................................................85

4.9.3.4

PC Side Correction (Max Only) ......................................................... 86

4.9.3.5

Creating a PC-Side NUC in ResearchIR ........................................... 87

4.9.4

View Menu ............................................................................................... 91

4.9.4.1

Zoom Menu ....................................................................................... 91

4.9.4.2

Palette Menu ..................................................................................... 91

4.9.4.3

Edit Palette Dialog ............................................................................ 92

4.9.4.4

Startup Dialog ................................................................................... 92

4.9.5

Tools Menu .............................................................................................. 93

4.9.5.1

Color Bar........................................................................................... 95

4.9.5.2

Flying Spot Meter .............................................................................. 95

4.9.5.3

File Operation ................................................................................... 95

4.9.5.4

Make Self Viewing File [Max] ............................................................ 96

ResearchIR User’s Guide

5

4.9.6

Hotkeys .................................................................................................... 96

4.9.7

Help Menu ............................................................................................... 97

4.10

Metadata display ............................................................................................. 97

4.10.1Time in ResearchIR ................................................................................. 98

4.10.1.1

Time Source ..................................................................................... 98

4.10.1.2

Time Reference ................................................................................ 98

5

Camera Control .................................................................................................... 100

6Other Utilities ....................................................................................................... 102

7

6.1

REdit ............................................................................................................. 102

6.2

CalibratIR ...................................................................................................... 102

6.3

File AbatIR .................................................................................................... 102

6.4

CNUC Manager ............................................................................................ 103

Acknowledgements .............................................................................................. 104

ResearchIR User’s Guide

6

Revision History
Version

Date

Initials

Notes

A

FEB 14 2014

RIM

V4.0 beta release1

MAR 05 2014

RIM

V4.0 release2

JUL 1 2014

RIM

V4.10 release3

FEB 10 2015

RIM

V4.20 release

4

FEB 19 2015

RIM

Added HSDR triggered recording information

5

APR 08 2015

RIM

Updated for 4.20.1. Added updated info on
troubleshooting activation issues.

6

MAY 05 2015

RIM

Fixed section numbering errors

7

MAY 12 2015

RIM

Updated for 4.20.2, added RUS tool info

8

NOV 20 2015

RIM

Updated for 4.30.0

9

JUN 30 2016

RIM

Updated for 4.30.2, and localization

10

JAN 12 2017

JAT

Updated for 4.40.2, copyright only

11

JAN 26, 2018

AAR

Updated with frame grabber info

ResearchIR User’s Guide

7

Chapter 1 – Introduction

1

Introduction[taw1]

ResearchIR is a thermographic data acquisition and analysis application designed for
the R&D environment.
Some of the key features of ResearchIR include:
▪
▪
▪
▪
▪
▪
▪
▪

Easy to use, customizable workspaces
Supports factory and user calibrations
Supports factory and user Non-Uniformity Correction (NUC)
Supports all FLIR R&D cameras
Supports high-speed data acquisition (HSDR)
Supports SEQ, SAF, PTW, ATS, FCF and RJPG file formats
Supports Windows Vista/Win7/Win8 (32-bit and 64-bit)
A combination of traditional and new capabilities designed to provide a complete
solution for the R&D user

Recommended Minimum Hardware/Software:
OS: Windows7 (32-bit or 64-bit) or higher
Processor: Intel Pentium 4 3.0 GHz or faster recommended
RAM: 8GB or greater is recommended.
Hard Disk Free Space: 1GB (free space)
Network Adapter: Gigabit Ethernet
USB: One USB 1.1 (or higher) port for the license dongle, USB 2.0 required for camerasthat support USB video. Note: a USB 3.0 port is required for HSDR Core2 operation.

ResearchIR User’s Guide

8

Chapter 1 – Introduction

End User License Agreement (EULA)
Computer Software License Agreement for FLIR Systems, Inc.
NOTICE TO USER: This is a Contract.
FLIR is willing to license the Software identified as ResearchIR to You only on thecondition that You accept all of the terms and conditions contained in this License
Agreement. Please read the terms and conditions carefully before installing or using thesoftware. By installing or using the software, You are indicating Your acceptance of thisAgreement. If You do not agree to the terms of this Agreement, FLIR is unwilling tolicense the software to You. In that event, You should not install or use the Software.
1. Scope of Permitted Use: In this Agreement, "Software" shall mean the machinereadable software programs and associated files identified as ResearchIR, any modified
version, upgrades or other copies of such programs and files, and any associated media
and printed materials. You have the nonexclusive right to install and use the Software ona single central processing unit. Only one copy of Your licensed Software may be madeby and for You for backup purposes. You may not make or distribute any other copies of
the Software, nor does this license permit You to allow multiple users access to a single
copy of the Software via a computer network. You may not resell or redistribute theSoftware.
2. Proprietary Rights: The Software is owned by FLIR and/or its suppliers and You
acknowledge that the structure, organization and/or code to the Software is/are thevaluable trade secret(s) of FLIR. You agree to hold such trade secret(s) in confidence.
You further agree not to translate, decompile, disassemble, modify, reverse engineer, orotherwise attempt to discover the source code of the Software, in whole or in part. The
Software is protected by United States Copyright Law and International Treaty
provisions.
3. No Other Rights: FLIR retains title and ownership to any and all copies of the
Software whether transmitted electronically or recorded as diskette copies and all
subsequent copies of the Software, regardless of the form or media in or on which theoriginal and other copies may exist. Except as expressly stated, this Agreement does notgrant You any rights to patents, copyrights, trade secrets, trademarks or any other rights
with respect to the Software.
4. Term: The Agreement is effective until terminated. This Agreement shall terminate
automatically upon failure by You to comply with any of its terms. FLIR also has the rightto terminate Your license immediately at any time. Upon any such termination, You must
destroy the original and any copies of the Software. However, any terms of thisAgreement which can reasonably be construed to protect FLIR will survive its
termination.

ResearchIR User’s Guide

9Chapter 2 – Installation2

Installation

FULL Administrator privileges are required to install ResearchIR andassociated drivers. If you install ResearchIR on a computer managed
by an IT department, please contact your System Administrator forassistance. After installation, ResearchIR can be run as a normal user.

2.1

Software and GigE Driver Installation

The installation program will install the ResearchIR application. In addition, it will installnecessary support software if it detects that they are not installed on you system. The
support software includes:•

Pleora GigE (eBUS) drivers•

FLIR camera drivers•

Vircam SDK•

SafeNet software license support

In general, you can accept all defaults for any dialog you see during the install process.
Some drivers may cause Windows to display a message that the driver is “unsigned”.
This is normal. Choose the option to continue with the installation.
Important Note: If you have an ResearchIR dongle, please do not insert it
until after you have installed the software.
Step 1: Launch the downloaded .EXE file. (If you downloaded the .ISO file, that can beused to create an install CD using most CD burner applications.) You will be guided
through the installation wizard.

ResearchIR User’s Guide

10

Chapter 2 – Installation
Step 2: Accept the license agreement.

Step 4: Select any additional options.

ResearchIR User’s Guide

11

Chapter 2 – Installation
If this is an initial installation of ResearchIR, then you will have the option to install
additional components. Components that are recommended for all users will bechecked by default. If the component is already installed, it will be grayed out.
If you have used older versions of FLIR software (or have other GigE cameras, you may
already have an existing installation of the Pleora driver software. ResearchIR supports
many versions of the Pleora GigE drivers. However, not all versions are compatible withall cameras. The installer may indicate that certain cameras are not supported by yourcurrent version. If you need compatibility with these cameras you will need to uninstall
the older Pleora software using Control Panel. Then run the ResearchIR installer again.
If no Pleora software is installed you will have the option to install the latest supported
version.
Uninstalling older Pleora Driver software
STEP 1. Revert to Manufaturer’s NIC driver. Use the Driver Installation Tool to remove
the High Performance or eBUS driver and revert back to the Manufacturer’s NIC driver.
This will require a reboot.
STEP 2. Use Control Panel → Add/Remove Programs to uninstall the older Pleora
software (see figure below). If you have Pleora 2.2 or newer you should remove iPORT
Vision Suite, eBUS Driver Suite, and GEV Suite components from the Control Panel list.
Then run the ResearchIR installation again and the latest supported version will be
installed for you.

Step 5: ResearchIR will install drivers and libraries. The items displayed will varydepending on what components are already installed on the PC. A green check markwill appear next to each successfully installed component. If you see any red “x”
indicators, contact FLIR support at http://flir.custhelp.com.
Step 6: Click “Finish”. ResearchIR installation is now complete.

ResearchIR User’s Guide

12

Chapter 2 – Installation

2.2

Camera Link and CoaXPress (CXP) frame grabbers

ResearchIR supports a limited selection of frame grabber models that can be used toconnect to cameras with Camera Link and CXP interfaces. ResearchIR can use theseinterfaces for both control and digital video. For help installing these devices, pleaserefer to the FLIR ResearchIR Frame Grabber Installation Manual, document 4213512.
The PDF download is available here:
http://flir.custhelp.com/app/answers/detail/a_id/1658.
PLEASE NOTE: When using a Camera Link or CXP frame grabber with
ResearchIR, it will be necessary to install very specific driver and runtime libraries
that FLIR provides on this folder on Box.com:
https://flir.app.box.com/folder/29645234728.
You cannot just install the drivers and runtime libraries that came with the frame
grabber – they will not work!
The following frame grabber models are supported:
Camera Link•••

Silicon Software microEnable IV AD4-CL (Base/Medium/Full)
Dalsa Xcelera-CL PX4 (Base/Medium/Full)

IO Industries Core2 CL (HSDR)

Note: Other frame grabbers in the DALSA X64, DALSA Xcelera, and Silicon Software
microEnable IV product lines may work, but are not tested. The HSDR accessory
recorder system acts like a frame grabber and brings image data into ResearchIR
through an eSATA to USB 3.0 converter cable connected to the PC. The HSDR isavailable in either Camera Link or CoaXpress varieties.
CoaXPress••

Active Silicon Firebird (FDB-2XCXP6, FDB-4XCXP6)
Bitflow Cyton CXP-4

ResearchIR User’s Guide

13

Chapter 2 – Installation••

Euresys CXP Coaxlink Quad G1

IO Industries Core2 CXP (HSDR)

Software License Activation
ResearchIR 4 requires a license key in order for the software to run. Prior to version
4.20, the license key was in the form of a USB dongle. Starting in version 4.20, thesoftware can also be activated online by entering a provided product key. This method
will require an internet connection for the activation process. (After the software is
activated, an internet connection is no longer required.) Going forward, online activation
will be the default method for license activation. (However, existing USB keys willcontinue to work and can be ordered if needed.)

2.2.1 License Activation Process
When ResearchIR is first launched it will automatically search for a valid license. If
multiple licenses are found (for example both software and USB key are found) then thehighest level license will be used). If no license is detected, then the user will see theActivation dialog. This window will present the use with three options:
1. Enter a Product Key
2. Insert a Hardware (USB) dongle
3. Start a 30-day trial (evaluation)

2.2.1.1

Online Activation

If Option 1 is chosen, the user will be presented with a screen where product can beregistered. User must enter the following:
1. Product Key
2. User’s name OR Company Name
3. Email address

2.2.1.2

30-day Trial (Evaluation)

If you choose the 30-day trial, you will have the option to try either the Max or
Max+HSDR editions. The 30-day trial does not require an internet connection and thetrial will start immediately. If you later activate a product key for a lower edition, the trial
will continue to run until it expires and then the product key will take over. Trial periods
cannot be renewed or extended. The trial time remaining can be viewed under the
Help>>Gather Information menu item.

2.3

Installation Issues

2.3.1 Activation Issues
If you encounter issues with product activation the following steps should help to isolate
the problem.
ResearchIR will return an error code if activation fails. Please provide the error codewhen requesting technical support.
E1. Invalid Product Key: Please make sure you entered your product key
correctly. Then try again.

ResearchIR User’s Guide

14

Chapter 2 – Installation
E2. No more activations available: By default, all product keys can be activated 5
times. Please contact your local representative if you need more activation codes. Thentry again.
E3. Cannot find master dongle: This indicated that a network connection wasestablished to the license server, but the system is down. Please try again later. If thesituation persists please contact FLIR Customer Support.
E4. Cannot connect to server. Possibly because of blocked port but cannot
distinguish between that or other connection issues: Your product failed tosuccessfully activate. Please make sure you are connected to the internet and that port
8080 is not blocked by a software or hardware firewall. Then try again. If the situation
persists please contact FLIR Customer Support.
Another way to troubleshoot activation issues is to bypass the activation Wizard within
ResearchIR and use the web-based activation portal. To reach the portal, enter
http://researchir.flir.com:8080/ems/customerLogin.html into your web browser. If you get
see the following on your screen you have Internet connectivity to the license activation
system (so a blocked port is not the problem.)Enter your Product Key. If your key has been previously activated, then you will see
information about the number of activation and the amount remaining. If you see ascreen asking for registration information this indicates that the product has never been
activated. You can enter your registration information on the web portal. If the activation
succeeds, then the license on your PC will be updated and the next time ResearchIR islaunched it should skip the activation wizard.
If after following these steps you activation issue is still not resolved, please contact
FLIR Customer Support at http://flir.custhelp.com . Be sure to include information inyour problem description about any error codes and also include the “Gather
Information” text file which can be generated from the menu item under the Help menu.
This will provide the support agent with more details that can be used to troubleshootyour problem.

ResearchIR User’s Guide

15

Chapter 2 – Installation

2.3.2 Using the RIR 4 “RUS” license tool
The RIR4 RUS utility is designed to handle situations where internet access is notavailable for online license activation. The RUS tool can be used for the following
situations:••

Offline activation via web customer portal
Moving a license from one PC to anotherFor both cases, the user can complete the entire process without the need to submit aticket to FLIR customer support. The RUS tool can be downloaded using the following
link: https://flir.box.com/s/n7cuj7kkizcvee1gwbsndakkwpzq3ewy.

2.3.2.1

Offline Activation

If a customer PC with RIR4 does not have internet access, but they have another PCthat does, the RUS tool can be used to create a file that can be used to generate a
activated license file through the web customer portal.
a) Launch the RUS toolb) On the “Collect Status Information” tab, click the “Collect Information” button.
You will be prompted to save a “C2V” file.
c) Go to the ResearchIR customer portal at
http://researchir.flir.com:8080/ems/customerLogin.html. You should see thefollowing screen in your browser. Enter your product key and click Login.

ResearchIR User’s Guide

16

Chapter 2 – Installationd) If the key has not been used before, you will see a screen asking to register.
Enter your registration information and click Save.
e) One the next screen, click the “Offline Activation” button in the upper right corner.
f) A “Generate License” dialog box will appear. In the middle is a link to download
the RUS tool if you have not already downloaded it. At the bottom is a field called“Upload C2V”. Click the “…” button to browse and select the file you created with
the RUS tool. Then click “Generate”.
g) Under “Activation Details” there will now be a link to “Download V2C File”h) In the RUS tool, go to the “Apply License File” tab. Next to the “Update File”,
click the “…” to browse for the V2C file you just downloaded, then click “Apply
Update”.
i) RIR4 should now see the license when launched.

2.3.2.2

Transferring a license from one PC to another

You will need to install and run the RUS tool on both the source and recipient PCs. On
the recipient PC, launch the RUS tool and click on the “Transfer License” tab. Follow thesteps presented in the dialog box.

a) Next to “Save recipient information to”, click the “…” button to assign a name tothe .ID file.
b) Take the created file to the “source” PC. Run the RUS tool and go to the“Transfer License” tab. In the “Generate license transfer file” section, click the“…” next to “Read the recipient information file” to browse for the .ID file createdin step 5.
c) Click the “…” next to the “Generate the license transfer file to” to assign a namefor the H2H file.
d) Click the “Generate License Transfer File” button at the bottom of the window.
e) Take the generated H2H file to the recipient PC. In the “Apply License” tab of the
RUS tool, click the “…” button next to the “Update File” field and browse for the

ResearchIR User’s Guide

17

Chapter 2 – Installation
H2H file creates in step 8. Click the “Apply Update” button. The license fileshould be updated and RIR 4 should see the license when launched.

2.3.3 Firewalls
Firewalls will generally block connectivity to a camera. The ResearchIR installer willattempt to configure a firewall exception to the Windows firewall service. If you
computer is using a third party firewall, this service may be disabled. This could cause
the ResearchIR installation to abort and it will appear as if nothing was installed. To
work around this issue, you will need to browse the installation CD and look for the “MSI”
folder. Inside there are two msi install files (one for 32-bit and one for 64-bit). Run theappropriate file. This will run the install in a “verbose” mode. If the firewall service isdisabled, you will see the error below. Click the “Ignore” button and the installation willcontinue normally. (NOTE: You may need to manually configure a firewall exception if
you have trouble detecting and connecting to your camera.)

2.3.4 Adding Firewall Exceptions
If you cannot turn off the firewall then you may need to manually add some “exceptions”.
These exceptions will allow specific programs to get past the firewall. The “Vircam”
exception applies to SC2500/5000/7000 series cameras. The EBservice” exception
applies to SC2500/2600/5000/7000 series cameras.
The firewall is generally access through the Windows Control Panel.

Choosing the option to allow a program through the firewall will present you with a list of
current exceptions. If the “Allow another program…” button is disabled then you willneed to click the “Change settings” button. If your computer is controlled by an IT dept
ResearchIR User’s Guide

18

Chapter 2 – Installation
you may not have permission to change these settings and you will have to get your IT
person involved.

Once you get past this point you will see the “Add a Program” dialog.

Click the “Browse…” button. The two exceptions you should add are for Vircam andEBservice. The screenshots below show you the path and file that should be selected.
Enable all the check boxes for Domain/Work/Public.

ResearchIR User’s Guide

19

Chapter 2 – Installation

2.3.5 Troubleshooting steps for USB-Video cameras
Items 1-3 should be done before connecting a camera. Anything that needs to bedisabled can be enabled once the camera connection is established.
1. Make sure the camera is set to USB Video mode. This has a faster frame rate than
Network mode and is not blocked by Firewalls.
2. Switch off the wireless radios (Wi-Fi and Bluetooth.)
3. Remove all USB devices, including the mouse, before connecting the camera. You
can usually plug the mouse back in after a successful connection.
4. Try using a different USB port. Some ports run through an internal hub. In general
don’t use front USB hubs.

2.4

Configuring Pleora Drivers

Launch the Driver Install Tool located in the Pleora Technologies group.

Highlight the network adapter you want to configure and use the drop down list to selectthe eBUS Universal Driver. Click the Install button.

ResearchIR User’s Guide

20

Chapter 2 – Installation

Once install is complete, the “Current Driver” field will be updated. Press the “Close”
button to exit and reboot if prompted to do so.

If you need to configure more than one network adapter, it isrecommended that you only configure one port at a time. See Sec 2.5
for more information on configuring PCs with multiple network interfaces.

2.5

PC’s with multiple network interfaces

If your PC or laptop has multiple network interfaces (wired or wireless) there are somethings to watch for that can cause issues with connecting to cameras.
It is important that both network adapters not be in the same network subnet. This is
one reason that we recommend using static IP addressing because a DHCP derver willoften give two consecutive addressed to the PC’s NICs. When this happens, thenetwork routing can get confused in the Pleora driver, and traffic intended for the camera
can get routed to the wrong port.
This can happen with static IP addressing if both addresses are in the same subnet. So
if you have two ports, don’t set one to 192.168.10.1 and the other to 192.168.10.2.
Those are in the same subnet and will cause problems. Instead use 192.168.10.1 and192.168.11.1. Or use 192.168.10.1 for the wired port that is connected to the cameraand set the wireless port to DHCP top work with your corporate network.

ResearchIR User’s Guide

21

Chapter 3 – Getting Started

3
3.1

Getting[taw2] Started

Connecting to a camera

1. Connect the camera to the computer and power the camera on.
2. Run ResearchIR, the startup dialog should be shown. If you have it set to notshow on startup or if ResearchIR is already running, you can show it by selecting
View→Startup Dialog in the file menu. Click the camera you want to connect to.

NOTE: If your camera isn’t shown, you can click “Search Again” to look for it.
NOTE: It may take a few seconds to connect to the camera, especially if this is the firsttime ResearchIR has connected to this camera.
3. The camera image should now be displayed.

ResearchIR User’s Guide

22

Chapter 3 – Getting Started

3.2

Recording a file

1. Move your mouse over the record toolbar button and the click on the configure
icon.

2. Set the recording and file naming options you want and click “OK”.

3. Move your mouse over the record toolbar button and click the record button (oruse F5 if that option was enabled).

ResearchIR User’s Guide

23

Chapter 3 – Getting Started
4. ResearchIR will record a file. Wait for the status to display “Done” and the“Close” button to appear then click “Close”.

3.3

Playing back the recorded file

1. Make sure the File toolbox is visible by expanding the toolbox window and theFile toolbox if they are not already expanded. (NOTE: If you don’t have a dongle
and are running ResearchIR Standard then you won’t have access to the
Toolboxes. You will have to use the File Menu to access your recorded data.)

2. Click the show record folder button to display the record folder in the file toolbox
then double click on the file you just recorded.

ResearchIR User’s Guide

24

Chapter 3 – Getting Started
3. The file should now be displayed.

NOTE: Files can also be played back by opening them with File→Open in the File menu.

ResearchIR User’s Guide

25

Chapter 4 – User Interface

4

User[taw3] Interface

The ResearchIR main window is comprised of ten main regions:1.

Title Bar (Sec. 4.1)

2.

Main image window (Sec. 4.2)

3.

Image Enhancement Tool (Sec. 4.3)

4.

Colorbar (Sec. 4.4)

5.

Analysis Toolbar (Sec. 4.5)

6.

Unit and Display controls (Sec. 4.6)

7.

Plot and Acquisition Toolbar (Sec. 4.7)

8.

Toolboxes. (ResearchIR Max Only). (Sec. 4.8)

9.

Main Menu Bar (Sec. 4.9)

10.

Metadata display (Sec. 4.10)

ResearchIR User’s Guide

26

Chapter 4 – User Interface

4.1

Title Bar

Indicates what ResearchIR edition is running. There are three options:•

ResearchIR : indicates that the Standard edition is running.

•

ResearchIR Max: indicates that all add-on modules except HSDR are enabled•

ResearchIR Max + HSDR: indicates that all add-on modules are enabled.

NOTE: This manual describes features for all three editions. Some features are notsupported in all editions. Throughout the user manual a feature section heading may
have a notation in [ ] brackets. This notation will indicate the minimum edition levelthat will support this feature. Your license key will indicate and control what editionlevel you have access to. If you wish to upgrade to a higher edition, please contact
your sales representative for more information.

4.2

Main Image Window

The Main Image Window displays either live imagery from a camera or stored images
and movies. By default, the image size stretched as the application window is resized.
This can be changes by selecting a different zoom factor in the View→Zoom menu.
When a previously recorded movie is loaded, the movie player controls will be displayed
at the bottom of the image window.

Icon

Name

Description

Advance/Rewinda single frame

These arrow buttons at the ends of the playback slider
show the previous or next frame in the movie for eachpress.

Current frame
position

Indicates the currently displayed frame number. The
current frame position can be changed by dragging thehandle with the mouse or can be entered directly by
double clicking on the number.

Playback limits

The blue bar indicates the playback limits. If the user
only wishes to playback a subset of the data, the black
handle can be dragged to the desired start/stop frame
positions. The start/stop position can can be entereddirectly by double clicking on the number.

Rewind Controls

Rewind with normal speed, fast speed, and jump tobeginning.

Forward Controls

Forward with normal speed, fast speed, and jump toend.

Stops playback at current frame vertex points can be
moved individually.
NOTE: The Start and End frame for the play limits are also used for the Extract feature
discussed in Section 4.9.1.2.
Stop

ResearchIR User’s Guide

27

Chapter 4 – User Interface

4.3

Image Enhancement Tool

This tool allows the user to control the scale limits and how the color palette is mapped
to the data. A real-time histogram of the data is display for each image frame so that theuser can see how the data values are distributed. This powerful tool can allow the user
to see amazing detail even in low contrast imagery.

Icon

Name

Description

HistogramShows distribution of data against current
scale. Color bar palette is used forHistogram colors.

Scale limits

The numerical fields to the left and right of
the histogram indicate the lower and upper
scale limits. Can be adjusted using theoptions described in Sec. Error! Reference s
ource not found.. The upper and lower
scale limits are also reflected in the colorbar
limits to the right of the image.

Scaling Mode

Choose Scaling mode using the drop down
list. Options are described in Sec. 4.3.1

Automatic Gain
Control (AGC).

Choose AGC mode from drop down list.
Modes are described in Sec. 4.3.2. Slider
to the right adjusts the “intensity” of theAGC.

DDE Level

This controls the DDE “intensity”. This
control is disabled for other AGC modes.

Stop

Stops playback at current frame vertex
points can be moved individually.

4.3.1 Scaling Mode
ResearchIR offers four choices for determining the scale limits.
Scale Limits From

Description

Image

ResearchIR looks at the entire image to determine themin and max values for the scale

Active ROI [Max]ResearchIR looks only at the values within the selected
ROI to determine min and max values for the scale

ResearchIR User’s Guide

28

Chapter 4 – User Interface

Segmentation [Max]ResearchIR uses the limits in the Segmentation Toolbox
to determine min and max values for the scale

ManualThe user manually sets the limits either by:(1) typing numbers in the boxes at the left and rightcorners of the data histogram(2) using the mouse to drag the edges of the shadedbox on the histogram

4.3.2 AGC Modes
Although the camera data is 14-bit/16-bit, the color palettes used for display are 8-bit.
Automatic Gain Control (AGC) algorithms are used to control how the colors are applied
to the data. ResearchIR offers three choices for AGC algorithms. These algorithms canimprove image detail and contrast.
Algorithm

Description

Linear

Simple linear mapping. Evenly distributes the color in thepalette across all count values.

Plateau Equalization (PE)Non-linear, histogram based algorithm. Provides good
contrast for almost all scenes. The slider, next to thedrop down controls the aggressiveness of the algorithm

Digital Detail Enhancement(DDE) [Max]FLIR proprietary algorithm. Runs in addition to PE.
Enhances image detail. The drop down next to the PE
slider controls the aggressiveness of the DDE algorithm.

Advanced Plateau
Equalization (APE) [Max]FLIR proprietary algorithm. Enhances image detail. The
drop down next to the PE slider controls theaggressiveness of the APE algorithm.

4.4

Color Bar

The Color bar shows the relationship between the color palette and the data values in
the currently selected units. The palette can be changed by using the View→Palettemenu. The scale limits and the color distribution are controlled by the Image
Enhancement Tool.
The current segmentation levels are also displayedon the color bar as full width shaded regions in thecurrently selected segmentation colors.
Active Isotherm ROIs are displayed as half width
shaded regions. Isotherm limits can be adjusted by
dragging the ROI on the color bar. Isotherms ROIs
can be deleted by clicking the isotherm on the color
bar and pressing the Delete key.

ResearchIR User’s Guide

29

Chapter 4 – User Interface

4.4.1 Isotherm ROIs
Isotherm ROIs are added by using the buttons above the color bar.
Icon

Type

Description

Interval

User sets range by dragging on color bar

Above

User click on color bar to set lower limit

Below

User clicks on color bar to set upper limit

Endpoints can be adjusted by dragging the limits on the color bar. Right click to set
properties.
Although there are tools to create Above/Below/Interval isotherms, any isotherm can beconverted to any type using the min/max properties. Right click the isotherm andchoose Properties from the pop up menu.
Above isotherms have the max box checked. Below isotherms have the min box
checked. Interval isotherms have neither box checked.
The Track By option tells ResearchIR how to display the isotherm as the scene changeover time.

Isotherm Track By:

Description

Value

Isotherm stays locked to the value limits. This is the mostcommon setting.

Color

Isotherm is locked to the color bar values. As the scenechanges and the AGC adjusts the color assignments theisotherm numerical limits can change.

ResearchIR User’s Guide

30

Chapter 4 – User Interface

4.5

Analysis Toolbar

The Analysis Toolbar allows the user to draw a Region of Interest (ROI) using a varietyof drawing tools.
Icon

Name

Description

Select/Edit ROIWith this tool selected, the user can mouse over an ROI.
The ROI can be dragged to move it or the user can grab a“handle” to resize the ROI

Box ROI

Draw an arbitrary rectangular box.

Ellipse ROI [Max]Draw an arbitrary ellipse

Line ROI [Max]Draw a straight line

Bendable Line
ROI [Max]

Draw a multi-segment line. Each left click adds a vertex.
Right click to stop adding points. Using the Edit ROI tool
the vertex points can be moved individually.

Polygon ROI[Max]

Draw a closed polygon. Left click to add a vertex. Rightclick to close the polygon. Using the Edit ROI tool thevertex points can be moved individually.

Freehand ROI[Max]

Draw a freehand shape. Hold down the left mouse buttonand drag to draw. Release the left button to close the
ROI.

Spot Cursor ROI[Max]

This ROI reads the value of a single pixel.

Measurement
Cursor ROI

Reads the average of a 3x3 box of pixels. Standardpractice in thermography is to use a 3x3 block of pixels formeasurements.

Add/Remove
Point [Max]Add/remove vertex from Bendable Line or Polygon. Clickon a vertex to deleted it or click on a line segment to add avertex.

Rotate ROI [Max]With this tool selected, mouse over an ROI to activate the“handles”. Drag the ROI to rotate it.

Select Next ROI

Select next ROI. Use to select very small or overlapping
ROIs

Delete current
ROI

Select an ROI and then click this button or press Delete
key to remove it

Delete All ROIs

Clears all ROIs

Load ROIs [Max]Load an ROI descriptor file

Merge ROIs [Max]Load ROIs from file and add to existing ROIs

ResearchIR User’s Guide

31

Chapter 4 – User Interface

Icon

Name
Save ROIs [Max]Save an ROI descriptor file

Show/Hide ROIs

Allows user to turn on/off the display of ROIs without
having to delete and add them

Isotherm ROI
[Max]

4.6

Description

This tool is located above the color bar. See section 4.4.1

Units and display controls

4.6.1 Units Selector
This dropdown allows the user to choose the data units. The units available depend on
the type of calibration done with the camera.

Factory calibrated cameras typically allow:•

Counts [Max]•Object Signal (N/A for SCx000 camera) [Max]•

Temperature (factory)•

Radiance (factory) [Max]User calibrated cameras typically allow:•

Counts•Radiance (user) [Max]•

Temperature (user) [Max]ResearchIR User’s Guide

32

Chapter 4 – User Interface

Unit

Description

Counts [Max]Digital value of pixel. Often referred to as “raw data” but canbe NUC corrected. Cameras typically have a 14-bit A-D
converter so the resulting values will be in the range of 016383

Object Signal[Max]

Typically available only on handheld cameras. This NUC
corrected but is proportional to radiance. Typically not of use
to the user but used internally for diagnostic purposes.

Temperature

If the camera is calibrated, the raw pixel counts can beconverted to units of temperature.

Radiance [Max]

Measure of IR power per unit area of the target. Units ofWatts/(cm2-steradian).

4.6.2 “Info” Button
The “Info” button gives the user a quick preview of file naming and acquisition settings.
Hovering the mouse over the “i” will show the info panel. Clicking the “i” button will makethe info panel a floating box that stays open until you close it.

4.6.3 Image Invert/Revert [Max]Thebuttons will cause the image to be flipped vertically or horizontally. This
flipping is done in software. Some cameras also have image flipping controls, but
activating these will require the NUC to be updated. Flipping the image on the computerside will not affect the NUC.

4.6.4 Saturation/Clipping On/Off
With the, control “on”, the software will display color indicators on the image andcolorbar to show if data in the image is exceeding calibration limits. Turning this control
off suppress these visual indicators.

ResearchIR User’s Guide

33

Chapter 4 – User Interface

4.7

Plot and Acquisition Toolbar

This toolbar provides quick access to plotting and acquisition functions. The icon for thecurrently selected tool is displayed. When the mouse is placed over the current tool adrop down menu is displayed to show other available tools.
Icon

ResearchIR User’s Guide

Tool

Description

Plot Tools

User can choose from a selection of plots
for each ROI. Only the Stats table andTemporal plot are available in ResearchIR
Basic.

Bad Pixel Tool
[Max]

Allows user to manually add a bad pixel tothe Bad Pixel Map (BPM). Click the reticle
tool and use the mouse or arrow keys toplace the reticle over the pixel to be marked.
Click the +/- button to add or remove thepixel from the BPM

Acquisition
Tools

Allows user to start or stop the acquisition,
record a snapshot or movie and to set
acquisition options.

PresetSelector[Max]

Allow user to select the displayed preset.
Only available if camera supports Preset
Sequencing (PS) and PS or Superframing
must be active.

Arm
Recording[Max]

This is optional for pre-trigger recordings.
This button pre-allocates memory;otherwise, memory is allocated at the time
the recording is triggered. When requestinga large memory buffer this can add a delay
to the start of recording. If you are
triggering off a header flag, then it is best to
Arm the recording so you can be sure thefirst flagged frame is captured

Export Bitmap

This is a quick export option. It will capture
a full image with no border and write a PNG
image to the Picture>>FLIR Systems folder.
IT DOES NOT USE THE NORMALEXPORT OPTIONS

Toggle File
Operation[Max]

Use this button to easily turn the File
Operation feature On and Off.

34

Chapter 4 – User Interface

Icon

Tool

Description

UltraMax Filedetected

This button will appear when an UltraMax
file is opened. Click the button will show
two options. (1) Upgrade and replacecurrent file with UltraMax image or (2)Backup the existing file before upgrading
the file. The file will be backed up to afolder within the current folder. [NOTE:
once a file is upgraded it cannot be
downgraded again.]

Apply PC-side
NUC
[Max]

Turns PC-side NUC on or off. Button only
active is PC-side NUC has been done.

Apply PC-Side
Bad Pixel Map
[Max]

Turns PC-side BPM on or off. Button only
active if PC-side BPM has been done.

4.7.1 Plot Tools
This toolbar allows the user to choose from various plots. You can have one of eachplot type per Region of Interest (ROI). Each of these plots can be free-floating or they
can be “docked”. The available plot types include:

Icon

ResearchIR User’s Guide

Description

1

Statistics viewer

2

Profile Plot

3

Temporal Plot

4

Histogram Plot

5

O-scope Plot

6

Tool Description

35

Chapter 4 – User Interface

4.7.1.1

Statistics Viewer

The Statistics Viewer allows the user to see a variety of statistic for all the ROIs currently
drawn. It is divided into three main areas.

1. Stats table toolbar
2. Stats table
3. Measurement functions

4.7.1.1.1

Stats Toolbar
Pause the update of the stats. (While the image keeps updating). Click again
to restart the update.
Save the current stats to a text file
Turn on/off the Image ROI. Creates a column in the table with stats for thewhole image.
ROI Subtraction. Opens a dialog that allows the user to create an new column
in the stats table that is a subtraction of two current ROIs.

ResearchIR User’s Guide

36

Chapter 4 – User Interface

4.7.1.1.2

Stats Table

There will be one column in the table for each active ROI. The top line of each column
shows the ROI name and its color. A “*” next to a temperature value indicated that thevalue has exceeded the limit of the calibration range but is still below the hard clip limit.
This data may not be within the normally specified accuracy. A “<” or “>” next to atemperature value indicates that the value has hit the hard clipping limit and should not
be considered accurate. Statistics for areas and lengths will be “N/A” unless the distancecheckbox is enabled.

ROI attributes can be changed by right clicking on the ROI or its column in the table andchoosing “Properties” from the menu.

NOTE: Emissivity must be a value between 0 and 1. If you enter a value outside thisrange the box will turn yellow to indicate an invalid entry.

ResearchIR User’s Guide

37

Chapter 4 – User Interface

4.7.1.1.3

Measurement Functions [Max]The righthand side of the stats window is used to define measurement functions. This
tool allows the user to define mathematical expressions using ROI statistics. Any
number can be defined. Once a function is defined you can view the expression bymousing over the function name. Measurement functions are managed using the toolbar
at the top of the pane.

Add Function

Opens the function definition dialog. User can create amathematical expression using constants, object
parameters, ROI stats, and other measurement
functions. An arbitrary name can be assigned to thefunction and will be displayed in the table.

Edit Function

Opens the function definition dialog with the current
expression. Edit the expression and click OK to save.

Delete Function

Deletes the highlighted function.

Delete All Functions Clears the Measurement Function table
Load Functions

User can load a previous set of function from disk

Save Functions

User can save a set of functions for later use

Temporal PlotUser can create a temporal plot of a defined function.

ResearchIR User’s Guide

38

Chapter 4 – User Interface

4.7.1.1.4

Adding and Editing Measurement functions

Choosing to add or edit a function will bring up the Measurement Function Editor.

The left area (1) allows the user to choose an input variable. Possible choices include
existing ROIs, data from the camera image header, or even other measurement
functions. Click the arrows to expand the lists. The top area (2) allows the user to set
the name and reference color for the function. Area (3) shows the complete expression
as a “formula”. These formulas can be a combination of inputs and math functions fromthe “calculator” area. Boolean functions (True, False, etc) can be used to evaluate thefunction and this state can be used to trigger the start of data recoding. (See Recording
Conditions, Sec 4.7.3.5)

4.7.1.2

Profile Plot [Max]The Profile Plot creates a linear graph of the data along an ROI. If the ROI is a line
(straight or bendable), this will be a traditional linear profile, where the actual data values(in the currently selected units) are plotted on an X-Y graph. If the ROI is an area (box,circle, polygon, freeform, or isotherm) then plot will be a “thick profile”. Think of a thickprofile as drawing a line across an ROI and then computing a statistic (Mean, Max, etc).
That will be one data point in the thick profile. You then scan the line across the ROI
one pixel at a time. This will produce a series of data points. As shown in the picture
below, the thick profile can horizontal or vertical.

ResearchIR User’s Guide

39

Chapter 4 – User Interface
If you open the plot tools by clicking the “<<” icon in the upper right corner of the plot,
and selecting the legend, you can choose the direction and statistic for the thick profile .

4.7.1.3

Temporal Plot

The Temporal plots allows the user to plot an ROI statistic versus time
As with other plots types, the plot tools can be displayed by clicking the << icon in theupper right of the plot window. The common tools are described in Sec 4.7.1.8. The“Plot vs:” option is used to select the units for the X-axis. The width field is used to set
the plot time span. This can also be done with the slider bar below the plot. If the spanis less than the total data, the dark gray part of slider can be moved to display earlier
data while keeping the same span.

ResearchIR User’s Guide

40

Chapter 4 – User Interface

4.7.1.4

Histogram Plot [Max]The Histogram Plot shows the user the distribution of values within an ROI. The
common plot tools are described in Sec 4.7.1.8. The Classes field is used to set the
number of “bins” that the data is group into.

4.7.1.5

Oscilloscope Plot [Max]The Oscilloscope Plot (O-scope) gives the user an “edge-on” view of the image. The Oscope can be thought of as a line profile with a profile for all the rows overlayed on top ofeach other. This allows the user to quickly identify regions of the image that are
saturated. This plot can be very useful when setting up a camera for a user calibration
to make sure that the integration time is set correctly.

ResearchIR User’s Guide

41

Chapter 4 – User Interface

4.7.1.6

Opening a plot

1. Select an ROI by clicking on it. The ROI color will change slightly and sizing
handles will appear to indicate that the ROI is selected.

2. If you want to open the plot to its default location, just click the plot button without
dragging.

3. If you want to open the plot and drag into a specific dock location, click and dragthe plot button into a dock location. The plot will be displayed as a translucent
preview.

4. When a plot can be docked into a dock location the dock location will highlightblue.
ResearchIR User’s Guide

42

Chapter 4 – User Interface

5. Release the left mouse button to dock the plot.

NOTE: Plots can be docked to the right and bottom of the initial ResearchIR layout.
When a plot is docked, it creates a plot container. New plots can be docked to the top,
left, bottom, right, and inside plot containers. In addition, there are two options fordocking a plot inside a plot container. As shown in the figure below, selecting the leftResearchIR User’s Guide

43

Chapter 4 – User Interface
center docking handle creates a plot in a new tab. Selecting the right-center dockhandle adds a new graph to the existing plot (called a multi-plot).

4.7.1.7

Managing docked plots

Docked plots can be closed or undocked by clicking the “x” on the plot tab or by
dragging the tab. Undocking a plot turns it into a floating window that can be dockedagain by dragging its title bar into a dock location. The currently displayed plot in a plot
container will have a darker colored tab.

4.7.1.8

Plot Toolbar

When the mouse cursor is hovering over the plot, the plot toolbar is activated and can beseen in the upper right corner of the plot window.

Clicking the “<<” opens the toolbar with all the available plot tools. Mousing over a tool
will display a tooltip with the tool name. Not all tools are available for all plot types

ResearchIR User’s Guide

44

Chapter 4 – User Interface
The plot tools include:
Icon

Tool
Reset

Lock Scales

Pan

Description
Reset plot option to default values
Do not auto scale. This option may be activated in conjunction
with other tools such as zoom.
Use mouse to move plot

Horizontal Box
Zoom

Use mouse to click and drag horizontal. Captures full y-axis.

Vertical Box
Zoom

Use mouse to click and drag vertical. Captures full x-axis.

Arbitrary Box
Zoom

Use mouse to draw an arbitrary box

Horizontal
Magnify

Only zoom x-axis. Left click to zoom in. Right click to zoom out.

Vertical Magnify

Only zoom y-axis. Left click to zoom in. Right click to zoom out.

Arbitrary
Magnify
Cursor selectOn/Off
Print

Zoom both x and y-axis. Left click to zoom in. Right click tozoom out.
When enabled (blue), user can set cursor location.

Send plot capture to printer device

Save (BMP or
CSV)

Save plot data to disk

Clear all plots

Clear plots (temporal plot only)

ResearchIR User’s Guide

45

Chapter 4 – User Interface

4.7.1.8.1

Plot Cursors [Max]Clicking on the
button in the toolbar activates the plot cursor. Use the mouse to point
to the desired cursor location and click. This will place an “X” on all displayed plots.
Multiple cursors will all share the same x-axis location. When mousing over the plot, abutton will also appear in the upper left corner. Clicking this button activates the
cursor readout window. If you don’t want the window to block the upper left portion of
the plot, then click the

button to “pin” the display to the left of the plot. The

buttons, will move the cursor to the next/previous data point. With
the mouse, you can point to any position on the plot. If there is no actual data point you
will see an interpolated value.

4.7.1.8.2

Plot Legend

Under the toolbar is the interactive legend. The legend can be used to select the y-axis
scale or delete a graph from a plot. To show a mini (non-interactive) legend when thetool bar is closed, right click on the plot and choose “Properties” from the menu. On the
Legend tab there is an option to draw the legend.

Icon

Description
Name and color of ROI
Clicking this icon switches the Y1 and Y2 axis
Deletes the ROI from the plot

ResearchIR User’s Guide

46

Chapter 4 – User Interface

4.7.1.9

Plot Properties

Right-clicking on any plot window will bring up the plot properties dialog. This dialog
allows the user to customize the plot appearance.

4.7.2 Bad Pixel Tool [Max]The Bad Pixel Tool allows the user to manually add bad pixels to the Bad Pixel Map(BPM) that was created when doing a PC-Side Non-Uniformity Correction (PC-NUC).
Place the cursor over the bad pixel and click the add/remove button (or the Spacebar) tomark the pixel as bad. Pressing the button again will unmark the pixel. Once the pixel
has been marked it will turn blue. Clicking the Bad Pixel tool again (see cursor in picture
below) will turn off the tool and all blue pixels will be replaced with a nearest good pixel.

1. Enable bad pixel selection cursor
2. Add/remove selected pixel from map
The program will search for a good replacement pixel using the pattern indicated below.
It will start with the pixel to the upper left of the bad pixel. If that pixel is bad or invalid(pixel is in a corner) the algorithm will search other adjacent pixels. If none of thosepixels are good, then the algorithm will expand the search ring by one pixel.
ResearchIR User’s Guide

47

Chapter 4 – User Interface

4.7.3 Acquisition Tools
The Acquisition Tools allow the user to start and stop the live display, record single
images or movies and set recording options.

Icon

Description
Play/pause live image stream
Record a single image
Record a movie
Edit record settings

4.7.3.1

Record Settings

Selecting the “Edit Recording Settings” Tool displays the following dialog. This dialog
allows the user to choose the Record Mode (To Memory or To Disk) as well as Record
Options and the location to store recorded data. Each section of this dialog is explainedin more detail in the sections that follow.

ResearchIR User’s Guide

48

Chapter 4 – User Interface

4.7.3.2

Record Mode

Allows user to choose option for recording to memory or disk

4.7.3.2.1

Record to Memory Mode [Max]Recording to PC memory is the fastest recording mode, but the time is limited byavailable physical RAM (does not use virtual RAM). When recording to PC memory theuser can set either a specific number of frames to record or a time to record, in minutes
or seconds.
When specifying time it is still necessary to specify a max frame limit. The frame limit
can be much higher than the number of frames needed to record the specified time.
The thing to keep in mind for all recordings to memory is that the frame limit is used toallocate a RAM buffer. RAM allocated to this buffer will not be available to otherapplications running on the PC. If the number specified is more than can be fromcontinuous PC RAM, the acquisition will not start properly. You will see the acquisition
status dialog but the acquisition will terminate with zero frames acquired. If thishappens, lower number of frames to record.

ResearchIR User’s Guide

49

Chapter 4 – User Interface

4.7.3.2.2

Record to Disk Mode

Recording to disk can accommodate longer recording times, but at a slower rate. In
addition to setting a number of frames or length of time for recording, the user can stopor start the recording with the F5 key or use the PC clock to start or stop the acquisition.

4.7.3.2.3

Periodic Recording

Periodic recording involves setting a pattern for recording frames. The user also
specifies how the pattern should be repeated, when it should stop, and how the data
should be saved. This mode is currently only available to recording to PC memory.

4.7.3.3

Record Options

These additional options may be used with any recording mode. The limit record rate is
typically used with uncooled cameras because this type of camera may not have a frame
rate control. ResearchIR tries to achieve the selected rate by dropping frames.

ResearchIR User’s Guide

50

Chapter 4 – User Interface

4.7.3.4

Pre-Trigger Recording Options [Max]User can setup a circular buffer where data is continually captured. When a recording is
initiated the frames in the buffer allow the user to see data before the recording wasstarted.

The user can set the buffer size (a tool tip will show the max value for a given computer).
The rate limiter options allow the user to slow down the rate of data recorded prior to thetrigger. This is useful for extending the time span of the pre-trigger buffer.

4.7.3.5

Record Conditions

The Record Conditions allow the user to choose additional options for starting andstopping a recording. Some camera models have an external trigger input and can set a
bit in the image header to indicate a trigger was detected. ResearchIR can use thisimage header information to start a recording. It is also possible to use a measurement
function with a Boolean result to trigger a recording, or to use the PC clock to trigger arecording.

The “Stop Recording” option is only available when recording to disk and using the“Start/Stop” recording mode.

4.7.3.6

File Naming Options

ResearchIR provides the user with a number of options for automatically generating
filenames. A separate set of options can be specified for both movies and snapshots.
Options include:•

Prefix: This is an alphanumeric code that is placed at the beginning of thefilename. These codes can be used for anything but are often used to refer to a
specific camera. The table of prefixes can be edited by the user and are not
restricted to two characters.

•

Text: This is an arbitrary text string•

Count: This is a numeric counter that is automatically incremented for eachacquisition. The starting number and increment can be specified.

•Timestamp: This will place the timestamp from the first image in the file name.
The time will be extracted from the image header on the first frame. If thecamera does not support time in the header then PC clock time will be used.

ResearchIR User’s Guide

51

Chapter 4 – User Interface

4.7.4 Preset Selector [Max]For cameras that support Preset Sequencing (also called Superframing or Multi-IT), thePreset Selector control allow the user to choose which preset to display. This feature iscurrently only available in SCx000 and RSx000 cameras.

Control

Description
Tells ResearchIR to display all active presets in sequence. For generaldisplay purposes this mode is not very helpful because it can be quite “flashy”
as the AGC adjusts from frame to frame. This mode is useful if you are trying
to do a PC-side NUC with multiple presets. With this mode ResearchIR will
NUC all active presets at the same time, using the same NUC scenes.
Depending on the integration times being used this may or may not produce
optimal results.
Tells ResearchIR to filter out a particular preset for display. If a chosenpreset is not active in the camera, ResearchIR will display an message“Frame Not Available” in the image window.
Enables real-time Dynamic Range Extension (DRX). If a camera is calibrated(factory or user), with a different temperature range loaded in each preset, thisoption will apply the DRX algorithm. Using Preset Sequencing, DRX will takethe best pixel data from each preset and combine the data to form a newimage that spans all of the available calibration ranges. This allows the user
to span a much larger dynamic range than could typically be covered with one
integration time. DRX works best for static scenes.

ResearchIR User’s Guide

52

Chapter 4 – User Interface

4.8

Toolboxes [Max]Toolboxes are only available in ResearchIR Max. Toolboxes allow uses to accessadvanced program functions. Some toolboxes are available only if a certain add-on
module is active, such as User Calibration, Export, or Dynamic Range Extension. Other
toolboxes are only available for certain camera types. For example, the Object
Parameters Toolbox is only available if a camera has a factory calibration.
The toolbox view can be customized to show only what the user wants to see. The
program will remember the last settings the next time the program is started.
ResearchIR User’s Guide

53

Chapter 4 – User Interface

4.8.1 Object Parameters Toolbox
Object Parameters are used to more accurately compute the temperature of an object.
The object parameters toolbox displays the current object parameters as downloaded
from the camera and allows you to edit them. Editing the values in the toolbox overrides
the values coming from the camera but does not change the values for theseparameters in the camera. (NOTE: For ResearchIR Basic users, this toolbox is available
under the Tools menu.)

4.8.2 Camera Control Toolbox
This toolbox gives the user a mini version of the camera controller where the common
functions like temperature range can be selected without having to bring up the fullcamera controller.

4.8.3 Source Information Toolbox
The Source Information toolbox displays information about the camera or file being
viewed. This information differs from the metadata viewer in that this information is notframe dependent. Source information includes data like camera type, lens used, filters,
calibration ranges, GPS information, frame rate, integration time, spatial calibration data,etc. The information shown will vary depending on the data source.

4.8.4 Minimap Toolbox
The Minimap allows the user to see a thumbnail version of the current image. If theimage is digitally zoomed then a box appears on the minimap to indicate which part ofthe image is currently displayed in the main image window. The zoom box on theminimap can be moved with the mouse to easily position it over the area of interest.

4.8.5 Segmentation Toolbox [Max]The Segmentation toolbox controls if and how segmentation is applied to the image
data. Segmentation defines a range of values that are considered valid in the image.
For instance, if the segmentation min and max are 7000 counts and 9000 counts
respectively then only the pixels in the image that have a value between 7000 and 9000
are considered valid. All other pixels are segmented out (ignored). Pixels that aresegmented out are not included when computing statistics. The Number of Pixels
statistic will reflect the number of valid pixels in the ROI. Pixels below the segmentation
minimum are show as blue and pixels above the segmentation maximum are show as
red. The segmentation range can be defined in terms of counts, radiance, or
temperature units.

ResearchIR User’s Guide

54

Chapter 4 – User Interface

4.8.6 Filters Toolbox [Max]The filters toolbox allows the user to apply a variety of operators to the entire image.
Click “Add Filter” will display dialog where the user can choose available filters from alist. Multiple filters can be chosen and they will be applied sequentially.

Icon

Description
Enable or disable a single filter or all filters
Change the order that filters are applied
Set filter parameters
Delete filtert

Filter Name

Operates on

Description

Gain

Pixel

Multiply each pixel by the gain value

Offset

Pixel

Add the offset value to each pixel

Exponential

Pixel

Compute exp(pixel value)

Natual Logarithm

Pixel

Compute ln(pixel value)

Square root

Pixel

Compute square root (pixel value)

Gaussian

Pixel

Compute a Gaussian blur (smoothing) to the image

Window Average

Pixel

Make each pixel the average of the selected kernel

MATLAB

Image

Passes an image to a MATLAB script. See Sec
4.8.6.1 for more details.

MedianPixel

Make each pixel the median of the selected kernel

Min – Continous

Pixel

Make each pixel the temporal minimum until reset

Min – Frame interval

Pixel

Make each pixel the temporal minimum over the lastn frames

Max – Continuous

Pixel

Make each pixel the temporal maximum until reset

ResearchIR User’s Guide

55

Chapter 4 – User Interface

Max – Frame interval

Pixel

Make each pixel the temporal maximum over the lastn frames

Frame Average

Image

Make current image the average of the last n frames.
Relative mode shows the actual delta values. If this
output will be fed into another filter that cannot
accept negative numbers, the absolute mode will
add the min value of the image in order to make all
pixels >0

Sliding subtraction

Image

Subtract the previous nth frame from the current
frame. Relative mode shows the actual delta values.
If this output will be fed into another filter that cannot
accept negative numbers, the absolute mode will
add the min value of the image in order to make all
pixels >0

HSM Mode

Image

Emulates the HSM mode found in GF-series
cameras4.8.6.1

MATLAB Filter

This filter allows a user to pass an image to an external MATLAB script for further
processing. This filter will only be available if MATLAB is installed (not included with
ResearchIR). The data that is passed will already have NUCs and calibrations applied(if enabled) and will be in the units selected in the upper right corner of the ResearchIR
window. Below is an example of how to make a MATLAB script that is useable by thefilter.
h = size(rir_filter_input, 1);
w = size(rir_filter_input, 2);
if rir_filter_reset
rir_filter_output = zeros(h, w, class(rir_filter_input));
end
for y = 1:hfor x = 1:w
rir_filter_output(y,x) = max(rir_filter_output(y,x), rir_filter_input(y,x));
end
end
rir_filter_input is a matrix with the input image
rir_filter_reset is a boolean scalar that is set to true when the image size changes or theuser disables and enables the filter or the user clicks reset
rir_filter_output is the output image matrix, the filter is expected to create this matrix
the input will be 16-bit unsigned integer or 32-bit floating point depending on the unit
selected in RIR

ResearchIR User’s Guide

56

Chapter 4 – User Interface
the output is also expected to be 16-bit unsigned integer or 32-bit floating point, if you
need to you can promote from a 16-bit unsigned integer to a 32-bit floating point in thefilter.

4.8.6.2

Passing metadata between ResearchIR and MATLAB

Most cameras have some metadata embedded in the image stream. The specificinformation with depend on camera model but it will typically include data like timestamp, and some camera settings. This data can be viewed in the metadata viewer
under the image window. It is possible to pass these parameters to MATLAB along with
the image. If MATLAB is being used to calculate a numeric result, rather than an image,it is also possible to pass this result back to ResearchIR and see it in the metadata
viewer. Data in the metadata viewer can be plotted versus time using a temporal plot.
Below is an example of a script that passes the average, min, and max values of animage back to ResearchIR.
rir_filter_metadata_output.Average = mean(rir_filter_input,'double');rir_filter_metadata_output.Max = max(max(rir_filter_input));
rir_filter_metadata_output.Min = min(min(rir_filter_input));

4.8.7 HSDR Toolbox [Max+]
This toolbox will only be available if you have a High Speed Data Recorder (HSDR).
ResearchIR can work with CL-160, CL-SAS, pHSDR versions of HSDR.

4.8.7.1

First-time Setup

Before the HSDR can be used with ResearchIR, the HSDR core software drivers must
be installed. If one is using the HSDR Core2 hardware, the host PC must have a USB
3.0 port on it for the eSATA to USB 3.0 converter cable. If you are installing ResearchIR
on an existing CL-160 or CL-SAS HSDR (with RTools), this software should already beinstalled, and you can proceed to Sec 4.8.7.2. If you have a pHSDR, this software canbe found on a CD that came with the unit. Just run the “core.exe” program. Reboot thePC.
After installing the drivers, go to the “Tools” menu and select “HSDR Setup…” You will
see the dialog box shown below. Select the type of HSDR you have and check the“Enable HSDR” box
NOTE: For pHSDR systems, you must connect the HSDR unit to the PC
using the USB 3.0 to eSATA cable BEFORE launching ResearchIR,
otherwise the software will not detect the HSDR. Refer to the HSDR User
Guide for more information and troubleshooting help. It is FLIR document
number 4212427.

ResearchIR User’s Guide

57

Chapter 4 – User Interface
Once this step has been completed, you will see the HSDR Toolbox and File / HSDR
tabs in the File Toolbox.

4.8.7.2

Pairing

Each time a new camera is connected to an HSDR, the two devices must be “paired”.
Connect to camera using the GigE interface. Once you have a live image, click the
button to pair the camera to the HSDR. Once complete, the “Not Paired”
indicator will be replaced with the Camera information (Model # / SN)

4.8.7.3

HSDR Triggered recording (DVR express Core only)

It is possible to to trigger the start of a recording on the HSDR providing an externalsignal to the AUX connector on the rear of the HSDR. A TTL signal can be applied topin 18 (pin 26 for ground).
In ResearchIR, there is abutton that will “arm” the recording and set the program tolook for the HSDR trigger signal.

4.8.7.4

Movie Recording

Use thebutton in the HSDR Toolbox to set recording option for the HSDR. These
options are independent of the options set for non-HSDR recording (see Sec 4.7.3.3).

ResearchIR User’s Guide

58

Chapter 4 – User Interface

The Record Mode options are similar to those available for non-HSDR recording. Thereis an additional “Start/Stop” mode. Here you can use theandbuttons tostart and stop the recording when desired. After a recording is completed, a message
will be displayed in the toolbox indicating the number of frames recorded, frame rate,
recording time, and number of dropped frames (should be zero).

File name options are similar to those described in Sec. 4.7.3.6.

4.8.7.5

Movie Playback

The HSDR tab in the File Toolbox allows the user to access data that has been recorded
to the HSDR but has not been extracted to the PC hard drive. Just double-click themovie you wish to play.

4.8.7.6

Movie Extraction

Use the Extract feature (Sec 4.9.1.2) to copy files from the HSDR drives to the regular
PC hard drives. Once extracted, the movie will be displayed in the File tab of the FileToolbox. It is IMPORTANT that you extract data you want to keep as soon as possible.
Certain actions such as pairing a new camera or changing the camera window size cantrigger a reformat of the HSDR drives, possibly causing this data to be permanently lost.

4.8.8 File Toolbox
The File toolbox displays files in the current directory that ResearchIR can open.

ResearchIR User’s Guide

59

Chapter 4 – User Interface

Icon

Description
Current displayed directory
Set current directory
Set current directory to record directory.
Set current directory to export directory

In addition to clicking the open button, you can double click on a file to open it.
NOTE: The “Show Record Folder” and “Show Export Folder” buttons only change thefolder being viewed. It does not set the location for recording and exporting. To set therecording location use the “Edit Recording Settings” button described in Sec. 4.7.3.

4.9

Main Menu Bar

This set of menus allow the user to access functions pertaining to camera connectivity,
display parameters and plot tools.

4.9.1 File Menu
Menu Option

Description

Open

Open a file

Close

Close the current file

Open Recent

Shows a list of recently used files

Save Bad Pixel Map

Updates PC-side NUC bad pixel map

ExportShows options for exporting data

Extract

Allows the user to save a portion of
the current file

ResearchIR User’s Guide

60

Chapter 4 – User Interface

4.9.1.1

Batch Extract

Extract data from multiple files

Page Setup

Options for setting up page forprinting

Print Main Screen

Allows user to print the current screen

Exit

Exits the program

Export Dialog

The Export Dialog allows the user to export images and data from ResearchIR for use inreports or other programs. Data values can be exported to CSV files or images andmovies can be exported to a number of standard formats. ResearchIR provides anumber of options to customize the exported objects.

There are three basic export types:•

Current Image: Exports only the currently displayed image frame•

Movie: Exports the selected range of frames as a video•

Multiple Images: Exports the selected range of frames as a series of individual
files.

Each type has a number of format options. (Pnly CSV, BMP. JPG, PNG, and WMV are
available in Standard)

ResearchIR User’s Guide

61

Chapter 4 – User Interface

Export Type

Export Format

Description

Current Image

Comma Separated
Variable (CSV)

Export ASCII text file that
contains the data for each
image pixel. Can beimported to other programs
like Excel.

Windows Bitmap (BMP)

Export Image capture
stored in BMP format

Portable Network Graphics(PNG)

Export Image capture
stored in PNG format

JPEG

Export Image capture
stored in JPG format

TIFF

Standard 24-bit TIFF (8-bit
RGB)

TIFF (16-bit counts)

Monochrome. Each pixel
value stored in counts.
Can be imported to Matlab

TIFF (32-bit floating point)

Monochrome. Used forstoring calibrated data.
Can be imported to Matlab.

FITS

Export binary data file in
FITS format. This is an
open file format.

SAF Image

Export binary data file in
SAF file format. This is an
open file format.

Windows Media Movie(WMV)

Export a movie file in WMVformat

FITS

Export binary data file in
FITS format. This is an
open file format.

SAF

Export binary data file in
SAF file format. This is an
open file format.

TIFF (32-bit floating point)

Monochrome. Used forstoring calibrated data.
Can be imported to Matlab.

YUVThis is a near losslessformat that can be read mymany high-end video
editing packages. If you

Movie

ResearchIR User’s Guide

62

Chapter 4 – User Interface

Export Type

Export Format

Description
need to encode you data ina specific codec, you canexport in YUV and thenuse the video editing
software to encode in thecodec of your choice

Multiple Images

Comma Separated
Variable (CSV)

Export ASCII text file that
contains the data for each
image pixel. Can beimported to other programs
like Excel.

Windows Bitmap (BMP)

Export Image capture
stored in BMP format

Portable Network Graphics(PNG)

Export Image capture
stored in PNG format

JPEG

Export Image capture
stored in JPG format

TIFF

RGB, 16-bit counts, or 32bit floating point

FITS

Export binary data file in
FITS format. This is an
open file format.

SAF

Export binary data file in
SAF file format. This is an
open file format.

The JPEG Quality control adjusts the amount of compression. The further the slider is
moved to the right, the better the image quality (larger the file size).
The Rate (Hz) control allows the user to set the playback rate. This is useful when thesource data rate is much slower or much fast than normal.
The Output field allows the user to designate the location for exported files to be stored.
There are also a number of additional export options that can be enables by checking
the boxes. Options that do not apply to the chosen export settings are greyed out.
•

Export Entire Image: If unchecked, the image is exported using the current size(as displayed). This could be a zoom factor less than 1x or greater than 1x,
depending on the window layout and monitor resolution. If this option is checked
then the exported image will be full size (as if you were set to a 1x zoom factor.)•

Include Image Border: Adds a border to the image.

ResearchIR User’s Guide

63

Chapter 4 – User Interface•

Include color bar: Adds the color bar and scale to the exported image.

•Show ROIs: Include the ROIs in the exported image.

•Show ROI names: Include the ROI name in the exported image.

•Show ROIs: Include the ROIs in the exported image.

•Show ROI crosshairs: Include the ROI center marker in the exported image.

•Show min/max crosshairs: Includes the markers showing the min/max pixels
in the image.

•Show Classification: This option allows the user to add labels to the top andbottom of the image. These labels can be used for any purpose in addition toclassification markings.

•

Show Timestamp: This option adds the image timestamp to the exported video.
The time can be appended to the bottom of the image, overlayed on top of theimage, near the bottom of the frame, or merged with the classification text labels.

•Export ROI bitmasks: In addition to the image, additional files are exported with
the ROI bitmasks. The files have the same base name with the ROI nameappended. These are stored in the location specified in the Output field.

•

Export stats: In addition to the image, an additional text file is exported with the
ROI statistics.

•

Display images while exporting: When checked, ResearchIR will display theframe being exported.

•

Include header when exporting to CSV. Adds a block of header data to thebeginning of the CSV file.

•

Use frame skipping: When checked the user can specify a pattern of frames tokeep and skip.

File TypeCSV (Comma Separated Variable)

Description••••

Imager data.
Can be read into excel, but excel hassome row/colum count limitations.
Is an easy format to read if you want tolook at the raw data.
This format does not describe what
units the data is in.

BMP (Windows Bitmap)••

Uncompressed rendered image.
Common format for images, using thisover TIFF is a matter of preference.

PNG (Portable Network Graphic)••

Lossless compressed rendered image.
Smaller file size than TIFF/BMP, but
without any loss of information.

JPEG

•

Lossy compressed rendered image.

ResearchIR User’s Guide

64

Chapter 4 – User Interface••

Usually has the smallest file size, but
still looks relatively good.
Because it's a lossy compression
method, the resulting image is not a
perfect representation of the renderedframe.

TIFF••

Uncompressed rendered image.
Common format for images, using thisover BMP is a matter of preference.

TIFF (16-bit)

•
•
•
•

Imager data.
Only available in counts mode.
Truncates data to an integer.
Outputs a 16-bit grayscale TIFF file witheach pixel being a 16-bit counts value
This format does not describe what
units the data is in.
Many image editing applications canread 16-bit TIFFs.

••
TIFF (32-bit)

•
•
•
•
•

FPF (FLIR Public Format)

•
•
•

•
•
•
FITS

•
•
•
•
•

ResearchIR User’s Guide

Imager data.
Doesn't suffer from data truncation likea 16-bit TIFF.
This format is standard, but much lesscommon than 16-bit TIFF.
If your a fan of TIFF and want to get
reduced data then this is a good format,
otherwise use SAF.
This format does not describe what
units the data is in.
Imager data.
Only available for temperature / object
signal.
Only factory calibrated cameras can
produce complete FPF files.
Currently broken, currently only
available for factory calibrated cameras.
This is a good format for factory
calibrated cameras in temperature or
object signal mode.
The format does have a units field.
Imager data.
Does not truncate data (can be floating
point or integer).
Format is standard and fairly easy toread.
Can be used for movies.
This format does not describe what
units the data is in.

65

Chapter 4 – User Interface

SAF (Standard Archive Format)•

This is a good choice if you haveexisting software that uses FITS files,
otherwise use SAF.

••

Imager data.
Does not truncate data (can be floating
point or integer).
Format is standard and fairly easy toread.
Can be used for movies.
The format does have a units field.
Compatible with RTools.
This is the recommended format forimager data.

•••
WMV (Windows Media Video)

•
•
•
•

4.9.1.2

Lossy compressed rendered image.
Only rendered movie format available.
Can be viewed from almost any
windows computer.
Produces relatively small files withrelatively good quality.

Extract Dialog [Max+]The Extract feature allows the user to save a portion of a long video into another file to
make a smaller file. If ResearchIR has recorded data to a High Speed Data Recorder(HSDR), the Extract dialog allows the user to move the data from the data recorder tothe PC hard drive and to trim a file and save that portion to a new file.

When first opened this dialog displays the last folder used for extraction and the current
filename. If you have been using the original data directory, you must change thelocation or filename as ResearchIR will not let you overwrite the original file.

ResearchIR User’s Guide

66

Chapter 4 – User Interface

4.9.1.3

Batch Extract Dialog [Max+]If you have a lot of data that needs to be extracted from the HSDR, this can be a time
consuming process. The batch extract dialog allows the user to setup a list of files toextract. Only one file can be specified per row in the table. (It is currently not possible to
add a list of files from a list or folder in a single operation, but this will be added in a
future version).

4.9.2 Edit Menu

4.9.2.1

Menu Option

Description

Spatial Calibration…

Enter data for computing lengths andareas of ROIs.

Preferences

Set program preferences

Spatial Calibration [Max]A spatial calibration allows ResearchIR to compute lengths and areas of ROIs drawn on
an image. The Spatial Calibration dialog allows the user to enter the data necessary tocompute the camera’s Instantaneous Field of View (IFOV). IFOV is the field-of-view of asingle pixel. ResearchIR supports independent values for horizontal and vertical IFOV;
however, modern cameras have square pixels so these values will be the same.
The Spatial calibration dialog presents the user with four options for computing IFOV
values. The results will be displayed in microradians.

ResearchIR User’s Guide

67

Chapter 4 – User Interface

Spatial Calibration Method

Description

Calculate from FOVEnter the FPA height and width in pixels and theField-of-view (FOV) of the optics

Calculate from focal length

Enter the pixel pitch (size), and lens focal length

ManualIf you know the IFOV, just enter it manually

MeasureDraw a line ROI on an object of known length in
the image and enter the distance to the object
from the front of the lens.

4.9.2.2

Preferences Dialog

The Preferences dialog allows you to edit settings that affect how ResearchIR behaves.

ResearchIR User’s Guide

68

Chapter 4 – User Interface

ResearchIR User’s Guide

69

Chapter 4 – User Interface

Preference

Description

Metadata

Metadata are items that can be extracted from the frame
header and can be shown in the metadata control on themain window. The available items will vary depending on thecamera type. Multiple items can be selected by holding
down the CTRL key while selecting with the left mousebutton.

ROIs

Check to display ROI names and center crosshair
Smooth ROIs:(Off) ROIs are pixel accurate when rendered. Allows user tosee exactly which pixels are included. Useful when trying tocompute accurate lengths, areas, and intensity(On) ROIs are not pixel accurate but rendering is notaffected by native resolution of the image.

Level and Span

Attempt to decrease jitter or wobbling in the level and spancontrol often caused by twinkling pixels. This is done byignoring a few of the pixels on the top and bottom of therange of values. Enter the number of pixels at the top andbottom of the range to ignore

Fast Forward Skip

Enter number of frames to skip in fast forward/reverse
playback

Target Frame Rate

Sets a limit for displaying live data. This is not related to thecamera frame rate. The default value is 16 (Hz). It issometimes useful to lower this value when trying to log
temporal plots for very long periods of time (many hours)
because the plot buffer can get full

Settings for all Users

If unchecked, preferences will be per user

Draw Min/Max

Check to display a “+” or arrow at the location of the min/max value in each ROI

Loop Movie Playback

Check this to play movies in a continuous loop

Image Interpolation

For lower resolution cameras (320x240 and below), thisoption can make the displayed image look less pixelated

Enable ATS-US USB
remote start or Serial-USB
remote start

ResearchIR supports two variants of USB Remote Start
boxes. The older FLIR proprietary box or you can use astandard USB to RS-232 converter (must provide your own
button) for switch closure only. Short pins 7/8 (CTS/RTS)

Remote Start Controls

Remote Start can be set to trigger recording of Live (currently
connected camera) or HSDR or both

Stop Recording

When Hotkey / remote start can stop recording

Theme

Two color themes are supported: Light or Dark

Reset

Sets all Preferences to default values

ResearchIR User’s Guide

70

Chapter 4 – User Interface

4.9.3 Camera Menu
Menu Option

Description

Connect

Connects to last selected camera

Disconnect

Disconnect from camera

SelectSelect a camera to connect to from a list ofavailable cameras

Control

Show camera controller for current connectedcameraUser Calibration

Functions for performing, saving, and loading user
calibrations

PC Side Correction

Function for performing, loading, and saving PC
side NUCs

ResearchIR User’s Guide

71

Chapter 4 – User Interface

4.9.3.1

Camera Selector

ResearchIR has two methods of selecting a camera: Auto detection, and manual
selection. If you select a camera with the Startup dialog (shown at startup or View>Startup Dialog menu), ResearchIR will try to auto detect the control interface. This is
generally the recommended method. If you need to manually specify the connection
interface you can use the Camera Selector.
The Camera Selector has two view modes: Standard and Custom. The Standard Mode
automatically scans the computer and displays available cameras. The cameras aregrouped by interface (Firewire or Ethernet). The Custom Mode allows you to manuallychoose the camera and connection interface
NOTE: You can run more than one instance of ResearchIR on the same PC. If one
instance of ResearchIR is connected to a camera, then that camera will not show
up in the Camera Selector in other instances of the program. Once the camera has
been disconnected, it will show up as an available camera.

Camera Selector (Standard View)

ResearchIR User’s Guide

72

Chapter 4 – User Interface
Camera Selector (Custom View)

4.9.3.2

Camera Control

ResearchIR provides a camera controller for all supported cameras. The controller iscustomized for each camera and provides access to all camera functions.

4.9.3.3

User Calibration [Max]The user calibration menu manages user radiance/temperature calibrations .
Menu Option

Description

Load

Load a previous user cal from disk

Save

Save the current user cal to disk

Load Pack

Pack file contains both INC and CAL file

Save Pack

Pack file contains both INC and CAL file

Perform

Start user cal wizard

Edit

Make changes to an existing user calibration

Clear

Unload current user cal from memory

4.9.3.3.1

Load Calibration

ResearchIR User’s Guide

73

Chapter 4 – User Interface
Brings up a file dialog box and allows user to select a user calibration to be loaded intomemory. The user calibration can then be applied to the data by choosing it with theUnits Selector.

4.9.3.3.2

Save Calibration

Brings up a file dialog box and allows user to save the current user calibration to disk.
This will create two files: a .INC and a .CAL. These two files are part of the SAF format,
which is fully described in a separate document.

4.9.3.3.3

Perform Calibration

The Perform option starts the User Calibration Wizard. This wizard will walk the user
through the steps required to calibrate a camera. You will need a calibrated blackbody
source to complete this procedure. This section is only a discussion of how to input user
calibration data into ResearchIR.
It is important to note that as a general rule, the User Calibration Wizard will generate acalibration in terms of apparent effective radiance. This means that the calibration ismapping the digital counts from the camera to what radiance the camera sees, notnecessarily to radiance at the source. If you use only ideal response curves for spectral
response and atmosphere, ResearchIR will compute theoretical source radiance basedon Planck’s function and map the camera counts to that. Therefore, when you include
data for spectral response and atmospheric path you are trying to reduce the theoreticalradiance of the calibration source to the energy that the camera actually sees.
4.9.3.3.3.1
Wizard Modes
The user will be presented with a dialog asking them to choose the Wizard Mode, from
Simple to Expert. The more advanced the mode, the fewer question will be asked.
Also, the process is less “step-by-step”, allowing the user to customize the processaccording to their needs. It is recommended that beginners use the Simple wizard until
they are comfortable with the process.

ResearchIR User’s Guide

74

Chapter 4 – User Interface

Mode

Description

Simple• For temperature only calibration• Assumes a Blackbody emissivity of 0.98.
• Assumes a top hat spectral response based on camera type.
• No MODTRAN input• No Additional Responses• No reflected radiance compensation• Must follow the wizard steps• No access to calibration coefficients

Standard• Best option for users new to User Calibration• Appropriate for Radiance and Temperature calibrations• Allows input of Spectral Response and MODTRAN data
• Allows input of Additional responses• User can input blackbody emissivity• Allows for compensation of reflected radiance• Walks user through Wizard, but then user can review/edit data
without Wizard• User can review/modify calibration coefficients

Advanced• Same inputs as Standard• Limited wizard steps

Expert• No wizard• User has full control of calibration data entry

4.9.3.3.3.2
Standard Calibration Wizard
This section will outline the steps in the Standard Calibration Wizard. The other Wizard
modes will be variations of this mode.
STEP 1: Getting Started. Before starting a user calibration, you will need tochoose the desired integration time for the camera and you will need to perform a

ResearchIR User’s Guide

75

Chapter 4 – User Interface
Non-Uniformity Correction (NUC). The NUC can either be done on the camera
side or on the PC side. Most FLIR cameras support on-camera NUCs. (The
SC8000 is an example of a camera that does not.) PC-Side NUCs are discussed
in the next section. See your camera’s user’s manual for more information on
camera-side NUCs.

STEP 2: Input Camera Spectral Response. The user can choose to use either
an ideal “top hat” response or provide a file with an actual response curve. The
graph will show the response curve that will be used.

An actual response file should be a peak-normalized power spectral response(not a photon response). A response file is a simple tab-delimited ASCII file withthe wavelength in microns and normalized response values. Below is an
example.
STEP 3: Input Atmospheric Path. This screen provides a place to input
Atmospheric path data from MODTRAN. MODTRAN is a widely accepted modelResearchIR User’s Guide

76

Chapter 4 – User Interface
used to predict atmospheric transmission. The MODTRAN model has several
output files. ResearchIR is setup to read the TOTAL TRANSMISSION and
PATH THERMAL data from the MODOUT2 files.
Once the MODTRAN data has been loaded, ResearchIR can plot the data.

STEP 4: Input Additional Responses: Additional responses can be used toaccount for other factors that can affect the path between the cal target and thecamera that are not already accounted for by camera spectral response or
atmospheric modeling. Such things might be a mirror reflectance curve or an
additional filter. The values in this file are multiplied against the data.
More than one response curve can be added using the

button.

Unwanted responses can be deleted using the

buttonResearchIR User’s Guide

77

Chapter 4 – User Interface
The file format for an additional response file is a simple tab-delimited ASCII file.
The first column should be the wavelength in microns and the second column
should be the transmission (value from 0 to 1). The data increment does nothave to be the same as the spectral response or atmospheric files. ResearchIR
will automatically interpolate the values.
STEP 5: Set default blackbody emissivity and reflected radiancecompensation options. This dialog allows the user to set the default emissivity
value for the blackbody. If you are using more than one blackbody or theemissivity change with temperature, it is possible to override this value when you
are taking the actual data.

The user can also set options to try and compensate for reflected energy in thescene that is not coming from the calibration source. Typically, this extra sourceis reflected solar energy. In almost all cases, you should not attempt tocompensate for reflected radiance unless you have no other option. If at all
possible you should arrange your calibration setup to provide clean, uncorrupted
view of the calibration target. This will give you the best and most repeatablecalibration.
STEP 6: Setup calibration source. This dialog box prompts the user to setup
the camera to see the blackbody. Once the blackbody is setup, click “Next”.

ResearchIR User’s Guide

78

Chapter 4 – User Interface

STEP 7: Draw an ROI on the blackbody. This dialog box prompts the user todraw a Region of Interest (ROI) on the blackbody emitter. The ROI should be
drawn so that it is large enough to get as many good pixels as possible but
should not be drawn to close to the edge of the source. ResearchIR will take thespatial average of all the pixels in the ROI so any pixels that are off of theblackbody will cause errors. Not all blackbody sources are created equal anduniformity at the edges is usually the worst so It is better to have fewer pixels thatyou know are good. Sometimes it is hard to tell from looking at the image if theedges of the blackbody are uniform. Using the O-scope plot is a good way to tell
if all of the pixels in the ROI are uniform.

ResearchIR User’s Guide

79

Chapter 4 – User Interface
STEP 8: Ready to Start Calibrating. The user is now ready to start adding
points to the calibration table. The calibration wizard uses a linear curve fit so atleast two points are required. However, more points are better. This dialog gives
instructions and helpful tips for collecting good calibration data. Keep these inmind:
1. A calibration must have at least two points.
2. The calibration should cover the entire range of temperature you want tomeasure. Extrapolation is not a good practice. A good calibration will bevery linear. If your curve has nonlinear characteristics there is generally
something wrong with the calibration data.
Click “Next” to continue.

ResearchIR User’s Guide

80

Chapter 4 – User Interface
STEP 9: Add calibration point. This dialog is used to collect and plot thecalibration data. The settings chosen here only affect this calibration point.

1.
2.
3.
4.
5.

ResearchIR User’s Guide

Enter the temperature of the calibration target
Set the emissivity of the calibration target
Check the presets for which this calibration point will beacquired. By default, all active presets are checked.
The current ROI value for each preset is displayed here
Click the “Add” button to record the calibration point.

81

Chapter 4 – User Interface
STEP 10: Review data and add more points. Once you have added a data
point you will see a table summarizing all of the data taken. To add an additional
point, click the
button. Below is a sample of a complete
calibration. The summary table and graph allow the user to modify the data andassess the quality of the calibration. The top section shows information about
each cal point. The check boxes can be used to remove a particular point from apreset. The bottom section shows a plot of the counts versus radiance so thatthe user can see if the calibration has the expected linearity.

ResearchIR User’s Guide

82

Chapter 4 – User Interface
STEP 11: Edit Misc Tab. The Misc tab allows the user to edit tags that will bepart of the INC file. The top section has several commonly used tags. The
bottom section allows the user to add any tag desired.

Commonly used and recommended tags are located at the top of the dialog box.
Check the boxes to enable the tags. These include:
Tag

Description

TPFACT

This parameter is a Multiplier to the computed
radiance. It is generally a number >1. It is most often
used to compensate for the effects of atmosphericattenuation or an ND filter that was not part of theoriginal calibration.

Slant Range (m)This is the direct distance from the camera to thetarget. This parameter is used in conjunction with IFOV
to compute the size and areas of objects in the image.
Area is need to compute target intensity

IFOV

This is the field-of-view of a single pixel. If a Spatial
Calibration (see Sec 4.9.2.1) has already been
performed, the IFOV data will be imported to this
dialog. The user cal also run the Spatial Calibration
calculator by clicking the “Calculate” button.

Bandpass

This is an option tag and is superseded by the spectral
response data. If a spectral response is loaded, thesefields will be populated with the 50% points of the
response curve.

Additional (optional) tags can be entered at the bottom of the form. These canbe tags that are defined as part of the SAF file format or they can be userdefined. Placing them in the “Global” tab means they are assigned to all presets;or they can be assigned only to a single preset. All tags entered on this tab will
become part of the default INC file. As long as this calibration is loaded thisResearchIR User’s Guide

83

Chapter 4 – User Interface
default INC will be used as a template to generate the INC file for each SAF
movie that is recorded.
Click “Finish” to close the calibration wizard. To save the calibration data for
future use click the
button. To apply the calibration to the live
data choose either a Radiance (user) or Temperature (user) from the Units
Selector.
4.9.3.3.3.3
Review Calibration Coefficients
The “Coeffs” tab allows the user to review/edit the coefficients for computing radianceand temperature. The four ain sections are described in the table below.

SectionDescription

Counts to RadianceDisplays the coeffs used to convert digital counts toradiance. Order one is typical but higher orders canbe selected using the dropdown. Order “-1” or “-2” canbe chosen if doing an “offset correction”. R2 is a figureof merit for the quality of the curve fit. A value >0.9995 is typical for a good calibration.

Lookup table

Radiance to Temperature

ResearchIR User’s Guide

Controls the generation of the lookup table thatconverts radiance to temperature. In “Auto” mode, thetable will use the min and max temperatures used in
the table at the top of the dialog box. If “Auto” isunchecked, the user can manually set the limits andincrement. It is generally best to leave the Emissivity
field set to 1.

Displays the coefficients used to convert radiance totemperature using a polynomial. This section can
generally be ignored as this is a legacy method. The
Lookup Table is the preferred method for computing
temperature.

84

Chapter 4 – User Interface

SectionDescription

Check

Allows the user to compute a value of counts,
radiance, or temperature using the coefficients. Enter
any values and the other two will be computed.
Temperature is computed using the lookup table.

4.9.3.3.3.4
Calibration Plots
By default, the calibration wizard will build a plot of counts vs. radiance. The user canbuild additional plots using the Add Graph and Edit Graph buttons. This will launch the
Add/Edit Graph dialog.

ResearchIR User’s Guide

85

Chapter 4 – User Interface
This dialog (shown above), allows the user to select from a number of graph type. As
the graph are selected using the “>>” button they will appear in the preview pane to theright. Once a graph is selected, other graph type that are not compatible with the thecurrent axes will be disabled. To use one of these the user would need to create
another new graph. One the graph is created in the preview the user can give it a name.
In the box below the name the user can delete graph or change their order. By mousing
over the preview you can access the plot toolbar with functions for pan/zoom and saving
the plot to CSV or BMP.

4.9.3.4

PC-Side Correction (Max Only)

PC-Side NUCs are similar to the camera-side NUCs. Both provide good image
correction but there are some differences in functionality. The following table compares
the two types of NUCs.
PC-SideNUC

Camera-sideNUC

1-point correction (Compute offset, Gain =1)✓✓2-point correction (Compute Gain and Offset)✓✓

Update offset only (keep current gain, compute newoffset)✓✓Bad pixel detection✓✓

NUC Feature

Use factory bad pixel map (eliminates more bad
pixels and twinklers)✓

Can be applied to camera analog output✓

Can use camera internal NUC flag✓

NUC data stored separately from raw digital data
(NUC data can be changed in post-processing)✓

Manual bad pixel tool✓

NUC storage space

unlimited

limitedIf desired, both types of NUCs can be used simultaneously. However, if you
are using a factory calibration it is STRONGLY recommended that you not
use a PC-Side NUC as this can affect the calibration accuracy.

One exception to this recommendation is using the Bad Pixel Tool to mark additional
bad pixels that are not masked by the automatic bad pixel detection algorithm.
ResearchIR keeps track of the last PC-Side NUC done for each camera it connects to.
If a PC-Side NUC is available, then the NUC icons will appear next to the Units Selector.

ResearchIR User’s Guide

86

Chapter 4 – User Interface

A blue shading over the icons indicates that the NUC and Bad Pixel Map (BPM) areenabled.

4.9.3.5

Creating a PC-Side NUC in ResearchIR

STEP 1: Choose the NUC Type. This dialog allows the user to select the NUC action
to perform. Click Next to continue.

NUC Type

Description

One Point Correction

Compute Offset, set Gain=1. No automatic bad pixel
detection.

Two Point Correction

Compute both Offset and Gain. Optional automatic bad pixel
detection.

Update Offset

Keep current gain. Compute new offset.

Bad Pixel Detection

Keep current Gain and Offset. Compute new Bad Pixel map.

Default

Remove current PC-side NUC. Set Gain=1 and Offset=0.

ResearchIR User’s Guide

87

Chapter 4 – User Interface
STEP 2: Set NUC Options. This dialog allows the user to set the number of frames toaverage, and whether to detect bad pixels and twinkling pixels. The default values aregood for most situations.

STEP 3: Collect NUC data. User will be prompted to fill the field of view with a uniform
scene. One or two scenes (hot and cold) will be needed depending on the type ofcorrection being performed. Once you have filled the field of view of the camera with auniform scene, click “Next”. It does not matter which scene (hot or cold) is used first.

For the best results, the two scenes should be far enough apart in temperature to span
as much of the A/D range as possible. If the real scene spans a large range of the A/Dthan the scenes used to generate the NUC then the NUC algorithm with attempt to
extrapolate. This will generally lead to undesirable artifacts in the image.
NOTE: When choosing the hot and cold scenes for the NUC it is not always necessaryor desirable to span the same temperature range as the scene. The NUC source isgenerally placed right up to the camera so in many cases a temperature that would notsaturate the camera at a normal measurement distance may saturate the camera when
NUCing. This is caused by the difference in atmospheric transmission. For this reason,
when choosing scenes for a NUC it is better to think in terms of how many A/D counts
the source produces rather than its temperature.

ResearchIR User’s Guide

88

Chapter 4 – User Interface
STEP 4: Accept or Discard Correction. A dialog will appear showing the number ofbad pixels detected. Generally this will be a very low number. A high number usuallyindicates that one of the scenes was not uniform. If accepted, the new correction will be
stored as the default PC-side NUC.

STEP 5: Enable the PC-Side NUC. Once you have accepted the NUC, you can apply
it to the live image by using the NUC controls next to the Units Selector.

Below is the original scene before the NUC and with the NUC and bad pixel map
applied.

ResearchIR User’s Guide

89

Chapter 4 – User Interface

ResearchIR User’s Guide

90

Chapter 4 – User Interface

4.9.4 View Menu

4.9.4.1

4.9.4.2

Menu Option

Description

Zoom

Select image zoom level

PaletteChoose image color palettePreserve Aspect
Ratio

Maintain image aspect ratio whenresizing application window

Fullscreen

Show image only in fullscreen mode

Startup Dialog

Show the initial startup screen for
selecting recent files and cameras

Zoom Menu
Menu Option

Description

StretchStretch the image to fill the space available.

1/4

Display the image at ¼ (25%) of its original
size.

1/2

Display the image at ½ (50%) of its original
size.

1x

Display the image at its original size.

2x

Display the image at twice (200%) its original
size.

4x

Display the image at four times (400%) its
original size.

Palette Menu
Menu Option

Description

InvertInvert the colors in the current palette.

Load

Load an external palette.

Edit

Configure a given palette’s settings

1234,
Blue,
Glowbow,
Grayscale,Green,
Ironbow,
Rainbow,
Red,
Sepia

Use the selected built-in palette.

ResearchIR User’s Guide

91

Chapter 4 – User Interface

4.9.4.3

Edit Palette Dialog

The Edit Palette dialog allows the user to customize and create palettes. You cannot
permanently modify a default palette but you can save a new file. New palette files do
not show up in the menu list but can be loaded using the Palette>>Load menu option.

Control Points tell ResearchIR where to start and stop gradients. You can set the colorand location of as many control points as you like. ResearchIR will make a gradient
between those points. Control points do not have to be evenly spaced.
You can also specify some special purpose colors for Segmentation and Clipping.
Clipping colors will be applied when a pixel falls outside of a calibration range.

4.9.4.4

Startup Dialog

The Startup dialog allows you to quickly open a recent file or connect to an available
camera. The startup dialog is shown when ResearchIR starts up by default. It can be
set to not show when ResearchIR starts up with an option in the dialog.

ResearchIR User’s Guide

92

Chapter 4 – User Interface

4.9.5 Tools Menu
Menu Option

Description

Statistics Viewer

Toggles to show or hide the stats
viewer.

Profile PlotShows a plot of the data values
along a profile of the selected ROI.
If ROI is a Line, the graph will be a
profile along the line. If the ROI is
an area, the graph will be a “thick”
profile. Y-axis units correspond tounits selector.

Temporal Plot

Toggles to show a time history plot
for selected ROI. User can choose
statistic to plot vs. time.

Histogram Plot

Toggles to show a histogram plot of
selected ROI.

Oscilloscope Plot

Toggles to show an edge-on viewof the entire image

Color Bar

Toggles to turn the color scale on
or offFlying Spot Meter

Toggles to show a flying cursor
when the mouse cursor is over theimage

File Operation

Shows a dialog that allows a user
to specify a reference image thatcan be added, subtracted,
multiplied or divided by all images

Make Self Viewing
FileShows dialog to create a Self
Viewing File

Hotkeys…

Define Hotkeys

Setup HSDR

Initial Configuration of HSDR for
use with ResearchIR

Export/Import
HSDR Database

Allows user to save and reload the
HSDR database when swapping
media shuttles

Although the HSDR contains all of the recorded imagery, there is a database kept
by ResearchIR on the PC that is an index of what movies have been recorded.
If you wish to swap media shuttles on the HSDR is EXTREMELY CRITICAL thatyou use the Export function to save a copy of the data base before swapping themedia. This database file must be kept with the SSD shuttle and imported once
again when the shuttle is installed. The Database is reset when the “Setup HSDR”
function is used. Once the database has been overwritten it is IMPOSSIBLE torecover the data on the SSD drives..
ResearchIR User’s Guide

93

Chapter 4 – User Interface

ResearchIR User’s Guide

94

Chapter 4 – User Interface

4.9.5.1

Color Bar

The Color Bar shows the relationship between colors in the selected color palette andthe data values in the currently selected units.
The current segmentation levels are also displayedon the color bar as full width shaded regions in thecurrently selected segmentation colors.
Active Isotherm ROIs are displayed as half width
shaded regions. Isotherm limits can be adjusted by
dragging the ROI on the color bar. Isotherms ROIs
can be deleted by clicking the isotherm on the color
bar and pressing the Delete key.

4.9.5.2

Flying Spot Meter
The Flying Spot Meter is a real-time data
cursor that appears as the user runs themouse cursor over the image. To the lower
right of the cross-hairs is a tooltip that
displays the cursor coordinate (in pixels) andthe data value in the currently selected units.

4.9.5.3

File Operation

The File Operation dialog allows the user to designate an operation and a reference
image. Once selected, the reference image is applied on a pixel basis to the current
image using the operator. For example, this can be used to subtract one image fromanother and only show the differences. If the reference file is a movie, you can specify
the frame within the movie to be used. Using the “Frame” option you can specify aframe from the current movie or from live data.

You can use the Extract feature (Sec. 4.9.1.2) to pull a frame from a movie and use as
the reference or you can use the Snapshot record function (Sec. 4.7.3) to grab a single
frame.

ResearchIR User’s Guide

95

Chapter 4 – User Interface

4.9.5.4

Make Self Viewing File [Max]The Self Viewing File allows the user to share data with another person that does nothave ResearchIR. Rather than just sharing a graphical format like JPEG, the SVF allow
the secondary user to analyze the IR data with most of the features of the ResearchIr
program. The main limitations of the SVF version of ResearchIR are:••••can only open the file to which it is linked
max data sixe of 2GB
cannot connect to cameras
cannot export data

The Make Self Viewing File has two modes of operation: Single and Batch. The Single
mode creates a single self viewing file from a single input (typically the currently openfile). The Batch mode creates multiple self viewing files from multiple inputs.

4.9.6 Hotkeys
Hotkeys are keyboard shortcuts that can be configured by the user. A green check in
the “en” field indicated the hotkey is enabled. Clicking the red x in the “rm” field will
delete a hotkey assignment. To assign a hotkey, click on the command field to selectthe hotkey. Then click in the hotkey edit box at the bottom of the dialog box. Then press
the key combination you wish to assign to this hotkey and click the “Assign” button.

ResearchIR User’s Guide

96

Chapter 4 – User Interface

4.9.7 Help Menu
Menu Option
ResearchIR Help
About ResearchIR…

Gather Information

Description
Shows an online copy of the
ResearchIR User’s Guide.
Shows the program About Box. The
About Box provides information
about the program version.
This options is useful fortroubleshooting when contacting
FLIR Support. A text file is createdthat contains a variety of informationthat can be easily emailed to the
support agent.

4.10 Metadata display
The metadata display allows the user to see data embedded in the image header. The
data available is camera dependent but typically can include things like image
timestamp, camera settings, and camera status flags.

The View → Preferences dialog allows the user to choose which header items are
displayed in the table. The items available will vary, depending on the camera model.

ResearchIR User’s Guide

97

Chapter 4 – User Interface

4.10.1Time in ResearchIR
The time displayed in the metadata can come from different sources, depending on thecamera being used. Understanding the source time and the time reference areimportant when looking at the data at a future time

4.10.1.1 Time Source
Time can either come from the camera or the PC clock. The most accurate (andprecise) time is camera time. If the camera inserts a timestamp in the image header,ResearchIR will use that time. If camera time is not available, ResearchIR will fall backon the PC clock. The following table shows what time source ResearchIR will use for agiven camera.
NOTE: When viewing RGB, Visible, and Screen modes, PC time is always used.
Time Source

CameraCamera Time

SC4000/SC6x00/SC8x00 (IRIG-B)
SC5000/SC7000 (IRIG optional)
SC620/640/660
A40, S45, S65

PC Time (UTC)A320/A325
SC3xx
T-series (T200-T400)
i-series (i40, i60)

4.10.1.2

Time ReferenceTime can be referenced to either a local time zone or UTC (Coordinated Universal Time– formerly known as Greenwich Mean Time (GMT))
When using camera time, ResearchIR has no way to know what the time zone referenceis, so this is the responsibility of the user to keep track of. See your cameras User’s
Manual for details on setting the internal PC clock.
The SCx000 cameras generally offer an IRIG-B timestamp. IRIG is a precision time
format developed by the US Government Test Ranges. The camera’s IRIG clock can be
set locally or it can be slaved to a master clock. IRIG does not have a time zone
reference so the user will have to keep track of the time reference.
When ResearchIR falls back on using the PC clock for time, it will store the timereferenced to UTC. In order to know the local time, the user will have to offset the timeby the difference between local time and UTC. The table below gives some common
time zones and their reference to UTC. These offsets are for Standard Time. Daylight
Saving Time (or its international equivalent) would cause the offset to be one hour less(or more depending on the location).

ResearchIR User’s Guide

98

Chapter 4 – User Interface

Location

Time Offset from UTC

Daylight Time Offset

US Eastern Time (EST)US Central Time (CST)US Mountain Time (MST)US Pacific Time (PST)

UTC-05
UTC-06
UTC-07
UTC-08

UTC-04UTC-05
UTC-06
UTC-07

United Kingdom

UTC

UTC+01

France, Germany, Italy

UTC+01

UTC+02

Sydney, Australia

UTC+08

UTC+09ResearchIR User’s Guide

99

Chapter 6 – Other Utilities

5

Camera[taw4] Control

ResearchIR has a built-in camera controller for each of the supported cameras.
Selecting the Camera→Control menu item will display the controller for the currently
connected camera.
This section gives a summary of the controllers for some of the cameras supported. For
detailed explanations of your cameras features please refer to your camera’s user
manual.
For handheld cameras that have on-camera controls, the ResearchIR controller will havea basic configuration screen where you can set temperature range and update the NUC.
You can also select the image mode to display the IR image, visible camera (if available)or the screen image. There is also a button interface where you roughly have the same
button layout and labels as are on the camera. Using the button interface along with thescreen display makes it possible to remotely navigate the on-camera menus.

Below is an example of ResearchIR displaying the IR image, visible and screen image
from an S65.
ResearchIR User’s Guide

100

Chapter 6 – Other Utilities
NOTE: Thermal analysis can only be done on the IR image. The visible and screen
display are RGB data streams. The analysis tools will still work but you will be analyzing
the RGB values. You can analyze the individual RGB channels or the average of thethree.
Calibrated IR image data will be recorded in an SEQ file format. Visible and Screen
images can also be recorded but they will be stored in a SAF RGB movie.

ResearchIR User’s Guide

101

Chapter 6 – Other Utilities

6

Other[taw5] Utilities

In the Utilities folder there a number of external utilities provided. This section will
explain their use and operation.

6.1

REdit

This utility has been carried over directly from RTools. It allows users to edit theheaders of SAF files. This utility has its own online help which can be accessed from the“About…” menu.

6.2

CalibratIR

This is a standalone version of the User Calibration Wizard (see Sec 4.9.3.3.3.) With
this utility a user can view/edit user calibration files with needing to run ResearchIR .

6.3

File AbatIR

The File AbatIR utility is used to apply the DRX algorithm to recorded data in postprocessing. This is similar to the algorithm applied in Section 4.7.4. File AbatIR works
with SAF, SEQ, and PTW files. The File AbatIR utility differs from the Realtime DRX
feature in several key ways.
••

Rather than computing the DRX data on-the-fly, File AbatIR generates acompletely separate “ABMOV” file.
The user can control the order in which the presets are processed and the countthreshold at which the next preset is used.

The table below explains the various options and their uses. “Editable” output types
allow the user to change “Object Parameters” (i.e. emissivity), even after processing.
Also, “higher” unit types can be derived. For example a counts (editable) file be used togenerate radiance or temperature data. These files can only be viewed in ResearchIR .
Non-editable types have fixed values.
Output Type

Description

Counts (Editable)

Useful to “pre-process” data so that the real-time
DRX feature can display data at a faster rate.
Radiance and temperature units can be generated
in ResearchIR

Radiance (User, Editable)

Output data is stored in radiance units but object
parameters can still be changed in ResearchIR .
Temperature units can be generated in
ResearchIR

Radiance (User, Rescaled)

Data has been rescaled (normalized) to hide theabsolute values.

Radiance (User)

Output stored in radiance units. Computations
based on user cal data. (This is the traditional
output produced by the “FPAbater” utility in

ResearchIR User’s Guide

102

Chapter 6 – Other Utilities

RTools). Temperature units cannot be generated
from this data.
Temperature (User)

Output stored in temperature units using user cal.

Radiance (Factory)

Output stored in radiance units. Computations
based on factory cal data. Temperature units
cannot be generated from this data.

Temperature (Factory)

Output stored in temperature units. Computations
based on factory cal data. Radiance units cannot
be generated from this data.

6.4

CNUC Manager

If you have an SC5000 or SC7000 series camera with multiple CNUCs, this utility can beused to manage which CNUCs are loaded on the camera. This functionality is not
integrated in to the ResearchIR camera controller for these cameras.

ResearchIR User’s Guide

103

Chapter 7 – Acknowledgements

7

Acknowledgements[taw6]

The authors would like to acknowledge the Independent JPEG Group for their JPEG
library used by this software for JPEG file support. The authors would also like toacknowledge the ZLib and LibPNG projects for their libraries used by this software for
PNG file support.
The authors would also like to acknowledge the libtiff project; this software uses libtiff(http://www.libtiff.org) for TIFF file support. libtiff is subject to the following copyright:
Copyright (c) 1988-1997 Sam Leffler
Copyright (c) 1991-1997 Silicon Graphics, Inc.

Permission to use, copy, modify, distribute, and sell this software andits documentation for any purpose is hereby granted without fee, provided
that (i) the above copyright notices and this permission notice appear in
all copies of the software and related documentation, and (ii) the names of
Sam Leffler and Silicon Graphics may not be used in any advertising or
publicity relating to the software without the specific, prior written
permission of Sam Leffler and Silicon Graphics.

THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND,
EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCEOF THIS SOFTWARE.

ResearchIR User’s Guide

104