Skip to main content
Ctrl+K
Logo image

Site Navigation

  • Getting started
  • Tutorials
  • API Reference
  • Bibliography
  • Contributing

Site Navigation

  • Getting started
  • Tutorials
  • API Reference
  • Bibliography
  • Contributing

Section Navigation

  • pymovements.datasets
    • pymovements.datasets.Dataset
      • pymovements.datasets.Dataset.__init__
      • pymovements.datasets.Dataset.clear_events
      • pymovements.datasets.Dataset.compute_event_properties
      • pymovements.datasets.Dataset.detect_events
      • pymovements.datasets.Dataset.infer_fileinfo
      • pymovements.datasets.Dataset.load
      • pymovements.datasets.Dataset.load_event_files
      • pymovements.datasets.Dataset.load_gaze_files
      • pymovements.datasets.Dataset.pix2deg
      • pymovements.datasets.Dataset.pos2vel
      • pymovements.datasets.Dataset.save
      • pymovements.datasets.Dataset.save_events
      • pymovements.datasets.Dataset.save_preprocessed
      • pymovements.datasets.Dataset.take_subset
    • pymovements.datasets.PublicDataset
      • pymovements.datasets.PublicDataset.__init__
      • pymovements.datasets.PublicDataset.clear_events
      • pymovements.datasets.PublicDataset.compute_event_properties
      • pymovements.datasets.PublicDataset.detect_events
      • pymovements.datasets.PublicDataset.download
      • pymovements.datasets.PublicDataset.extract
      • pymovements.datasets.PublicDataset.infer_fileinfo
      • pymovements.datasets.PublicDataset.load
      • pymovements.datasets.PublicDataset.load_event_files
      • pymovements.datasets.PublicDataset.load_gaze_files
      • pymovements.datasets.PublicDataset.pix2deg
      • pymovements.datasets.PublicDataset.pos2vel
      • pymovements.datasets.PublicDataset.save
      • pymovements.datasets.PublicDataset.save_events
      • pymovements.datasets.PublicDataset.save_preprocessed
      • pymovements.datasets.PublicDataset.take_subset
    • pymovements.datasets.ToyDataset
      • pymovements.datasets.ToyDataset.__init__
      • pymovements.datasets.ToyDataset.clear_events
      • pymovements.datasets.ToyDataset.compute_event_properties
      • pymovements.datasets.ToyDataset.detect_events
      • pymovements.datasets.ToyDataset.download
      • pymovements.datasets.ToyDataset.extract
      • pymovements.datasets.ToyDataset.infer_fileinfo
      • pymovements.datasets.ToyDataset.load
      • pymovements.datasets.ToyDataset.load_event_files
      • pymovements.datasets.ToyDataset.load_gaze_files
      • pymovements.datasets.ToyDataset.pix2deg
      • pymovements.datasets.ToyDataset.pos2vel
      • pymovements.datasets.ToyDataset.save
      • pymovements.datasets.ToyDataset.save_events
      • pymovements.datasets.ToyDataset.save_preprocessed
      • pymovements.datasets.ToyDataset.take_subset
    • pymovements.datasets.GazeBase
      • pymovements.datasets.GazeBase.__init__
      • pymovements.datasets.GazeBase.clear_events
      • pymovements.datasets.GazeBase.compute_event_properties
      • pymovements.datasets.GazeBase.detect_events
      • pymovements.datasets.GazeBase.download
      • pymovements.datasets.GazeBase.extract
      • pymovements.datasets.GazeBase.infer_fileinfo
      • pymovements.datasets.GazeBase.load
      • pymovements.datasets.GazeBase.load_event_files
      • pymovements.datasets.GazeBase.load_gaze_files
      • pymovements.datasets.GazeBase.pix2deg
      • pymovements.datasets.GazeBase.pos2vel
      • pymovements.datasets.GazeBase.save
      • pymovements.datasets.GazeBase.save_events
      • pymovements.datasets.GazeBase.save_preprocessed
      • pymovements.datasets.GazeBase.take_subset
    • pymovements.datasets.JuDo1000
      • pymovements.datasets.JuDo1000.__init__
      • pymovements.datasets.JuDo1000.clear_events
      • pymovements.datasets.JuDo1000.compute_event_properties
      • pymovements.datasets.JuDo1000.detect_events
      • pymovements.datasets.JuDo1000.download
      • pymovements.datasets.JuDo1000.extract
      • pymovements.datasets.JuDo1000.infer_fileinfo
      • pymovements.datasets.JuDo1000.load
      • pymovements.datasets.JuDo1000.load_event_files
      • pymovements.datasets.JuDo1000.load_gaze_files
      • pymovements.datasets.JuDo1000.pix2deg
      • pymovements.datasets.JuDo1000.pos2vel
      • pymovements.datasets.JuDo1000.save
      • pymovements.datasets.JuDo1000.save_events
      • pymovements.datasets.JuDo1000.save_preprocessed
      • pymovements.datasets.JuDo1000.take_subset
  • pymovements.events
    • pymovements.events.EventDataFrame
      • pymovements.events.EventDataFrame.__init__
      • pymovements.events.EventDataFrame.add_event_properties
    • pymovements.events.EventDetectionCallable
      • pymovements.events.EventDetectionCallable.__init__
    • pymovements.events.EventProcessor
    • pymovements.events.EventGazeProcessor
    • pymovements.events.idt
    • pymovements.events.ivt
    • pymovements.events.microsaccades
    • pymovements.events.event_properties.duration
    • pymovements.events.event_properties.dispersion
    • pymovements.events.event_properties.disposition
    • pymovements.events.event_properties.amplitude
    • pymovements.events.event_properties.peak_velocity
  • pymovements.gaze
    • pymovements.gaze.Experiment
      • pymovements.gaze.Experiment.__init__
      • pymovements.gaze.Experiment.pos2vel
    • pymovements.gaze.Screen
      • pymovements.gaze.Screen.__init__
      • pymovements.gaze.Screen.pix2deg
    • pymovements.gaze.GazeDataFrame
      • pymovements.gaze.GazeDataFrame.__init__
      • pymovements.gaze.GazeDataFrame.pix2deg
      • pymovements.gaze.GazeDataFrame.pos2vel
    • pymovements.gaze.transforms.pix2deg
    • pymovements.gaze.transforms.pos2vel
    • pymovements.gaze.transforms.norm
    • pymovements.gaze.transforms.split
    • pymovements.gaze.transforms.downsample
    • pymovements.gaze.transforms.consecutive
  • pymovements.plotting
  • pymovements.synthetic
    • pymovements.synthetic.step_function
  • pymovements.utils
    • pymovements.utils.archives
      • pymovements.utils.archives.extract_archive
    • pymovements.utils.checks
      • pymovements.utils.checks.check_is_length_matching
      • pymovements.utils.checks.check_is_mutual_exclusive
      • pymovements.utils.checks.check_is_none_is_mutual
      • pymovements.utils.checks.check_nan_both_channels
      • pymovements.utils.checks.check_no_zeros
      • pymovements.utils.checks.check_shapes_positions_velocities
      • pymovements.utils.checks.check_two_kwargs
    • pymovements.utils.decorators
      • pymovements.utils.decorators.auto_str
    • pymovements.utils.downloads
      • pymovements.utils.downloads.download_and_extract_archive
      • pymovements.utils.downloads.download_file
    • pymovements.utils.filters
      • pymovements.utils.filters.events_split_nans
      • pymovements.utils.filters.filter_candidates_remove_nans
    • pymovements.utils.parsing
      • pymovements.utils.parsing.check_nan
      • pymovements.utils.parsing.get_eye_tracking_sample_feature
      • pymovements.utils.parsing.process_asc2csv
      • pymovements.utils.parsing.scolor
        • pymovements.utils.parsing.scolor.__init__
    • pymovements.utils.paths
      • pymovements.utils.paths.get_filepaths
      • pymovements.utils.paths.match_filepaths
  • API Reference

API Reference#

pymovements.datasets

This module provides access to dataset classes.

pymovements.events

This module holds all event related functionality.

pymovements.gaze

This module holds gaze time series related functionality.

pymovements.plotting

This module holds all plotting related functionality.

pymovements.synthetic

This module holds functionality for generating synthetic eye gaze data.

pymovements.utils

This module provides access to all utility functions.

previous

How to use pymovements in R

next

pymovements.datasets

Show Source

© Copyright 2022-2023 The pymovements Project Authors.

Created using Sphinx 5.3.0.

Built with the PyData Sphinx Theme 0.13.1.