Skip to main content
Ctrl+K
pymovements  documentation - Home

Site Navigation

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

Site Navigation

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

Section Navigation

  • pymovements.dataset
    • pymovements.dataset.Dataset
      • pymovements.dataset.Dataset.__init__
      • pymovements.dataset.Dataset.apply
      • pymovements.dataset.Dataset.clear_events
      • pymovements.dataset.Dataset.compute_event_properties
      • pymovements.dataset.Dataset.compute_properties
      • pymovements.dataset.Dataset.detect
      • pymovements.dataset.Dataset.detect_events
      • pymovements.dataset.Dataset.download
      • pymovements.dataset.Dataset.extract
      • pymovements.dataset.Dataset.load
      • pymovements.dataset.Dataset.load_event_files
      • pymovements.dataset.Dataset.load_gaze_files
      • pymovements.dataset.Dataset.pix2deg
      • pymovements.dataset.Dataset.pos2acc
      • pymovements.dataset.Dataset.pos2vel
      • pymovements.dataset.Dataset.save
      • pymovements.dataset.Dataset.save_events
      • pymovements.dataset.Dataset.save_preprocessed
      • pymovements.dataset.Dataset.scan
    • pymovements.dataset.DatasetDefinition
      • pymovements.dataset.DatasetDefinition.__init__
    • pymovements.dataset.DatasetLibrary
      • pymovements.dataset.DatasetLibrary.__init__
      • pymovements.dataset.DatasetLibrary.add
      • pymovements.dataset.DatasetLibrary.get
    • pymovements.dataset.DatasetPaths
      • pymovements.dataset.DatasetPaths.__init__
      • pymovements.dataset.DatasetPaths.fill_name
      • pymovements.dataset.DatasetPaths.get_preprocessed_filepath
      • pymovements.dataset.DatasetPaths.raw_to_event_filepath
  • pymovements.datasets
    • pymovements.datasets.GazeBase
      • pymovements.datasets.GazeBase.__init__
    • pymovements.datasets.GazeBaseVR
      • pymovements.datasets.GazeBaseVR.__init__
    • pymovements.datasets.GazeGraph
      • pymovements.datasets.GazeGraph.__init__
    • pymovements.datasets.GazeOnFaces
      • pymovements.datasets.GazeOnFaces.__init__
    • pymovements.datasets.HBN
      • pymovements.datasets.HBN.__init__
    • pymovements.datasets.JuDo1000
      • pymovements.datasets.JuDo1000.__init__
    • pymovements.datasets.PoTeC
      • pymovements.datasets.PoTeC.__init__
    • pymovements.datasets.SBSAT
      • pymovements.datasets.SBSAT.__init__
    • pymovements.datasets.ToyDataset
      • pymovements.datasets.ToyDataset.__init__
    • pymovements.datasets.ToyDatasetEyeLink
      • pymovements.datasets.ToyDatasetEyeLink.__init__
  • pymovements.events
    • pymovements.events.EventDataFrame
      • pymovements.events.EventDataFrame.__init__
      • pymovements.events.EventDataFrame.add_event_properties
      • pymovements.events.EventDataFrame.copy
    • pymovements.events.EventProcessor
    • pymovements.events.EventGazeProcessor
    • pymovements.events.idt
    • pymovements.events.ivt
    • pymovements.events.microsaccades
    • pymovements.events.fill
    • pymovements.events.amplitude
    • pymovements.events.duration
    • pymovements.events.dispersion
    • pymovements.events.disposition
    • pymovements.events.peak_velocity
    • pymovements.events.location
  • 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.apply
      • pymovements.gaze.GazeDataFrame.copy
      • pymovements.gaze.GazeDataFrame.detect
      • pymovements.gaze.GazeDataFrame.nest
      • pymovements.gaze.GazeDataFrame.pix2deg
      • pymovements.gaze.GazeDataFrame.pos2acc
      • pymovements.gaze.GazeDataFrame.pos2vel
      • pymovements.gaze.GazeDataFrame.smooth
      • pymovements.gaze.GazeDataFrame.transform
      • pymovements.gaze.GazeDataFrame.unnest
    • pymovements.gaze.transforms.center_origin
    • pymovements.gaze.transforms.downsample
    • pymovements.gaze.transforms.norm
    • pymovements.gaze.transforms.pix2deg
    • pymovements.gaze.transforms.pos2acc
    • pymovements.gaze.transforms.pos2vel
    • pymovements.gaze.transforms.savitzky_golay
    • pymovements.gaze.transforms_numpy.pix2deg
    • pymovements.gaze.transforms_numpy.pos2acc
    • pymovements.gaze.transforms_numpy.pos2vel
    • pymovements.gaze.transforms_numpy.norm
    • pymovements.gaze.transforms_numpy.split
    • pymovements.gaze.transforms_numpy.downsample
    • pymovements.gaze.transforms_numpy.consecutive
  • pymovements.plotting
    • pymovements.plotting.heatmap
    • pymovements.plotting.main_sequence_plot
    • 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_greater_than_zero
      • pymovements.utils.checks.check_is_int
      • 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_is_not_none
      • pymovements.utils.checks.check_is_positive_value
      • pymovements.utils.checks.check_is_scalar
      • pymovements.utils.checks.check_nan_both_channels
      • pymovements.utils.checks.check_no_zeros
      • pymovements.utils.checks.check_shapes
      • 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.compile_patterns
      • pymovements.utils.parsing.get_additional_columns
      • pymovements.utils.parsing.parse_eyelink
    • pymovements.utils.paths
      • pymovements.utils.paths.get_filepaths
      • pymovements.utils.paths.match_filepaths
  • API Reference
  • pymovements.utils.parsing
  • pymovements....

pymovements.utils.parsing.parse_eyelink#

pymovements.utils.parsing.parse_eyelink(filepath: Path | str, patterns: list[dict[str, Any]] | None = None, schema: dict[str, Any] | None = None) → pl.DataFrame[source]#

Process EyeLink asc file.

Parameters:
  • filepath (Path | str) – file name of ascii file to convert.

  • patterns (list[dict[str, Any]] | None) – list of patterns to match for additional columns. (default: None)

  • schema (dict[str, Any] | None) – Dictionary to optionally specify types of columns parsed by patterns. (default: None)

Returns:

Returns parsed eyelink polars dataframe.

Return type:

pl.DataFrame

previous

pymovements.utils.parsing.get_additional_columns

next

pymovements.utils.paths

On this page
  • parse_eyelink()
Show Source

© Copyright 2022-2023 The pymovements Project Authors.

Created using Sphinx 7.2.6.

Built with the PyData Sphinx Theme 0.14.4.