All software releases
Here you will find a log of all features, changes, bug fixes, and developer notes for Pupil Labs software.
November 29, 2023
We are excited to announce another round of updates for Pupil Cloud! This time, we have improvements for the recording timeline and several other smaller changes.
Enrichment Results in the Timeline
The recording timeline now contains visualizations for enrichments that indicate when they successfully tracked the reference image, surface, or face respectively.
This provides you with a high-level overview of when the stimuli were in the subject’s field of view.

Timeline Zoom
You can now zoom in the timeline. Zoom out for an overview of the entire recording and zoom in up to 1-second intervals to inspect the details.
Project Layout Changes
Enrichments now have a dedicated table. This enables you to search/sort enrichments and view more information about each enrichment in a single view. It also cleans up the sidebar!

Faster Downloads
Downloads of Marker Mapper and Reference Image Mapper exports are now 20x faster!
Search
You can now search for workspaces and projects by their ID.
November 29, 2023
We are excited to announce another round of updates for Pupil Cloud! This time, we have improvements for the recording timeline and several other smaller changes.
Enrichment Results in the Timeline
The recording timeline now contains visualizations for enrichments that indicate when they successfully tracked the reference image, surface, or face respectively.
This provides you with a high-level overview of when the stimuli were in the subject’s field of view.

Timeline Zoom
You can now zoom in the timeline. Zoom out for an overview of the entire recording and zoom in up to 1-second intervals to inspect the details.
Project Layout Changes
Enrichments now have a dedicated table. This enables you to search/sort enrichments and view more information about each enrichment in a single view. It also cleans up the sidebar!

Faster Downloads
Downloads of Marker Mapper and Reference Image Mapper exports are now 20x faster!
Search
You can now search for workspaces and projects by their ID.
August 7, 2023
Introducing the Analysis View
We are excited to introduce the Analysis View in Pupil Cloud! This is where high-level analysis, data aggregation, and advanced visualization will take place.
While this is just the first release and we are starting small, we have many features in the pipeline that will make the Analysis View one of the most important areas in Pupil Cloud in the near future!
What is available today?
Here is what has changed in this release:
In this first release, we are mostly rearranging existing features in preparation for bigger upcoming releases.
Analysis View: In each Project, you will see “Analysis” as a new menu item in the sidebar.
Heatmaps: We moved heatmaps out of enrichments and into Analysis. A Heatmap visualization is automatically added for each Reference Image Mapper or Marker Mapper enrichment.
Video Renderer: We renamed the Gaze Overlay Enrichment to Video Renderer and moved it into the Analysis view.
What’s next?
We have many exciting features planned for the Analysis View in the near future. This includes:
Areas of Interest (AOIs): We’re putting the finishing touches on an AOI tool. Draw AOIs on reference images and surfaces. Aggregate data on AOIs.
Metrics: Automatically calculate standard metrics for data on AOIs like e.g. “Average Fixation Duration”. Visualize them using various graphing options.
Video Renderer: More gaze visualization options (think cross-hair, eye video overlay). Abilities to visualize and render data from multiple enrichments.
Sharing: Share links to videos and visualizations with others.
We will be adding more and more of these features in the coming weeks, so stay tuned for updates!
Updates and Fixes
Workspace collaboration: Now when you create a new workspace, you can immediately invite other editors to collaborate. Hopefully this makes this feature more discoverable! You can also invite users from workspace settings.
Enrichment recordings: The enrichment track now has a tooltip and visual style to clearly communicate if a recording is not matched/included in the enrichment.
August 7, 2023
Introducing the Analysis View
We are excited to introduce the Analysis View in Pupil Cloud! This is where high-level analysis, data aggregation, and advanced visualization will take place.
While this is just the first release and we are starting small, we have many features in the pipeline that will make the Analysis View one of the most important areas in Pupil Cloud in the near future!
What is available today?
Here is what has changed in this release:
In this first release, we are mostly rearranging existing features in preparation for bigger upcoming releases.
Analysis View: In each Project, you will see “Analysis” as a new menu item in the sidebar.
Heatmaps: We moved heatmaps out of enrichments and into Analysis. A Heatmap visualization is automatically added for each Reference Image Mapper or Marker Mapper enrichment.
Video Renderer: We renamed the Gaze Overlay Enrichment to Video Renderer and moved it into the Analysis view.
What’s next?
We have many exciting features planned for the Analysis View in the near future. This includes:
Areas of Interest (AOIs): We’re putting the finishing touches on an AOI tool. Draw AOIs on reference images and surfaces. Aggregate data on AOIs.
Metrics: Automatically calculate standard metrics for data on AOIs like e.g. “Average Fixation Duration”. Visualize them using various graphing options.
Video Renderer: More gaze visualization options (think cross-hair, eye video overlay). Abilities to visualize and render data from multiple enrichments.
Sharing: Share links to videos and visualizations with others.
We will be adding more and more of these features in the coming weeks, so stay tuned for updates!
Updates and Fixes
Workspace collaboration: Now when you create a new workspace, you can immediately invite other editors to collaborate. Hopefully this makes this feature more discoverable! You can also invite users from workspace settings.
Enrichment recordings: The enrichment track now has a tooltip and visual style to clearly communicate if a recording is not matched/included in the enrichment.
May 10, 2023
Pupil Cloud UI Overhaul
Since the first release of Pupil Cloud in 2019 (time flies!), we have received a lot of feedback from the community and gained tons of experience using it ourselves. This led us to rethink the entire UI and do a major overhaul, which is now ready for release.
The new UI is available starting today at cloud.pupil-labs.com and we encourage you to check it out! In case you are not ready to make the switch yet, you can still access the old Pupil Cloud UI at old.cloud.pupil-labs.com.
We compiled a shortlist of the most important changes and the motivation behind them below. If you'd prefer a short video introduction check out our new onboarding video!
There are some significant changes, and we would love to hear what you think about them! If you have any feedback or feature requests, please let us know. If you have any issues or questions, reach out via via chat!
Navigation
The new navigation bar lets you move between workspaces and projects faster and easier. The breadcrumb structure keeps you informed of your current location.
Project Editor
We have completely redesigned the project and enrichment interaction. In the old design, there was a lot of back-and-forth between different views. With this update we aim to provide a streamlined pipeline.
Enrichment View
The new Enrichment View lets you see everything about your enrichment in one place, including its definition and visualizations of the results.
Downloads
We have added a new Downloads View to projects, which enables you to download all recording and enrichment data from a single place. The overview now includes a summary of the files that will be included in each download. In a future update, you will also be able to customize which files you wish to download.

Global Events
We are making changes to how events work to create more consistency. Previously, there were two types of events in Pupil Cloud:
Recording events: These events were created at recording time and uploaded to Pupil Cloud with the recording. They were then available in all projects to which the recording was added.
Project events: These events were created post hoc as part of a project and were only available within that project.
This system was confusing because events did not behave consistently. It also meant additional work for many users, as they had to define the same events repeatedly if they used the same recording in multiple projects.
With this update, we are introducing Global Events. Every event, no matter when or where it was created, will always be available with the respective recording. This allows you to define an event once and use it in every project.
As part of this change, we are promoting all existing events to global events. Users who previously defined the same event multiple times in different projects will now see duplicate events in their projects. We apologize for any inconvenience caused.
Customizing and Filtering Recording Tables
We added Filters to make it even easier to find recordings in your workspace. You can use filters together with search. Filter based on attributes like wearer, duration, or any other recording attribute.Furthermore, you can now customize the columns displayed in the recording table. This means you can add columns that are important to you and remove those that are less relevant.

Hotkeys
We have introduced several new hotkeys to help power users move more quickly. To view the hotkey overview, access the help menu in the top-right corner of the screen.
These hotkeys will enable you to move more swiftly through recordings and speed up the event annotation process. If there are any additional hotkeys you would like to see implemented let us know.

Resizable Panels
The panels in the new user interface are resizable. You can choose what you want to see most of: the recording table, the player, or the timeline!
Templates and Wearers in Workspace Settings
All functionality to create, edit and delete Templates and Wearers has been moved to the workspace settings.

May 10, 2023
Pupil Cloud UI Overhaul
Since the first release of Pupil Cloud in 2019 (time flies!), we have received a lot of feedback from the community and gained tons of experience using it ourselves. This led us to rethink the entire UI and do a major overhaul, which is now ready for release.
The new UI is available starting today at cloud.pupil-labs.com and we encourage you to check it out! In case you are not ready to make the switch yet, you can still access the old Pupil Cloud UI at old.cloud.pupil-labs.com.
We compiled a shortlist of the most important changes and the motivation behind them below. If you'd prefer a short video introduction check out our new onboarding video!
There are some significant changes, and we would love to hear what you think about them! If you have any feedback or feature requests, please let us know. If you have any issues or questions, reach out via via chat!
Navigation
The new navigation bar lets you move between workspaces and projects faster and easier. The breadcrumb structure keeps you informed of your current location.
Project Editor
We have completely redesigned the project and enrichment interaction. In the old design, there was a lot of back-and-forth between different views. With this update we aim to provide a streamlined pipeline.
Enrichment View
The new Enrichment View lets you see everything about your enrichment in one place, including its definition and visualizations of the results.
Downloads
We have added a new Downloads View to projects, which enables you to download all recording and enrichment data from a single place. The overview now includes a summary of the files that will be included in each download. In a future update, you will also be able to customize which files you wish to download.

Global Events
We are making changes to how events work to create more consistency. Previously, there were two types of events in Pupil Cloud:
Recording events: These events were created at recording time and uploaded to Pupil Cloud with the recording. They were then available in all projects to which the recording was added.
Project events: These events were created post hoc as part of a project and were only available within that project.
This system was confusing because events did not behave consistently. It also meant additional work for many users, as they had to define the same events repeatedly if they used the same recording in multiple projects.
With this update, we are introducing Global Events. Every event, no matter when or where it was created, will always be available with the respective recording. This allows you to define an event once and use it in every project.
As part of this change, we are promoting all existing events to global events. Users who previously defined the same event multiple times in different projects will now see duplicate events in their projects. We apologize for any inconvenience caused.
Customizing and Filtering Recording Tables
We added Filters to make it even easier to find recordings in your workspace. You can use filters together with search. Filter based on attributes like wearer, duration, or any other recording attribute.Furthermore, you can now customize the columns displayed in the recording table. This means you can add columns that are important to you and remove those that are less relevant.

Hotkeys
We have introduced several new hotkeys to help power users move more quickly. To view the hotkey overview, access the help menu in the top-right corner of the screen.
These hotkeys will enable you to move more swiftly through recordings and speed up the event annotation process. If there are any additional hotkeys you would like to see implemented let us know.

Resizable Panels
The panels in the new user interface are resizable. You can choose what you want to see most of: the recording table, the player, or the timeline!
Templates and Wearers in Workspace Settings
All functionality to create, edit and delete Templates and Wearers has been moved to the workspace settings.

July 8, 2022
Big updates for Pupil Cloud! A Demo Workspace with sample recordings, projects, and enrichments for everyone to explore. Fixation scanpaths can now visualized in all video playback in Cloud.
Demo Workspace
Every Pupil Cloud user now has access to our new Demo Workspace. It contains recordings and an example project with enrichments. We encourage everyone to explore it to help understand cloud features, best practices, and to get hands-on on with a real world dataset recorded with Pupil Invisible. We will continue to add more projects over time. Have a use-case you'd like to see as a demo? Get in touch!
Learn more about the demo workspace here.

