Skip to content

Events / alignment / multimodal

TTL extraction, event matching, cross-stream synchronization, shared timebases, multimodal windows, and trial-level alignment.

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

Open workflow All API domains Complete reference

Functions

align_gazepoint_biometrics_to_ttl

align_gazepoint_biometrics_to_ttl(data, ttl_cols=None, event_col=None, ttl_valid_col=None, time_col=None, sample_col=None, group_cols=None, participant_col=None, stimulus_col=None, trial_col=None, event_value=None, valid_values=(True, 1, '1'), event_edge='rising', pre_window_ms=1000, post_window_ms=5000, pre_window_samples=None, post_window_samples=None, collapse_nearby_ms=0, require_valid_ttl=True)

align_gazepoint_streams_by_events

align_gazepoint_streams_by_events(reference, target, reference_events, target_events, reference_time_col=None, target_time_col=None, reference_event_time_col=None, target_event_time_col=None, event_id_col=None, method='linear', include_streams=True)

align_gazepoint_to_eeg

align_gazepoint_to_eeg(gazepoint, gazepoint_events, eeg_events, gazepoint_time_col=None, gazepoint_event_time_col=None, eeg_event_time_col=None, eeg_event_sample_col=None, gazepoint_event_id_col=None, eeg_event_id_col=None, gazepoint_time_unit='auto', eeg_time_unit='auto', eeg_sampling_rate_hz=None, method='offset', match_by='auto', robust=True, maximum_residual_s=None, residual_action='error', output_col='time_eeg_s')

audit_gazepoint_biometric_sync_drift

audit_gazepoint_biometric_sync_drift(data, time_col=None, group_cols=None, signal_pairs=None, signal_cols=None, reference_signal_col=None, max_lag=1000, lag_step=None, drift_tolerance=None, method='pearson', min_complete_pairs=20, use_first_difference=False, include_reset_segments=True)

audit_gazepoint_event_coverage

audit_gazepoint_event_coverage(data, event_col, participant_col=None, trial_col=None, unit_cols=None, expected_events=None)

chunk_gazepoint_biometrics

chunk_gazepoint_biometrics(dat, time_col='CNT', group_cols=None, chunk_seconds=60, start_time=None, chunk_col='chunk_id', episode_col='episode_id', include_partial=False)

compute_gazepoint_signal_lag_matrix

compute_gazepoint_signal_lag_matrix(data, signal_cols=None, time_col=None, group_cols=None, max_lag_s=2, lag_step_s=None, min_overlap=10)

create_gazepoint_trial_regressors

create_gazepoint_trial_regressors(data, design, pre=0, post=5, time_col=None, event_time_col=None, event_id_col=None, signal_cols=None, subject_col=None, design_subject_col=None, carry_design_cols=None)

detect_gazepoint_biometric_timebase

detect_gazepoint_biometric_timebase(data, time_col=None, counter_col=None)

diagnose_gazepoint_sync_drift

diagnose_gazepoint_sync_drift(reference, target=None, reference_time_col=None, target_time_col=None, max_pairs=None)

estimate_gazepoint_signal_lag

estimate_gazepoint_signal_lag(data, signal_x_col, signal_y_col, time_col=None, group_cols=None, max_lag=1000, lag_step=None, method='pearson', min_complete_pairs=20, use_first_difference=False)

extract_gazepoint_ttl_events

extract_gazepoint_ttl_events(data, ttl_columns=None, group_columns=None, validity_column='TTLV', require_validity=True, mode='changes', include_initial=True)

import_gazepoint_event_log

import_gazepoint_event_log(path, time_col=None, event_col=None, id_col=None, sep=None, **kwargs)

match_gazepoint_events_to_biometrics

match_gazepoint_events_to_biometrics(data, events, pre=0, post=5, time_col=None, event_time_col=None, event_id_col=None, summary_cols=None, return_='windows', **kwargs)

plot_gazepoint_multimodal_timeline

plot_gazepoint_multimodal_timeline(data, time_col=None, signal_cols=None, group_cols=None, participant_col=None, stimulus_col=None, trial_col=None, event_time_col=None, event_col=None, standardise=True, show_event_markers=True, title=None)

prepare_gazepoint_multimodal_model_data

prepare_gazepoint_multimodal_model_data(biometrics, eye_tracking=None, group_columns=None, biometric_is_summarised=False, by=None, all=False)

simulate_gazepoint_multimodal_data

simulate_gazepoint_multimodal_data(n=None, duration_s=20, sampling_rate_hz=50, seed=1, participant='P01', n_trials=4)

summarise_gazepoint_multimodal_windows

summarise_gazepoint_multimodal_windows(data, group_columns=None, exclude_zero=True)

summarize_gazepoint_eventlocked_multimodal

summarize_gazepoint_eventlocked_multimodal(data, events, time_col=None, event_time_col=None, event_id_col=None, group_cols=None, signal_cols=None, pre_s=1, post_s=3, baseline_window_s=(-1, 0), summary_window_s=(0, 3))