From 02b999b5899037ef188aba070097ee6255ec6212 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miguel=20Garc=C3=ADa=20Garc=C3=ADa?= Date: Fri, 25 Oct 2024 12:37:46 +0200 Subject: [PATCH] Add monocular settings --- neon/.vitepress/config.mts | 4 ++ neon/data-collection/data-format/index.md | 1 + neon/data-collection/gaze-mode/index.md | 56 +++++++++++++++++++++++ 3 files changed, 61 insertions(+) create mode 100644 neon/data-collection/gaze-mode/index.md diff --git a/neon/.vitepress/config.mts b/neon/.vitepress/config.mts index 1c9f38d17..73b660244 100644 --- a/neon/.vitepress/config.mts +++ b/neon/.vitepress/config.mts @@ -106,6 +106,10 @@ let theme_config_additions = { text: "Measuring the IED", link: "/data-collection/measuring-ied/", }, + { + text: "Monocular Gaze", + link: "/data-collection/gaze-mode/", + }, { text: "Scene Camera Exposure", link: "/data-collection/scene-camera-exposure/", diff --git a/neon/data-collection/data-format/index.md b/neon/data-collection/data-format/index.md index 7fe76fdfb..e1aceaf61 100644 --- a/neon/data-collection/data-format/index.md +++ b/neon/data-collection/data-format/index.md @@ -34,6 +34,7 @@ This file contains meta-information on the recording. | **start_time** | Timestamp of when the recording was started. Given as UTC timestamp in nanoseconds. | | **template_data** | Data regarding the selected template for the recording as well as the response values. | | **wearer_id** | Unique identifier of the wearer selected for this recording. | +| **gaze_mode** | Indicates whether binocular or monocular (right/ left) pipeline was used to infer gaze. | | **wearer_name** | Name of the wearer selected for this recording. | | **workspace_id** | The ID of the Pupil Cloud workspace this recording has been assigned to. | diff --git a/neon/data-collection/gaze-mode/index.md b/neon/data-collection/gaze-mode/index.md new file mode 100644 index 000000000..c183a799a --- /dev/null +++ b/neon/data-collection/gaze-mode/index.md @@ -0,0 +1,56 @@ +# Binocular vs. Monocular Gaze Mode + +Starting from version 2.8.33, the Neon Companion App allows you to select between using both eyes (binocular) or a single eye (monocular) images for outputing gaze positions. This flexibility can help optimize performance based on your specific requirements, especially in wearers with eye phorias (strabismus) or other eye conditions. + +## Modes + +- `Binocular` _(default)_: Utilizes images from both the right and left eyes to infer gaze position. This mode offers higher accuracy and robustness by leveraging information from both eyes. +- `Mono Right`: Uses only the right eye's image to infer gaze position. This mode may be useful in scenarios where one eye provides a clearer view or when reducing computational load is necessary. +- `Mono Left`: Uses only the left eye's image to infer gaze position. Similar to Mono Right, this mode is beneficial when focusing on a single eye enhances performance or reliability. + +::: warning +**Monocular gaze is less accurate and robust** since it relies on a single eye image. Use this mode only if binocular tracking is not feasible or if there's a specific need for single-eye tracking. +::: + +## Changing Gaze Modes + +To switch between gaze modes, follow these steps: + +1. From the home screen of the Neon Companion App, tap the gear icon located at the top-right corner to open **Companion Settings**. +2. Scroll down to the **NeonNet** section. +3. Choose your desired **Gaze Mode** (`Binocular`, `Mono Right`, or `Mono Left`). +4. After selecting the new gaze mode, **unplug and re-plug** the Neon device to apply the changes. + +::: tip +After altering the gaze mode to monocular, it's recommended to perform a new [Offset Correction](/data-collection/offset-correction/) to improve accuracy. +::: + +## Other Considerations + +- Changing the gaze mode modifies the existing gaze stream. It does **not** create an additional stream. +- All downstream processes, including fixations and enrichments, will utilize this monocular gaze data. +- Eye State and Pupillometry remain unaffected by changes to the gaze mode and will output the data for each eye. + +## In Pupil Cloud: + +Pupil Cloud handles gaze data processing as follows: + +- **Default Behavior**: Pupil Cloud reprocesses recordings to maintain a consistent sampling rate of **200Hz**, regardless of the real-time sampling rate set in the app. + +- **Monocular Mode**: If a monocular gaze mode is selected, Pupil Cloud **will not** reprocess the recordings. Ensure that this aligns with your data analysis requirements. + +## Where Can I Find Which Mode Was Used on a Recording? + +On the recording's view in the Neon Companion App, you can tap on the three dots to visualize the metadata. + +Additionally, the [info.json](/data-collection/data-format/#info-json) file now includes a new field `gaze_mode`. + +--- + +### Best Practices / Additional Recommendations + +- **Testing**: After changing the gaze mode, perform tests to verify that the gaze tracking meets your accuracy and performance needs. + +- **Update your Team**: Keep your team informed about changes in gaze modes to ensure consistency in data collection and analysis. + +---