pymovements.Gaze.save_events#

Gaze.save_events(dirname: str | Path, verbose: int = 1, extension: str = 'feather') → None[source]#

Save gaze events to file.

Data will be saved as the events.{extension} file to dirname.

Parameters:

dirname (str) – Directory name to save data. This argument is used only for this single call and does not alter pymovements.Dataset.events_rootpath().
verbose (int) – Verbosity level (0: no print output, 1: show progress bar, 2: print saved filepaths) (default: 1)
extension (str) – Specifies the file format for loading data. Valid options are: csv, feather. (default: ‘feather’)

Raises:

ValueError – If extension is not in list of valid extensions.