Quick Start

System Requirements

OpenIris is written in the C# programming language and relies on OpenCV and its wrapper for C# emguC to achieve real-time binocular performance exceeding 500 frames per second. C# provides a good balance between ease of development and performance. OpenIris currently targets .Net Framework 4.8 and is developed as a Windows application, but future versions will be upgraded to target newer versions of .Net to become cross-platform and run under Windows, Linux and macOS.

Download and Setup

You can test and try the OpenIris even without a camera by running the built-in simulation video. To quickly install and explore OpenIris's cool features, download the latest version of the application (from here).

• Download the release zip file in the desired directory
• Unzip the folder
• Inside the unzipped release folder, open the openiris.exe file

• On the OpenIris main window, select "Simulation" from the "Eye Tracking System" menu and click on "Start Tracking". On the OpenIris main window that we selected, "Simulation", the available hardware plugin can be selected to initiate the cameras or, instead, the simulation or previously saved videos can be opened to look at or re-process.

Tip

In some cases, Windows requires manual permission to enable the plugins to work. On the first window of the program, under the "Eye Tracking System" drop-down menu, there should be more than three options. If you don't see more than three options, you need to enable them manually. To enable the available plugins, go to the release folder and its subfolders, right-click on a dll file, and select more options. Under the security section, check "Unblock" and hit ok. Repeat for all dll files. [Would you happen to know how to fix this? Please join the project, and let's improve it together.]

• The default pupil, corneal reflection, and torsion pipeline will start tracking.

Running Simulation

Let's look at the most commonly used features of the OpenIris User Interface together.

Configuration Page

Click on "File" and select "Configuration". This will open a new window that contains the information about three plugins.