Skip to content

Interoperability / exchange formats

BIDS, MNE, EEG/LSL, XDF, external package manifests, cross-package handoffs, and export/import bridges.

18 functions from the frozen 406-function contract are routed here by the documentation classifier.

Open workflow All API domains Complete reference

Functions

audit_gazepoint_interoperability_versions

audit_gazepoint_interoperability_versions(manifest=None, include_python=True, strict=False)

check_gazepoint_bids

check_gazepoint_bids(root, subject_pattern='^sub-[A-Za-z0-9]+$', recursive=True, expected_files=('dataset_description.json', 'participants.tsv'), gazepoint_patterns=('all[_-]?gaze', 'fixation', 'summary', 'biometric', 'eda', 'gsr', 'ecg', 'ppg', 'hr', 'ibi'))

create_gazepoint_sidecar_template

create_gazepoint_sidecar_template(dataset_id=None, export_type=None, include_optional=True, custom_fields=None)

estimate_gazepoint_lsl_clock_offsets

estimate_gazepoint_lsl_clock_offsets(stream_name=None, stream_type=None, source_id=None, timeout_s=5, n_estimates=5, pause_s=0.05, python=None, execute=True)

export_gazepoint_mne_cluster_input

export_gazepoint_mne_cluster_input(data, outcome_col, time_col, condition_col, participant_col, condition_a=None, condition_b=None, path=None, prefix='gazepoint_mne_cluster', overwrite=False, aggregate=True)

export_gazepoint_permuco_cluster_input

export_gazepoint_permuco_cluster_input(data, outcome_col, time_col, condition_col, participant_col, path=None, prefix='gazepoint_permuco_cluster', overwrite=False, aggregate=True)

export_gazepoint_permutes_cluster_input

export_gazepoint_permutes_cluster_input(data, outcome_col, time_col, condition_col, participant_col, path=None, prefix='gazepoint_permutes_cluster', overwrite=False, aggregate=True)

export_gazepoint_to_bids

export_gazepoint_to_bids(data, bids_root, subject, task, dataset_name=None, recorded_eye='cyclopean', recording='eye1', datatype='beh', session=None, acquisition=None, run=None, timestamp_col=None, x_col=None, y_col=None, include_pupil=True, pupil_col=None, additional_cols=None, timestamp_units='auto', coordinate_units='normalized', pupil_units='arbitrary', sample_coordinate_system='gaze-on-screen', sampling_rate_hz=None, sampling_tolerance=0.05, start_time_s=0, screen_distance_m=None, screen_origin=None, screen_resolution_px=None, screen_size_m=None, screen_refresh_rate_hz=None, stimulus_software_name=None, stimulus_software_version=None, operating_system=None, vision_correction=None, manufacturer='Gazepoint', manufacturers_model_name=None, software_versions=None, device_serial_number=None, eye_tracking_method='P-CR', calibration_type=None, calibration_count=None, average_calibration_error_deg=None, maximal_calibration_error_deg=None, eye_tracker_distance_m=None, raw_data_filters=None, timestamp_origin='Eye-tracker clock', custom_coordinate_system_description=None, column_metadata=None, bids_version='1.11.1', dry_run=False, overwrite=False)

gazepoint_interoperability_manifest

gazepoint_interoperability_manifest(include_support=True)

import_gazepoint_lsl_xdf

import_gazepoint_lsl_xdf(path, stream_name_pattern='Gazepoint|GP3|GSR|EDA|Biometric|TTL|Pupil|Gaze', include_all_streams=False, flatten=True, pyxdf_module='pyxdf')

join_gazepoint_biometrics_to_gp3tools

join_gazepoint_biometrics_to_gp3tools(biometrics, gp3tools_master, *args, **kwargs)

prepare_gazepoint_bids_eye

prepare_gazepoint_bids_eye(data, execute=True, **kwargs)

prepare_gazepoint_bids_physio

prepare_gazepoint_bids_physio(data, execute=True, **kwargs)

prepare_gazepoint_mne_events

prepare_gazepoint_mne_events(events, event_time_col=None, event_label_col=None, event_code_col=None, marker_cols=None, participant_col=None, trial_col=None, time_unit='auto', sampling_rate_hz=None, recording_start_s=0, first_samp=0, event_id=None, previous_value=0, marker_onset='change', duplicate='error', export_csv=None)

prepare_gazepoint_mne_input

prepare_gazepoint_mne_input(data, channel_cols=None, channel_names=None, channel_types=None, time_col=None, time_unit='auto', sampling_rate_hz=None, first_samp=0, scale_factors=None, missing='error', irregular='error', sampling_tolerance=0.05)

sync_gazepoint_signals_via_lsl

sync_gazepoint_signals_via_lsl(streams, reference=None, time_cols=None, clock_offsets_s=None, known_lags_s=None, relative_zero='reference', dejitter='none', nominal_rates_hz=None, merge='none', tolerance_s=None)

write_gazepoint_interoperability_audit

write_gazepoint_interoperability_audit(x, output_dir, prefix='gpbiometrics-interoperability', overwrite=False)

write_gazepoint_mne_fif

write_gazepoint_mne_fif(x, fname, events=None, overwrite=False, fmt='single', python=None, execute=True, keep_intermediate=False, verbose=False, **kwargs)