API reference

This section documents every public Pyxations module, class and function. Docstrings are rendered automatically from the source, so what you read here is what the installed package provides.

The pages follow the order of the pipeline itself: recordings are converted to raw BIDS, segmented into trials, annotated with detected eye movements, and then loaded back for analysis and plotting.

Page	What it covers
Conversion to BIDS	Reading vendor recordings and behavioral tables, and writing the raw BIDS dataset
Preprocessing	Trial segmentation, bad-sample marking and provenance recipes
Event detection	Fixation, saccade and blink detection algorithms
Analysis	The experiment, subject, session and trial hierarchy
Visual search	The search-task specialization of that hierarchy
Visualization	Scanpaths, summary panels, calibration plots and animations
Data storage	The canonical table container and the BIDS derivative reader and writer

Top-level entry points

The most common entry points are re-exported from the package root:

from pyxations import (
    dataset_to_bids,
    read_behavioral_events,
    psychopy_log_to_events,
    compute_derivatives_for_dataset,
    validate_bids_dataset,
    BIDSValidationError,
    PreProcessing,
    EngbertDetection,
    Visualization,
    SampleVisualization,
    Experiment,
    VisualSearchExperiment,
    BIDSDerivativeExport,
    SessionTables,
)

RemodnavDetection is also available from the package root after installing the remodnav extra:

from pyxations import RemodnavDetection