Skip to content

Commit

Permalink
Merge pull request #726 from pupil-labs/al_scanpath_marker_mapper
Browse files Browse the repository at this point in the history
Al scanpath marker mapper
  • Loading branch information
marc-tonsen authored Dec 12, 2024
2 parents 11f8b2d + 25d8f3b commit 4058267
Showing 1 changed file with 6 additions and 33 deletions.
39 changes: 6 additions & 33 deletions alpha-lab/scanpath-rim/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
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
permalink: /alpha-lab/scanpath-rim/
tags: [Pupil Invisible, Neon, Cloud]
---
Expand All @@ -11,7 +11,7 @@ tags: [Pupil Invisible, Neon, Cloud]
<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!
:::

## Visualising Gaze Exploration With Scanpaths
Expand All @@ -21,19 +21,19 @@ Scanpaths are graphical representations of gaze behaviour over time. They show h
- 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 @@ After running the notebook, you'll find the following files in your folder:
::: 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>

0 comments on commit 4058267

Please sign in to comment.