Getting Started

Welcome to Pupil Core! The first thing you need to do is download the latest Pupil Core software.

Download Pupil Core Software

Follow the steps below to get up and running and become familiar with the workflow.


1. Put on Pupil Core

Put on Pupil Core headset and plug it in to your computer.

Make sure there is space between the headset frame and your forehead. Headsets are adjustable and shipped with additional parts. For more information head over to the Hardware section of the docs.

2. Launch Pupil Capture

Start Pupil Capture on your computer. Once the program has initalized, a world video and eye video window will appear.

3. Check Pupil Detection

Everything depends on capturing good raw videos of the eyes.

You will need to physically adjust the eye cameras on your Pupil Core headset to get good images of the eyes.

Take a look at the eye window(s).

If the pupil is detected you will see a red circle around the edge of your pupil and a red dot at the center of your pupil.

  1. ✔️ Do - All range of the eye movements are visible.
  2. ❌ Don't - The camera arm here is too far away from the eye.
  3. ❌ Don't - The eye is not centered in the frame and eyebrow in the frame.
  4. ❌ Don't - The eye is out of focus.

Check the world window.

You will see confidence graphs in the top for each eye. 1.0 = high confidence pupil detection. 0.0 = no confidence.

Tip - move your head around while looking at a fixed position. This enables you to check that your pupil is visible in the video even at extreme angles.

4. Calibration

In order to know what someone is looking at, we must establish a mapping between pupil and gaze positions. This is what we call calibration. The calibration process establishes a mapping from pupil to gaze coordinates.

Screen Marker Calibration Method

Click c on the world screen or press c on the keyboard to start calibrate. Follow the marker on the screen with your eyes and try to keep your head stationary.

5. Start Recording

Start capturing data!

Pupil Capture will save the world video stream and all the corresponding gaze data in a folder in your main user directory named recordings.

Start/Stop recording: Press the r key on your keyboard or press the circular R button on the left hand side of the world window. The elapsed recording time will appear next to the R button.

6. Locate Saved Recording

By default, each recording will live in its own unique data folder contained in the recordings folder.

The default recordings directory will organize all recordings by date. Each time you press record a new folder will be created. Below we show an example of 3 recordings that have been made on the same date 001, 002, and 003:

recordings/
  2019-09-30/
    001/
    002/
    003/

7. Visualize in Pupil Player

Launch Pupil Player. Then drag and drop the recording folder (e.g 001) onto the Pupil Player window.

Player comes with a number of plugins. Plugins are classified by their use-case. Visualization plugins can be additive. This means that you can add multiple instances of a plugin to build up a visualization.

8. Export Data

You can export videos and data by pressing e on your keyboard or the down arrow button in the Pupil Player window.

Exports are saved within a dedicated folder named exports within the original recording folder.

Read more about the recording format