Skip to content

Commit

Permalink
Neil's final edits
Browse files Browse the repository at this point in the history
  • Loading branch information
N-M-T committed Aug 15, 2024
1 parent 777c8bf commit 33459bc
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 31 deletions.
19 changes: 10 additions & 9 deletions alpha-lab/scanpath-rim/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,11 @@ Picture this: Build and customise scanpath visualisations with your Reference Im
:::

## Visualising Gaze Exploration With Scanpaths

Check warning on line 17 in alpha-lab/scanpath-rim/index.md

View workflow job for this annotation

GitHub Actions / ✍️ Check spelling

Unknown word (Visualising)

Check warning on line 17 in alpha-lab/scanpath-rim/index.md

View workflow job for this annotation

GitHub Actions / ✍️ Check spelling

Unknown word (Scanpaths)
Scanpaths are graphical representations of gaze over time. They show how an observer has focused attention on different aspects of a scene, making them a valuable tool for understanding a person's visual attention and perception. The video above illustrates this concept. It shows:
- Fixation locations, visualised as numbered circles
- Fixation durations, which are mapped to the size of the circles. Longer fixations correspond to larger circles.
Scanpaths are graphical representations of gaze behaviour over time. They show how an observer has focused attention on different aspects of a scene, making them a valuable tool for understanding a person's visual attention and perception. The video above illustrates this concept. It shows:

Check warning on line 18 in alpha-lab/scanpath-rim/index.md

View workflow job for this annotation

GitHub Actions / ✍️ Check spelling

Unknown word (Scanpaths)
- Fixation locations - Visualised as numbered circles
- Fixation durations - Mapped to the size of the circles. Longer fixations correspond to larger circles
- Saccades - Represented by lines connecting sequential fixations
- Saccade distances (between sequential fixations) - Reflected by the length of the lines. Longer lines correspond to bigger gaze shifts

In this guide, we will show you how to generate static and dynamic scanpath visualisations using your Reference Image Mapper or Manual Mapper exported data.

Expand All @@ -32,9 +34,9 @@ To automate the process as much as possible, you can download your data directly

## Steps
1. Run a [Reference Image Mapper](https://docs.pupil-labs.com/neon/pupil-cloud/enrichments/reference-image-mapper/) or a [Manual Mapper](https://docs.pupil-labs.com/neon/pupil-cloud/enrichments/manual-mapper/) enrichment.
2. Data from your enrichment needs to be loaded onto Google Drive. You can choose between one of the two options:
- Use a Pupil Cloud API token to have the enrichment loaded into Google Drive automatically. You simply need to obtain a developer token from Pupil Cloud (click [here](https://cloud.pupil-labs.com/settings/developer) to obtain yours).
- Download the enrichment manually from Pupil Cloud and then upload it to your Google Drive.
2. Data from your enrichment needs to be loaded onto Google Drive. You can choose between one of two options:
1. Use a Pupil Cloud API token to have the enrichment loaded into Google Drive automatically. You need to obtain a developer token from Pupil Cloud (click [here](https://cloud.pupil-labs.com/settings/developer) to obtain yours).
2. Download the enrichment manually from Pupil Cloud and then upload it to your Google Drive.
3. Access our **[Google Colab Notebook](https://colab.research.google.com/drive/13FIZroc7ckyOs7APSSskqo7ew2JAZR-q?usp=sharing)** and carefully follow the instructions.

<div class="mb-4" style="display:flex;justify-content:center;">
Expand All @@ -48,7 +50,7 @@ To automate the process as much as possible, you can download your data directly
</a>
</div>

If you want to work with the code locally, feel free to download it [here](https://gist.github.com/nadje/7a8f1e5590ab9022be4253a5b0d8d238).
If you want to work with the code locally, feel free to download it from this [GitHub Repository](https://gist.github.com/nadje/7a8f1e5590ab9022be4253a5b0d8d238).

## Review the Scanpaths
After running the notebook, you'll find the following files in your folder:
Expand All @@ -59,10 +61,9 @@ After running the notebook, you'll find the following files in your folder:
![Static scanpath](./scanpath_image_nad.png)

::: tip
Need guidance in further customising your scanpath visualisations? You can refer to our [legacy scanpath visualisation](https://gist.github.com/elepl94/9f669c4d81e455cf2095957831219664) or reach out to us via email at [[email protected]](mailto:[email protected]), on our [Discord server](https://pupil-labs.com/chat/), or visit our [Support Page](https://pupil-labs.com/products/support/) for dedicated support options.
Need guidance in further customising your scanpath visualisations? Reach out to us via email at [[email protected]](mailto:[email protected]), on our [Discord server](https://pupil-labs.com/chat/), or visit our [Support Page](https://pupil-labs.com/products/support/) for dedicated support options.
:::


<style scoped>
img, iframe {
width: 100%;
Expand Down
19 changes: 12 additions & 7 deletions neon/data-collection/measuring-ied/index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
# Measuring the Inter-Eye-Distance (IED) of a Subject
# Measuring the Inter-Eye-Distance (IED)

The Inter-Eye-Distance (IED) can be adjusted for applications requiring precise pupillometry or eye-state measurements. These adjustments do not require prior calibration of the device. However, the accuracy of Neon’s 3D eye-state and pupil-size measurements can be enhanced by correctly setting the IED for each wearer.
The wearer's IED can be set in the Neon Companion app for applications requiring
precise pupillometry or eye-state measurements.
This does not require prior calibration of the device. However, the accuracy of Neon’s 3D eye-state and pupil-size
measurements can be enhanced by correctly setting the IED for each wearer.

To add the participant’s IED, input the value into their ‘Wearer Profile’ within the Neon Companion app before starting a recording. By default, the IED is set to 63 mm, which is the average for adults.
To add the wearer's IED, input the value into their ‘Wearer Profile’ in the Neon Companion app before
starting
a recording. The default IED is set to 63 mm, which is the average for adults.

Please follow the simple steps below to measure the participant’s IED:

- Ask the person to look at a distant object (to avoid eye convergence).
- Hold the ruler in front of the person’s eyes and measure from the center of one pupil to the center of the other.
Here's a simple way to measure IED:
1. Ask the person to look at a distant object (to avoid convergence)
2. Hold a ruler in front of their eyes and measure from the center of one pupil to the center of the
other
10 changes: 0 additions & 10 deletions neon/data-collection/measuring-the-IED/index.md

This file was deleted.

8 changes: 3 additions & 5 deletions neon/neon-player/eye-state-timeline/index.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
# Eye State Timeline


The `Eye State Timeline` plugin visualizes the 3D eye state and pupil diameter data.
This plugin visualizes [3D eye state](/data-collection/data-streams/#_3d-eye-states) and [pupil diameter](/data-collection/data-streams/#pupil-diameters) data.

![Eye State Timeline](./eye-state-timeline.webp)

::: info
The data will be visualized only if the Eye State computation was enabled in the Neon Companion app settings during this recording.
The data will only be visualized if Eye State computation was enabled in the Neon Companion app during recording.
:::

## Export Format
Results exported to `3d_eye_states.csv` contain the [3D eye states](/data-collection/data-streams/#_3d-eye-states) as well as [pupil diameter](/data-collection/data-streams/#pupil-diameters) data. The fields are listed below:

Results exported to `3d_eye_states.csv` with the following fields:
| Field | Description |
| ------------------------- | -------- |
| **section id** | Unique identifier of the corresponding section. |
Expand Down

0 comments on commit 33459bc

Please sign in to comment.