Skip to main content
Ctrl+K
pymovements  documentation - Home pymovements  documentation - Home
  • User Guide
  • Tutorials
  • Datasets
  • API Reference
  • Contributing
    • About Us
    • Bibliography
  • GitHub
  • User Guide
  • Tutorials
  • Datasets
  • API Reference
  • Contributing
  • About Us
  • Bibliography
  • GitHub

Section Navigation

  • Dataset
    • Dataset
      • pymovements.Dataset.__init__
      • pymovements.Dataset.apply
      • pymovements.Dataset.clear_events
      • pymovements.Dataset.clip
      • pymovements.Dataset.compute_event_properties
      • pymovements.Dataset.compute_properties
      • pymovements.Dataset.deg2pix
      • pymovements.Dataset.detect
      • pymovements.Dataset.detect_events
      • pymovements.Dataset.download
      • pymovements.Dataset.drop_event_properties
      • pymovements.Dataset.extract
      • pymovements.Dataset.load
      • pymovements.Dataset.load_event_files
      • pymovements.Dataset.load_gaze_files
      • pymovements.Dataset.load_participants
      • pymovements.Dataset.load_precomputed_events
      • pymovements.Dataset.load_precomputed_reading_measures
      • pymovements.Dataset.load_stimuli
      • pymovements.Dataset.pix2deg
      • pymovements.Dataset.pos2acc
      • pymovements.Dataset.pos2vel
      • pymovements.Dataset.resample
      • pymovements.Dataset.save
      • pymovements.Dataset.save_events
      • pymovements.Dataset.save_preprocessed
      • pymovements.Dataset.scan
      • pymovements.Dataset.scan_participants
      • pymovements.Dataset.split_gaze_data
      • pymovements.Dataset.split_precomputed_events
    • DatasetDefinition
      • pymovements.DatasetDefinition.__init__
      • pymovements.DatasetDefinition.from_yaml
      • pymovements.DatasetDefinition.to_dict
      • pymovements.DatasetDefinition.to_yaml
    • DatasetLibrary
      • pymovements.DatasetLibrary.__init__
      • pymovements.DatasetLibrary.add
      • pymovements.DatasetLibrary.get
      • pymovements.DatasetLibrary.names
    • DatasetPaths
      • pymovements.DatasetPaths.__init__
      • pymovements.DatasetPaths.fill_name
      • pymovements.DatasetPaths.get_preprocessed_filepath
      • pymovements.DatasetPaths.raw_to_event_filepath
    • ResourceDefinition
      • pymovements.ResourceDefinition.__init__
      • pymovements.ResourceDefinition.from_dict
      • pymovements.ResourceDefinition.to_dict
    • ResourceDefinitions
      • pymovements.ResourceDefinitions.__init__
      • pymovements.ResourceDefinitions.append
      • pymovements.ResourceDefinitions.clear
      • pymovements.ResourceDefinitions.copy
      • pymovements.ResourceDefinitions.count
      • pymovements.ResourceDefinitions.extend
      • pymovements.ResourceDefinitions.filter
      • pymovements.ResourceDefinitions.from_dict
      • pymovements.ResourceDefinitions.from_dicts
      • pymovements.ResourceDefinitions.has_content
      • pymovements.ResourceDefinitions.index
      • pymovements.ResourceDefinitions.insert
      • pymovements.ResourceDefinitions.pop
      • pymovements.ResourceDefinitions.remove
      • pymovements.ResourceDefinitions.reverse
      • pymovements.ResourceDefinitions.sort
      • pymovements.ResourceDefinitions.to_dicts
    • WebSource
      • pymovements.WebSource.__init__
      • pymovements.WebSource.download
      • pymovements.WebSource.from_dict
      • pymovements.WebSource.to_dict
    • Participants
      • pymovements.Participants.__init__
      • pymovements.Participants.load
      • pymovements.Participants.save
      • pymovements.Participants.update
  • Metadata
    • Experiment
      • pymovements.Experiment.__init__
      • pymovements.Experiment.from_dict
      • pymovements.Experiment.pos2vel
      • pymovements.Experiment.to_dict
      • pymovements.Experiment.to_yaml
    • Screen
      • pymovements.Screen.__init__
      • pymovements.Screen.pix2deg
      • pymovements.Screen.to_dict
    • EyeTracker
      • pymovements.EyeTracker.__init__
      • pymovements.EyeTracker.to_dict
  • Gaze
    • Gaze
      • pymovements.Gaze.__init__
      • pymovements.Gaze.apply
      • pymovements.Gaze.clip
      • pymovements.Gaze.clone
      • pymovements.Gaze.compute_event_properties
      • pymovements.Gaze.deg2pix
      • pymovements.Gaze.detect
      • pymovements.Gaze.drop_event_properties
      • pymovements.Gaze.map_to_aois
      • pymovements.Gaze.measure_events_ratio
      • pymovements.Gaze.measure_samples
      • pymovements.Gaze.nest
      • pymovements.Gaze.nullify_event_samples
      • pymovements.Gaze.pix2deg
      • pymovements.Gaze.pos2acc
      • pymovements.Gaze.pos2vel
      • pymovements.Gaze.resample
      • pymovements.Gaze.save
      • pymovements.Gaze.save_calibrations
      • pymovements.Gaze.save_events
      • pymovements.Gaze.save_messages
      • pymovements.Gaze.save_samples
      • pymovements.Gaze.save_validations
      • pymovements.Gaze.smooth
      • pymovements.Gaze.split
      • pymovements.Gaze.transform
      • pymovements.Gaze.unnest
    • GazeDataFrame
      • pymovements.GazeDataFrame.__init__
    • from_asc
    • from_csv
    • from_ipc
    • from_numpy
    • from_pandas
  • Events
    • Events
      • pymovements.Events.__init__
      • pymovements.Events.add_event_properties
      • pymovements.Events.add_trial_column
      • pymovements.Events.clone
      • pymovements.Events.copy
      • pymovements.Events.drop
      • pymovements.Events.filter_by_name
      • pymovements.Events.map_to_aois
      • pymovements.Events.merge_subsequent_close_events
      • pymovements.Events.split
      • pymovements.Events.unnest
    • EventDataFrame
      • pymovements.EventDataFrame.__init__
    • idt
    • ivt
    • microsaccades
    • blink
    • fill
  • Transforms
    • center_origin
    • downsample
    • norm
    • pix2deg
    • deg2pix
    • pos2acc
    • pos2vel
    • savitzky_golay
    • events2segmentation
    • events2timeratio
    • segmentation2events
    • pix2deg
    • pos2acc
    • pos2vel
    • norm
    • split
    • downsample
    • consecutive
  • Measures
    • amplitude
    • bcea
    • data_loss
    • dispersion
    • disposition
    • location
    • null_ratio
    • peak_velocity
    • rms_s2s
    • std_rms
    • SampleMeasureLibrary
      • pymovements.measure.samples.SampleMeasureLibrary.__init__
      • pymovements.measure.samples.SampleMeasureLibrary.add
      • pymovements.measure.samples.SampleMeasureLibrary.get
    • duration
    • EventProcessor
      • pymovements.measure.events.EventProcessor.__init__
      • pymovements.measure.events.EventProcessor.process
    • EventSamplesProcessor
      • pymovements.measure.events.EventSamplesProcessor.__init__
      • pymovements.measure.events.EventSamplesProcessor.process
    • ReadingMeasures
      • pymovements.measure.reading.ReadingMeasures.__init__
  • Stimulus
    • ImageStimulus
      • pymovements.stimulus.ImageStimulus.__init__
      • pymovements.stimulus.ImageStimulus.from_file
      • pymovements.stimulus.ImageStimulus.show
    • TextStimulus
      • pymovements.stimulus.TextStimulus.__init__
      • pymovements.stimulus.TextStimulus.from_csv
      • pymovements.stimulus.TextStimulus.get_aoi
      • pymovements.stimulus.TextStimulus.split
    • WritingSystem
      • pymovements.stimulus.WritingSystem.__init__
      • pymovements.stimulus.WritingSystem.from_descriptor
    • from_file
    • from_files
    • from_file
  • Synthetic
    • step_function
  • Plotting
    • heatmap
    • main_sequence_plot
    • scanpathplot
    • traceplot
    • tsplot
  • Extending the API
    • register_dataset
    • register_sample_measure
  • API Reference

API Reference#

Dataset

Overview of the Dataset class

Metadata

Overview of the different types of metadata

Gaze

Overview of the Gaze class

Events

Overview of the Events class

Transforms

Overview of transformation functions

Measures

Overview of eye movement measures

Stimulus

Overview of stimulus classes

Synthetic

Overview of data generation functionality

Plotting

Overview of plotting functionality

Extending the API

Overview on how to extend pymovements with your own functions

previous

UCL

next

Dataset

Show Source

© Copyright 2022-2025 The pymovements Project Authors.

Created using Sphinx 8.2.3.

Built with the PyData Sphinx Theme 0.18.0.