Skip to content

MultiplEYE-COST/multipleye-preprocessing

Repository files navigation

Documentation GitHub Repository Python Version

MultiplEYE Preprocessing

Important

This repository is actively maintained and evolving. Features, configurations, and behaviors may change as we improve the codebase. Please:

  • Keep the repository up-to-date to receive the latest changes, fixes, and improvements
  • Report issues if you encounter unexpected behavior
  • Refer to the documentation for the latest information on how to use the pipeline
  • Check the troubleshooting guide if you encounter any issues

This repository contains the preprocessing pipeline for eye-tracking data and psychometric test scoring from the MultiplEYE project.

If you are running the pipeline and encounter any issues, please check the troubleshooting guide.

Note

This repository processes data recorded with MultiplEYE-psychometric-tests.

What You Can Do With This Repository

1. Run the Preprocessing Pipeline

Process raw eye-tracking data (EyeLink .edf files) through a complete preprocessing workflow:

# Configure your settings in multipleye_settings_preprocessing.yaml
run_multipleye_preprocessing

This pipeline handles:

  • Converting .edf to .asc format
  • Parsing and validating eye-tracking data
  • Applying filters and detecting events
  • Generating preprocessed output files

Tip

A step-by-step notebook is available in preprocessing.ipynb to walk through the pipeline in detail.

2. Score Psychometric Tests

Calculate scores from the psychometric test battery:

preprocess_psychometric_tests

This calculates scores for:

  • Lewandowsky WMC Battery (Memory Update, Operation Span, Sentence Span, Spatial STM)
  • Rapid Automatized Naming (RAN)
  • Stroop Test
  • Flanker Task
  • PLAB (Pimsleur Language Aptitude Battery)
  • WikiVocab

Important

The psychometric tests require data to be structured correctly. See the Psychometric Tests documentation for details on the expected data format.


Installation

For full installation instructions, see the Getting Started guide.

Quick setup:

git clone https://github.com/MultiplEYE-COST/multipleye-preprocessing.git
cd multipleye-preprocessing/
uv sync
source .venv/bin/activate  # Unix/Mac
# or
.venv\Scripts\activate  # Windows

Warning

This project is actively maintained and evolving. Features, configurations, and behaviors may change as we improve the codebase. Please:

  • Keep the repository up-to-date to receive the latest changes, fixes, and improvements
  • Report issues if you encounter unexpected behavior

Documentation Overview

Topic Description
Getting Started Installation, requirements, and running the pipeline
Preprocessing Detailed preprocessing pipeline documentation
Reading Measures Reading measures from preprocessed eye-tracking data
Psychometric Tests Test descriptions and scoring details
Configuration Configuration file options
Technical Architecture Code structure and design

Quick Start

  1. Update settings in multipleye_settings_preprocessing.yaml
  2. Run preprocessing: run_multipleye_preprocessing
  3. Score psychometric tests: preprocess_psychometric_tests

Caution

EyeLink-specific: You must install the EyeLink Developers Kit to convert .edf files. See the installation guide for details.

Releases

No releases published

Packages

 
 
 

Contributors