Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add details about gaze.csv in ref. image mapper #688

Merged
merged 1 commit into from
May 30, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions neon/pupil-cloud/enrichments/reference-image-mapper/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

## Setup

<Youtube src="ygqzQEzUIS4"/>

Check warning on line 11 in neon/pupil-cloud/enrichments/reference-image-mapper/index.md

View workflow job for this annotation

GitHub Actions / ✍️ Check spelling

Unknown word (ygqz)

As described in the setup video, you will need two things in addition to your eye tracking recording(s) to produce a Reference Image Mapper enrichment:

Expand All @@ -21,7 +21,7 @@
<br/>
<br/>
<b>Duration</b><br/>
The **3 min** duration limit only applies to the scanning recording, the rest of your videos can be as long as you like. <br/>But to avoid long processing times and get the best results, we recommend spliting the recordings into relevant parts where you expect the image to be mapped. <br/>

Check warning on line 24 in neon/pupil-cloud/enrichments/reference-image-mapper/index.md

View workflow job for this annotation

GitHub Actions / ✍️ Check spelling

Unknown word (spliting)
:::

In this guide, we will show you how the Reference Image Mapper can be used in a few different situations. This should help you get set up using the enrichment in your own testing environment!
Expand All @@ -30,17 +30,17 @@

![Reference images collage](./rim-collage.webp)

Let's take a look at what the Reference Image and Scanning Recording look like to produce these heatmaps.

Check warning on line 33 in neon/pupil-cloud/enrichments/reference-image-mapper/index.md

View workflow job for this annotation

GitHub Actions / ✍️ Check spelling

Unknown word (heatmaps)

### 1. Magazine Reading

<div class="grid grid-cols-1 sm:grid-cols-2 gap-4">
<div class="grid subgrid" style="grid-row: 1 / 4">

Check warning on line 38 in neon/pupil-cloud/enrichments/reference-image-mapper/index.md

View workflow job for this annotation

GitHub Actions / ✍️ Check spelling

Unknown word (subgrid)
<h4>Reference image</h4>
<img src="./magazine-img.jpg" alt="Magazine Reference Image">
<div>First, we need a high-resolution .jpeg of the page.</div>
</div>
<div class="grid subgrid" style="grid-row: 1 / 4">

Check warning on line 43 in neon/pupil-cloud/enrichments/reference-image-mapper/index.md

View workflow job for this annotation

GitHub Actions / ✍️ Check spelling

Unknown word (subgrid)
<h4>Scanning video</h4>
<div class="m-auto">
<Youtube src="SplYZK-ZzE8"/>
Expand All @@ -54,12 +54,12 @@
### 2. Basketball

<div class="grid grid-cols-2 gap-4">
<div class="grid subgrid" style="grid-row: 1 / 4">

Check warning on line 57 in neon/pupil-cloud/enrichments/reference-image-mapper/index.md

View workflow job for this annotation

GitHub Actions / ✍️ Check spelling

Unknown word (subgrid)
<h4>Reference image</h4>
<img src="./basketball-img.jpg" alt="Basketball Reference Image">
<div>Here we can take a photo of the basketball hoop and court background.</div>
</div>
<div class="grid subgrid" style="grid-row: 1 / 4">

Check warning on line 62 in neon/pupil-cloud/enrichments/reference-image-mapper/index.md

View workflow job for this annotation

GitHub Actions / ✍️ Check spelling

Unknown word (subgrid)
<h4>Scanning video</h4>
<div class="m-auto">
<Youtube src="4MB5o4W_XJo"/>
Expand All @@ -73,15 +73,15 @@
### 3. Supermarket Shelf

<div class="grid grid-cols-2 gap-4">
<div class="grid subgrid" style="grid-row: 1 / 4">

Check warning on line 76 in neon/pupil-cloud/enrichments/reference-image-mapper/index.md

View workflow job for this annotation

GitHub Actions / ✍️ Check spelling

Unknown word (subgrid)
<h4>Reference image</h4>
<img src="./supermarket-img.jpg" alt="Supermarket Reference Image">
<div>This photo captures the assortment of packagíng in the coffee aisle of a supermarket.</div>

Check warning on line 79 in neon/pupil-cloud/enrichments/reference-image-mapper/index.md

View workflow job for this annotation

GitHub Actions / ✍️ Check spelling

Unknown word (packagíng)
</div>
<div class="grid subgrid" style="grid-row: 1 / 4">
<h4>Scanning video</h4>
<div class="m-auto">
<Youtube src="d3Yk3nKDIOQ"/>

Check warning on line 84 in neon/pupil-cloud/enrichments/reference-image-mapper/index.md

View workflow job for this annotation

GitHub Actions / ✍️ Check spelling

Unknown word (KDIOQ)
</div>
<div>
Notice that the scanning recording is fairly slow to reduce motion blur for this feature-rich shelf.
Expand Down Expand Up @@ -177,6 +177,10 @@
| **fixation id** | If this gaze sample belongs to a fixation event, this is the corresponding id of the fixation. Otherwise, this field is empty. |
| **blink id** | If this gaze samples belongs to a blink event, this is the corresponding id of the blink. Otherwise this field is empty. |

::: info
This CSV file only contains data-points where the reference image has been localised in the scene. Looking for all the gaze points? Check [this file.](/data-collection/data-format/#gaze-csv)
:::

### fixations.csv

This file contains fixation events detected in the gaze data stream and mapped to the reference image.
Expand Down
Loading