pymovements.Gaze.save

Gaze.save(dirname: str | Path, save_events: bool = True, save_samples: bool = True, save_experiment: bool = True, verbose: int = 1, extension: str = 'feather') → Gaze

Save preprocessed gaze in samples, events and experiment files in the provides directory.

Data will be saved as feather/csv files to the provided directory.

Returns:

Returns self, useful for method cascading.

Return type:

Gaze

Parameters:

• dirname (str) – Absloute directory name to save data. This argument is used only for this single call and does not alter pymovements.Dataset.events_rootpath().

• save_events (bool) – Save events in events.{extension} file

• save_samples (bool) – Save samples in sample.{extension} file

• save_experiment (bool) – Save experiment metadata in experiment.yaml file

• verbose (int) – Verbosity level (0: no print output, 1: show progress bar, 2: print saved filepaths) (default: 1)

• extension (str) – Extension specifies the fileformat to store the data. (default: ‘feather’)