pymovements.datasets.gazebase.GazeBase

class pymovements.datasets.gazebase.GazeBase(**kwargs)[source]

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].

__init__(**kwargs)[source]

Initialize the dataset object.

Parameters:
  • root (str, Path) – Path to the root directory of the dataset.

  • experiment (Experiment) – The experiment definition.

  • filename_regex (str) – Regular expression which needs to be matched before trying to read the file. Named groups will appear in the fileinfo dataframe.

  • filename_regex_dtypes (dict[str, type], optional) – If named groups are present in the filename_regex, this makes it possible to cast specific named groups to a particular datatype.

  • custom_read_kwargs (dict[str, Any], optional) – If specified, these keyword arguments will be passed to the file reading function.

Methods

__init__(**kwargs)

Initialize the dataset object.

download([remove_finished])

Download dataset.

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.

read()

Parse file information and read all gaze files.

read_fileinfo()

Parse file information from filepaths and filenames.

read_gaze_files()

Read all available gaze data files.

Attributes

dirpath

Get the path to the dataset directory.

raw_dirpath

Get the path to the directory of the raw data.