pymovements.datasets.gazebase.GazeBase

class pymovements.datasets.gazebase.GazeBase(**kwargs)

GazeBase dataset [Griffith et al., 2021].

This dataset includes monocular (left eye) eye tracking data from 322 participants captured over a period of 37 months. Participants attended up to 9 rounds during this time frame, with each round consisting of two contiguous sessions.

Eye movements are recorded at a sampling frequency of 1000 Hz using an EyeLink 1000 video-based eye tracker and are provided as positional data in degrees of visual angle.

In each of the two sessions per round, participants are instructed to complete a series of tasks, including a fixation task (FIX), a horizontal saccade task (HSS), a random saccade task (RAN), a reading task (TEX), two free viewing video tasks (VD1 and VD2) and a gaze-driven gaming task (BLG).

Check the respective paper for details [Griffith et al., 2021].

Change to download=True and extract=True for downloading and extracting the dataset.

>>> dataset = GazeBase(
...     root='data/',
...     download=False,
...     extract=False,
...     remove_finished=False,
... )
>>> dataset.load()  

__init__(**kwargs)

Initialize dataset.

If desired, dataset resources will be downloaded and extracted.

Parameters:

• download (bool) – Download all dataset resources.

• extract (bool) – Extract dataset archive files.

• remove_finished (bool) – Remove archive files after extraction.

Methods

__init__(**kwargs)	Initialize dataset.
clear_events()	Clear event DataFrame.
detect_events(method[, eye, clear, verbose])	Detect events by applying a specific event detection method.
download()	Download dataset.
extract([remove_finished])	Extract dataset archives.
infer_fileinfo()	Infer information from filepaths and filenames.
load([events, preprocessed, subset])	Parse file information and load all gaze files.
load_event_files()	Load all available event files.
load_gaze_files([preprocessed])	Load all available gaze data files.
pix2deg([verbose])	Compute gaze positions in degrees of visual angle from pixel coordinates.
pos2vel([method, verbose])	Compute gaze velocites in dva/s from dva coordinates.
save([verbose])	Save preprocessed gaze and event files.
save_events([verbose])	Save events to files.
save_preprocessed([verbose])	Save preprocessed gaze files.
take_subset([subset])	Take a subset of the dataset.

Attributes

events_rootpath	Get the path to the directory of the event data.
preprocessed_rootpath	Get the path to the directory of the preprocessed gaze data.
raw_rootpath	Get the path to the directory of the raw data.
rootpath	Get the path to the dataset directory.