PoTeC

class pymovements.datasets.PoTeC(name: str = 'PoTeC', long_name: str = 'Potsdam Textbook Corpus', mirrors: dict[str, Sequence[str]] = <factory>, resources: ResourceDefinitions = <factory>, experiment: Experiment = <factory>, extract: dict[str, bool] | None = None, custom_read_kwargs: dict[str, dict[str, Any]] = <factory>, column_map: dict[str, str] = <factory>, trial_columns: list[str] | None = None, time_column: str = 'time', time_unit: str = 'ms', pixel_columns: list[str] = <factory>, position_columns: list[str] | None = None, velocity_columns: list[str] | None = None, acceleration_columns: list[str] | None = None, distance_column: str | None = None, filename_format: dict[str, str] | None = None, filename_format_schema_overrides: dict[str, dict[str, type]] | None = None)

PoTeC dataset [Jakobi et al., 2024].

The Potsdam Textbook Corpus (PoTeC) is a naturalistic eye-tracking-while-reading corpus containing data from 75 participants reading 12 scientific texts. PoTeC is the first naturalistic eye-tracking-while-reading corpus that contains eye-movements from domain-experts as well as novices in a within-participant manipulation: It is based on a 2×2×2 fully-crossed factorial design which includes the participants’ level of study and the participants’ discipline of study as between-subject factors and the text domain as a within-subject factor. The participants’ reading comprehension was assessed by a series of text comprehension questions and their domain knowledge was tested by text-independent background questions for each of the texts. The materials are annotated for a variety of linguistic features at different levels. We envision PoTeC to be used for a wide range of studies including but not limited to analyses of expert and non-expert reading strategies.

The corpus and all the accompanying data at all stages of the preprocessing pipeline and all code used to preprocess the data are made available via GitHub.

name

The name of the dataset.

Type:

str

long_name

The entire name of the dataset.

Type:

str

resources

A list of dataset gaze_resources. Each list entry must be a dictionary with the following keys: - resource: The url suffix of the resource. This will be concatenated with the mirror. - filename: The filename under which the file is saved as. - md5: The MD5 checksum of the respective file.

Type:

ResourceDefinitions

experiment

The experiment definition.

Type:

Experiment

filename_format

Regular expression which will be matched before trying to load the file. Namedgroups will appear in the fileinfo dataframe.

Type:

dict[str, str] | None

filename_format_schema_overrides

If named groups are present in the filename_format, this makes it possible to cast specific named groups to a particular datatype.

Type:

dict[str, dict[str, type]] | None

time_column

The name of the timestamp column in the input data frame. This column will be renamed to time.

Type:

str

time_unit

The unit of the timestamps in the timestamp column in the input data frame. Supported units are ‘s’ for seconds, ‘ms’ for milliseconds and ‘step’ for steps. If the unit is ‘step’ the experiment definition must be specified. All timestamps will be converted to milliseconds.

Type:

str

pixel_columns

The name of the pixel position columns in the input data frame. These columns will be nested into the column pixel. If the list is empty or None, the nested pixel column will not be created.

Type:

list[str]

custom_read_kwargs

If specified, these keyword arguments will be passed to the file reading function.

Type:

dict[str, dict[str, Any]]

Examples

Initialize your Dataset object with the PoTeC definition:

>>> import pymovements as pm
>>>
>>> dataset = pm.Dataset("PoTeC", path='data/PoTeC')

Download the dataset resources:

>>> dataset.download()

Load the data into memory:

>>> dataset.load()

Methods

__init__([name, long_name, mirrors, ...])
from_yaml(path)	Load a dataset definition from a YAML file.
to_dict(*[, exclude_private, exclude_none])	Return dictionary representation.
to_yaml(path, *[, exclude_private, exclude_none])	Save a dataset definition to a YAML file.

Attributes

acceleration_columns
distance_column
extract
filename_format
filename_format_schema_overrides
has_resources	Checks for resources in resources.
long_name
name
pixel_columns
position_columns
time_column
time_unit
trial_columns
velocity_columns
resources
experiment
custom_read_kwargs
mirrors
column_map