Core I/O / schema / utilities¶
Import, schema detection, column standardization, manifests, metadata, general utilities, and functions that span multiple scientific domains.
58 functions from the frozen 406-function contract are routed here by the documentation classifier.
Recommended articles¶
Functions¶
anonymize_gazepoint_data¶
assert_gazepoint_columns¶
assess_gazepoint_sampling_irregularity¶
assess_gazepoint_sampling_irregularity(data, time_col=None, group_cols=None, nominal_rate_hz=None, large_gap_factor=3)
clean_gazepoint_rr_intervals¶
clean_gazepoint_rr_intervals(rr_ms, method='quotient', group_col='group', quotient_threshold=0.2, iqr_multiplier=1.5, z_threshold=3.5)
compute_gazepoint_engagement_index¶
compute_gazepoint_engagement_index(dial, time=None, threshold=50, group=None, return_='data', **kwargs)
compute_gazepoint_signal_band_power¶
compute_gazepoint_signal_correlation¶
compute_gazepoint_signal_phase_locking¶
compute_gazepoint_signal_power_spectrum¶
create_gazepoint_analysis_manifest¶
create_gazepoint_analysis_manifest(files=None, settings=None, outputs=None, exclusions=None, path=None, include_session=True)
create_gazepoint_dictionary¶
create_gazepoint_dictionary(data=None, file_paths=None, units=None, descriptions=None, required_cols=None, write_path=None)
create_gazepoint_methods_section¶
create_gazepoint_methods_section(export_profile=None, design_audit=None, event_audit=None, condition_audit=None, decision_log=None, package_version='2.0.0', validation=None, include_guardrails=True)
create_gazepoint_qc_supplement¶
create_gazepoint_qc_supplement(export_profile=None, design_audit=None, event_audit=None, condition_audit=None, decision_log=None, title='Gazepoint workflow quality-control supplement')
denoise_gazepoint_quantization_noise¶
denoise_gazepoint_quantization_noise(dat, signal_cols, resolution, group_cols=None, output_suffix='_quantization_jittered', seed=None, overwrite=False)
detect_active_biometric_channels¶
detect_gazepoint_biometric_schema¶
detect_gazepoint_blinks¶
detect_gazepoint_blinks(data, pupil_cols=None, id_cols=None, min_pupil=0, max_pupil=inf, change_threshold=None, extend_samples=0, mask=True, flag_suffix='_blink_flag', clean_suffix='_blink_clean')
detect_gazepoint_time_columns¶
diagnose_gazepoint_biometrics_workflow¶
diagnose_gazepoint_biometrics_workflow(workflow, require_gsr=True, require_hr=True, require_dial=False, max_exclude_window_pct=25, max_review_window_pct=25)
estimate_gazepoint_samplerate_datetime¶
estimate_gazepoint_samplerate_mstimer¶
extract_gazepoint_edr_pca¶
extract_gazepoint_edr_pca(dat, ecg_cols, time_col=None, group_cols=None, n_components=1, scale=True, output_prefix='edr_pca')
flag_gazepoint_rr_outliers¶
flag_gazepoint_rr_outliers(rr_intervals, method='mad', z_threshold=5, mad_threshold=5, min_rr=300, max_rr=2000, return_='flags', **kwargs)
generate_gazepoint_manifest¶
generate_gazepoint_manifest(input_paths=None, parameters=None, outputs=None, notes=None, write_path=None, include_session_info=True)
get_gazepoint_plot_data¶
get_gazepoint_plot_settings¶
gpbiometrics_info¶
import_gazepoint_biometric_folder¶
import_gazepoint_biometric_folder(path, pattern='\\.csv$', recursive=False, include_fixations=True, include_all_gaze=True, include_other_csv=False, na=('', 'NA', 'NaN'))
import_gazepoint_biometrics¶
import_gazepoint_data¶
import_gazepoint_data(dir, session=None, pattern='\\.csv$', recursive=False, session_match='prefix', file_encoding='UTF-8-BOM', add_file_info=True)
import_gazepoint_data_summary¶
join_gazepoint_biometrics_to_master¶
plot_gazepoint_biometric_signals¶
plot_gazepoint_biometric_signals(data, signal_cols=None, time_col=None, group_col=None, max_points=5000, standardize=False, type='line', main=None, xlab=None, ylab=None, legend=True, plot=True, **kwargs)
plot_gazepoint_design_coverage¶
plot_gazepoint_signal_activity¶
plot_gazepoint_signal_activity(data, signal_cols=None, group_cols=None, metric='active_signal', max_groups=30, title=None)
plot_gazepoint_time_resets¶
prepare_gazepoint_biometrics_lme_data¶
prepare_gazepoint_biometrics_lme_data(data, outcome_col, fixed_effect_cols=None, condition_cols=None, covariate_cols=None, random_effect_cols=None, participant_col=None, stimulus_col=None, trial_col=None, window_col=None, baseline_col=None, baseline_correct=False, factor_cols=None, continuous_cols=None, scale_continuous=False, include_window=True, drop_missing=True, min_rows=10)
prepare_gazepoint_biosppy_input¶
prepare_gazepoint_biosppy_input(data, signal_type='auto', signal_col=None, time_col=None, group_cols=None, sampling_rate_hz=None, missing='error', irregular='error', sampling_tolerance=0.05, min_segment_samples=3, signal_units=None, output_dir=None, prefix='gazepoint_biosppy', write_manifest=True, overwrite=False)
prepare_gazepoint_ctsi_input¶
prepare_gazepoint_ctsi_input(dat, eda_col='GSR_US', time_col='CNT', group_cols=None, event_onset_col=None, event_name_col=None, sampling_rate=None, tau0_range=(2, 4), tau1_range=(0.5, 1), sparsity_grid=(0.001, 0.01, 0.1, 1), output_dir=None, prefix='gazepoint_ctsi')
prepare_gazepoint_timecourse_test_data¶
prepare_gazepoint_timecourse_test_data(data, outcome_col, time_col, condition_col, participant_col, condition_a=None, condition_b=None, time_bin_width=None, aggregation='mean', require_complete=True)
preprocess_gazepoint_all¶
preprocess_gazepoint_all(data, impute_missing=True, clean_pupil=True, filter_gaze=True, max_gap=10, screen_bounds=(0, 1, 0, 1), max_velocity=inf, verbose=True)
run_gazepoint_biometrics_workflow¶
run_gazepoint_biometrics_workflow(path, group_columns=None, recursive=False, include_fixations=False, include_all_gaze=True, include_other_csv=False, require_active_signal=True, create_exclusion_recommendations=True, gsr_min_usable_pct=50, hr_min_usable_pct=50, dial_min_usable_pct=50, extract_ttl_events=True, ttl_event_mode='changes', audit_sampling=True, sampling_group_columns=None, sampling_time_column=None, sampling_time_unit='samples', expected_sampling_rate_hz=60)
run_gazepoint_online_design_optimization¶
run_gazepoint_online_design_optimization(candidate_table, condition_col='condition', utility_col='expected_utility', block_col=None, cost_col=None, previous_assignments=None, exploration_weight=0.1, balance_weight=0.1, maximise=True)
run_gazepoint_real_data_smoke¶
run_gazepoint_real_data_smoke(data_dir='', output_dir=None, dataset_mode='subdirectories', pattern='\\.csv$', recursive=True, workflow_args=None, diagnostic_args=None, workflow_runner=None, summary_runner=None, diagnostic_runner=None, stop_on_error=False, write_results=False, overwrite=False, protect_repository=True)
run_gazepoint_tfce¶
run_gpbiometrics_shiny¶
run_gpbiometrics_shiny_annotator¶
session_info_gazepoint¶
summarise_gazepoint_biometric_validity¶
summarise_gazepoint_biometric_validity(data, signal_cols=None, validity_cols=None, group_cols=None, active_min_unique=2)
summarise_gazepoint_biometrics_workflow¶
summarise_gazepoint_dial_windows¶
summarise_gazepoint_engagement_windows¶
summarise_gazepoint_engagement_windows(data, group_columns=None, value_column='DIAL', validity_column='DIALV', exclude_zero=False)
summarise_gazepoint_full_biometric_windows¶
summarize_gazepoint_export_inventory¶
summarize_gazepoint_feature_coverage¶
summarize_gazepoint_qc_overview¶
summarize_gazepoint_qc_overview(data, group_cols=None, quality_index_col=None, flag_cols=None, metric_cols=None)
summarize_gazepoint_tracking¶
summarize_gazepoint_tracking(data, pupil_cols=None, x_col=None, y_col=None, group_cols=None, screen_bounds=(0, 1, 0, 1), nonpositive_is_invalid=True)