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

Al scanpath marker mapper #726

Merged
merged 2 commits into from
Dec 12, 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
39 changes: 6 additions & 33 deletions alpha-lab/scanpath-rim/index.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,39 @@
---
description: Generate static and dynamic scanpaths with Reference Image Mapper and Manual Mapper
description: Generate static and dynamic scanpaths with Reference Image Mapper, Marker Mapper, and Manual Mapper

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

View workflow job for this annotation

GitHub Actions / ✍️ Check spelling

Unknown word (scanpaths)
permalink: /alpha-lab/scanpath-rim/

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

View workflow job for this annotation

GitHub Actions / ✍️ Check spelling

Unknown word (scanpath)
tags: [Pupil Invisible, Neon, Cloud]
---

# Generate Scanpath Visualisations

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

View workflow job for this annotation

GitHub Actions / ✍️ Check spelling

Unknown word (Scanpath)

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

View workflow job for this annotation

GitHub Actions / ✍️ Check spelling

Unknown word (Visualisations)

<TagLinks />

<Youtube src="F52WXh1txVs"/>

::: tip
Picture this: Build and customise scanpath visualisations with your Reference Image Mapper or Manual Mapper exports!
Picture this: Build and customise scanpath visualisations with your Reference Image Mapper, Marker Mapper, or Manual Mapper exports!

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

View workflow job for this annotation

GitHub Actions / ✍️ Check spelling

Unknown word (customise)

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

View workflow job for this annotation

GitHub Actions / ✍️ Check spelling

Unknown word (scanpath)

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

View workflow job for this annotation

GitHub Actions / ✍️ Check spelling

Unknown word (visualisations)
:::

## 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 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.
In this guide, we will show you how to generate static and dynamic scanpath visualisations using your Reference Image Mapper, Marker Mapper, or Manual Mapper exported data.

::: tip
Before continuing, ensure you are familiar with the [Reference Image Mapper](https://docs.pupil-labs.com/neon/pupil-cloud/enrichments/reference-image-mapper/) and the [Manual Mapper](https://docs.pupil-labs.com/neon/pupil-cloud/enrichments/manual-mapper/) enrichments.
Before continuing, ensure you are familiar with the [Reference Image Mapper](https://docs.pupil-labs.com/neon/pupil-cloud/enrichments/reference-image-mapper/), the [Marker Mapper](https://docs.pupil-labs.com/neon/pupil-cloud/enrichments/marker-mapper/), and the [Manual Mapper](https://docs.pupil-labs.com/neon/pupil-cloud/enrichments/manual-mapper/) enrichments.
:::

## Extending Current Tools
The [Reference Image Mapper](https://docs.pupil-labs.com/neon/pupil-cloud/enrichments/reference-image-mapper/) and the [Manual Mapper](https://docs.pupil-labs.com/neon/pupil-cloud/enrichments/manual-mapper/) enrichments available in Pupil Cloud are tools that map fixations onto 2D images. Following the completion of these enrichments, you can generate heatmaps and Areas of Interest. However, they currently do not support the production of scanpath visualisations. Thus, we chose to provide an easy click-and-run solution that allows you to build your own scanpaths using the enrichment data.
The [Reference Image Mapper](https://docs.pupil-labs.com/neon/pupil-cloud/enrichments/reference-image-mapper/), the [Marker Mapper](https://docs.pupil-labs.com/neon/pupil-cloud/enrichments/marker-mapper/), and the [Manual Mapper](https://docs.pupil-labs.com/neon/pupil-cloud/enrichments/manual-mapper/) enrichments available in Pupil Cloud are tools that map fixations onto 2D images or surfaces. Following the completion of these enrichments, you can generate heatmaps and Areas of Interest. However, they currently do not support the production of scanpath visualisations. Thus, we chose to provide an easy click-and-run solution that allows you to build your own scanpaths using the enrichment data.

To automate the process as much as possible, you can download your data directly via the Pupil Cloud API. Alternatively, you can manually download the data and upload the unzipped folder to your Google Drive.

## 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.
1. Run a [Reference Image Mapper](https://docs.pupil-labs.com/neon/pupil-cloud/enrichments/reference-image-mapper/), the [Marker Mapper](https://docs.pupil-labs.com/neon/pupil-cloud/enrichments/marker-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 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.
Expand Down Expand Up @@ -63,30 +63,3 @@
::: tip
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%;
height: 100%;
object-fit: contain;
box-sizing: border-box;
}

.iframe-container2 {
position: relative;
width: 100%;
padding-bottom: 75%;
margin-bottom: 10px;
height: 0;
margin-left: 0;
margin-right: 0;
}

.iframe-container2 iframe {
position: absolute;
top: 0;
left: 0;
width: 100%;
height: 100%;
}
</style>
Loading