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.Dataset
        • pymovements.datasets.dataset.Dataset.__init__
        • pymovements.datasets.dataset.Dataset.clear_events
        • pymovements.datasets.dataset.Dataset.compute_event_properties
        • pymovements.datasets.dataset.Dataset.detect_events
        • pymovements.datasets.dataset.Dataset.infer_fileinfo
        • pymovements.datasets.dataset.Dataset.load
        • pymovements.datasets.dataset.Dataset.load_event_files
        • pymovements.datasets.dataset.Dataset.load_gaze_files
        • pymovements.datasets.dataset.Dataset.pix2deg
        • pymovements.datasets.dataset.Dataset.pos2vel
        • pymovements.datasets.dataset.Dataset.save
        • pymovements.datasets.dataset.Dataset.save_events
        • pymovements.datasets.dataset.Dataset.save_preprocessed
        • pymovements.datasets.dataset.Dataset.take_subset
    • pymovements.datasets.gazebase
      • pymovements.datasets.gazebase.GazeBase
        • pymovements.datasets.gazebase.GazeBase.__init__
        • pymovements.datasets.gazebase.GazeBase.clear_events
        • pymovements.datasets.gazebase.GazeBase.compute_event_properties
        • pymovements.datasets.gazebase.GazeBase.detect_events
        • pymovements.datasets.gazebase.GazeBase.download
        • pymovements.datasets.gazebase.GazeBase.extract
        • pymovements.datasets.gazebase.GazeBase.infer_fileinfo
        • pymovements.datasets.gazebase.GazeBase.load
        • pymovements.datasets.gazebase.GazeBase.load_event_files
        • pymovements.datasets.gazebase.GazeBase.load_gaze_files
        • pymovements.datasets.gazebase.GazeBase.pix2deg
        • pymovements.datasets.gazebase.GazeBase.pos2vel
        • pymovements.datasets.gazebase.GazeBase.save
        • pymovements.datasets.gazebase.GazeBase.save_events
        • pymovements.datasets.gazebase.GazeBase.save_preprocessed
        • pymovements.datasets.gazebase.GazeBase.take_subset
    • pymovements.datasets.judo1000
      • pymovements.datasets.judo1000.JuDo1000
        • pymovements.datasets.judo1000.JuDo1000.__init__
        • pymovements.datasets.judo1000.JuDo1000.clear_events
        • pymovements.datasets.judo1000.JuDo1000.compute_event_properties
        • pymovements.datasets.judo1000.JuDo1000.detect_events
        • pymovements.datasets.judo1000.JuDo1000.download
        • pymovements.datasets.judo1000.JuDo1000.extract
        • pymovements.datasets.judo1000.JuDo1000.infer_fileinfo
        • pymovements.datasets.judo1000.JuDo1000.load
        • pymovements.datasets.judo1000.JuDo1000.load_event_files
        • pymovements.datasets.judo1000.JuDo1000.load_gaze_files
        • pymovements.datasets.judo1000.JuDo1000.pix2deg
        • pymovements.datasets.judo1000.JuDo1000.pos2vel
        • pymovements.datasets.judo1000.JuDo1000.save
        • pymovements.datasets.judo1000.JuDo1000.save_events
        • pymovements.datasets.judo1000.JuDo1000.save_preprocessed
        • pymovements.datasets.judo1000.JuDo1000.take_subset
    • pymovements.datasets.public_dataset
      • pymovements.datasets.public_dataset.PublicDataset
        • pymovements.datasets.public_dataset.PublicDataset.__init__
        • pymovements.datasets.public_dataset.PublicDataset.clear_events
        • pymovements.datasets.public_dataset.PublicDataset.compute_event_properties
        • pymovements.datasets.public_dataset.PublicDataset.detect_events
        • pymovements.datasets.public_dataset.PublicDataset.download
        • pymovements.datasets.public_dataset.PublicDataset.extract
        • pymovements.datasets.public_dataset.PublicDataset.infer_fileinfo
        • pymovements.datasets.public_dataset.PublicDataset.load
        • pymovements.datasets.public_dataset.PublicDataset.load_event_files
        • pymovements.datasets.public_dataset.PublicDataset.load_gaze_files
        • pymovements.datasets.public_dataset.PublicDataset.pix2deg
        • pymovements.datasets.public_dataset.PublicDataset.pos2vel
        • pymovements.datasets.public_dataset.PublicDataset.save
        • pymovements.datasets.public_dataset.PublicDataset.save_events
        • pymovements.datasets.public_dataset.PublicDataset.save_preprocessed
        • pymovements.datasets.public_dataset.PublicDataset.take_subset
    • pymovements.datasets.toy_dataset
      • pymovements.datasets.toy_dataset.ToyDataset
        • pymovements.datasets.toy_dataset.ToyDataset.__init__
        • pymovements.datasets.toy_dataset.ToyDataset.clear_events
        • pymovements.datasets.toy_dataset.ToyDataset.compute_event_properties
        • pymovements.datasets.toy_dataset.ToyDataset.detect_events
        • pymovements.datasets.toy_dataset.ToyDataset.download
        • pymovements.datasets.toy_dataset.ToyDataset.extract
        • pymovements.datasets.toy_dataset.ToyDataset.infer_fileinfo
        • pymovements.datasets.toy_dataset.ToyDataset.load
        • pymovements.datasets.toy_dataset.ToyDataset.load_event_files
        • pymovements.datasets.toy_dataset.ToyDataset.load_gaze_files
        • pymovements.datasets.toy_dataset.ToyDataset.pix2deg
        • pymovements.datasets.toy_dataset.ToyDataset.pos2vel
        • pymovements.datasets.toy_dataset.ToyDataset.save
        • pymovements.datasets.toy_dataset.ToyDataset.save_events
        • pymovements.datasets.toy_dataset.ToyDataset.save_preprocessed
        • pymovements.datasets.toy_dataset.ToyDataset.take_subset
  • pymovements.events
    • pymovements.events.engbert
      • pymovements.events.engbert.compute_threshold
      • pymovements.events.engbert.microsaccades
    • pymovements.events.event_processing
      • pymovements.events.event_processing.EventGazeProcessor
        • pymovements.events.event_processing.EventGazeProcessor.__init__
        • pymovements.events.event_processing.EventGazeProcessor.process
      • pymovements.events.event_processing.EventProcessor
        • pymovements.events.event_processing.EventProcessor.__init__
        • pymovements.events.event_processing.EventProcessor.process
    • pymovements.events.event_properties
      • pymovements.events.event_properties.amplitude
      • pymovements.events.event_properties.dispersion
      • pymovements.events.event_properties.disposition
      • pymovements.events.event_properties.duration
      • pymovements.events.event_properties.peak_velocity
      • pymovements.events.event_properties.register_event_property
    • pymovements.events.events
      • pymovements.events.events.EventDataFrame
        • pymovements.events.events.EventDataFrame.__init__
        • pymovements.events.events.EventDataFrame.add_event_properties
      • pymovements.events.events.EventDetectionCallable
        • pymovements.events.events.EventDetectionCallable.__init__
    • pymovements.events.idt
    • pymovements.events.ivt
  • pymovements.gaze
    • pymovements.gaze.experiment
      • pymovements.gaze.experiment.Experiment
        • pymovements.gaze.experiment.Experiment.__init__
        • pymovements.gaze.experiment.Experiment.pos2vel
    • pymovements.gaze.gaze_dataframe
      • pymovements.gaze.gaze_dataframe.GazeDataFrame
        • pymovements.gaze.gaze_dataframe.GazeDataFrame.__init__
        • pymovements.gaze.gaze_dataframe.GazeDataFrame.pix2deg
        • pymovements.gaze.gaze_dataframe.GazeDataFrame.pos2vel
    • pymovements.gaze.screen
      • pymovements.gaze.screen.Screen
        • pymovements.gaze.screen.Screen.__init__
        • pymovements.gaze.screen.Screen.pix2deg
    • pymovements.gaze.transforms
      • pymovements.gaze.transforms.consecutive
      • pymovements.gaze.transforms.downsample
      • pymovements.gaze.transforms.norm
      • pymovements.gaze.transforms.pix2deg
      • pymovements.gaze.transforms.pos2vel
      • pymovements.gaze.transforms.split
  • pymovements.plotting
    • pymovements.plotting.traceplot
    • pymovements.plotting.tsplot
  • 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.paths
      • pymovements.utils.paths.get_filepaths
      • pymovements.utils.paths.match_filepaths
  • API Reference

API Reference#

pymovements.datasets

This module provides access to publicly available datasets.

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

Working with Datasets

next

pymovements.datasets

Show Source

© Copyright 2022-2023 The pymovements Project Authors.

Created using Sphinx 6.1.3.

Built with the PyData Sphinx Theme 0.13.1.