Release v1.15

Features

Apriltags support for Surface Tracking

Starting with v1.15, the Surface Tracker will detect apriltags instead of “square markers”.

We highly recommend to replace “square markers” with apriltags in your setup since their improved detection performance translates to gaze being mapped to surfaces with higher accuracy and surfaces being detected more reliably, especially during movements.

You can still use the “square markers” by setting the Marker Detector Mode to Legacy square markers. This is especially useful, if you want to process recordings that were made previous to this release.

Apriltags version 3 and support for Windows

We started to maintain our own fork of @duckietown's apriltags Python bindings for @AprilRobotics’ AprilTag 3 library. Forking the projects was mostly necessary in order to support them on Windows.

This change allows us to finally enable the Head Pose Tracker feature (initially released in v1.12) on Windows!

Freeze the current 3d eye model

You now have the option to freeze the current eye model. Doing so will prevent any changes to the current eye model and discard any alternative models that might have built up in the background.

Warning: Freezing the eye model will disable its ability to compensate for any kind of slippage.

Bugfixes

  • Drop invalid frame after disconnect - #1573
  • Revert change that caused eye process to crash when minimizing

Developers notes

Changed requirements

Please install apriltags via

pip install git+https://github.com/pupil-labs/apriltags

API changes

Improved fixations_on_surface export

A fixation is based on gaze data that full-fills the maximum-dispersion-minimum-duration-criterion. We use it to infer e.g. fixation’s position. When mapping a fixation to a surface, we use the surface’s homography to calculate the fixation’s position in surface coordinates. The surface’s homography is calculated based on the detected surface markers for a given world frame. In most cases, the fixation appears during multiple world frames, i.e. there are multiple surface homographies which could be used to map the fixation to the surface. Until now, we only exported fixations for the first frame during which the fixation appeared. This is not a problem, as long the surface does not move in relation to the world camera during the fixation. Since this is an assumption, that does not always hold true, we will export all fixation mappings starting with v1.15. This means, that if a fixation spans multiple world frames during which a surface was detected, we will export the fixation and its position for each of these world frames.

Therefore, we added two new columns, world_timestamp and world_index, to identify the world frame which was used to map the fixation.

Eye model freezing

You can un/freeze the 3d eye models via a notification:

{
    "subject": "pupil_detector.set_property.3d",
    "name": "model_is_frozen",
    "value": True,  # set to False to unfreeze
    
    # remove this line if you want
    # to freeze the model both eyes
    "target": "eye0",
}

See this example on how to use the Pupil Detector Network API.

Change pupil detection ROI by notification - #1576

You can change the pupil detector’s region of interest via a notification:

{
    "subject": "pupil_detector.set_property",
    "target": "eye0",
    "name": "roi",
    # value: (minX, maxX, minY, maxY)
    "value": [0, 100, 0, 200],
}

HMD-Eyes Streaming - #1501

This new video backend allows to stream a virtual Unity camera to Pupil Capture.

HMD-Eyes Streaming is an experimental feature for the hmd-eyes project and can only be activated via a network notification.

More news on this topic will follow soon over at the hmd-eyes project!

Release Updated

Update: Versions v1.15-65 and higher include multiple fixes for surface tracking. Please update Pupil if you have been using versions v1.15-4 or v1.15-5. A release download for macOS will follow soon.

Update 2019-08-27 10:07: Please find the macOS release attached below. Update 2019-09-05 12:05: We updated the Windows bundle to include fixes for the HMD Streaming backend.