Calibrate gaze mapping

This examples shows how to calibrate the gaze mapper with a connected Pupil Core headset.

Note

This example requires the dependencies for streaming and pupil detection.

import sys
import logging

import pupil_recording_interface as pri

Set Pupil Core generation

Set the generation of your Pupil Core device (1, 2 or 3)

pupil_gen = 2

Set folder for saving calibration

folder = "~/pupil_capture_settings"

Set up stream configurations

configs = [
    pri.VideoStream.Config(
        device_type="uvc",
        device_uid=f"Pupil Cam{pupil_gen} ID2",
        name="world",
        resolution=(1280, 720),
        fps=30,
        pipeline=[
            pri.CircleDetector.Config(paused=True),
            pri.Calibration.Config(save=True, folder=folder),
            pri.GazeMapper.Config(),
            pri.VideoDisplay.Config(),
        ],
    ),
    pri.VideoStream.Config(
        device_type="uvc",
        device_uid=f"Pupil Cam{pupil_gen} ID0",
        name="eye0",
        resolution=(320, 240) if pupil_gen == 1 else (192, 192),
        fps=120,
        color_format="gray",
        pipeline=[
            pri.PupilDetector.Config(),
            pri.VideoDisplay.Config(flip=True),
        ],
    ),
    pri.VideoStream.Config(
        device_type="uvc",
        device_uid=f"Pupil Cam{pupil_gen} ID1",
        name="eye1",
        resolution=(320, 240) if pupil_gen == 1 else (192, 192),
        fps=120,
        color_format="gray",
        pipeline=[pri.PupilDetector.Config(), pri.VideoDisplay.Config()],
    ),
]

Set up logger

logging.basicConfig(
    stream=sys.stdout, level=logging.INFO, format="%(message)s"
)

Run manager

With one of the video windows in focus, press ‘c’ to start collecting calibration data, then ‘c’ again to calculate the calibration from the collected data. Press ‘q’ to quit.

collecting = False
with pri.StreamManager(configs) as manager:
    while not manager.stopped:
        if manager.keypresses._getvalue():
            key = manager.keypresses.popleft()
            if key.lower() == "c":
                if not collecting:
                    print("Collecting calibration data...")
                    manager.send_notification(
                        {"resume_process": "world.CircleDetector"},
                        streams=["world"],
                    )
                    manager.send_notification(
                        {"collect_calibration_data": True}, streams=["world"],
                    )
                    collecting = True
                else:
                    print("Calculating calibration...")
                    manager.send_notification(
                        {"pause_process": "world.CircleDetector"},
                        streams=["world"],
                    )
                    manager.send_notification({"calculate_calibration": True})
                    collecting = False
            elif key.lower() == "q":
                break

print("\nStopped")