Fixation Scanpath Visualization
We have added a new visualization for fixation scanpaths to all video playback in Pupil Cloud. It shows the sequence of fixations for the last two seconds in a recording. The visualization compensates for head movements to ensure fixations remain in the right location even when the viewpoint changes. (We've got a white paper on the new fixation detection algorithm coming soon - stay tuned!)

July 8, 2022
Big updates for Pupil Cloud! A Demo Workspace with sample recordings, projects, and enrichments for everyone to explore. Fixation scanpaths can now visualized in all video playback in Cloud.
Demo Workspace
Every Pupil Cloud user now has access to our new Demo Workspace. It contains recordings and an example project with enrichments. We encourage everyone to explore it to help understand cloud features, best practices, and to get hands-on on with a real world dataset recorded with Pupil Invisible. We will continue to add more projects over time. Have a use-case you'd like to see as a demo? Get in touch!
Learn more about the demo workspace here.

Fixation Scanpath Visualization
We have added a new visualization for fixation scanpaths to all video playback in Pupil Cloud. It shows the sequence of fixations for the last two seconds in a recording. The visualization compensates for head movements to ensure fixations remain in the right location even when the viewpoint changes. (We've got a white paper on the new fixation detection algorithm coming soon - stay tuned!)

May 11, 2022
Gaze Super Speed!
We have drastically increased the framerate of the real-time gaze signal to 120+ Hz. This was made possible by the hard work of our R&D and engineering teams in optimizing the neural network that runs on the Companion Device. Accuracy remains with drastic improvements to inference speed!
The high speed gaze data is available both in the recording data as well as via the real-time API. As usual, the full 200 Hz signal is available after uploading to Pupil Cloud.
May 11, 2022
Gaze Super Speed!
We have drastically increased the framerate of the real-time gaze signal to 120+ Hz. This was made possible by the hard work of our R&D and engineering teams in optimizing the neural network that runs on the Companion Device. Accuracy remains with drastic improvements to inference speed!
The high speed gaze data is available both in the recording data as well as via the real-time API. As usual, the full 200 Hz signal is available after uploading to Pupil Cloud.
April 29, 2022
Pupil Invisible Monitor
Monitor your data collection straight from the web-browser - on any device!
Just type pi.local:8080
into your address bar and the Pupil Invisible Monitor app will open, which allows you to view video and gaze data from all the Pupil Invisible Glasses in your network!
It also allows you to remote control them, see storage and battery levels, and save events with the press of a button.
A more detailed introduction can be found here.
April 29, 2022
Pupil Invisible Monitor
Monitor your data collection straight from the web-browser - on any device!
Just type pi.local:8080
into your address bar and the Pupil Invisible Monitor app will open, which allows you to view video and gaze data from all the Pupil Invisible Glasses in your network!
It also allows you to remote control them, see storage and battery levels, and save events with the press of a button.
A more detailed introduction can be found here.
March 24, 2022
We are excited to announce our latest update for Pupil Cloud including a new blink detector for Pupil Invisible, visualizations for the Reference Image Mapper enrichment and quicker access to data downloads in convenient formats!
Blink Detector
We built a brand new blink detection algorithm and are making it available in Pupil Cloud. Blinks will be calculated for recordings automatically on upload to Pupil Cloud and be available in exports. The algorithm analyzes motion patterns in the eye videos to robustly detect blink events including blink duration. We are planning on open sourcing the blink detection algorithm in the near future.
Learn more about the algorithm here.
Checkout the export format of blink data here.
Reference Image Mapper Visualizations
The Reference Image Mapper enables you to automatically map gaze from the scene video onto a reference image. We want to give users a glimpse into how the algorithm works and a way to inspect the results.
To facilitate that, we added two new visualizations for the Reference Image Mapper to the project editor.
If you select a Reference Image Mapper enrichment in the project editor sidebar you can enable a side-by-side view of the reference image and the scene video. You can play back gaze on them simultaneously and verify the correctness of the mapping.
Internally, the Reference Image Mapper is generating a 3D point cloud representation of the recorded environment. You can now enable a visualization of this point cloud projected onto the scene video. This allows you to verify that the 3D scene camera motion has been estimated correctly.

CSV Data Downloads In Drive
You can already use the Raw Data Exporter enrichment to download recordings in convenient formats like CSV and MP4 files. Now you can download recordings in convenient formats directly from Drive! We did this to help speed up the exploration of data for those who don’t need to create a project.
In the Drive view you can click on the Download button and now see two options. Download binary recording data which downloads the raw data as recorded on the Companion Device (plus 200Hz gaze data). And the new option called Download Recording which will result in CSV data files and videos in convenient formats (including 200 Hz gaze, fixation and blink data).

March 24, 2022
We are excited to announce our latest update for Pupil Cloud including a new blink detector for Pupil Invisible, visualizations for the Reference Image Mapper enrichment and quicker access to data downloads in convenient formats!
Blink Detector
We built a brand new blink detection algorithm and are making it available in Pupil Cloud. Blinks will be calculated for recordings automatically on upload to Pupil Cloud and be available in exports. The algorithm analyzes motion patterns in the eye videos to robustly detect blink events including blink duration. We are planning on open sourcing the blink detection algorithm in the near future.
Learn more about the algorithm here.
Checkout the export format of blink data here.
Reference Image Mapper Visualizations
The Reference Image Mapper enables you to automatically map gaze from the scene video onto a reference image. We want to give users a glimpse into how the algorithm works and a way to inspect the results.
To facilitate that, we added two new visualizations for the Reference Image Mapper to the project editor.
If you select a Reference Image Mapper enrichment in the project editor sidebar you can enable a side-by-side view of the reference image and the scene video. You can play back gaze on them simultaneously and verify the correctness of the mapping.
Internally, the Reference Image Mapper is generating a 3D point cloud representation of the recorded environment. You can now enable a visualization of this point cloud projected onto the scene video. This allows you to verify that the 3D scene camera motion has been estimated correctly.

CSV Data Downloads In Drive
You can already use the Raw Data Exporter enrichment to download recordings in convenient formats like CSV and MP4 files. Now you can download recordings in convenient formats directly from Drive! We did this to help speed up the exploration of data for those who don’t need to create a project.
In the Drive view you can click on the Download button and now see two options. Download binary recording data which downloads the raw data as recorded on the Companion Device (plus 200Hz gaze data). And the new option called Download Recording which will result in CSV data files and videos in convenient formats (including 200 Hz gaze, fixation and blink data).

March 21, 2022
Real-Time Network API and python library
Check out Pupil Invisible’s new real-time network API! This makes it easier than ever to get real-time eye tracking data for your research and applications.
Use our new Python library to instantly receive video and gaze data on your computer and remote control all your Pupil Invisible devices.
Implement gaze-interaction methodologies or track the progress of your data collection by starting recordings and saving events programmatically in no-time!
To learn more, please check out our Real-Time API Guides.
A new and improved version of Pupil Invisible Monitor based on this API is also coming very soon!
Pupil Invisible & Pupil Cloud Docs
Big update to the Pupil Invisible & Pupil Cloud docs. We improved the structure and added new tutorials and guides. Take a look!
If you are new to Pupil Invisible & Pupil Cloud, check out our new getting started guides.
Looking to dive deep? Check out the explainer sections on. the available data streams or enrichments.
More guides and other content additions are already in the works!
March 21, 2022
Real-Time Network API and python library
Check out Pupil Invisible’s new real-time network API! This makes it easier than ever to get real-time eye tracking data for your research and applications.
Use our new Python library to instantly receive video and gaze data on your computer and remote control all your Pupil Invisible devices.
Implement gaze-interaction methodologies or track the progress of your data collection by starting recordings and saving events programmatically in no-time!
To learn more, please check out our Real-Time API Guides.
A new and improved version of Pupil Invisible Monitor based on this API is also coming very soon!
Pupil Invisible & Pupil Cloud Docs
Big update to the Pupil Invisible & Pupil Cloud docs. We improved the structure and added new tutorials and guides. Take a look!
If you are new to Pupil Invisible & Pupil Cloud, check out our new getting started guides.
Looking to dive deep? Check out the explainer sections on. the available data streams or enrichments.
More guides and other content additions are already in the works!
December 10, 2021
We are excited to announce our latest release for Pupil Cloud including a novel fixation detector, advanced privacy features in workspaces, and more! All recordings uploaded after this release will automatically have fixation data.
Fixation Detection
We have developed a novel fixation detector for Pupil Invisible! It was designed to cope with the challenges of head-mounted eye tracking and is one of the most robust algorithms out there!
Traditional fixation detection algorithms are designed for stationary settings which assume minimal head movement. Our algorithm actively compensates for head movements and can detect fixations more reliably in dynamic scenarios. This includes robustness to vestibulo–ocular reflex (VOR) movements.
Fixations will be calculated automatically on upload to Pupil Cloud and be available in all exports. We are planning on open sourcing our new fixation detection algorithm in the near future along with a white paper and integration into Pupil Player for offline support.
Check out documentation on fixations exported for enrichments in the docs
Advanced Workspace Privacy Settings
We are introducing additional privacy settings for workspaces to cover a few specialized use cases that were requested by the community.
You can now disable scene video upload for the entire workspace. This allows users to make use of Pupil Cloud features like the calculation of 200 Hz gaze or fixations, while complying with strict privacy policies that would not allow scene video uploads to our servers.
In a future release we will introduce the ability to automatically blur faces on-upload of a recording to a workspace, such that the potentially sensitive original version is never stored in Pupil Cloud.
“Created by” Column in Recordings List
You can now see who uploaded each recording in the Drive view “Created by” column. We hope this makes collaboration easier within your workspace.
Optimized Project Editor Layout
We made more space for the video player at the center, and added a toolbar above the video player. The toolbar contains contextual enrichment related functions. Currently only for the Marker Mapper enrichment - more in the near future!
December 10, 2021
We are excited to announce our latest release for Pupil Cloud including a novel fixation detector, advanced privacy features in workspaces, and more! All recordings uploaded after this release will automatically have fixation data.
Fixation Detection
We have developed a novel fixation detector for Pupil Invisible! It was designed to cope with the challenges of head-mounted eye tracking and is one of the most robust algorithms out there!
Traditional fixation detection algorithms are designed for stationary settings which assume minimal head movement. Our algorithm actively compensates for head movements and can detect fixations more reliably in dynamic scenarios. This includes robustness to vestibulo–ocular reflex (VOR) movements.
Fixations will be calculated automatically on upload to Pupil Cloud and be available in all exports. We are planning on open sourcing our new fixation detection algorithm in the near future along with a white paper and integration into Pupil Player for offline support.
Check out documentation on fixations exported for enrichments in the docs
Advanced Workspace Privacy Settings
We are introducing additional privacy settings for workspaces to cover a few specialized use cases that were requested by the community.
You can now disable scene video upload for the entire workspace. This allows users to make use of Pupil Cloud features like the calculation of 200 Hz gaze or fixations, while complying with strict privacy policies that would not allow scene video uploads to our servers.
In a future release we will introduce the ability to automatically blur faces on-upload of a recording to a workspace, such that the potentially sensitive original version is never stored in Pupil Cloud.
“Created by” Column in Recordings List
You can now see who uploaded each recording in the Drive view “Created by” column. We hope this makes collaboration easier within your workspace.
Optimized Project Editor Layout
We made more space for the video player at the center, and added a toolbar above the video player. The toolbar contains contextual enrichment related functions. Currently only for the Marker Mapper enrichment - more in the near future!
November 29, 2021
We are pleased to announce the release of Pupil Core software v3.5!
Download the latest bundle (scroll down to the end of the release notes and see Assets).
Please feel free to get in touch with feedback and questions via the #pupil channel on Discord! 😄
Overview
In Pupil v3.5, we cleaned up log messages, improved software stability, fixations are now cached between Pupil Player sessions, and we have fine tuned 3d pupil confidence.
Pupil v3.5 is the first release that supports the new macOS Monterey (with a small caveat). Read more below.
New
Recording-specific annotation hotkeys
Add option to filter out low-confidence values in raw data export
Add option to disable world video recording
macOS Monterey support
Improved
Reduced number of user-facing log messages
Export-in-progress file-name suffixes
Windows: Handle exceptions during driver installation gracefully
Windows: Option to skip automatic driver installation
Windows: Create start menu entries and desktop shortcuts for all users on install
Add Euler angles to headpose tracker result
Normalize IMU pitch/roll values to [-180, 180] degrees
Confidence adjustment for pye3d results
Cache post-hoc fixation detector results
Documentation
New
Recording-specific annotation hotkeys - #2170
Until now, the keyboard-shortcut setup for annotations was stored in Pupil Player's session settings. These were reset if you updated Pupil Core software to a new version.
Starting with this version, annotation keyboard shortcuts will be stored persistently within the recording.
The definitions are stored in <recording dir>/offline_data/annotation_definitions.json
with the format:
{
"version": 1,
"definitions": {
"<label>": "<hotkey>"
}
}
This file can be shared between recordings.
When Pupil Player is opened, it will attempt to load the annotation definitions from the recording-specific file. If the file is not found or is invalid, Pupil Player will fallback to the session settings which contain the last known annotation definitions.
Add option to filter out low-confidence values in raw data export - #2210
Pupil Core software assigns "confidence" values to its pupil detections and gaze estimations. They indicate the quality of the measurement. For visualization and some analysis Plugins, Pupil Player hides gaze data below the "Minimum data confidence" threshold (adjustable in the general settings menu).
Prior to this release, the raw data exporter plugin exported all data, independently of its confidence. New users, therefore, often wonder why their exported data looks noisier than what they have seen in Pupil Player.
Starting with this release, users will have the option to filter out low-confidence data (i.e. below the "Minimum data confidence" threshold) in the export. The option can be enabled in the raw data exporter's menu.
Add option to disable world video recording - #2169
If you are not interested in recording the scene video, you can now disable the scene video recording in the Recorder
menu of Pupil Capture's world
window.
macOS Monterey support
Due to new technical limitations, Pupil Capture and Pupil Service need to be started with administrator privileges to get access to the video camera feeds. To do that, copy the applications into your /Applications
folder and run the corresponding command from the terminal:
Pupil Capture:
sudo /Applications/Pupil\ Capture.app/Contents/MacOS/pupil_capture
Pupil Service:
sudo /Applications/Pupil\ Service.app/Contents/MacOS/pupil_service
Note: The terminal will prompt you for your administrator password. It will not preview any typed keys. Simply hit enter once the password has been typed.
Note: When recording with administrator privileges, the resulting folder inherits admin file permissions. Pupil Player will detect these and ask you for the administrator password to reset the file permissions. This will be only necessary once per recording.
Improved
Export-in-progress file-name suffixes - #2167, #2186
Exporting video can take a long time. Pupil Player displays the progress as a growing circle around the menu icon while writing the result incrementally to disk. Specifically, it writes the result directly to the final export location. While the export is ongoing, the video file is invalid but still available to the user. This can lead to users opening the video before it has finished exporting and then encountering playback issues.
Starting with this release, Pupil Core software changes the video exports to include a .writing
file name suffix during the export. This prevents other applications from recognizing the partially exported video file as complete. Once the export is done, the suffix is removed and other applications are able to recognize the file type as video.
Reduced number of user-facing log messages - #2190
Over the years, Pupil Capture's functionality has grown and with it the number of user-facing log messages. They can be overwhelming to the point where important log messages are overlooked or ignored. For this release, we have reviewed the log messages that are being displayed in the UI during typical actions, e.g. calibration and recordings, and have reduced them significantly.
Windows: Handle exceptions during driver installation gracefully - #2173
Previously, errors during the driver installation could cause the software to crash. Now, errors will be logged to the log file and the user will be asked to install the drivers manually.
Windows: Option to skip automatic driver installation - #2207
Using the -skip-driv
or --skip-driver-installation
flags, one can now launch Pupil Capture and Pupil Service without running the automatic driver installation on Windows. This can be helpful to speed up the start up time or to avoid unwanted driver installations.
Windows: Create start menu entries and desktop shortcuts for all users on install - #2166
Pupil Core software is installed to C:\Program Files (x86)\Pupil-Labs
by default. This directory should be accessible by all users but the start menu entry and desktop shortcut are only installed for the current user. Starting with this release, the installer will create start menu entries and desktop shortcuts for all users on install.
Add Euler angles to headpose tracker result - #2175
Next to camera poses as Rodrigues' rotation vectors, the headpose tracker now also exports the camera orientation in Euler angles.
We also fixed a typo in the exported file name.
- head_pose_tacker_model.csv
+ head_pose_tracker_model.csv
Normalize IMU pitch/roll values to [-180, 180] - #2171
Orientation values exported by the IMU Timeline plugin will now be normalized to a range of [-180, 180] degrees.
Confidence adjustment for pye3d results - #2195
In some cases, pye3d was overestimating the confidence of its pupil detections. These were visible as noisy gaze estimations in the Pupil Core applications. This release includes an updated version of pye3d with adjusted confidence estimations. As a result, the gaze signal should look more stable during lower confidence situations, e.g. while squinting or looking down. For more information, see the Developer notes below.
Cache post-hoc fixation detector results - #2194
Post-hoc fixation detector results no longer need to be recalculated if you close and reopen a recording. Pupil Player stores the results together with the used configuration (version of the gaze data and fixation detection parameters) within the recording directory. The cached data will be restored if the Player configuration matches the configuration stored on disk. If it does not match, Player will recalculate the fixations to avoid inconsistencies.
Documentation
We have improved our documentation in several places:
Pupillometry best practices - pupil-docs#453
Blink detection - pupil-docs#463
Pupil Core API - pupil-docs#455
Fixed
Fixed typo in exported headpose tracker files - #2185
Fix confidence graphs in Pupil Player for pre-2.0 recordings - #2191
Use correct socket API to retrieve local IP address for Service - #2201
Fix loading 200 Hz gaze data in Pupil Invisible recordings - #2204
Fix loading short audio streams - #2206
Known issues
Windows: Connecting remotely to Pupil Remote on Pupil Service does not work in some cases
Pupil Groups: Users have reported issues with Pupil Groups connectivity when running Pupil Capture on different devices.
We are investigating these issues and will try to resolve them with an update as soon as possible.
Developer notes
Dependencies updates
Python dependencies can be updated using pip
and the requirements.txt
file:
python -m pip install --upgrade pip wheel
pip install -r requirements.txt
pye3d v0.2.0 and v0.3.0
Version 0.2.0 of pye3d
has lowered 3d-search-result confidence by 40%. When the confidence of the input 2d pupil datum is lower than a specific threshold (0.7), pye3d attempts to reconstruct the 2d pupil ellipse based on its existing 3d eye model. We noticed that the confidence for these results was systematically overestimated given the actual detection result quality and have therefore adjusted the overall confidence assignment for them. See pye3d-detector#36 for reference.
Version 0.3.0 uses a new serialization format for the refractionizer parameters but is otherwise functionally equivalent to version 0.2.0.
pyglui v1.31.0
This new version of pyglui
introduces support for multi-line thumb and icon labels.
Example:
from pyglui import ui
context = {"state": False}
ui.Icon(
"state",
context,
label="Multi\nLine",
label_offset_size=-10, # smaller font
label_offset_x=0, # no horizontal adjustments
label_offset_y=-10, # move label upwards
label_line_height=0.8, # reduce line height
)
zeromq-pyre >= v0.3.4
Starting with version v0.3.4, zeromq-pyre
is able to handle cases gracefully where it is not able to access any network interfaces. See #2187 for reference.
Plugin API
Easy plugin icon customization - #2196
Plugins can now overwrite the following class attributes to customize the menu icon:
icon_pos_delta
: relative positioningicon_size_delta
: relative font resizingicon_line_height
(multi-line icons only): line distance
Requires pyglui v1.31.0 or higher
Real-time Network API
Add surf_to_dist_img_trans
and dist_img_to_surf_trans
to surface events #2168
These two homographies are necessary to transform points from the surface coordinate system to the 2d image space of the scene camera, and vice versa. They have been available as part of the surface location exports in Pupil Player. With this release, they also become available to other plugins in Pupil Capture or via its Network API.
Example plugin that access the new homographies in real-time:
import numpy as np
from plugin import Plugin
class Example(Plugin):
def recent_events(self, events):
# access surfaces or fallback to empty list if not available
surfaces = events.get("surfaces", [])
for surface in surfaces:
# access raw homography data, a list of lists
homography = surface["surf_to_dist_img_trans"]
# convert to a matrix
homography = np.array(homography)
# use homography, e.g. printing it
print(f"{surface['name']}: {homography}")
Downloads
To open the RAR-archive on Windows, you will need to use decompression software, such as WinRAR or 7-Zip (both are available for free).
Supported operating systems
macOS Mojave 10.14, macOS Catalina 10.15, macOS Big Sur 11
macOS Monterey 12 requires administrator privileges to access the video cameras
Ubuntu 16.04 or newer
Windows 10
Checksums
$ shasum -a 256 pupil_v3.5*
41428173c33d07171bb7bf8f0c83b7debfabb66a1dfc7530d1ae302be70ccc9c pupil_v3.5-1-g1cdbe38_windows_x64.msi.rar
608aceaf4bf450254812b3fcaf8ea553450fcf2d626ae9c2ed0404348918d6ad pupil_v3.5-7-g651931ba_macos_x64.dmg
786feb5e937a68a21821ab6b6d86be915bcbb7c5e24c11664dbf8a95e5fcb8cc pupil_v3.5-8-g0c019f6_linux_x64.zip
November 29, 2021
We are pleased to announce the release of Pupil Core software v3.5!
Download the latest bundle (scroll down to the end of the release notes and see Assets).
Please feel free to get in touch with feedback and questions via the #pupil channel on Discord! 😄
Overview
In Pupil v3.5, we cleaned up log messages, improved software stability, fixations are now cached between Pupil Player sessions, and we have fine tuned 3d pupil confidence.
Pupil v3.5 is the first release that supports the new macOS Monterey (with a small caveat). Read more below.
New
Recording-specific annotation hotkeys
Add option to filter out low-confidence values in raw data export
Add option to disable world video recording
macOS Monterey support
Improved
Reduced number of user-facing log messages
Export-in-progress file-name suffixes
Windows: Handle exceptions during driver installation gracefully
Windows: Option to skip automatic driver installation
Windows: Create start menu entries and desktop shortcuts for all users on install
Add Euler angles to headpose tracker result
Normalize IMU pitch/roll values to [-180, 180] degrees
Confidence adjustment for pye3d results
Cache post-hoc fixation detector results
Documentation
New
Recording-specific annotation hotkeys - #2170
Until now, the keyboard-shortcut setup for annotations was stored in Pupil Player's session settings. These were reset if you updated Pupil Core software to a new version.
Starting with this version, annotation keyboard shortcuts will be stored persistently within the recording.
The definitions are stored in <recording dir>/offline_data/annotation_definitions.json
with the format:
{
"version": 1,
"definitions": {
"<label>": "<hotkey>"
}
}
This file can be shared between recordings.
When Pupil Player is opened, it will attempt to load the annotation definitions from the recording-specific file. If the file is not found or is invalid, Pupil Player will fallback to the session settings which contain the last known annotation definitions.
Add option to filter out low-confidence values in raw data export - #2210
Pupil Core software assigns "confidence" values to its pupil detections and gaze estimations. They indicate the quality of the measurement. For visualization and some analysis Plugins, Pupil Player hides gaze data below the "Minimum data confidence" threshold (adjustable in the general settings menu).
Prior to this release, the raw data exporter plugin exported all data, independently of its confidence. New users, therefore, often wonder why their exported data looks noisier than what they have seen in Pupil Player.
Starting with this release, users will have the option to filter out low-confidence data (i.e. below the "Minimum data confidence" threshold) in the export. The option can be enabled in the raw data exporter's menu.
Add option to disable world video recording - #2169
If you are not interested in recording the scene video, you can now disable the scene video recording in the Recorder
menu of Pupil Capture's world
window.
macOS Monterey support
Due to new technical limitations, Pupil Capture and Pupil Service need to be started with administrator privileges to get access to the video camera feeds. To do that, copy the applications into your /Applications
folder and run the corresponding command from the terminal:
Pupil Capture:
sudo /Applications/Pupil\ Capture.app/Contents/MacOS/pupil_capture
Pupil Service:
sudo /Applications/Pupil\ Service.app/Contents/MacOS/pupil_service
Note: The terminal will prompt you for your administrator password. It will not preview any typed keys. Simply hit enter once the password has been typed.
Note: When recording with administrator privileges, the resulting folder inherits admin file permissions. Pupil Player will detect these and ask you for the administrator password to reset the file permissions. This will be only necessary once per recording.
Improved
Export-in-progress file-name suffixes - #2167, #2186
Exporting video can take a long time. Pupil Player displays the progress as a growing circle around the menu icon while writing the result incrementally to disk. Specifically, it writes the result directly to the final export location. While the export is ongoing, the video file is invalid but still available to the user. This can lead to users opening the video before it has finished exporting and then encountering playback issues.
Starting with this release, Pupil Core software changes the video exports to include a .writing
file name suffix during the export. This prevents other applications from recognizing the partially exported video file as complete. Once the export is done, the suffix is removed and other applications are able to recognize the file type as video.
Reduced number of user-facing log messages - #2190
Over the years, Pupil Capture's functionality has grown and with it the number of user-facing log messages. They can be overwhelming to the point where important log messages are overlooked or ignored. For this release, we have reviewed the log messages that are being displayed in the UI during typical actions, e.g. calibration and recordings, and have reduced them significantly.
Windows: Handle exceptions during driver installation gracefully - #2173
Previously, errors during the driver installation could cause the software to crash. Now, errors will be logged to the log file and the user will be asked to install the drivers manually.
Windows: Option to skip automatic driver installation - #2207
Using the -skip-driv
or --skip-driver-installation
flags, one can now launch Pupil Capture and Pupil Service without running the automatic driver installation on Windows. This can be helpful to speed up the start up time or to avoid unwanted driver installations.
Windows: Create start menu entries and desktop shortcuts for all users on install - #2166
Pupil Core software is installed to C:\Program Files (x86)\Pupil-Labs
by default. This directory should be accessible by all users but the start menu entry and desktop shortcut are only installed for the current user. Starting with this release, the installer will create start menu entries and desktop shortcuts for all users on install.
Add Euler angles to headpose tracker result - #2175
Next to camera poses as Rodrigues' rotation vectors, the headpose tracker now also exports the camera orientation in Euler angles.
We also fixed a typo in the exported file name.
- head_pose_tacker_model.csv
+ head_pose_tracker_model.csv
Normalize IMU pitch/roll values to [-180, 180] - #2171
Orientation values exported by the IMU Timeline plugin will now be normalized to a range of [-180, 180] degrees.
Confidence adjustment for pye3d results - #2195
In some cases, pye3d was overestimating the confidence of its pupil detections. These were visible as noisy gaze estimations in the Pupil Core applications. This release includes an updated version of pye3d with adjusted confidence estimations. As a result, the gaze signal should look more stable during lower confidence situations, e.g. while squinting or looking down. For more information, see the Developer notes below.
Cache post-hoc fixation detector results - #2194
Post-hoc fixation detector results no longer need to be recalculated if you close and reopen a recording. Pupil Player stores the results together with the used configuration (version of the gaze data and fixation detection parameters) within the recording directory. The cached data will be restored if the Player configuration matches the configuration stored on disk. If it does not match, Player will recalculate the fixations to avoid inconsistencies.
Documentation
We have improved our documentation in several places:
Pupillometry best practices - pupil-docs#453
Blink detection - pupil-docs#463
Pupil Core API - pupil-docs#455
Fixed
Fixed typo in exported headpose tracker files - #2185
Fix confidence graphs in Pupil Player for pre-2.0 recordings - #2191
Use correct socket API to retrieve local IP address for Service - #2201
Fix loading 200 Hz gaze data in Pupil Invisible recordings - #2204
Fix loading short audio streams - #2206
Known issues
Windows: Connecting remotely to Pupil Remote on Pupil Service does not work in some cases
Pupil Groups: Users have reported issues with Pupil Groups connectivity when running Pupil Capture on different devices.
We are investigating these issues and will try to resolve them with an update as soon as possible.
Developer notes
Dependencies updates
Python dependencies can be updated using pip
and the requirements.txt
file:
python -m pip install --upgrade pip wheel
pip install -r requirements.txt
pye3d v0.2.0 and v0.3.0
Version 0.2.0 of pye3d
has lowered 3d-search-result confidence by 40%. When the confidence of the input 2d pupil datum is lower than a specific threshold (0.7), pye3d attempts to reconstruct the 2d pupil ellipse based on its existing 3d eye model. We noticed that the confidence for these results was systematically overestimated given the actual detection result quality and have therefore adjusted the overall confidence assignment for them. See pye3d-detector#36 for reference.
Version 0.3.0 uses a new serialization format for the refractionizer parameters but is otherwise functionally equivalent to version 0.2.0.
pyglui v1.31.0
This new version of pyglui
introduces support for multi-line thumb and icon labels.
Example:
from pyglui import ui
context = {"state": False}
ui.Icon(
"state",
context,
label="Multi\nLine",
label_offset_size=-10, # smaller font
label_offset_x=0, # no horizontal adjustments
label_offset_y=-10, # move label upwards
label_line_height=0.8, # reduce line height
)
zeromq-pyre >= v0.3.4
Starting with version v0.3.4, zeromq-pyre
is able to handle cases gracefully where it is not able to access any network interfaces. See #2187 for reference.
Plugin API
Easy plugin icon customization - #2196
Plugins can now overwrite the following class attributes to customize the menu icon:
icon_pos_delta
: relative positioningicon_size_delta
: relative font resizingicon_line_height
(multi-line icons only): line distance
Requires pyglui v1.31.0 or higher
Real-time Network API
Add surf_to_dist_img_trans
and dist_img_to_surf_trans
to surface events #2168
These two homographies are necessary to transform points from the surface coordinate system to the 2d image space of the scene camera, and vice versa. They have been available as part of the surface location exports in Pupil Player. With this release, they also become available to other plugins in Pupil Capture or via its Network API.
Example plugin that access the new homographies in real-time:
import numpy as np
from plugin import Plugin
class Example(Plugin):
def recent_events(self, events):
# access surfaces or fallback to empty list if not available
surfaces = events.get("surfaces", [])
for surface in surfaces:
# access raw homography data, a list of lists
homography = surface["surf_to_dist_img_trans"]
# convert to a matrix
homography = np.array(homography)
# use homography, e.g. printing it
print(f"{surface['name']}: {homography}")
Downloads
To open the RAR-archive on Windows, you will need to use decompression software, such as WinRAR or 7-Zip (both are available for free).
Supported operating systems
macOS Mojave 10.14, macOS Catalina 10.15, macOS Big Sur 11
macOS Monterey 12 requires administrator privileges to access the video cameras
Ubuntu 16.04 or newer
Windows 10
Checksums
$ shasum -a 256 pupil_v3.5*
41428173c33d07171bb7bf8f0c83b7debfabb66a1dfc7530d1ae302be70ccc9c pupil_v3.5-1-g1cdbe38_windows_x64.msi.rar
608aceaf4bf450254812b3fcaf8ea553450fcf2d626ae9c2ed0404348918d6ad pupil_v3.5-7-g651931ba_macos_x64.dmg
786feb5e937a68a21821ab6b6d86be915bcbb7c5e24c11664dbf8a95e5fcb8cc pupil_v3.5-8-g0c019f6_linux_x64.zip
September 30, 2021
Big release! We added two powerful new features. Workspaces enable collaboration with your colleagues. Face Mapper automatically detects faces in recordings!
Workspaces
Workspaces enable you to collaborate with colleagues through role based access from data collection with Pupil Invisible Companion App to data annotation and enrichment in Pupil Cloud. Workspaces act as isolated spaces that contain recordings, wearers, templates, labels, projects and enrichments.
Note: Update the Pupil Invisible Companion app to the most recent version (v1.3.0) to make use of workspaces.
Face Mapper
Face Mapper is a new enrichment that automatically and robustly detects faces in the scene video and maps gaze data onto the detected faces. This enables you to easily determine when a subject has been looking at a face and to compute aggregate statistics (example: how much time was spent looking at faces?).
Share your thoughts
Have feedback, questions, feature requests - send us your thoughts!
September 30, 2021
Big release! We added two powerful new features. Workspaces enable collaboration with your colleagues. Face Mapper automatically detects faces in recordings!
Workspaces
Workspaces enable you to collaborate with colleagues through role based access from data collection with Pupil Invisible Companion App to data annotation and enrichment in Pupil Cloud. Workspaces act as isolated spaces that contain recordings, wearers, templates, labels, projects and enrichments.
Note: Update the Pupil Invisible Companion app to the most recent version (v1.3.0) to make use of workspaces.
Face Mapper
Face Mapper is a new enrichment that automatically and robustly detects faces in the scene video and maps gaze data onto the detected faces. This enables you to easily determine when a subject has been looking at a face and to compute aggregate statistics (example: how much time was spent looking at faces?).
Share your thoughts
Have feedback, questions, feature requests - send us your thoughts!
July 22, 2021
Head Pitch & Roll Estimates are now available!
The Inertial Measurment Unit (IMU) sensor embedded in the Pupil Invisible Glasses frame provides measurements that can tell us how the wearer’s head is moving. This can be valuable if you want to measure when your subject is looking downwards vs upwards for example.
In this update we have made the outputs of the IMU much easier to work with. Instead of only reporting the raw outputs of the IMU (rotational speed and translational acceleration), we now include estimates of the absolute pitch and roll of the head.
This is part of the Raw Data Exporter. You can find more details about how the estimates are calculated in the docs!
Information on when the Glasses are worn now included in Raw Data Export
The gaze.csv file included in the Raw Data Export now contains a new column called worn that indicates whether the Pupil Invisible Glasses have been worn by a subject at the respective time point (1.0 = worn, 0.0 = not worn).
This data has previously only been available as part of the binary recording data.
Improved Export Format of Marker Mapper
We have updated the export format of the Marker Mapper to be easier to use:
We have added a new column detected markers to the aoi_positions.csv file that contains the IDs of all the markers detected in the respective frame.We have split the corner coordinates in image column in the aoi_positions.csv file in to a separate column per coordinate to make it easier to parse.
Do you have feedback you would like to share?
July 22, 2021
Head Pitch & Roll Estimates are now available!
The Inertial Measurment Unit (IMU) sensor embedded in the Pupil Invisible Glasses frame provides measurements that can tell us how the wearer’s head is moving. This can be valuable if you want to measure when your subject is looking downwards vs upwards for example.
In this update we have made the outputs of the IMU much easier to work with. Instead of only reporting the raw outputs of the IMU (rotational speed and translational acceleration), we now include estimates of the absolute pitch and roll of the head.
This is part of the Raw Data Exporter. You can find more details about how the estimates are calculated in the docs!
Information on when the Glasses are worn now included in Raw Data Export
The gaze.csv file included in the Raw Data Export now contains a new column called worn that indicates whether the Pupil Invisible Glasses have been worn by a subject at the respective time point (1.0 = worn, 0.0 = not worn).
This data has previously only been available as part of the binary recording data.
Improved Export Format of Marker Mapper
We have updated the export format of the Marker Mapper to be easier to use:
We have added a new column detected markers to the aoi_positions.csv file that contains the IDs of all the markers detected in the respective frame.We have split the corner coordinates in image column in the aoi_positions.csv file in to a separate column per coordinate to make it easier to parse.
Do you have feedback you would like to share?
July 13, 2021
We are pleased to announce the release of Pupil Core software v3.4!
Download the latest bundle (scroll down to the end of the release notes and see Assets).
Please feel free to get in touch with feedback and questions via the #pupil channel on Discord! 😄
Overview
Pupil v3.4 introduces a new color scheme for pupil detection algorithms, improved gaze-estimation stability for frozen eye models, and a new IMU visualization and export plugin for Pupil Invisible recordings within Pupil Player.
New
Dynamic pye3d model confidence
Pupil detection color scheme
Added IMU Timeline plugin
Improved
Gaze-estimation stability with frozen eye models
Annotation log message
Prevent log flood in Surface Tracker related to finding homographies
Support upgrading legacy recordings
New
Dynamic pye3d model confidence
Pupil Core software version v3.4 ships the new pye3d
version 0.1.1.
In the previous versions of pye3d model_confidence
was fixed to a value of 1.0
. Starting with version 0.1.0, pye3d assigns different model_confidence
values based on the long-term model's parameters. Specifically, model_confidence
is set to 1.0
by default and set to 0.1
if at least one model output exceeds its physiologically reasonable range. If the ranges are exceeded, it is likely that the model is either not fit well or the 2d input ellipse was a false detection.
The assumed physiological bounds are:
phi: [-80, 80] degrees
theta: [-80, 80] degrees
pupil diameter: [1.0, 9.0] mm
eyeball center x: [-10, 10] mm
eyeball center y: [-10, 10] mm
eyeball center z: [20, 75] mm
Phi and theta ranges are relative to the eye camera's optical axis. The eye ball center ranges are defined relative to the origin of the eye camera's 3d coordinate system.
The model_confidence
will be set to 0.0
if the gaze direction cannot be calculated.
Pupil detection color scheme
The new pupil detection color scheme makes use of the dynamic model confidence values by visualizing within-bounds and out-of-bounds models in different colors.
Color legend:
#FAC800
: Pupil ellipse (2d)#F92500
: Pupil ellipse (3d)#0777FA
: Long-term model outline (within-bounds)#80E0FF
: Long-term model outline (out-of-bounds)
Note: Even though the detected pupil ellipses fit the pupil well on the right-side picture, the model is outside of the physiological ranges defined above. This can lead to errors in gaze-direction and pupil-size estimates. You can improve such a model by looking into different directions.
While the 3d debug window is opened, pye3d also visualizes the short- and ultra-long-term model outlines:
#FFB876
: Short-term model outline#FF5C16
: Ultra-long-term model outline
Added IMU Timeline plugin - #2151
This is a new plugin designed to visualize and export IMU data available in Pupil Invisible recordings.
In addition to the raw angular velocity and linear acceleration, the plugin also uses Madgwick's algorithm to estimate pitch and roll.
To export the data, the plugin must be enabled and a raw data export must be triggered. Once the export is complete, there should be a imu_timeline.csv
file with the following columns

Improved
Improve gaze-estimation stability with frozen eye models
Freezing the eye models is the best way to reduce noisy data when in a controlled environment. Prior to this release, freezing the eye model only affected eye ball center and pupil diameter measurements. Starting with this version, freezing the eye model also stabilizes gaze direction estimates.
In order to adapt to slippage, pye3d
estimates eyeball positions on different time scales. These serve specific downstream purposes. By default, the short-term model, which integrates only the most recent pupil observations, is used for calculating raw gaze-direction estimates.
In highly controlled environments with few eye movements (e.g. subject uses head rest and is asked to fixate a static target), the most recent pupil observations might not be sufficient to build a stable short-term model. If this is the case, the gaze direction varies more than one would expect given the controlled environment.Starting in pye3d
version 0.1.0, the gaze direction will be inferred from the long-term model if it is frozen.
Freezing the eye model is only recommended in controlled environments as this prevents the model from adapting to slippage. In turn, it is able to provide very stable data.
Improve annotation log message - #2148
When creating a new annotation, the log message will no longer show the Pupil Timestamp. Instead, Pupil Capture will show how old the annotation is, while Pupil Player will show the frame index of the world video.
This change should help avoid the confusion associated with displaying Pupil Timestamp.
Prevent log flood in Surface Tracker related to finding homographies - #2150
Previously, failing to locate a surface because of missing homographies would print an error message in the main window. In some cases, this would result in a flood of error logs.
This change ensures that failures of such type are only issued once, and are written to the log file directly.
Support upgrading legacy recordings - #2161
Pupil Core software version v1.16 is no longer necessary to upgrade deprecated recording formats. Instead, Pupil v3.4 performs all necessary upgrades by itself. This release also includes a bug fix for an issue with pre v0.7.4 recordings.
In v1.16, recordings made with Pupil Capture v1.2
or earlier, andPupil Mobile r0.22.x
or earlier have been deprecated due to the fact that these recordings are missing meta information that is required for the upgrade to the Pupil Player Recording Format 2.0. For details see "Missing Meta Information" in the v1.16 release notes.
Fixed
Use UTF-8 decoding for known UTF-8 encoded text files - #2146
Update circle drawing to display correctly on Apple Silicon devices - #2147
Fix crash on surface tracker export if filling the marker cache is not complete - #2157
Fix surface tracker marker export to use export range - #2158
Developer notes
Dependencies updates
Python dependencies can be updated using pip
and the requirements.txt
file:
python -m pip install --upgrade pip wheel
pip install -r requirements.txt
pyglui v1.30.0
This new version of pyglui
includes the menu icon for the new IMU timeline plugin as well as the new Color_Legend
UI element.
from pyglui import ui
color_rgb_red = (1.0, 0.0, 0.0)
label = "red color label"
ui.Color_Legend(color_rgb_red, label)
pye3d v0.1.1
This version improves gaze-estimation stability for frozen eye models. For details see above and the pye3d
changelog.
Downloads
To open the RAR-archive on Windows, you will need to use decompression software, such as WinRAR or 7-Zip (both are available for free).
Supported operating systems
Windows 10
Ubuntu 16.04+
macOS Mojave 10.14+
macOS Monterey 12 is not supported by this release
July 13, 2021
We are pleased to announce the release of Pupil Core software v3.4!
Download the latest bundle (scroll down to the end of the release notes and see Assets).
Please feel free to get in touch with feedback and questions via the #pupil channel on Discord! 😄
Overview
Pupil v3.4 introduces a new color scheme for pupil detection algorithms, improved gaze-estimation stability for frozen eye models, and a new IMU visualization and export plugin for Pupil Invisible recordings within Pupil Player.
New
Dynamic pye3d model confidence
Pupil detection color scheme
Added IMU Timeline plugin
Improved
Gaze-estimation stability with frozen eye models
Annotation log message
Prevent log flood in Surface Tracker related to finding homographies
Support upgrading legacy recordings
New
Dynamic pye3d model confidence
Pupil Core software version v3.4 ships the new pye3d
version 0.1.1.
In the previous versions of pye3d model_confidence
was fixed to a value of 1.0
. Starting with version 0.1.0, pye3d assigns different model_confidence
values based on the long-term model's parameters. Specifically, model_confidence
is set to 1.0
by default and set to 0.1
if at least one model output exceeds its physiologically reasonable range. If the ranges are exceeded, it is likely that the model is either not fit well or the 2d input ellipse was a false detection.
The assumed physiological bounds are:
phi: [-80, 80] degrees
theta: [-80, 80] degrees
pupil diameter: [1.0, 9.0] mm
eyeball center x: [-10, 10] mm
eyeball center y: [-10, 10] mm
eyeball center z: [20, 75] mm
Phi and theta ranges are relative to the eye camera's optical axis. The eye ball center ranges are defined relative to the origin of the eye camera's 3d coordinate system.
The model_confidence
will be set to 0.0
if the gaze direction cannot be calculated.
Pupil detection color scheme
The new pupil detection color scheme makes use of the dynamic model confidence values by visualizing within-bounds and out-of-bounds models in different colors.
Color legend:
#FAC800
: Pupil ellipse (2d)#F92500
: Pupil ellipse (3d)#0777FA
: Long-term model outline (within-bounds)#80E0FF
: Long-term model outline (out-of-bounds)
Note: Even though the detected pupil ellipses fit the pupil well on the right-side picture, the model is outside of the physiological ranges defined above. This can lead to errors in gaze-direction and pupil-size estimates. You can improve such a model by looking into different directions.
While the 3d debug window is opened, pye3d also visualizes the short- and ultra-long-term model outlines:
#FFB876
: Short-term model outline#FF5C16
: Ultra-long-term model outline
Added IMU Timeline plugin - #2151
This is a new plugin designed to visualize and export IMU data available in Pupil Invisible recordings.
In addition to the raw angular velocity and linear acceleration, the plugin also uses Madgwick's algorithm to estimate pitch and roll.
To export the data, the plugin must be enabled and a raw data export must be triggered. Once the export is complete, there should be a imu_timeline.csv
file with the following columns

Improved
Improve gaze-estimation stability with frozen eye models
Freezing the eye models is the best way to reduce noisy data when in a controlled environment. Prior to this release, freezing the eye model only affected eye ball center and pupil diameter measurements. Starting with this version, freezing the eye model also stabilizes gaze direction estimates.
In order to adapt to slippage, pye3d
estimates eyeball positions on different time scales. These serve specific downstream purposes. By default, the short-term model, which integrates only the most recent pupil observations, is used for calculating raw gaze-direction estimates.
In highly controlled environments with few eye movements (e.g. subject uses head rest and is asked to fixate a static target), the most recent pupil observations might not be sufficient to build a stable short-term model. If this is the case, the gaze direction varies more than one would expect given the controlled environment.Starting in pye3d
version 0.1.0, the gaze direction will be inferred from the long-term model if it is frozen.
Freezing the eye model is only recommended in controlled environments as this prevents the model from adapting to slippage. In turn, it is able to provide very stable data.
Improve annotation log message - #2148
When creating a new annotation, the log message will no longer show the Pupil Timestamp. Instead, Pupil Capture will show how old the annotation is, while Pupil Player will show the frame index of the world video.
This change should help avoid the confusion associated with displaying Pupil Timestamp.
Prevent log flood in Surface Tracker related to finding homographies - #2150
Previously, failing to locate a surface because of missing homographies would print an error message in the main window. In some cases, this would result in a flood of error logs.
This change ensures that failures of such type are only issued once, and are written to the log file directly.
Support upgrading legacy recordings - #2161
Pupil Core software version v1.16 is no longer necessary to upgrade deprecated recording formats. Instead, Pupil v3.4 performs all necessary upgrades by itself. This release also includes a bug fix for an issue with pre v0.7.4 recordings.
In v1.16, recordings made with Pupil Capture v1.2
or earlier, andPupil Mobile r0.22.x
or earlier have been deprecated due to the fact that these recordings are missing meta information that is required for the upgrade to the Pupil Player Recording Format 2.0. For details see "Missing Meta Information" in the v1.16 release notes.
Fixed
Use UTF-8 decoding for known UTF-8 encoded text files - #2146
Update circle drawing to display correctly on Apple Silicon devices - #2147
Fix crash on surface tracker export if filling the marker cache is not complete - #2157
Fix surface tracker marker export to use export range - #2158
Developer notes
Dependencies updates
Python dependencies can be updated using pip
and the requirements.txt
file:
python -m pip install --upgrade pip wheel
pip install -r requirements.txt
pyglui v1.30.0
This new version of pyglui
includes the menu icon for the new IMU timeline plugin as well as the new Color_Legend
UI element.
from pyglui import ui
color_rgb_red = (1.0, 0.0, 0.0)
label = "red color label"
ui.Color_Legend(color_rgb_red, label)
pye3d v0.1.1
This version improves gaze-estimation stability for frozen eye models. For details see above and the pye3d
changelog.
Downloads
To open the RAR-archive on Windows, you will need to use decompression software, such as WinRAR or 7-Zip (both are available for free).
Supported operating systems
Windows 10
Ubuntu 16.04+
macOS Mojave 10.14+
macOS Monterey 12 is not supported by this release
June 15, 2021
Reference Image Mapper
The Reference Image Mapper is a powerful enrichment that enables you to automatically map gaze to an object of interest. This enrichment works best when you provide optimal reference image and scanning recording, and understand the limitations of the tool. To make this easier we have created an explainer video and integrated it directly into the enrichment creator.
We also added the reference image that was used to create the enrichment in the download. This ensures that this important image is always available for further analysis.
Undistorted Gaze Overlay Videos

Pupil Invisible's world camera uses a wide-angle lens to capture a large field of view which introduces optical distortion. We have introduced a new setting to the Gaze Overlay enrichment that enables you to removing this distortion from the video.
In-App Feature Notifications
We are regularly adding new features to Pupil Cloud and want to make sure every user stays on top of what is currently available and possible. New features will be announced within Pupil Cloud itself.
June 15, 2021
Reference Image Mapper
The Reference Image Mapper is a powerful enrichment that enables you to automatically map gaze to an object of interest. This enrichment works best when you provide optimal reference image and scanning recording, and understand the limitations of the tool. To make this easier we have created an explainer video and integrated it directly into the enrichment creator.
We also added the reference image that was used to create the enrichment in the download. This ensures that this important image is always available for further analysis.
Undistorted Gaze Overlay Videos

Pupil Invisible's world camera uses a wide-angle lens to capture a large field of view which introduces optical distortion. We have introduced a new setting to the Gaze Overlay enrichment that enables you to removing this distortion from the video.
In-App Feature Notifications
We are regularly adding new features to Pupil Cloud and want to make sure every user stays on top of what is currently available and possible. New features will be announced within Pupil Cloud itself.
May 12, 2021
We are pleased to announce the release of Pupil Core software v3.3!
Download the latest bundle (scroll down to the end of the release notes and see Assets).
Please feel free to get in touch with feedback and questions via the #pupil channel on Discord! 😄
Overview
Pupil v3.3 focuses on improving software usability, stability and performance. We have made improvements to how product-specific plugins are loaded in Pupil Player, updated keyboard shortcuts, and fixed several stability issues. Additionally, the surface tracker now exports marker detection results.
Note: Prior to this release,diameter_3d
data for all Pupil Core v3 recordings did not have corneal refraction applied. See pye3d v0.0.7 notes below for updates and post-hoc fixes.
Improved
pye3d v0.0.7
This release comes with our latest pye3d version including the following improvements
Performance improvements - #27
Simplification of
Conic
parameter calculation - #26Correctly apply corneal-refraction correction to
diameter_3d
result - #28
All pye3d versions prior to 0.0.7 do not correctly apply corneal refraction to the diameter_3d
field. To check if you are affected by this bug, take a look at the method
column of your pupil_positions.csv
export.
You have two options to get correctly calculated pupil size data:
Use the
circle_3d_radius
values and multiply them by 2, orRe-run the post-hoc pupil detection in Pupil Player v3.3 or later
Marker detection export - #2140
The Surface Tracker plugin requires fiducial markers for defining and tracking areas of interest. Until now, the detection result of these was only stored as an intermediate result. With this release, the data is also stored as a CSV file next to other surface-tracking related exports.
The data is exported to surfaces/marker_detections.csv
.

Improve surface detection consistency - #2139
Surfaces can now be defined as long as one or more markers are detected in the scene video. Previously, this was only sufficient in some cases -- usually, at least two markers were needed.
Note: Surface tracking works best if you use multiple markers spread-out over the area of interest to define and track your surface. The surface position export files contains information about how many markers were detected for each surface position. You can use this information as an estimation of the tracking stability.
Product-specific plugin loading in Pupil Player, part 2 - #2125
We continue work on finetuning the list of enabled plugins for Pupil Invisible recordings.
Starting with this release we have removed the “Pupil from recording” option, as there is no pupillometry data to load from Pupil Invisible recordings. Pupil Player will no longer generate an empty pupil_positions.csv
file after export.
Keyboard shortcuts update - #2129
The default annotation keyboard shortcut was changed to x
in both Pupil Capture and Pupil Player to avoid collision with other plugin shortcuts.
We've posted tables of keyboard shortcuts for Pupil Capture and Pupil Player below. You can find these tables in our Capture and Player documentation.
Fixed
Fixed HMD calibration crashing Pupil Service - #2120
Fixed Pupil Groups serialization issue - #2124
Fixed toggling pupil detection on and off - #2126
Fixed calibration area calculation errors - #2128
Fixed video source replacement in eye process - #2131
Fixed gaze visualization on Apple Silicon computers - #2132
Fixed Pupil Invisible timestamp update procedure precision loss - #2134
Made pye3d plugin's debug visualization colors consistent - #2136
Fixed validation crash when not enough reference data is collected - #2137
Fixed a crash when using Time Sync on macOS - #2138
Developer notes
Dependencies updates
Python dependencies can be updated using pip
and the requirements.txt
file:
python -m pip install --upgrade pip wheel
pip install -r requirements.txt
We have specifically updated the version requirement for pye3d.
Downloads
To open the RAR-archive on Windows, you will need to use decompression software, such as WinRAR or 7-Zip (both are available for free).
May 12, 2021
We are pleased to announce the release of Pupil Core software v3.3!
Download the latest bundle (scroll down to the end of the release notes and see Assets).
Please feel free to get in touch with feedback and questions via the #pupil channel on Discord! 😄
Overview
Pupil v3.3 focuses on improving software usability, stability and performance. We have made improvements to how product-specific plugins are loaded in Pupil Player, updated keyboard shortcuts, and fixed several stability issues. Additionally, the surface tracker now exports marker detection results.
Note: Prior to this release,diameter_3d
data for all Pupil Core v3 recordings did not have corneal refraction applied. See pye3d v0.0.7 notes below for updates and post-hoc fixes.
Improved
pye3d v0.0.7
This release comes with our latest pye3d version including the following improvements
Performance improvements - #27
Simplification of
Conic
parameter calculation - #26Correctly apply corneal-refraction correction to
diameter_3d
result - #28
All pye3d versions prior to 0.0.7 do not correctly apply corneal refraction to the diameter_3d
field. To check if you are affected by this bug, take a look at the method
column of your pupil_positions.csv
export.
You have two options to get correctly calculated pupil size data:
Use the
circle_3d_radius
values and multiply them by 2, orRe-run the post-hoc pupil detection in Pupil Player v3.3 or later
Marker detection export - #2140
The Surface Tracker plugin requires fiducial markers for defining and tracking areas of interest. Until now, the detection result of these was only stored as an intermediate result. With this release, the data is also stored as a CSV file next to other surface-tracking related exports.
The data is exported to surfaces/marker_detections.csv
.

Improve surface detection consistency - #2139
Surfaces can now be defined as long as one or more markers are detected in the scene video. Previously, this was only sufficient in some cases -- usually, at least two markers were needed.
Note: Surface tracking works best if you use multiple markers spread-out over the area of interest to define and track your surface. The surface position export files contains information about how many markers were detected for each surface position. You can use this information as an estimation of the tracking stability.
Product-specific plugin loading in Pupil Player, part 2 - #2125
We continue work on finetuning the list of enabled plugins for Pupil Invisible recordings.
Starting with this release we have removed the “Pupil from recording” option, as there is no pupillometry data to load from Pupil Invisible recordings. Pupil Player will no longer generate an empty pupil_positions.csv
file after export.
Keyboard shortcuts update - #2129
The default annotation keyboard shortcut was changed to x
in both Pupil Capture and Pupil Player to avoid collision with other plugin shortcuts.
We've posted tables of keyboard shortcuts for Pupil Capture and Pupil Player below. You can find these tables in our Capture and Player documentation.
Fixed
Fixed HMD calibration crashing Pupil Service - #2120
Fixed Pupil Groups serialization issue - #2124
Fixed toggling pupil detection on and off - #2126
Fixed calibration area calculation errors - #2128
Fixed video source replacement in eye process - #2131
Fixed gaze visualization on Apple Silicon computers - #2132
Fixed Pupil Invisible timestamp update procedure precision loss - #2134
Made pye3d plugin's debug visualization colors consistent - #2136
Fixed validation crash when not enough reference data is collected - #2137
Fixed a crash when using Time Sync on macOS - #2138
Developer notes
Dependencies updates
Python dependencies can be updated using pip
and the requirements.txt
file:
python -m pip install --upgrade pip wheel
pip install -r requirements.txt
We have specifically updated the version requirement for pye3d.
Downloads
To open the RAR-archive on Windows, you will need to use decompression software, such as WinRAR or 7-Zip (both are available for free).
May 11, 2021
Improved: Enrichment statuses have been renamed for more clarity:
‘Processing’ is now ‘In progress’
‘Ready’ is now ‘Ready to Compute’
‘Computed’ is now ‘Done’
Improved: Reference Image Mapper now accepts PNG images as well as JPG images.
May 11, 2021
Improved: Enrichment statuses have been renamed for more clarity:
‘Processing’ is now ‘In progress’
‘Ready’ is now ‘Ready to Compute’
‘Computed’ is now ‘Done’
Improved: Reference Image Mapper now accepts PNG images as well as JPG images.
May 10, 2021
New: Volume controls! Now all video players in app have a volume slider. Tip: Click the volume icon to mute.
May 10, 2021
New: Volume controls! Now all video players in app have a volume slider. Tip: Click the volume icon to mute.
April 12, 2021
Local Recording Export
Pupil Cloud is the recommended and most convenient method for moving recordings off of the Companion Device. However, we recognize that some users may not be able to use Pupil Cloud or have their own data processing pipelines running locally. Therefore, we implemented a feature to make it easier for users to export recordings from the Companion Device using a USB connection to a computer. This feature ensures that internal files required by the Pupil Invisible Companion app are excluded from the exported recordings, thereby maintaining a consistent file format. Check out the user guide in docs for more.
Watchdog Service Update
In our previous update, we have introduced the “watchdog service” that automatically detects issues like e.g. faulty USB connections at recording time and warns you about it. If there is an issue the Companion device will vibrate, a red LED on the Pupil Invisible Glasses will blink and the Companion app will let you know what the problem is.
This is an incremental update to this service improving its robustness and the range of failure modes it can detect.
info.json Update
The info.json file is saved with each recording, containing meta data about the recording. This file is primarily used by other software reading the recordings and developers. We have added two new keys to the info.json files that are saved with each recording: os_version and recovered_files. Check out the entire recording data format in docs.
April 12, 2021
Local Recording Export
Pupil Cloud is the recommended and most convenient method for moving recordings off of the Companion Device. However, we recognize that some users may not be able to use Pupil Cloud or have their own data processing pipelines running locally. Therefore, we implemented a feature to make it easier for users to export recordings from the Companion Device using a USB connection to a computer. This feature ensures that internal files required by the Pupil Invisible Companion app are excluded from the exported recordings, thereby maintaining a consistent file format. Check out the user guide in docs for more.
Watchdog Service Update
In our previous update, we have introduced the “watchdog service” that automatically detects issues like e.g. faulty USB connections at recording time and warns you about it. If there is an issue the Companion device will vibrate, a red LED on the Pupil Invisible Glasses will blink and the Companion app will let you know what the problem is.
This is an incremental update to this service improving its robustness and the range of failure modes it can detect.
info.json Update
The info.json file is saved with each recording, containing meta data about the recording. This file is primarily used by other software reading the recordings and developers. We have added two new keys to the info.json files that are saved with each recording: os_version and recovered_files. Check out the entire recording data format in docs.
March 11, 2021
We are pleased to announce the release of Pupil Core software v3.2!
Download the latest bundle (scroll down to the end of the release notes and see Assets).
Please feel free to get in touch with feedback and questions via the #pupil channel on Discord! 😄
Overview
Pupil v3.2 focuses on quality-of-life and stability.
New
We added accuracy calculation and visualisation for VR/AR calibrations.
Enable plugins in Pupil Player only if they are able to be used with the product that created the recordings.
Improved
Pupil Player has improved playback for Pupil Invisible recordings.
New
Accuracy visualisation and calculation for HMD calibrations - #2112
Prior to this release, when performing HMD calibration, accuracy was not calculated nor visualised in Pupil Capture. This release makes accuracy calculation and visualisation consistent across setups.
Product specific Pupil Player plugin loading - #2100
Load plugins in Pupil Player only if they are able to be used with the product that created the recordings.
Pupil Player is a very flexible tool. It can load, playback, visualize, and export data from recordings made with Pupil Core, Pupil Mobile, and Pupil Invisible! Each of these products has different capabilities and data formats for their recordings.
We have evaluated all Pupil Player plugins and their validity for each product. Starting with this release, Pupil Player will only enable plugins that are suitable for the active recording type.
Here is a list of what plugins are available based on the product that generated the recording:

Improved
pye3d detection speed improvement
We are aware that pye3d requires more computational resources than its predecessor, and are actively working to improve the speed. For some users, it has become more difficult to reach a consistent detection rate of 200Hz.
The first step we have taken to speed up pye3d is to disable some optional computations that are not currently used by Pupil Capture and Pupil Player (jump to developer notes for details).
Fixed
Support recordings with decoding issues - #2107
Support recordings when an audio device fails - #2103
Fixed laggy playback after seeking on Pupil Invisible recordings - #2108
Developer notes
Dependencies updates
Python dependencies can be updated using pip
and the requirements.txt
file:
python -m pip install --upgrade pip wheel
pip install -r requirements.txt
pye3d v0.0.6
pye3d v0.0.6 allows disabling optional computations. Pupil Core is not making use of these optional computations, they have been disabled, effectively reducing the computational load of pye3d pupil detections. Read about the changes here.
Release Note Updates
15.03.2021 - v3.2-16
Fixes an issue causing Pupil Player to crash on Windows when enabling the eye video overlay or post-hoc pupil detection - #2117
21.03.2021 - v3.2-20
Downloads
To open the RAR-archive on Windows, you will need to use decompression software, such as WinRAR or 7-Zip (both are available for free).
March 11, 2021
We are pleased to announce the release of Pupil Core software v3.2!
Download the latest bundle (scroll down to the end of the release notes and see Assets).
Please feel free to get in touch with feedback and questions via the #pupil channel on Discord! 😄
Overview
Pupil v3.2 focuses on quality-of-life and stability.
New
We added accuracy calculation and visualisation for VR/AR calibrations.
Enable plugins in Pupil Player only if they are able to be used with the product that created the recordings.
Improved
Pupil Player has improved playback for Pupil Invisible recordings.
New
Accuracy visualisation and calculation for HMD calibrations - #2112
Prior to this release, when performing HMD calibration, accuracy was not calculated nor visualised in Pupil Capture. This release makes accuracy calculation and visualisation consistent across setups.
Product specific Pupil Player plugin loading - #2100
Load plugins in Pupil Player only if they are able to be used with the product that created the recordings.
Pupil Player is a very flexible tool. It can load, playback, visualize, and export data from recordings made with Pupil Core, Pupil Mobile, and Pupil Invisible! Each of these products has different capabilities and data formats for their recordings.
We have evaluated all Pupil Player plugins and their validity for each product. Starting with this release, Pupil Player will only enable plugins that are suitable for the active recording type.
Here is a list of what plugins are available based on the product that generated the recording:

Improved
pye3d detection speed improvement
We are aware that pye3d requires more computational resources than its predecessor, and are actively working to improve the speed. For some users, it has become more difficult to reach a consistent detection rate of 200Hz.
The first step we have taken to speed up pye3d is to disable some optional computations that are not currently used by Pupil Capture and Pupil Player (jump to developer notes for details).
Fixed
Support recordings with decoding issues - #2107
Support recordings when an audio device fails - #2103
Fixed laggy playback after seeking on Pupil Invisible recordings - #2108
Developer notes
Dependencies updates
Python dependencies can be updated using pip
and the requirements.txt
file:
python -m pip install --upgrade pip wheel
pip install -r requirements.txt
pye3d v0.0.6
pye3d v0.0.6 allows disabling optional computations. Pupil Core is not making use of these optional computations, they have been disabled, effectively reducing the computational load of pye3d pupil detections. Read about the changes here.
Release Note Updates
15.03.2021 - v3.2-16
Fixes an issue causing Pupil Player to crash on Windows when enabling the eye video overlay or post-hoc pupil detection - #2117
21.03.2021 - v3.2-20
Downloads
To open the RAR-archive on Windows, you will need to use decompression software, such as WinRAR or 7-Zip (both are available for free).
February 26, 2021
New: Reference Image Mapper enrichment. This enrichment enables you to track areas of interest in your environment based on a reference image of them. See our blog post on this and the docs.
Enrichment: Gaze Overlay Export enrichment. This enrichment enables you to export world video with gaze overlay directly from Pupil Cloud. See docs.
New: Raw Data Export enrichment. This enrichment allows you to export all recording data in easy to use CSV and MP4 file formats for further processing. See docs.
New: All data formats for all enrichments are now documented in detail in the docs.
Improved: Help menu in left side bar has been updated for quicker access to all important resources.
February 26, 2021
New: Reference Image Mapper enrichment. This enrichment enables you to track areas of interest in your environment based on a reference image of them. See our blog post on this and the docs.
Enrichment: Gaze Overlay Export enrichment. This enrichment enables you to export world video with gaze overlay directly from Pupil Cloud. See docs.
New: Raw Data Export enrichment. This enrichment allows you to export all recording data in easy to use CSV and MP4 file formats for further processing. See docs.
New: All data formats for all enrichments are now documented in detail in the docs.
Improved: Help menu in left side bar has been updated for quicker access to all important resources.
February 10, 2021
We are pleased to announce the release of Pupil Core software v3.1!
Download the latest bundle (scroll down to the end of the release notes and see Assets).
Please feel free to get in touch with feedback and questions via the #pupil channel on Discord! 😄
Motivation
Pupil Core software is now compatible with macOS 11 Big Sur! In addition, we have added support in Pupil Player for 200Hz gaze data downloaded from Pupil Cloud.
Improvements
macOS 11 Big Sur compatibility - #2086, #2087, #2090, #2095
macOS 11 Big Sur introduced backwards-incompatible changes that caused earlier versions of Pupil Core and other software to not run properly.
There is currently only a single Python version, Python 3.9.1, that is fully compatible with macOS Big Sur. As a result, our new macOS Pupil Core bundle ships with this new Python version. This may have an effect on user plugin dependencies. For more information, check out the developer notes below.
Support for Pupil Cloud's 200Hz gaze recordings - #2082
Due to the computational limitations on the Companion Device, gaze data is recorded at 66Hz. Recent updates to Pupil Cloud automatically "upgrades" the gaze data recordings when they are uploaded to Pupil Cloud providing you with 200Hz gaze data. In version 3.1, Pupil Player can read and export the new data.
Note: Recordings that were downloaded prior to this Pupil Cloud update need to be re-downloaded in order to include the 200Hz gaze data.
Changes
Visual calibration marker appearance - #2095
The visual appearance of the calibration marker changed slightly, due to how we render the calibration marker on screen. The change was necessary to support screen-based calibrations on Apple Silicon Macs. As a result, the marker edges do not appear as smooth as the previous version. The overall design and detection process remains the same.
Bug Fixes
Gracefully handle Pupil Invisible video files starting with a null frame - #2077, #2089
Handle zero-byte video files when looking up Pupil Mobile intrinsics #2083
Developer notes
Dependencies updates
Python dependencies can be updated using pip
and the requirements.txt
file:
python -m pip install --upgrade pip wheel
pip install -r requirements.txt
Support latest GLEW 2.2 - pyglui #117
This release also adds support for the latest version of GLEW. This means that the pyglui
dependency needs to be updated to version 1.29
.
pye3d v0.0.5
We have included pye3d==0.0.5
which fixes compatibility issues with numpy==1.20
and scikit-learn==0.24.1
.
macOS bundle shipping with Python 3.9.1
To simplify the usage of the application bundles, each bundle is shipped with their own Python environment. All plugins and their dependencies will run in the context of this environment.
Especially compiled dependencies, e.g. pyrealsense2, are always compiled against a specific Python version. If you are running custom user plugins, you will have to reinstall compiled dependencies in order to make them work with the new Python version.
Bundles ship with the following Python versions:
macOS: Python 3.9.1
Windows bundle: Python 3.6
Linux bundle: Python 3.6
Downloads
To open the RAR-archive on Windows, you will need to use decompression software, such as WinRAR or 7-Zip (both are available for free).
macOS compatibility - #2086, #2087
Note: This is the first release to support macOS 11 Big Sur. We no longer support macOS 10.13 High Sierra since the macOS package manager homebrew no longer provides pre-compiled binaries for Pupil Core software dependencies.
February 10, 2021
We are pleased to announce the release of Pupil Core software v3.1!
Download the latest bundle (scroll down to the end of the release notes and see Assets).
Please feel free to get in touch with feedback and questions via the #pupil channel on Discord! 😄
Motivation
Pupil Core software is now compatible with macOS 11 Big Sur! In addition, we have added support in Pupil Player for 200Hz gaze data downloaded from Pupil Cloud.
Improvements
macOS 11 Big Sur compatibility - #2086, #2087, #2090, #2095
macOS 11 Big Sur introduced backwards-incompatible changes that caused earlier versions of Pupil Core and other software to not run properly.
There is currently only a single Python version, Python 3.9.1, that is fully compatible with macOS Big Sur. As a result, our new macOS Pupil Core bundle ships with this new Python version. This may have an effect on user plugin dependencies. For more information, check out the developer notes below.
Support for Pupil Cloud's 200Hz gaze recordings - #2082
Due to the computational limitations on the Companion Device, gaze data is recorded at 66Hz. Recent updates to Pupil Cloud automatically "upgrades" the gaze data recordings when they are uploaded to Pupil Cloud providing you with 200Hz gaze data. In version 3.1, Pupil Player can read and export the new data.
Note: Recordings that were downloaded prior to this Pupil Cloud update need to be re-downloaded in order to include the 200Hz gaze data.
Changes
Visual calibration marker appearance - #2095
The visual appearance of the calibration marker changed slightly, due to how we render the calibration marker on screen. The change was necessary to support screen-based calibrations on Apple Silicon Macs. As a result, the marker edges do not appear as smooth as the previous version. The overall design and detection process remains the same.
Bug Fixes
Gracefully handle Pupil Invisible video files starting with a null frame - #2077, #2089
Handle zero-byte video files when looking up Pupil Mobile intrinsics #2083
Developer notes
Dependencies updates
Python dependencies can be updated using pip
and the requirements.txt
file:
python -m pip install --upgrade pip wheel
pip install -r requirements.txt
Support latest GLEW 2.2 - pyglui #117
This release also adds support for the latest version of GLEW. This means that the pyglui
dependency needs to be updated to version 1.29
.
pye3d v0.0.5
We have included pye3d==0.0.5
which fixes compatibility issues with numpy==1.20
and scikit-learn==0.24.1
.
macOS bundle shipping with Python 3.9.1
To simplify the usage of the application bundles, each bundle is shipped with their own Python environment. All plugins and their dependencies will run in the context of this environment.
Especially compiled dependencies, e.g. pyrealsense2, are always compiled against a specific Python version. If you are running custom user plugins, you will have to reinstall compiled dependencies in order to make them work with the new Python version.
Bundles ship with the following Python versions:
macOS: Python 3.9.1
Windows bundle: Python 3.6
Linux bundle: Python 3.6
Downloads
To open the RAR-archive on Windows, you will need to use decompression software, such as WinRAR or 7-Zip (both are available for free).
macOS compatibility - #2086, #2087
Note: This is the first release to support macOS 11 Big Sur. We no longer support macOS 10.13 High Sierra since the macOS package manager homebrew no longer provides pre-compiled binaries for Pupil Core software dependencies.
February 9, 2021
Improved: Lots of UI tweaks and improvements.
Improved: The entire app has been tuned to improve the performance especially for accounts with a large number of recordings.
New: Drive view has a projects column that shows which projects a recording belongs to.
February 9, 2021
Improved: Lots of UI tweaks and improvements.
Improved: The entire app has been tuned to improve the performance especially for accounts with a large number of recordings.
New: Drive view has a projects column that shows which projects a recording belongs to.
February 9, 2021
Improved stability of video transcoding pipeline.
February 9, 2021
Improved stability of video transcoding pipeline.
February 8, 2021
Watchdog Service
We have added a “watchdog service” to further minimize data loss while recording. Stability is one of Pupil Invisible’s strongest features during data acquisition, but there is always the off-chance of something going wrong. The watchdog service detects failure cases, like e.g. a faulty USB connection, automatically and warns you already at recording time.
The warning consists of the Companion Device vibrating and a red LED blinking on the Pupil Invisible Glasses. A message will be displayed on the Companion Device about what needs to be done!
Gaze Estimation Pipeline Update
We have updated the deep learning pipeline for gaze estimation to version 1.7. This update results in an improvement to gaze estimation accuracy of about 0.5° on average compared to the accuracy originally reported in our white paper.
February 8, 2021
Watchdog Service
We have added a “watchdog service” to further minimize data loss while recording. Stability is one of Pupil Invisible’s strongest features during data acquisition, but there is always the off-chance of something going wrong. The watchdog service detects failure cases, like e.g. a faulty USB connection, automatically and warns you already at recording time.
The warning consists of the Companion Device vibrating and a red LED blinking on the Pupil Invisible Glasses. A message will be displayed on the Companion Device about what needs to be done!
Gaze Estimation Pipeline Update
We have updated the deep learning pipeline for gaze estimation to version 1.7. This update results in an improvement to gaze estimation accuracy of about 0.5° on average compared to the accuracy originally reported in our white paper.
January 7, 2021
We are pleased to announce the release of Pupil Core software v3.0!
Download the latest bundle (scroll down to the end of the release notes and see Assets).
Please feel free to get in touch with feedback and questions via the #pupil channel on Discord! 😄
Motivation
We are excited to introduce pye3d
- a complete overhaul of the 3D pupil detector employed by Pupil Core software. In building pye3d
, we have left no stone unturned, reimagining many of the algorithmic building blocks constituting the final gaze-estimation pipeline. pye3d
is the result of three years of hard work and we are excited to get it into your hands!
Improvements
Improved built-in 3D pupil detector - #2011, #2065
pye3d
implements a novel eye-model fitting strategy that incorporates a corneal refraction-correction step, accounting for nonlinear effects in ocular optics. Gaze estimates and pupil diameter estimates are now more accurate than ever before [2,3]. Thanks to a new sphere center estimation methodology [3], it is also considerably faster than our previous 3D detector [1] in regards to fitting robust and accurate eye models. Read more about how it works in our documentation.
Academic references
[1]
L. Świrski and N. A. Dodgson. A Fully-Automatic, Temporal Approach to Single Camera, Glint-Free 3D Eye Model Fitting. In Proceedings of ECEM 2013. "L. Świrski and N. A. Dodgson. A Fully-Automatic, Temporal Approach to Single Camera, Glint-Free 3D Eye Model Fitting. In Proceedings of ECEM 2013."[2]
K. Dierkes, M. Kassner, A. Bullling, A novel approach to single camera, glint-free 3D eye model fitting including corneal refraction. In ETRA ’18: Symposium on Eye Tracking Research and Applications, 2018.[3]
K. Dierkes, M. Kassner, A. Bulling. A fast approach to refraction-aware eye-model fitting and gaze prediction. In ETRA ’19: Symposium on Eye Tracking Research and Applications, 2019.
Changes
Removal of old Pupil 3D detector
With this release, we also stop the maintainance of the previous 3D detector. Starting with the new 2.0
release, our pupil-detectors
package no longer includes the previous 3D detector. This allows us to remove Ceres as a dependency, making the project much easier to maintain and build from source.
Should you rely on this detector, you can still download previous Pupil Core software releases or install previous pupil-detectors
via PyPI.
Bug Fixes
Fixed issue that would leave an unresponsive eye window due to plugin crash - #2059
Fixed crash on canceling single marker calibration window mode - #2062
Fixed crash on post-hoc pupil detection when the frame count is zero - #2063
Developer notes
Network API Changes
Reworked pupil detector plugin and network API
In this release we reworked the pupil detector plugin base class. It is now easier than ever to implement a custom pupil detector and accompanying pupil detector plugin.
We have also introduced breaking changes to our network API for pupil detector plugins. Here is a list of possible notification payload descriptions that are handled by detector plugins:
# Notification for enabling/disabling any or all pupil detector plugins
{
'topic': 'notify.pupil_detector.set_enabled',
'subject': 'pupil_detector.set_enabled',
'value': <is_enabled: bool>,
'eye_id': <eye_id: int>, # optional; possible values: 0 or 1
'detector_plugin_class_name': <detector_plugin_class_name: str>, # optional
}
# Notification for setting the Region-Of-Interest (ROI) for any or all pupil detector plugins
{
'topic': 'notify.pupil_detector.set_roi',
'subject': 'pupil_detector.set_roi',
'value': <roi: (min_x: int, min_y: int, max_x: int, max_y: int)>,
'eye_id': <eye_id: int>, # optional; possible values: 0 or 1
'detector_plugin_class_name': <detector_plugin_class_name: str>, # optional
}
# Notification for updating a partial set of pupil detector properties for a specific pupil detector plugin
{
'topic': 'notify.pupil_detector.set_properties',
'subject': 'pupil_detector.set_properties',
'values': <detector_properties: dict>,
'eye_id': <eye_id: int>, # required; possible values: 0 or 1
'detector_plugin_class_name': <detector_plugin_class_name: str>, # required
}
# Notification for requesting pupil detector properties broadcast for any or all pupil detector plugins
{
'topic': 'notify.pupil_detector.broadcast_properties',
'subject': 'pupil_detector.broadcast_properties',
'eye_id': <eye_id: int>, # optional; possible values: 0 or 1
'detector_plugin_class_name': <detector_plugin_class_name: str>, # optional
}
For more information about custom pupil detector plugins, please read the documentation. You can also see examples of custom pupil detection plugins here.
For an example script that showcases the network API, please consult this helper script.
Changed 3D pupil datum format
pye3d
uses a slightly different pupil format than our previous 3D detector. Because pye3d
continously updates a single model instead of fitting multiple parallel ones, the new 3D pupil datum no longer contains the following keys: model_id
and model_birth_timestamp
.
Our latest Hmd-eyes release handles this by falling back to "0" and 0.0, respectively.
Binocular 3D gaze data with string-only keys - #2068
In order to be compatible with the msgpack-python v1.0.0
(specifially the new strict_map_key=True
default), this release uses strings only as dictionary keys for all msgpack-encoded data that is published via the Network API.
This change affects primarily binocular 3D gaze data which used to contain integer dictionary keys.
Raw Data Exporter - Optional model_id
key - #2061
Some of the fields in the pupil datum related to the 3D model no longer exist in pye3d
(see above). This change ensures the raw data export handles missing fields and outputs a compatible csv file.
Updated msgpack
dependency to version 1.0
- #2068
We continue to streamline and simplify the installation of Pupil Core dependencies. In this release we updated the msgpack
to the latest 1.0
. To ensure you have the latest required versions of all dependencies, please install them via requirements.txt
.
python -m pip install --upgrade pip wheel
pip install -r requirements.txt
Added support for custom receiver high-water mark for HMD Streaming source - #2058
This change adds the ability to set a custom ZMQ high watermark value for HMD Streaming source. This gives users more control over the streaming behaviour when using Pupil Core with an HMD headset.
Added launcher_process.should_stop
notification handling #2070
This change adds the ability to request stopping Capture, Player or Service with the same notification.
import zmq
import msgpack
# create and connect PUB socket to IPC
pub_socket = zmq.Socket(zmq.Context(), zmq.PUB)
pub_socket.connect(ipc_pub_url)
subject = "launcher_process.should_stop"
topic = "notify." + subject
payload = {
'topic': topic,
'subject': subject,
}
pub_socket.send_string(topic, flags=zmq.SNDMORE)
pub_socket.send(msgpack.dumps(payload, use_bin_type=True))
Simplified running from source on Windows - #2073
We have removed the necessity to run Pupil from source using the run_<app>.bat
files on Windows. Instead of extending the PATH environment variable via the .bat
file, we extend it via the application launcher. This also makes it easier to attach a debugger, e.g. via Visual Studio Code.
Downloads
To open the RAR-archive on Windows, you will need to use decompression software, such as WinRAR or 7-Zip (both are available for free).
macOS (11) Big Sur compatibility - #2079
Note: Pupil Core is not currently supported on Mac OS Big Sur. We aim to release a compatability update within the next few weeks. :construction_worker:
January 7, 2021
We are pleased to announce the release of Pupil Core software v3.0!
Download the latest bundle (scroll down to the end of the release notes and see Assets).
Please feel free to get in touch with feedback and questions via the #pupil channel on Discord! 😄
Motivation
We are excited to introduce pye3d
- a complete overhaul of the 3D pupil detector employed by Pupil Core software. In building pye3d
, we have left no stone unturned, reimagining many of the algorithmic building blocks constituting the final gaze-estimation pipeline. pye3d
is the result of three years of hard work and we are excited to get it into your hands!
Improvements
Improved built-in 3D pupil detector - #2011, #2065
pye3d
implements a novel eye-model fitting strategy that incorporates a corneal refraction-correction step, accounting for nonlinear effects in ocular optics. Gaze estimates and pupil diameter estimates are now more accurate than ever before [2,3]. Thanks to a new sphere center estimation methodology [3], it is also considerably faster than our previous 3D detector [1] in regards to fitting robust and accurate eye models. Read more about how it works in our documentation.
Academic references
[1]
L. Świrski and N. A. Dodgson. A Fully-Automatic, Temporal Approach to Single Camera, Glint-Free 3D Eye Model Fitting. In Proceedings of ECEM 2013. "L. Świrski and N. A. Dodgson. A Fully-Automatic, Temporal Approach to Single Camera, Glint-Free 3D Eye Model Fitting. In Proceedings of ECEM 2013."[2]
K. Dierkes, M. Kassner, A. Bullling, A novel approach to single camera, glint-free 3D eye model fitting including corneal refraction. In ETRA ’18: Symposium on Eye Tracking Research and Applications, 2018.[3]
K. Dierkes, M. Kassner, A. Bulling. A fast approach to refraction-aware eye-model fitting and gaze prediction. In ETRA ’19: Symposium on Eye Tracking Research and Applications, 2019.
Changes
Removal of old Pupil 3D detector
With this release, we also stop the maintainance of the previous 3D detector. Starting with the new 2.0
release, our pupil-detectors
package no longer includes the previous 3D detector. This allows us to remove Ceres as a dependency, making the project much easier to maintain and build from source.
Should you rely on this detector, you can still download previous Pupil Core software releases or install previous pupil-detectors
via PyPI.
Bug Fixes
Fixed issue that would leave an unresponsive eye window due to plugin crash - #2059
Fixed crash on canceling single marker calibration window mode - #2062
Fixed crash on post-hoc pupil detection when the frame count is zero - #2063
Developer notes
Network API Changes
Reworked pupil detector plugin and network API
In this release we reworked the pupil detector plugin base class. It is now easier than ever to implement a custom pupil detector and accompanying pupil detector plugin.
We have also introduced breaking changes to our network API for pupil detector plugins. Here is a list of possible notification payload descriptions that are handled by detector plugins:
# Notification for enabling/disabling any or all pupil detector plugins
{
'topic': 'notify.pupil_detector.set_enabled',
'subject': 'pupil_detector.set_enabled',
'value': <is_enabled: bool>,
'eye_id': <eye_id: int>, # optional; possible values: 0 or 1
'detector_plugin_class_name': <detector_plugin_class_name: str>, # optional
}
# Notification for setting the Region-Of-Interest (ROI) for any or all pupil detector plugins
{
'topic': 'notify.pupil_detector.set_roi',
'subject': 'pupil_detector.set_roi',
'value': <roi: (min_x: int, min_y: int, max_x: int, max_y: int)>,
'eye_id': <eye_id: int>, # optional; possible values: 0 or 1
'detector_plugin_class_name': <detector_plugin_class_name: str>, # optional
}
# Notification for updating a partial set of pupil detector properties for a specific pupil detector plugin
{
'topic': 'notify.pupil_detector.set_properties',
'subject': 'pupil_detector.set_properties',
'values': <detector_properties: dict>,
'eye_id': <eye_id: int>, # required; possible values: 0 or 1
'detector_plugin_class_name': <detector_plugin_class_name: str>, # required
}
# Notification for requesting pupil detector properties broadcast for any or all pupil detector plugins
{
'topic': 'notify.pupil_detector.broadcast_properties',
'subject': 'pupil_detector.broadcast_properties',
'eye_id': <eye_id: int>, # optional; possible values: 0 or 1
'detector_plugin_class_name': <detector_plugin_class_name: str>, # optional
}
For more information about custom pupil detector plugins, please read the documentation. You can also see examples of custom pupil detection plugins here.
For an example script that showcases the network API, please consult this helper script.
Changed 3D pupil datum format
pye3d
uses a slightly different pupil format than our previous 3D detector. Because pye3d
continously updates a single model instead of fitting multiple parallel ones, the new 3D pupil datum no longer contains the following keys: model_id
and model_birth_timestamp
.
Our latest Hmd-eyes release handles this by falling back to "0" and 0.0, respectively.
Binocular 3D gaze data with string-only keys - #2068
In order to be compatible with the msgpack-python v1.0.0
(specifially the new strict_map_key=True
default), this release uses strings only as dictionary keys for all msgpack-encoded data that is published via the Network API.
This change affects primarily binocular 3D gaze data which used to contain integer dictionary keys.
Raw Data Exporter - Optional model_id
key - #2061
Some of the fields in the pupil datum related to the 3D model no longer exist in pye3d
(see above). This change ensures the raw data export handles missing fields and outputs a compatible csv file.
Updated msgpack
dependency to version 1.0
- #2068
We continue to streamline and simplify the installation of Pupil Core dependencies. In this release we updated the msgpack
to the latest 1.0
. To ensure you have the latest required versions of all dependencies, please install them via requirements.txt
.
python -m pip install --upgrade pip wheel
pip install -r requirements.txt
Added support for custom receiver high-water mark for HMD Streaming source - #2058
This change adds the ability to set a custom ZMQ high watermark value for HMD Streaming source. This gives users more control over the streaming behaviour when using Pupil Core with an HMD headset.
Added launcher_process.should_stop
notification handling #2070
This change adds the ability to request stopping Capture, Player or Service with the same notification.
import zmq
import msgpack
# create and connect PUB socket to IPC
pub_socket = zmq.Socket(zmq.Context(), zmq.PUB)
pub_socket.connect(ipc_pub_url)
subject = "launcher_process.should_stop"
topic = "notify." + subject
payload = {
'topic': topic,
'subject': subject,
}
pub_socket.send_string(topic, flags=zmq.SNDMORE)
pub_socket.send(msgpack.dumps(payload, use_bin_type=True))
Simplified running from source on Windows - #2073
We have removed the necessity to run Pupil from source using the run_<app>.bat
files on Windows. Instead of extending the PATH environment variable via the .bat
file, we extend it via the application launcher. This also makes it easier to attach a debugger, e.g. via Visual Studio Code.
Downloads
To open the RAR-archive on Windows, you will need to use decompression software, such as WinRAR or 7-Zip (both are available for free).
macOS (11) Big Sur compatibility - #2079
Note: Pupil Core is not currently supported on Mac OS Big Sur. We aim to release a compatability update within the next few weeks. :construction_worker:
December 8, 2020
Event name suggestions: When adding events in the project editor, the text field now allows to quickly reuse previous event names.
December 8, 2020
Event name suggestions: When adding events in the project editor, the text field now allows to quickly reuse previous event names.
December 3, 2020
Various bug fixes and performance improvements across the app.
December 3, 2020
Various bug fixes and performance improvements across the app.
December 3, 2020
New features to power analysis! Check out blog post for an overview or check out new features directly in Pupil Cloud 🐱
New: Projects enable you to group and analyze a collection of recordings. For more see docs.
New: Marker Mapper enrichment for analyzing AOIs using Apriltag Markers. See docs.
New: Now all recordings in the drive view have thumbnails. Tip: hover over the thumbnail and drag left/right to get a rough preview the recording.
December 3, 2020
New features to power analysis! Check out blog post for an overview or check out new features directly in Pupil Cloud 🐱
New: Projects enable you to group and analyze a collection of recordings. For more see docs.
New: Marker Mapper enrichment for analyzing AOIs using Apriltag Markers. See docs.
New: Now all recordings in the drive view have thumbnails. Tip: hover over the thumbnail and drag left/right to get a rough preview the recording.
November 16, 2020
We are pleased to announce the release of Pupil Core software v2.6!
Download the latest bundle (scroll down to the end of the release notes and see Assets).
Please feel free to get in touch with feedback and questions via the #pupil channel on Discord 😄
Motivation
In v2.6, we are taking a big step towards our modularity goal. We now support custom user pupil detector plugins. This change makes it easier than ever for you to modify the existing pupil detection algorithms or to build your own! You will no longer have to run Pupil Core software from source to get started with your custom pupil detector! Read more about it in our documentation.
Improvements
Support custom pupil detection plugins - #2033
You can now run your own pupil detection plugins that run in the eye processes. These plugins can be used to implement custom algorithms for extracting pupillometry data from the eye images and feeding it to the rest of the gaze mapping pipeline.
Pupil detection plugins are supported in Pupil Capture, Pupil Player, and Pupil Service. Similar to regular user plugins, custom pupil detection plugins should be placed inside pupil_capture_settings/plugins
for Pupil Capture, pupil_player_settings/plugins
for Pupil Player, and pupil_service_settings/plugin
for Pupil Service. The plugins are automatically loaded when the applications starts.
Read more about it in our documentation.
Support HMD Streaming Source in eye process - #2052
We have added support for using HMD Streaming Source in the eye process. This also adds support for BGR and Gray frame format for HMD streams.
Support Pupil Invisible recording format v1.4 - #2054
This new recording format has been introduced in Pupil Companion 1.0.0
. This version provides support for the OnePus 8 phone and Android 11. On the OnePlus 8, eye videos will be h264-encoded.
Bug Fixes
Removed
import *
statements - #2036Fixed typo in circle detector benchmark - #2038
Fixed gaze with negative z-component - #2043
Fixed issue when minimizing 3D pupil detector debug window on Windows - #2047
Fixed UVC camera auto-selection priority in case of multiple pattern matches - #2051
Developer Notes
Added ability to stop eye process plugins via notifications - #2039
Another small improvement for eye process plugin management in this release is the ability to stop plugins via notifications. This gives better control over the list of plugins running in the eye process.
import zmq
import msgpack
# class name of the plugin to stop
plugin_name = "..."
# create and connect PUB socket to IPC
pub_socket = zmq.Socket(zmq.Context(), zmq.PUB)
pub_socket.connect(ipc_pub_url)
for eye_id in (0, 1):
subject = "stop_eye_plugin"
topic = "notify." + subject
payload = {
'topic': topic
'subject': subject,
'target': f"eye{eye_id}",
'name': plugin_name,
}
pub_socket.send_string(topic, flags=zmq.SNDMORE)
pub_socket.send(msgpack.dumps(payload, use_bin_type=True))
Added requirements.txt
file - #2029
We continue to streamline and simplify the installation of Pupil Core dependencies. You can now use the requirements.txt
file from the root of the pupil
repository to install and update all Python dependencies.
python -m pip install --upgrade pip wheel
pip install -r requirements.txt
Downloads
To open the RAR-archive on Windows, you will need to use decompression software, e.g. WinRAR.
November 16, 2020
We are pleased to announce the release of Pupil Core software v2.6!
Download the latest bundle (scroll down to the end of the release notes and see Assets).
Please feel free to get in touch with feedback and questions via the #pupil channel on Discord 😄
Motivation
In v2.6, we are taking a big step towards our modularity goal. We now support custom user pupil detector plugins. This change makes it easier than ever for you to modify the existing pupil detection algorithms or to build your own! You will no longer have to run Pupil Core software from source to get started with your custom pupil detector! Read more about it in our documentation.
Improvements
Support custom pupil detection plugins - #2033
You can now run your own pupil detection plugins that run in the eye processes. These plugins can be used to implement custom algorithms for extracting pupillometry data from the eye images and feeding it to the rest of the gaze mapping pipeline.
Pupil detection plugins are supported in Pupil Capture, Pupil Player, and Pupil Service. Similar to regular user plugins, custom pupil detection plugins should be placed inside pupil_capture_settings/plugins
for Pupil Capture, pupil_player_settings/plugins
for Pupil Player, and pupil_service_settings/plugin
for Pupil Service. The plugins are automatically loaded when the applications starts.
Read more about it in our documentation.
Support HMD Streaming Source in eye process - #2052
We have added support for using HMD Streaming Source in the eye process. This also adds support for BGR and Gray frame format for HMD streams.
Support Pupil Invisible recording format v1.4 - #2054
This new recording format has been introduced in Pupil Companion 1.0.0
. This version provides support for the OnePus 8 phone and Android 11. On the OnePlus 8, eye videos will be h264-encoded.
Bug Fixes
Removed
import *
statements - #2036Fixed typo in circle detector benchmark - #2038
Fixed gaze with negative z-component - #2043
Fixed issue when minimizing 3D pupil detector debug window on Windows - #2047
Fixed UVC camera auto-selection priority in case of multiple pattern matches - #2051
Developer Notes
Added ability to stop eye process plugins via notifications - #2039
Another small improvement for eye process plugin management in this release is the ability to stop plugins via notifications. This gives better control over the list of plugins running in the eye process.
import zmq
import msgpack
# class name of the plugin to stop
plugin_name = "..."
# create and connect PUB socket to IPC
pub_socket = zmq.Socket(zmq.Context(), zmq.PUB)
pub_socket.connect(ipc_pub_url)
for eye_id in (0, 1):
subject = "stop_eye_plugin"
topic = "notify." + subject
payload = {
'topic': topic
'subject': subject,
'target': f"eye{eye_id}",
'name': plugin_name,
}
pub_socket.send_string(topic, flags=zmq.SNDMORE)
pub_socket.send(msgpack.dumps(payload, use_bin_type=True))
Added requirements.txt
file - #2029
We continue to streamline and simplify the installation of Pupil Core dependencies. You can now use the requirements.txt
file from the root of the pupil
repository to install and update all Python dependencies.
python -m pip install --upgrade pip wheel
pip install -r requirements.txt
Downloads
To open the RAR-archive on Windows, you will need to use decompression software, e.g. WinRAR.
October 20, 2020
We are pleased to announce the release of Pupil Core software v2.5!
Download the latest bundle (scroll down to the end of the release notes and see Assets).
Please feel free to get in touch with feedback and questions via the #pupil channel on Discord 😄
Motivation
Pupil v2.5 focuses on further improvements to software stability. We have fixed multiple issues that prevented very old recordings from being opened in Pupil Player.
Improvements
Replacing internal GLFW bindings with pyGLFW - #2015
In this release we replaced the internal glfw.py
bindings to GLFW with the external pyGLFW
package. This change simplifies our dependency list, making easier to install GLFW
on Windows.
New default camera intrinsics - #2023
We use camera intrinsics in multiple places to transform between the 2d distorted image space and the 3d undistorted camera space. With this release, we have updated the default scene camera intrinsics to perform this tansformation more accuractely at the image borders.
Note: Each camera is slightly different. Therefore, it is recommended to run your own camera intrinsics estimation to get the best possible transformations for your camera.
Bug Fixes
Fixed a crash in Pupil Player when attempting to visualize invalid data - #2021
Fixed an edge-case when handling recordings with negative time jumps - #2026, #2028
Fixed a frame drop issue on macOS when windows were occluded - #2027
Fixed an issue that caused instabilities when starting the Head Pose tracker - #2022
Surface Tracker stability improvements - #2025
Developer Notes
Improved Observable class - #2022
Improvements to the Observable class enable you to observe monkey patched methods (e.g. replaced methods that were not in the original class definition). Additionally, trying to add private methods as observers now fails with a more explicit error.
Changed Requirements
Please install the new external glfw
dependency:
pip install glfw
Downloads
To open the RAR-archive on Windows, you will need to use decompression software, e.g. WinRAR.
October 20, 2020
We are pleased to announce the release of Pupil Core software v2.5!
Download the latest bundle (scroll down to the end of the release notes and see Assets).
Please feel free to get in touch with feedback and questions via the #pupil channel on Discord 😄
Motivation
Pupil v2.5 focuses on further improvements to software stability. We have fixed multiple issues that prevented very old recordings from being opened in Pupil Player.
Improvements
Replacing internal GLFW bindings with pyGLFW - #2015
In this release we replaced the internal glfw.py
bindings to GLFW with the external pyGLFW
package. This change simplifies our dependency list, making easier to install GLFW
on Windows.
New default camera intrinsics - #2023
We use camera intrinsics in multiple places to transform between the 2d distorted image space and the 3d undistorted camera space. With this release, we have updated the default scene camera intrinsics to perform this tansformation more accuractely at the image borders.
Note: Each camera is slightly different. Therefore, it is recommended to run your own camera intrinsics estimation to get the best possible transformations for your camera.
Bug Fixes
Fixed a crash in Pupil Player when attempting to visualize invalid data - #2021
Fixed an edge-case when handling recordings with negative time jumps - #2026, #2028
Fixed a frame drop issue on macOS when windows were occluded - #2027
Fixed an issue that caused instabilities when starting the Head Pose tracker - #2022
Surface Tracker stability improvements - #2025
Developer Notes
Improved Observable class - #2022
Improvements to the Observable class enable you to observe monkey patched methods (e.g. replaced methods that were not in the original class definition). Additionally, trying to add private methods as observers now fails with a more explicit error.
Changed Requirements
Please install the new external glfw
dependency:
pip install glfw
Downloads
To open the RAR-archive on Windows, you will need to use decompression software, e.g. WinRAR.
September 17, 2020
We are pleased to announce the release of Pupil Core software v2.4!
Download the latest bundle (scroll down to the end of the release notes and see Assets).
Please feel free to get in touch with feedback and questions via the #pupil channel on Discord 😄
Motivation
In Pupil v2.4, we are adding support for eye camera intrinsics. These are used to improve 3d eyeball model positioning. Additionally, we have fixed a long-standing issue that caused application windows not to appear on startup when using Windows OS.
Improvements
Better 3D Eyeball Position - #1995
We now use the focal length of the eye cameras to improve the estimate of the 3D eyeball position. Previously, the 3d eye model assumed a fixed camera focal length. This will most likely not have any noticeable effect for most use-cases, as it does not influence the gaze estimation. We assume default focal lengths for the different types of eye cameras shipped with Pupil Labs's hardware.
Caveat: 200Hz Vive Add-on Recordings
Pupil Core software now saves the eye camera intrinsics to the recording folder. On opening recordings made with previous versions in Pupil Player, we patch up the recording by inserting the appropriate eye camera intrinsics.
It is important to note that the 200Hz Pupil Core and 200Hz Vive Add-on use eye cameras with different focal lengths. Unfortunately, it is not possible for Pupil Player to differentiate between existing eye videos made by these cameras. As a result, Pupil Player will use 200Hz Pupil Core eye camera intrinsics for existing 200hz Vive Add-on eye videos.
To avoid this, we recommend placing 200Hz Vive Add-on intrinsics into your exisiting recordings. You can download the default 200Hz Vive Add-on intrinsics from the Downloads section below. Remember to remove the vive_200hz_
prefix.
Recordings made with Pupil Capture v2.4 and higher will not require any action in this regard.
Bug Fixes
Fixed issue when opening Pupil Invisible recordings with more than 10 parts - #1996
Ensure timelines update when changing calibrations for post-hoc gaze-mapping - #2000
Fixed a crash when opening a recording that contained recorded fallback intrinsics - #2002
Fixed a very rare crash of the eye window caused by malformed data - #2008
Fixed occasionally missing windows on startup on Windows in multi-screen setups - #2007
Resolved an error message when minimizing the eye windows on Windows - #2009
Developer Notes
Changed Requirements
pupil-detectors - #1995
We have updated pupil-detectors to v1.1.1, please update with
pip install -U pupil-detectors
packaging - #1993
We now require packaging>=20.0
, please update with
pip install -U packaging
Internal Version Parsing - #1993
We have switched to a more general version-parsing method by using packaging.version.parse
to parse all internally used version strings (from Pupil and external dependencies).
Black Formatter 20.8 - #2003
We have upgraded our black formatter to version 20.8, which introduces a few changes to previous versions and reformats parts of the code which were fine previously. Please make sure to also upgrade black with
pip install -U black
Downloads
To open the RAR-archive on Windows, you will need to use decompression software, e.g. WinRAR.
September 17, 2020
We are pleased to announce the release of Pupil Core software v2.4!
Download the latest bundle (scroll down to the end of the release notes and see Assets).
Please feel free to get in touch with feedback and questions via the #pupil channel on Discord 😄
Motivation
In Pupil v2.4, we are adding support for eye camera intrinsics. These are used to improve 3d eyeball model positioning. Additionally, we have fixed a long-standing issue that caused application windows not to appear on startup when using Windows OS.
Improvements
Better 3D Eyeball Position - #1995
We now use the focal length of the eye cameras to improve the estimate of the 3D eyeball position. Previously, the 3d eye model assumed a fixed camera focal length. This will most likely not have any noticeable effect for most use-cases, as it does not influence the gaze estimation. We assume default focal lengths for the different types of eye cameras shipped with Pupil Labs's hardware.
Caveat: 200Hz Vive Add-on Recordings
Pupil Core software now saves the eye camera intrinsics to the recording folder. On opening recordings made with previous versions in Pupil Player, we patch up the recording by inserting the appropriate eye camera intrinsics.
It is important to note that the 200Hz Pupil Core and 200Hz Vive Add-on use eye cameras with different focal lengths. Unfortunately, it is not possible for Pupil Player to differentiate between existing eye videos made by these cameras. As a result, Pupil Player will use 200Hz Pupil Core eye camera intrinsics for existing 200hz Vive Add-on eye videos.
To avoid this, we recommend placing 200Hz Vive Add-on intrinsics into your exisiting recordings. You can download the default 200Hz Vive Add-on intrinsics from the Downloads section below. Remember to remove the vive_200hz_
prefix.
Recordings made with Pupil Capture v2.4 and higher will not require any action in this regard.
Bug Fixes
Fixed issue when opening Pupil Invisible recordings with more than 10 parts - #1996
Ensure timelines update when changing calibrations for post-hoc gaze-mapping - #2000
Fixed a crash when opening a recording that contained recorded fallback intrinsics - #2002
Fixed a very rare crash of the eye window caused by malformed data - #2008
Fixed occasionally missing windows on startup on Windows in multi-screen setups - #2007
Resolved an error message when minimizing the eye windows on Windows - #2009
Developer Notes
Changed Requirements
pupil-detectors - #1995
We have updated pupil-detectors to v1.1.1, please update with
pip install -U pupil-detectors
packaging - #1993
We now require packaging>=20.0
, please update with
pip install -U packaging
Internal Version Parsing - #1993
We have switched to a more general version-parsing method by using packaging.version.parse
to parse all internally used version strings (from Pupil and external dependencies).
Black Formatter 20.8 - #2003
We have upgraded our black formatter to version 20.8, which introduces a few changes to previous versions and reformats parts of the code which were fine previously. Please make sure to also upgrade black with
pip install -U black
Downloads
To open the RAR-archive on Windows, you will need to use decompression software, e.g. WinRAR.
August 25, 2020
We are pleased to announce the release of Pupil Core software v2.3!
Download the latest bundle (scroll down to the end of the release notes and see Assets).
Please feel free to get in touch with feedback and questions via the #pupil channel on Discord 😄
Motivation
Pupil v2.3 is a compatibility release for Pupil Invisible, adding support for a simple gaze confidence measure.
Improvements
Pupil Invisible Gaze Confidence - #1984
With its latest 0.8.23 release, Pupil Invisible can detect if the glasses are being worn. If they are not worn, gaze output will be hidden.
We now use this information as a simple binary gaze confidence when loading Pupil Invisible recordings in Pupil Player. If the glasses are detected as being worn, the gaze confidence will be 1.0
, otherwise 0.0
.
Smaller Improvements
Added better log message for pupil mobile network issues - #1994
Renamed "camera calibration" to "camera intrinsics" to avoid confusion with gaze calibration - #1992
Downloads
To open the RAR-archive on Windows, you will need to use decompression software, e.g. WinRAR.
August 25, 2020
We are pleased to announce the release of Pupil Core software v2.3!
Download the latest bundle (scroll down to the end of the release notes and see Assets).
Please feel free to get in touch with feedback and questions via the #pupil channel on Discord 😄
Motivation
Pupil v2.3 is a compatibility release for Pupil Invisible, adding support for a simple gaze confidence measure.
Improvements
Pupil Invisible Gaze Confidence - #1984
With its latest 0.8.23 release, Pupil Invisible can detect if the glasses are being worn. If they are not worn, gaze output will be hidden.
We now use this information as a simple binary gaze confidence when loading Pupil Invisible recordings in Pupil Player. If the glasses are detected as being worn, the gaze confidence will be 1.0
, otherwise 0.0
.
Smaller Improvements
Added better log message for pupil mobile network issues - #1994
Renamed "camera calibration" to "camera intrinsics" to avoid confusion with gaze calibration - #1992
Downloads
To open the RAR-archive on Windows, you will need to use decompression software, e.g. WinRAR.
August 5, 2020
We are pleased to announce the release of Pupil Core software v2.2!
Download the latest bundle (scroll down to the end of the release notes and see Assets).
Please feel free to get in touch with feedback and questions via the #pupil channel on Discord 😄
Motivation
With v2.2, we have focused on improving the user experience when using Pupil on high-pixel-density displays. Now, Pupil scales and layouts its content correctly based on the content-scaling factor set in your operating system's settings.
Improvements
Support For High-Pixel-Density Displays - #1976
On displays with a high pixel density, content looks much smaller than expected. Operating systems have the option to scale its content appropriately. Until now, Pupil only supported content-scaling on macOS. With this release, we have added support for content-scaling on Windows and Linux as well.
Smaller Improvements
Better user feedback when
Accuracy Visualizer
reportsnan
values - #1974Disabled
Duplicate
andDelete
buttons for read-only post-hoc calibrations - #1972Use a square default eye window aspect ratio, matching the latest default cameras - #1987
Changes
Remove Option To Manually Change The Interface Size - #1988
With native support for content scaling on the operating system level, there is no need to scale the UI manually anymore. Therefore, we have removed this feature to further simplify the user interface.
Bug Fixes
Fixed non-monotonic progress visualization for post-hoc gaze mapping - #1965
Fixed flickering on macOS when resetting the window size - #1973
Fixed an empty side-menu when restarting Capture after using HMD-Eyes - #1979
Fixed a crash when attempting to log any non-string object - #1980
Fixed 2D monocular gaze calibration not working - #1983
Developer Notes
Changed Requirements
pyglui v1.28
- #1972
We updated the pyglui dependency to v1.28. On Linux and macOS, you can update with:
pip install -U git+https://github.com/pupil-labs/pyglui
On Windows, please download and install the latest wheel from GitHub.
glfw 3.3
- #1976
In order to support content-scaling across all three platforms, we make use of the glfwGetWindowContentScale
function which has been introduced in glfw 3.3
.
We recommend installing the latest glfw 3.3
release via https://www.glfw.org/download.html.
Removed g_pool.gui_user_scale
- #1976, #1988
With the removal of the Interface Size
setting, the g_pool.gui_user_scale
variable has been removed as well. If you draw custom UI content in your plugins without using pyglui, you should now instead use g_pool.gui.scale
to scale the content appropriately for different native display scaling settings.
Removed Legacy Plugin Base Classes - #1971
The following legacy plugin base classes have been removed. All plugins inheriting from them now just inherit from Plugin
:
Visualizer_Plugin_Base
Analysis_Plugin_Base
Producer_Plugin_Base
Experimental_Plugin_Base
Downloads
To open the RAR-archive on Windows, you will need to use decompression software, e.g. WinRAR.
August 5, 2020
We are pleased to announce the release of Pupil Core software v2.2!
Download the latest bundle (scroll down to the end of the release notes and see Assets).
Please feel free to get in touch with feedback and questions via the #pupil channel on Discord 😄
Motivation
With v2.2, we have focused on improving the user experience when using Pupil on high-pixel-density displays. Now, Pupil scales and layouts its content correctly based on the content-scaling factor set in your operating system's settings.
Improvements
Support For High-Pixel-Density Displays - #1976
On displays with a high pixel density, content looks much smaller than expected. Operating systems have the option to scale its content appropriately. Until now, Pupil only supported content-scaling on macOS. With this release, we have added support for content-scaling on Windows and Linux as well.
Smaller Improvements
Better user feedback when
Accuracy Visualizer
reportsnan
values - #1974Disabled
Duplicate
andDelete
buttons for read-only post-hoc calibrations - #1972Use a square default eye window aspect ratio, matching the latest default cameras - #1987
Changes
Remove Option To Manually Change The Interface Size - #1988
With native support for content scaling on the operating system level, there is no need to scale the UI manually anymore. Therefore, we have removed this feature to further simplify the user interface.
Bug Fixes
Fixed non-monotonic progress visualization for post-hoc gaze mapping - #1965
Fixed flickering on macOS when resetting the window size - #1973
Fixed an empty side-menu when restarting Capture after using HMD-Eyes - #1979
Fixed a crash when attempting to log any non-string object - #1980
Fixed 2D monocular gaze calibration not working - #1983
Developer Notes
Changed Requirements
pyglui v1.28
- #1972
We updated the pyglui dependency to v1.28. On Linux and macOS, you can update with:
pip install -U git+https://github.com/pupil-labs/pyglui
On Windows, please download and install the latest wheel from GitHub.
glfw 3.3
- #1976
In order to support content-scaling across all three platforms, we make use of the glfwGetWindowContentScale
function which has been introduced in glfw 3.3
.
We recommend installing the latest glfw 3.3
release via https://www.glfw.org/download.html.
Removed g_pool.gui_user_scale
- #1976, #1988
With the removal of the Interface Size
setting, the g_pool.gui_user_scale
variable has been removed as well. If you draw custom UI content in your plugins without using pyglui, you should now instead use g_pool.gui.scale
to scale the content appropriately for different native display scaling settings.
Removed Legacy Plugin Base Classes - #1971
The following legacy plugin base classes have been removed. All plugins inheriting from them now just inherit from Plugin
:
Visualizer_Plugin_Base
Analysis_Plugin_Base
Producer_Plugin_Base
Experimental_Plugin_Base
Downloads
To open the RAR-archive on Windows, you will need to use decompression software, e.g. WinRAR.
July 15, 2020
We are pleased to announce the release of Pupil Core software v2.1!
Download the latest bundle (scroll down to the end of the release notes and see Assets).
Please feel free to get in touch with feedback and questions via the #pupil channel on Discord 😄
Motivation
With v2.1, we have continued to focus on making Pupil Core more core. We were able to resolve a lot of stability and user experience issues, especially regarding post-hoc calibrations.
Bug Fixes
Fixed that recorded calibration were displayed as being editable - #1932, #1938
Fixed that recorded calibration were duplicatable - #1933
Fixed that immutable calibration could be deleted - #1934
Fixed inconsistencies in the naming of recorded calibrations - #1935, #1944
Fixed minimum confidence slider for post-hoc calibration - #1942
Ensured correct validation is run even when a different calibration is selected - #1921
Removed UI for heatmaps across surfaces in Capture (only available in Player) - #1917
Fixed incorrect warning about deprecated surface definitions - #1923
Prevented crashes when rendering invalid eyeball outline - #1947, #1954
Fixed that restarting background tasks would not clear already running ones - #1939
Fixed frozen eye videos in HMD-Eyes - #1949
Disabled automatic reference location detection again in post-hoc gaze - #1951
Fixed crash when opening recording with unavailable gazer - #1922
Fixed crashes of the timeline for very short recordings - #1958
Fixed crash when deleting a running post-hoc calibration multiple times - #1955
Fixed crashing post-hoc gaze mapping for an HMD-Eyes recording - #1961
Fixed Service crashing when requesting a non-existing plugin - #1962
Fixed Capture crashing when finishing a calibration without reference data - #1960
Prevented starting gaze mappers on calibration fail - #1963
Fixed an issue when running Pupil Capture bundle on macOS 10.14 Mojave - #1919
Developer Notes
Customizing Screen Marker Positions - #1953
Using custom marker positions for the screen marker calibration choreography might be a common use case. Previously this was not easy to achieve with a custom plugin, as the relevant function was a private method. We have now made it public so that you can more easily implement custom calibration choreographies.
Black Formatting Checks on Travis - #1956
We are internally using Black as automatic Python formatter for our codebase. This helps us ensure that PRs only contain relevant changes and no formatting/whitespace changes. To enforce this more strictly, we added a black formatting check to our Travis integration, which will run on all commits and PRs. Please make sure to format your code with black before submitting a PR to ensure that all Travis checks pass.
Downloads
To open the RAR-archive on Windows, you will need to use decompression software, e.g. WinRAR.
July 15, 2020
We are pleased to announce the release of Pupil Core software v2.1!
Download the latest bundle (scroll down to the end of the release notes and see Assets).
Please feel free to get in touch with feedback and questions via the #pupil channel on Discord 😄
Motivation
With v2.1, we have continued to focus on making Pupil Core more core. We were able to resolve a lot of stability and user experience issues, especially regarding post-hoc calibrations.
Bug Fixes
Fixed that recorded calibration were displayed as being editable - #1932, #1938
Fixed that recorded calibration were duplicatable - #1933
Fixed that immutable calibration could be deleted - #1934
Fixed inconsistencies in the naming of recorded calibrations - #1935, #1944
Fixed minimum confidence slider for post-hoc calibration - #1942
Ensured correct validation is run even when a different calibration is selected - #1921
Removed UI for heatmaps across surfaces in Capture (only available in Player) - #1917
Fixed incorrect warning about deprecated surface definitions - #1923
Prevented crashes when rendering invalid eyeball outline - #1947, #1954
Fixed that restarting background tasks would not clear already running ones - #1939
Fixed frozen eye videos in HMD-Eyes - #1949
Disabled automatic reference location detection again in post-hoc gaze - #1951
Fixed crash when opening recording with unavailable gazer - #1922
Fixed crashes of the timeline for very short recordings - #1958
Fixed crash when deleting a running post-hoc calibration multiple times - #1955
Fixed crashing post-hoc gaze mapping for an HMD-Eyes recording - #1961
Fixed Service crashing when requesting a non-existing plugin - #1962
Fixed Capture crashing when finishing a calibration without reference data - #1960
Prevented starting gaze mappers on calibration fail - #1963
Fixed an issue when running Pupil Capture bundle on macOS 10.14 Mojave - #1919
Developer Notes
Customizing Screen Marker Positions - #1953
Using custom marker positions for the screen marker calibration choreography might be a common use case. Previously this was not easy to achieve with a custom plugin, as the relevant function was a private method. We have now made it public so that you can more easily implement custom calibration choreographies.
Black Formatting Checks on Travis - #1956
We are internally using Black as automatic Python formatter for our codebase. This helps us ensure that PRs only contain relevant changes and no formatting/whitespace changes. To enforce this more strictly, we added a black formatting check to our Travis integration, which will run on all commits and PRs. Please make sure to format your code with black before submitting a PR to ensure that all Travis checks pass.
Downloads
To open the RAR-archive on Windows, you will need to use decompression software, e.g. WinRAR.
June 11, 2020
We are pleased to announce the release of Pupil Core software v2.0!
Download the latest bundle (scroll down to the end of the release notes and see Assets).
Please feel free to get in touch with feedback and questions via the #pupil channel on Discord 😄
Motivation
With v2.0 and beyond, we will be focusing on making Pupil Core more core.
Our vision for Pupil Core emerged early on: we wanted to make eye tracking hardware and software that was accessible. Accessibility is a useful keyword for us because it encourages us to think about the diverse group of researchers that use Pupil. Pupil Core strives for the following:
Transparency: Open source is key here. Enable researchers to introspect into the algorithms. Be explicit about the methods and biases built into the software. Inspire others to make improvements and catch bugs.
Modularity: Make it easy for users to develop and run their own custom code - plugin architecture.
Connectivity: Make it easy to connect to other software - network API.
Diversity: Pupil core is flexible. Pupil Core strives to accommodate a diverse range of research and applications. Pupil Core enables researchers who want to use it as a desktop app with GUI, researchers who want to integrate with other software and sensors via Network API and plugins, and developers who want to tinker with the source code directly.
Over the years, Pupil Core software grew organically to support the community, new hardware, and novel applications. With v2.0 took a few steps back to look at the big picture and to think about the future of Pupil Core. If we want Pupil Core to continue to be a useful platform for researchers and developers, then we need to boil it down to its essentials.
How are we making Pupil Core more core? By focusing on making essential (or core) parts of Pupil Core work really well. Here are the steps we have taken with v2.0:
Restructuring the core pipeline: We have made changes to the application architecture that allows it to run multiple pupil detectors in parallel as well as easily add custom gaze mapping algorithms via user plugins.
Removing hard to maintain features: We had to make some tough decisions. We decided to remove audio capture and native Intel RealSense support. These components were too much work to maintain.
Simplifying the user interface: Over the years we have added many features and the UI has grown organically in the process. We have decided to streamline and improve the UI. Be it merging of menus or more sane default settings, we felt that new users need a bit more help getting started with Pupil Capture and Player.
Improvements
Parallel 2D and 3D Pupil Detection
To allow for using different pupil detection algorithms, we have decoupled our existing pipeline of 2D and 3D detection. Instead of running either of those, both will now run as separate plugins with only minimal overhead. This will enable researchers (including our own R&D team) to test, optimize and replace parts of the pipeline much more conveniently in the future.
Additionally this change has allowed for the following improvements to other parts of the system:
Pupil Diameter Timelines - #1854
With 3D pupil data always available we can always display the meaningful 3D pupil diameter in the timelines. Additionally, we added outlier removal and included the range for a more expressive visualization.
Blink Detection - #1900
With 2D pupil data always available we can run a more reliable blink detection in all circumstances.
Calibration Choreography and Gazer Plugins
By far the biggest change in this release was the refactoring of calibration and gaze mapping part of the core pipeline into separate, extendable components that are easy to swap with custom implementations.
Calibration Plugin in Pupil Capture
When running Pupil Capture, in the plugin list you can find the unified Calibration plugin, which is responsible for configuring both the calibration method (with the Choreography
selector), and the gaze mapping method (with the Method
selector).
Extending Calibration and Gaze Mapping with User Plugins
Now users can implement their own calibration routines and gaze mapping methods. These will automatically show up in the Choreography
and Method
selectors.
To do this, users must subclass CalibrationChoreographyPlugin
and GazerBase
respectively. See the Developer Notes section below for a code example.
Improved Installation Workflow on Windows - #1853
We have wrapped Pupil in a Windows Installer package (MSI) in order to simplify the Windows workflow.
By default, all 3 apps (Capture, Player, and Service) will be installed in C:\Program Files (x86)\Pupil-labs\Pupil v<version>\
. All apps will also get a start-menu entry, making it much easier to open Pupil. Installed versions of Pupil can be removed in the Windows Uninstall Settings.
New versions of Pupil will be installed alongside older versions and you can choose which to start. Switching versions will still overwrite your user settings as previously.
Changes
Fixation and Blink Detection by Default - #1870
In order to make Pupil Core even more useful with out-of-the-box settings, we have enabled the Fixation Detector and Blink Detector by default.
Simplified System Graphs - #1869
We have removed the configuration menu for the System Graphs plugin in order to simplify the user interface. The optional display of live graphs for the pupil diameter has been removed as well.
The confidence graphs will now always display the confidence of the 2D pupil detection, as this is a better indicator for correct positioning of the Pupil Core eye tracking headset.
Single Marker Calibration: Physical Markers - #1897
The single marker calibration is mostly intended for calibration with physical (printed) calibration markers, as opposed to the screen marker calibration. For sake of clarity, we changed the default mode for the single marker calibration to Physical Marker (previously this was called Manual).
Removed Manual Marker Calibration
With the restructuring of the calibration workflow, we have removed the deprecated Manual Marker Calibration. The Single Marker Calibration is a more general version and additionally allows for VOR-based choreographies. If you previously used the Manual Marker Calibration, try the Single Marker Calibration in Physical Marker mode (the new default)!
Parallel Pupil Detector Visualization - #1873
We have changed the color of the 2D ellipse visualization in all eye videos to blue in order to differentiate between 2D and 3D detection. You will now always see 3 ellipses on the eyes when the visualization is enabled:
Color Description
blue: 2D pupil detection result
red: 3D pupil detection result
green: 3D eye model
Flip Eye 0 Display - #1844
The eye 0 (right eye) camera sensor is physically flipped, which results in an upside-down eye image for the right eye. This is by design and does not negatively affect pupil detection or gaze estimation. However, the upside-down eye 0 image repeatedly led users to believe that something was broken or incorrect with Pupil Core headsets. We flipped the eye 0 image now by default to better match user expectations with a right-side-up eye image.
Deprecated Audio Capture - #1868
Recording synchronized audio on 3 different operating systems (macOS, Linux, Windows) has always been a challenge for Pupil Capture. (See our motivation section above.)
Unified Network API Plugin - #1881
The previous plugins Pupil Remote and Frame Publisher were commonly used to interact with Pupil Core's Network API. For the sake of simplicity and clarity, we merged both plugins into the new Network API plugin.
Removed Blink Detector Visualization - #1901
The visualization of the blink detector (brief dark flashing on the screen) could interfere with other plugins and cause visual bugs. We have removed this feature.
Bug Fixes
Fixed Player crashing when exporting while computing gaze history - #1843
Fixed Player crashing when disabling the Surface Tracker while exporting - #1848
Fixed wrong default camera selection in some cases - #1857
Fixed a rare crash in the Surface Tracker - #1879
Fixed deprecated RealSense cameras showing up in the camera selection - #1877
Fixed that offline gaze mappers without data would show as completed - #1889
Fixed corrupted gaze data when deactivating one of multiple gaze mappers - #1888
Fixed new offline pupil data not being correctly announced sometimes - #1890
Fixed a few small issues in offline pupil detection - #1899
Fixed problems with opening the macOS bundles on newer versions of macOS
Developer Notes
Changed Requirements
Scikit-learn
We have added scikit-learn as a dependency for Pupil.
pip install scikit-learn
PyAV - 1908
We updated the PyAV dependency to v0.4.5, which includes some bug fixes. On Linux and macOS, you can update with:
pip install -U git+https://github.com/pupil-labs/PyAV
On Windows, download and install the latest wheel from GitHub.
Changed data format
Both 2D and 3D pupil detector now publish their results independently of each other. To differentiate between them, we have added the origin to the topic. For a binocular setup, you will now get 4 different pupil topics:
pupil.0.2d
pupil.0.3d
pupil.1.2d
pupil.1.3d
This means that there can now be multiple pupil datums for one eye for the same timestamp (2D and 3D). When grouping by the entire topic however, the timestamps are still guaranteed to be unique.
Restarting Unique Plugins - #1871
We have added the previously missing feature to restart plugins with by_class
uniqueness via notifications.
Recording Version 2.2 - #1885
The info.player.json
meta-version has been bumped to 2.2 will be incompatible with Pupil Player version v1.
Allow specifying ZMQ HWM option - #1895
We added the option to start the eye processes with custom values for the ZMQ High Water Mark (HWM) via notification.
Custom Calibration Plugins
Below is an example with minimal implementation for a custom HMD 3D calibration choreography and gaze mapping method:
# To implement a custom calibration or gaze mapping method from scratch, subclass GazerBase and CalibrationChoreographyPlugin
from gaze_mapping.gazer_base import GazerBase
from calibration_choreography import CalibrationChoreographyPlugin
# Another option is to modify existing implementations by subclassing existing implementations
from gaze_mapping import Gazer3D
from calibration_choreography import ScreenMarkerChoreographyPlugin
class CustomGazer3D(Gazer3D):
# Must be unique across all subclasses of GazerBase
label = "Custom 3D Gazer"
class CustomChoreographyPlugin(ScreenMarkerChoreographyPlugin):
# Must be unique accross all subclasses of CalibrationChoreographyPlugin
label = "Custom Calibration"
@classmethod
def supported_gazer_classes(cls):
return [CustomGazer3D]
Release Note Updates
17.06.2020 - v2.0-175
Added compatibility for the HMD-Eyes VR integration
Fixed an issue that prevented the validation from working correctly
24.06.2020 - v2.0-177
Fixed an issue that prevented using the head pose tracker and creating new annotations in Player - #1927
25.06.2020 - v2.0-182
Fixed an issue that prevented Pupil Service from starting - #1928
Downloads
Officially minimum supported operating system versions for the bundles:
Ubuntu: 16.04macOS: 10.13 (High Sierra)Windows: 10
To open the RAR-archive on Windows, you will need a decompression software, e.g. WinRAR.
June 11, 2020
We are pleased to announce the release of Pupil Core software v2.0!
Download the latest bundle (scroll down to the end of the release notes and see Assets).
Please feel free to get in touch with feedback and questions via the #pupil channel on Discord 😄
Motivation
With v2.0 and beyond, we will be focusing on making Pupil Core more core.
Our vision for Pupil Core emerged early on: we wanted to make eye tracking hardware and software that was accessible. Accessibility is a useful keyword for us because it encourages us to think about the diverse group of researchers that use Pupil. Pupil Core strives for the following:
Transparency: Open source is key here. Enable researchers to introspect into the algorithms. Be explicit about the methods and biases built into the software. Inspire others to make improvements and catch bugs.
Modularity: Make it easy for users to develop and run their own custom code - plugin architecture.
Connectivity: Make it easy to connect to other software - network API.
Diversity: Pupil core is flexible. Pupil Core strives to accommodate a diverse range of research and applications. Pupil Core enables researchers who want to use it as a desktop app with GUI, researchers who want to integrate with other software and sensors via Network API and plugins, and developers who want to tinker with the source code directly.
Over the years, Pupil Core software grew organically to support the community, new hardware, and novel applications. With v2.0 took a few steps back to look at the big picture and to think about the future of Pupil Core. If we want Pupil Core to continue to be a useful platform for researchers and developers, then we need to boil it down to its essentials.
How are we making Pupil Core more core? By focusing on making essential (or core) parts of Pupil Core work really well. Here are the steps we have taken with v2.0:
Restructuring the core pipeline: We have made changes to the application architecture that allows it to run multiple pupil detectors in parallel as well as easily add custom gaze mapping algorithms via user plugins.
Removing hard to maintain features: We had to make some tough decisions. We decided to remove audio capture and native Intel RealSense support. These components were too much work to maintain.
Simplifying the user interface: Over the years we have added many features and the UI has grown organically in the process. We have decided to streamline and improve the UI. Be it merging of menus or more sane default settings, we felt that new users need a bit more help getting started with Pupil Capture and Player.
Improvements
Parallel 2D and 3D Pupil Detection
To allow for using different pupil detection algorithms, we have decoupled our existing pipeline of 2D and 3D detection. Instead of running either of those, both will now run as separate plugins with only minimal overhead. This will enable researchers (including our own R&D team) to test, optimize and replace parts of the pipeline much more conveniently in the future.
Additionally this change has allowed for the following improvements to other parts of the system:
Pupil Diameter Timelines - #1854
With 3D pupil data always available we can always display the meaningful 3D pupil diameter in the timelines. Additionally, we added outlier removal and included the range for a more expressive visualization.
Blink Detection - #1900
With 2D pupil data always available we can run a more reliable blink detection in all circumstances.
Calibration Choreography and Gazer Plugins
By far the biggest change in this release was the refactoring of calibration and gaze mapping part of the core pipeline into separate, extendable components that are easy to swap with custom implementations.
Calibration Plugin in Pupil Capture
When running Pupil Capture, in the plugin list you can find the unified Calibration plugin, which is responsible for configuring both the calibration method (with the Choreography
selector), and the gaze mapping method (with the Method
selector).
Extending Calibration and Gaze Mapping with User Plugins
Now users can implement their own calibration routines and gaze mapping methods. These will automatically show up in the Choreography
and Method
selectors.
To do this, users must subclass CalibrationChoreographyPlugin
and GazerBase
respectively. See the Developer Notes section below for a code example.
Improved Installation Workflow on Windows - #1853
We have wrapped Pupil in a Windows Installer package (MSI) in order to simplify the Windows workflow.
By default, all 3 apps (Capture, Player, and Service) will be installed in C:\Program Files (x86)\Pupil-labs\Pupil v<version>\
. All apps will also get a start-menu entry, making it much easier to open Pupil. Installed versions of Pupil can be removed in the Windows Uninstall Settings.
New versions of Pupil will be installed alongside older versions and you can choose which to start. Switching versions will still overwrite your user settings as previously.
Changes
Fixation and Blink Detection by Default - #1870
In order to make Pupil Core even more useful with out-of-the-box settings, we have enabled the Fixation Detector and Blink Detector by default.
Simplified System Graphs - #1869
We have removed the configuration menu for the System Graphs plugin in order to simplify the user interface. The optional display of live graphs for the pupil diameter has been removed as well.
The confidence graphs will now always display the confidence of the 2D pupil detection, as this is a better indicator for correct positioning of the Pupil Core eye tracking headset.
Single Marker Calibration: Physical Markers - #1897
The single marker calibration is mostly intended for calibration with physical (printed) calibration markers, as opposed to the screen marker calibration. For sake of clarity, we changed the default mode for the single marker calibration to Physical Marker (previously this was called Manual).
Removed Manual Marker Calibration
With the restructuring of the calibration workflow, we have removed the deprecated Manual Marker Calibration. The Single Marker Calibration is a more general version and additionally allows for VOR-based choreographies. If you previously used the Manual Marker Calibration, try the Single Marker Calibration in Physical Marker mode (the new default)!
Parallel Pupil Detector Visualization - #1873
We have changed the color of the 2D ellipse visualization in all eye videos to blue in order to differentiate between 2D and 3D detection. You will now always see 3 ellipses on the eyes when the visualization is enabled:
Color Description
blue: 2D pupil detection result
red: 3D pupil detection result
green: 3D eye model
Flip Eye 0 Display - #1844
The eye 0 (right eye) camera sensor is physically flipped, which results in an upside-down eye image for the right eye. This is by design and does not negatively affect pupil detection or gaze estimation. However, the upside-down eye 0 image repeatedly led users to believe that something was broken or incorrect with Pupil Core headsets. We flipped the eye 0 image now by default to better match user expectations with a right-side-up eye image.
Deprecated Audio Capture - #1868
Recording synchronized audio on 3 different operating systems (macOS, Linux, Windows) has always been a challenge for Pupil Capture. (See our motivation section above.)
Unified Network API Plugin - #1881
The previous plugins Pupil Remote and Frame Publisher were commonly used to interact with Pupil Core's Network API. For the sake of simplicity and clarity, we merged both plugins into the new Network API plugin.
Removed Blink Detector Visualization - #1901
The visualization of the blink detector (brief dark flashing on the screen) could interfere with other plugins and cause visual bugs. We have removed this feature.
Bug Fixes
Fixed Player crashing when exporting while computing gaze history - #1843
Fixed Player crashing when disabling the Surface Tracker while exporting - #1848
Fixed wrong default camera selection in some cases - #1857
Fixed a rare crash in the Surface Tracker - #1879
Fixed deprecated RealSense cameras showing up in the camera selection - #1877
Fixed that offline gaze mappers without data would show as completed - #1889
Fixed corrupted gaze data when deactivating one of multiple gaze mappers - #1888
Fixed new offline pupil data not being correctly announced sometimes - #1890
Fixed a few small issues in offline pupil detection - #1899
Fixed problems with opening the macOS bundles on newer versions of macOS
Developer Notes
Changed Requirements
Scikit-learn
We have added scikit-learn as a dependency for Pupil.
pip install scikit-learn
PyAV - 1908
We updated the PyAV dependency to v0.4.5, which includes some bug fixes. On Linux and macOS, you can update with:
pip install -U git+https://github.com/pupil-labs/PyAV
On Windows, download and install the latest wheel from GitHub.
Changed data format
Both 2D and 3D pupil detector now publish their results independently of each other. To differentiate between them, we have added the origin to the topic. For a binocular setup, you will now get 4 different pupil topics:
pupil.0.2d
pupil.0.3d
pupil.1.2d
pupil.1.3d
This means that there can now be multiple pupil datums for one eye for the same timestamp (2D and 3D). When grouping by the entire topic however, the timestamps are still guaranteed to be unique.
Restarting Unique Plugins - #1871
We have added the previously missing feature to restart plugins with by_class
uniqueness via notifications.
Recording Version 2.2 - #1885
The info.player.json
meta-version has been bumped to 2.2 will be incompatible with Pupil Player version v1.
Allow specifying ZMQ HWM option - #1895
We added the option to start the eye processes with custom values for the ZMQ High Water Mark (HWM) via notification.
Custom Calibration Plugins
Below is an example with minimal implementation for a custom HMD 3D calibration choreography and gaze mapping method:
# To implement a custom calibration or gaze mapping method from scratch, subclass GazerBase and CalibrationChoreographyPlugin
from gaze_mapping.gazer_base import GazerBase
from calibration_choreography import CalibrationChoreographyPlugin
# Another option is to modify existing implementations by subclassing existing implementations
from gaze_mapping import Gazer3D
from calibration_choreography import ScreenMarkerChoreographyPlugin
class CustomGazer3D(Gazer3D):
# Must be unique across all subclasses of GazerBase
label = "Custom 3D Gazer"
class CustomChoreographyPlugin(ScreenMarkerChoreographyPlugin):
# Must be unique accross all subclasses of CalibrationChoreographyPlugin
label = "Custom Calibration"
@classmethod
def supported_gazer_classes(cls):
return [CustomGazer3D]
Release Note Updates
17.06.2020 - v2.0-175
Added compatibility for the HMD-Eyes VR integration
Fixed an issue that prevented the validation from working correctly
24.06.2020 - v2.0-177
Fixed an issue that prevented using the head pose tracker and creating new annotations in Player - #1927
25.06.2020 - v2.0-182
Fixed an issue that prevented Pupil Service from starting - #1928
Downloads
Officially minimum supported operating system versions for the bundles:
Ubuntu: 16.04macOS: 10.13 (High Sierra)Windows: 10
To open the RAR-archive on Windows, you will need a decompression software, e.g. WinRAR.
March 26, 2020
We are pleased to announce the release of Pupil v1.23!
Download the latest bundle (scroll down to the end of the release notes and see Assets).
Please feel free to get in touch with feedback and questions via the #pupil channel on Discord 😄
Improvements
Windows Driver Installation Stability - #1833
We have greatly improved the driver installation workflow on Windows. You should not experience problems with spaces or non-english characters in the path to your Pupil installation anymore. Additionally, you do no longer have to run the application as administrator. You still need an administrator to authorize the driver installation.
Changes
On-demand Loading of Multi-part Recordings - #1835
Multiple users have reported problems when opening Pupil Mobile recordings with a large number of video parts. We were able to fix this issue by loading the video parts on demand instead of opening them all at once. As a result, Pupil Player will open Pupil Mobile or Pupil Invisible recordings with multiple parts much quicker than before.
As a side-effect, during playback in Pupil Player, you might experience short frame jumps when a new video part needs to be loaded. This does not affect the underlying data or any exports.
Bug Fixes
Fixed a crash when changing the ROI without a connected headset - #1827
Fixed a crash when opening recordings with empty video parts - #1832
Gracefully stop recordings when receiving non-monotonic timestamps - #1829
Fixed an issue with calibration file storage on macOS - #1836
Fixed an issue with gaze history settings restoration from session settings - #1836
Developer Notes
Changed Requirements - #1834
We updated the pyndsi
dependency on v1.3. On Linux and macOS, you can update with:
pip install -U git+https://github.com/pupil-labs/pyndsi
On Windows, please download and install the latest wheel from GitHub.
Removed All Direct C++ Dependencies - #1828
After the latest rework of the calibration codebase to remove C++ dependencies in v1.22, we have re-evaluated all dependencies for Pupil Core software -- especially on Windows. We are very pleased to announce that we have finally externalized or gotten rid of all C++ dependencies! :tada:
This greatly simplifies the developer setup on Windows. The biggest changes include:
You no longer have to install Visual Studio to run from source
You no longer need to download OpenCV
You are no longer bound to a fixed path
C:\work
We have updated the developer docs with the updated setup instructions. We hope that this simplifies your setup and enables you to develop awesome plugins for Pupil Capture and Pupil Player that can be shared with the community!
Release Note Updates
30.03.2020 14:00: Fix driver installation issue in Windows bundle - #1842
In Pupil v1.23-4
, we fixed an issue that prevented users from installing the camera drivers on Windows.
06.04.2020 11:50: Include missing libuvc.dylib
in macOS bundle
In Pupil v1.23-5
, we have included missing library files for Pupil Player and Pupil Service on macOS.
08.04.2020 17:00: Include missing libusb.dylib
in macOS bundle
In Pupil v1.23-5-fix0
, we have included missing library files for Pupil Player and Pupil Service on macOS.
24.04.2020 14:00: Improve driver installation stability on Windows - #1856
In Pupil v1.23-10
, we have made changes to the driver installation procedure that ensure a successful installation on a larger variety of Windows setups.
March 26, 2020
We are pleased to announce the release of Pupil v1.23!
Download the latest bundle (scroll down to the end of the release notes and see Assets).
Please feel free to get in touch with feedback and questions via the #pupil channel on Discord 😄
Improvements
Windows Driver Installation Stability - #1833
We have greatly improved the driver installation workflow on Windows. You should not experience problems with spaces or non-english characters in the path to your Pupil installation anymore. Additionally, you do no longer have to run the application as administrator. You still need an administrator to authorize the driver installation.
Changes
On-demand Loading of Multi-part Recordings - #1835
Multiple users have reported problems when opening Pupil Mobile recordings with a large number of video parts. We were able to fix this issue by loading the video parts on demand instead of opening them all at once. As a result, Pupil Player will open Pupil Mobile or Pupil Invisible recordings with multiple parts much quicker than before.
As a side-effect, during playback in Pupil Player, you might experience short frame jumps when a new video part needs to be loaded. This does not affect the underlying data or any exports.
Bug Fixes
Fixed a crash when changing the ROI without a connected headset - #1827
Fixed a crash when opening recordings with empty video parts - #1832
Gracefully stop recordings when receiving non-monotonic timestamps - #1829
Fixed an issue with calibration file storage on macOS - #1836
Fixed an issue with gaze history settings restoration from session settings - #1836
Developer Notes
Changed Requirements - #1834
We updated the pyndsi
dependency on v1.3. On Linux and macOS, you can update with:
pip install -U git+https://github.com/pupil-labs/pyndsi
On Windows, please download and install the latest wheel from GitHub.
Removed All Direct C++ Dependencies - #1828
After the latest rework of the calibration codebase to remove C++ dependencies in v1.22, we have re-evaluated all dependencies for Pupil Core software -- especially on Windows. We are very pleased to announce that we have finally externalized or gotten rid of all C++ dependencies! :tada:
This greatly simplifies the developer setup on Windows. The biggest changes include:
You no longer have to install Visual Studio to run from source
You no longer need to download OpenCV
You are no longer bound to a fixed path
C:\work
We have updated the developer docs with the updated setup instructions. We hope that this simplifies your setup and enables you to develop awesome plugins for Pupil Capture and Pupil Player that can be shared with the community!
Release Note Updates
30.03.2020 14:00: Fix driver installation issue in Windows bundle - #1842
In Pupil v1.23-4
, we fixed an issue that prevented users from installing the camera drivers on Windows.
06.04.2020 11:50: Include missing libuvc.dylib
in macOS bundle
In Pupil v1.23-5
, we have included missing library files for Pupil Player and Pupil Service on macOS.
08.04.2020 17:00: Include missing libusb.dylib
in macOS bundle
In Pupil v1.23-5-fix0
, we have included missing library files for Pupil Player and Pupil Service on macOS.
24.04.2020 14:00: Improve driver installation stability on Windows - #1856
In Pupil v1.23-10
, we have made changes to the driver installation procedure that ensure a successful installation on a larger variety of Windows setups.
February 20, 2020
We are pleased to announce the release of Pupil v1.22!
Download the latest bundle (scroll down to the end of the release notes and see Assets).
Please feel free to get in touch with feedback and questions via the #pupil channel on Discord 😄
Features and Changes
Video Source Rework - #1792
We have reworked the video source input system to greatly improve stability, user experience, and maintainability of the related features:
Single Plugin UI
All previous plugins for managing the video source (managers and sources) have been unified under a single plugin menu: Video Source, which handles device/camera selection as well as adjusting camera settings.
Automatic vs Manual Camera Selection
The new source system offers two ways for selecting cameras: automatic and manual:
In automatic mode (default) you can activate source devices, e.g. Local USB or Pupil Mobile. Activating a device selects the best matching available cameras as input for all windows in Pupil Capture.
Enabling manual mode allows you to select cameras individually for every window.
UI Cleanup
The following non-essential user interface elements have been removed to provide a better overall user experience:
The UI for selecting a file source has been removed. Starting a file source via network notification or via drag-and-drop is still possible.
Manually selecting HMD-Eyes as input source has been removed, as the plugin is started from Unity via network notification.
The Capture plugin UI in the eye windows has been removed entirely from Pupil Player as the displayed information was incomplete and the interactivity was limited.
The Test Image source has been removed as it was only intended for development use.
Removed Built-in RealSense Video Backend
Intel RealSense sensors are designed as a prototyping/development platform. Intel deprecates RealSense hardware frequently. Driver support is appropriate for a prototyping tool, but it is not sufficient for a production ready tool.
We have tried to build our tools around Intel's changing APIs and patchwork driver support, but this became difficult and confusing for users.
You can still use RealSense Video Backend as a custom plugin. You can load it directly in the plugin folder of Pupil Capture. Check it out here.
Player: Add Gaze History to Polyline Visualization - #1785
We decided to use the Polyline Visualization as a replacement for the previously removed Scan Path Plugin. You can now visualize past gaze points up to a certain duration by adjusting the duration slider in the Vis Polyline
Plugin. When first dragging the slider, the history for all frames will be computed, which will take some time. Afterwards you can see the gaze history and adjust the duration instantly.
Capture: Improved Region of Interest (ROI) selection - #1788
The ROI selector for the eye windows has been improved for better stability and better user experience. In doing so, we standardized the format of ROI boundaries across Pupil to the following order: (minx, miny, maxx, maxy)
. Please note that this changes the format for adjusting the ROI via network messages.
Player: Add 3D Eyeball Visualization - #1810
We have added the green circle overlay for the 3D eyeball to Player. The overlay will be added to the Eye Overlay
and Eye Video Exporter
plugins, when 3D pupil data is available. You can disable the visualization (including the pupil outline) via the corresponding plugin menus.
Bug Fixes
Changed Windows disconnection log-level from warning to debug - #1786
Fixed some of small bugs in the ROI selector - #1788
Fixed mixed up export columns for monocular
eye_center
andgaze_normal
- #1805Prevent a crash caused by incorrect UVC timestamps - #1812
Developer Notes
Getting Rid of C++ Dependencies - #1789
We have made the next step towards an easier installation process of Pupil. After the externalization of the Pupil Detectors in v1.20, we have been able to replace the last remaining C++ module with a Scipy re-implementation. This means that you do not have to compile any Python Extension Modules when starting Pupil.
As a result, you can now run Pupil from source on Windows without having to go through the trouble of setting up CERES. While the pupil-detectors still depend on CERES, we offer prebuilt wheels for Windows that you can install without having to set up the dependencies.
Changed Requirements
We updated the pyglui
dependency to v1.27. Please update with:
pip install -U git+https://github.com/pupil-labs/pyglui
We Are Hiring Python & DevOps Engineers!
Hey - you're reading the developer notes, so this is for you! We're looking to hire developers to contribute to Pupil source code. If you love Python and enjoy writing code that is a joy to read, get in touch. Experience with the scientific Python stack is a plus, but not required. We have a lot of exciting projects in the pipeline.
We are also looking for Senior Full Stack/DevOps engineers that have experience with kubernetes, docker, and server-side Python.
Send an email to jobs@pupil-labs.com with a CV to start a discussion. We look forward to hearing from you.
Release Notes Update
25.02.2019 v1.22.3
#1817 - Fixed a regression which caused all frames to be dropped after changing Pupil Capture's time base.
27.02.2019 v1.22.7
Commit bcfbf7d - Fixed a typo that caused the
v1.22.3
fix to not work correctly.
February 20, 2020
We are pleased to announce the release of Pupil v1.22!
Download the latest bundle (scroll down to the end of the release notes and see Assets).
Please feel free to get in touch with feedback and questions via the #pupil channel on Discord 😄
Features and Changes
Video Source Rework - #1792
We have reworked the video source input system to greatly improve stability, user experience, and maintainability of the related features:
Single Plugin UI
All previous plugins for managing the video source (managers and sources) have been unified under a single plugin menu: Video Source, which handles device/camera selection as well as adjusting camera settings.
Automatic vs Manual Camera Selection
The new source system offers two ways for selecting cameras: automatic and manual:
In automatic mode (default) you can activate source devices, e.g. Local USB or Pupil Mobile. Activating a device selects the best matching available cameras as input for all windows in Pupil Capture.
Enabling manual mode allows you to select cameras individually for every window.
UI Cleanup
The following non-essential user interface elements have been removed to provide a better overall user experience:
The UI for selecting a file source has been removed. Starting a file source via network notification or via drag-and-drop is still possible.
Manually selecting HMD-Eyes as input source has been removed, as the plugin is started from Unity via network notification.
The Capture plugin UI in the eye windows has been removed entirely from Pupil Player as the displayed information was incomplete and the interactivity was limited.
The Test Image source has been removed as it was only intended for development use.
Removed Built-in RealSense Video Backend
Intel RealSense sensors are designed as a prototyping/development platform. Intel deprecates RealSense hardware frequently. Driver support is appropriate for a prototyping tool, but it is not sufficient for a production ready tool.
We have tried to build our tools around Intel's changing APIs and patchwork driver support, but this became difficult and confusing for users.
You can still use RealSense Video Backend as a custom plugin. You can load it directly in the plugin folder of Pupil Capture. Check it out here.
Player: Add Gaze History to Polyline Visualization - #1785
We decided to use the Polyline Visualization as a replacement for the previously removed Scan Path Plugin. You can now visualize past gaze points up to a certain duration by adjusting the duration slider in the Vis Polyline
Plugin. When first dragging the slider, the history for all frames will be computed, which will take some time. Afterwards you can see the gaze history and adjust the duration instantly.
Capture: Improved Region of Interest (ROI) selection - #1788
The ROI selector for the eye windows has been improved for better stability and better user experience. In doing so, we standardized the format of ROI boundaries across Pupil to the following order: (minx, miny, maxx, maxy)
. Please note that this changes the format for adjusting the ROI via network messages.
Player: Add 3D Eyeball Visualization - #1810
We have added the green circle overlay for the 3D eyeball to Player. The overlay will be added to the Eye Overlay
and Eye Video Exporter
plugins, when 3D pupil data is available. You can disable the visualization (including the pupil outline) via the corresponding plugin menus.
Bug Fixes
Changed Windows disconnection log-level from warning to debug - #1786
Fixed some of small bugs in the ROI selector - #1788
Fixed mixed up export columns for monocular
eye_center
andgaze_normal
- #1805Prevent a crash caused by incorrect UVC timestamps - #1812
Developer Notes
Getting Rid of C++ Dependencies - #1789
We have made the next step towards an easier installation process of Pupil. After the externalization of the Pupil Detectors in v1.20, we have been able to replace the last remaining C++ module with a Scipy re-implementation. This means that you do not have to compile any Python Extension Modules when starting Pupil.
As a result, you can now run Pupil from source on Windows without having to go through the trouble of setting up CERES. While the pupil-detectors still depend on CERES, we offer prebuilt wheels for Windows that you can install without having to set up the dependencies.
Changed Requirements
We updated the pyglui
dependency to v1.27. Please update with:
pip install -U git+https://github.com/pupil-labs/pyglui
We Are Hiring Python & DevOps Engineers!
Hey - you're reading the developer notes, so this is for you! We're looking to hire developers to contribute to Pupil source code. If you love Python and enjoy writing code that is a joy to read, get in touch. Experience with the scientific Python stack is a plus, but not required. We have a lot of exciting projects in the pipeline.
We are also looking for Senior Full Stack/DevOps engineers that have experience with kubernetes, docker, and server-side Python.
Send an email to jobs@pupil-labs.com with a CV to start a discussion. We look forward to hearing from you.
Release Notes Update
25.02.2019 v1.22.3
#1817 - Fixed a regression which caused all frames to be dropped after changing Pupil Capture's time base.
27.02.2019 v1.22.7
Commit bcfbf7d - Fixed a typo that caused the
v1.22.3
fix to not work correctly.
February 16, 2020
Improved stability of video transcoding pipeline.
February 16, 2020
Improved stability of video transcoding pipeline.
January 9, 2020
We are pleased to announce the release of Pupil v1.21!
Download the latest bundle (scroll down to the end of the release notes and see Assets). Please feel free to get in touch with feedback and questions via the #pupil channel on Discord 😄
Features and Changes
Support for Pupil Invisible Audio Recordings - #1748
Pupil Player now supports audio playback and audio export for Pupil Invisible recordings with audio recordings.
Stream Head Pose over Network - #1774
You can now subscribe to the the topic head_pose
to receive live data from the Online Head Pose Tracker plugin.
Bug Fixes
Fixed eye processes always displayed the algorithm view - #1766
Fixed potential crash when changing the eye video size - #1770
Made pyrealsense warning a debug-level message in order to be less obtrusive - #1768
Fixed broken interactivity of the ROI mask in the eye windows - #1778
Fixed multiple stability issues with the fullscreen calibration window - #1767
Developer Notes
Changed Requirements
We updated the PyAV
dependency to v0.4.4 for the PI audio support. On Linux and macOS, you can update with:
pip install -U git+https://github.com/pupil-labs/PyAV
On Windows, download and install the latest wheel from GitHub.
We Are Hiring Python & DevOps Engineers!
Hey - you're reading the developer notes, so this is for you! We're looking to hire developers to contribute to Pupil source code. If you love Python and enjoy writing code that is a joy to read, get in touch. Experience with the scientific Python stack is a plus, but not required. We have a lot of exciting projects in the pipeline.
We are also looking for Senior Full Stack/DevOps engineers that have experience with kubernetes, docker, and server-side Python.
Send an email to jobs@pupil-labs.com with a CV to start a discussion. We look forward to hearing from you.
January 9, 2020
We are pleased to announce the release of Pupil v1.21!
Download the latest bundle (scroll down to the end of the release notes and see Assets). Please feel free to get in touch with feedback and questions via the #pupil channel on Discord 😄
Features and Changes
Support for Pupil Invisible Audio Recordings - #1748
Pupil Player now supports audio playback and audio export for Pupil Invisible recordings with audio recordings.
Stream Head Pose over Network - #1774
You can now subscribe to the the topic head_pose
to receive live data from the Online Head Pose Tracker plugin.
Bug Fixes
Fixed eye processes always displayed the algorithm view - #1766
Fixed potential crash when changing the eye video size - #1770
Made pyrealsense warning a debug-level message in order to be less obtrusive - #1768
Fixed broken interactivity of the ROI mask in the eye windows - #1778
Fixed multiple stability issues with the fullscreen calibration window - #1767
Developer Notes
Changed Requirements
We updated the PyAV
dependency to v0.4.4 for the PI audio support. On Linux and macOS, you can update with:
pip install -U git+https://github.com/pupil-labs/PyAV
On Windows, download and install the latest wheel from GitHub.
We Are Hiring Python & DevOps Engineers!
Hey - you're reading the developer notes, so this is for you! We're looking to hire developers to contribute to Pupil source code. If you love Python and enjoy writing code that is a joy to read, get in touch. Experience with the scientific Python stack is a plus, but not required. We have a lot of exciting projects in the pipeline.
We are also looking for Senior Full Stack/DevOps engineers that have experience with kubernetes, docker, and server-side Python.
Send an email to jobs@pupil-labs.com with a CV to start a discussion. We look forward to hearing from you.
December 12, 2019
We are pleased to announce the release of Pupil v1.20!
Download the latest bundle (scroll down to the end of the release notes and see Assets). Please feel free to get in touch with feedback and questions via the #pupil channel on Discord 😄
Features and Changes
Deprecated Fingertip Calibration - #1753, #1757
We removed the fingertip calibration method.
The fingertip calibration method was rarely used and provided lower accuracy compared to other calibration methods. Additionally, dependencies needed for the fingertip detection required some work to set up correctly and accounted for almost 50% of the size of our application bundles.
Bug Fixes
Fixed a crash when trying to open empty (but existing) recordings - #1751
Fixed a crash on Windows when missing the latest Visual Studio redistributables - #1756
Fixed visualization of circle markers in offline calibration for recordings with gaps - #1758
Fixed broken combination of
--hide-ui
and--profile
CLI flags - #1760
Developer Notes
Externalized Pupil Detectors - #1642
We have extracted the Pupil Detectors into their own repository: https://github.com/pupil-labs/pupil-detectors
This will make it very easy to use our pupil detectors in any standalone application or experimental setup without having to deal with all of Pupil's intricacies.
Additionally this will make it much easier to run Pupil from source (especially on Windows), since we are distributing pupil-detectors as package via PyPI and even provide precompiled binaries for Windows!
OpenGL Debugging - #1752
We occasionally receive crash reports involving error messages from PyOpenGL, which we cannot reproduce on our machines. We wrapped the PyOpenGL errors to prevent crashes and log additional messages in these cases. This can result in visual UI errors (instead of a crash) when there are OpenGL issues. If you notice any weird UI behavior, please save the log file and report back to us.
We Are Hiring Python & DevOps Engineers!
Hey - you're reading the developer notes, so this is for you! We're looking to hire developers to contribute to Pupil source code. If you love Python and enjoy writing code that is a joy to read, get in touch. Experience with the scientific Python stack is a plus, but not required. We have a lot of exciting projects in the pipeline.
We are also looking for Senior Full Stack/DevOps engineers that have experience with kubernetes, docker, and server-side Python.
Send an email to jobs@pupil-labs.com with a CV to start a discussion. We look forward to hearing from you.
December 12, 2019
We are pleased to announce the release of Pupil v1.20!
Download the latest bundle (scroll down to the end of the release notes and see Assets). Please feel free to get in touch with feedback and questions via the #pupil channel on Discord 😄
Features and Changes
Deprecated Fingertip Calibration - #1753, #1757
We removed the fingertip calibration method.
The fingertip calibration method was rarely used and provided lower accuracy compared to other calibration methods. Additionally, dependencies needed for the fingertip detection required some work to set up correctly and accounted for almost 50% of the size of our application bundles.
Bug Fixes
Fixed a crash when trying to open empty (but existing) recordings - #1751
Fixed a crash on Windows when missing the latest Visual Studio redistributables - #1756
Fixed visualization of circle markers in offline calibration for recordings with gaps - #1758
Fixed broken combination of
--hide-ui
and--profile
CLI flags - #1760
Developer Notes
Externalized Pupil Detectors - #1642
We have extracted the Pupil Detectors into their own repository: https://github.com/pupil-labs/pupil-detectors
This will make it very easy to use our pupil detectors in any standalone application or experimental setup without having to deal with all of Pupil's intricacies.
Additionally this will make it much easier to run Pupil from source (especially on Windows), since we are distributing pupil-detectors as package via PyPI and even provide precompiled binaries for Windows!
OpenGL Debugging - #1752
We occasionally receive crash reports involving error messages from PyOpenGL, which we cannot reproduce on our machines. We wrapped the PyOpenGL errors to prevent crashes and log additional messages in these cases. This can result in visual UI errors (instead of a crash) when there are OpenGL issues. If you notice any weird UI behavior, please save the log file and report back to us.
We Are Hiring Python & DevOps Engineers!
Hey - you're reading the developer notes, so this is for you! We're looking to hire developers to contribute to Pupil source code. If you love Python and enjoy writing code that is a joy to read, get in touch. Experience with the scientific Python stack is a plus, but not required. We have a lot of exciting projects in the pipeline.
We are also looking for Senior Full Stack/DevOps engineers that have experience with kubernetes, docker, and server-side Python.
Send an email to jobs@pupil-labs.com with a CV to start a discussion. We look forward to hearing from you.
November 21, 2019
We are pleased to announce the release of Pupil v1.19!
Download the latest bundle (at the end of the release notes under Assets) and let us know what you think via the #pupil channel on Discord 😄
Features and Changes
Improved Fixation Detector - #1743
We made improvements to the Fixation Detector to improve detection accuracy:
We were able to get rid of large gaps in between detected fixations. Now there will be more sequential fixations detected.
We decreased the false-positive detection rate by omitting low-confidence data.
We fixed a bug that would sometimes result in wrong fixations on 3D gaze data.
API Changes
Due to the improvements mentioned above, the Fixation Detector now requires calibrated gaze in both 2D and 3D mode. To reflect these changes, the method
field of a fixation datum now contains either 2d gaze
or 3d gaze
(previously pupil
vs gaze
). This effects both the real-time fixations published through the network API and the fixations.csv
export file.
Removed Fixation-Boosted Calibration - #1744
Since the Fixation Detector now requires calibrated gaze, it will not be used anymore to speed up the calibration process.
Improved Binocular Gaze Mapping - #1731
We improved the mapping of monocular gaze data streams by using a dynamic windows size dependent on the frame rate. This will result in better temporal accuracy when matching binocular gaze data for eyes with frequent low-confidence phases.
We also investigated some other variants of binocular gaze mapping, but chose to stick with this simple improvement. For a full evaluation and discussion, see this jupyter notebook.
Bug Fixes
Add/remove markers for legacy square markers works again - #1737
Fixed some bad UX with switching surface detection modes - #1738
Player is now able to load recordings with square brackets in the name - #1740
Fixed a crash when setting 2D detector properties via network API - #1742
Improved inconsistent background process behavior - #1741
Developer Notes
Automated Testing - #1721, #1724, #1730, #1735
We have done some work to consolidate old tests in the codebase and set it all up nicely with pytest. You can run the test suite from the repository root with:
pip install pytest
pytest
We set up a travis-ci integration to run pytest on all commits and pull requests. Now you will get feedback if you break something 😄 The test coverage is currently low. But from this point on, we - and you - are encouraged to write tests when adding new features and when fixing bugs.
We Are Hiring Python & DevOps Engineers!
Hey - you're reading the developer notes, so this is for you! We're looking to hire developers to contribute to Pupil source code. If you love Python and enjoy writing code that is a joy to read, get in touch. Experience with the scientific Python stack is a plus, but not required. We have a lot of exciting projects in the pipeline.
We are also looking for Senior Full Stack/DevOps engineers that have experience with kubernetes, docker, and server-side Python.
Send an email to jobs@pupil-labs.com with a CV to start a discussion. We look forward to hearing from you.
Release Notes Update
27.11.2019 17:00: v1.19.2
We have fixed an issue in v1.19.0
where multi-part Pupil Mobile and Pupil Invisible recordings were not displayed correctly in Pupil Player - #1747. If you have opened such a recording in Pupil Player v1.19.0
then delete all *_lookup.npy
files and reopen the recording in Pupil Player v1.19.2
.