EDA / GSR / SCR¶
Electrodermal preprocessing, artifacts, decomposition, response detection, event windows, and EDA-oriented toolbox bridges.
59 functions from the frozen 406-function contract are routed here by the documentation classifier.
Recommended articles¶
Functions¶
analyze_gazepoint_ac_susceptance¶
analyze_gazepoint_ac_susceptance(dat, conductance_col=None, susceptance_col=None, admittance_col=None, phase_col=None, frequency_col=None, time_col=None, group_cols=None)
analyze_gazepoint_skin_potential¶
analyze_gazepoint_skin_potential(dat, sp_col, time_col, group_cols=None, response_direction='both', response_threshold=None, min_response_distance_s=1)
audit_gazepoint_eda_artifacts¶
audit_gazepoint_eda_artifacts(data, signal_col=None, time_col=None, group_cols=None, prefer_gsr_us=True, jump_threshold_sd=6, slope_threshold_sd=6, flat_run_length=20, zero_run_length=20, saturation_min=None, saturation_max=None, negative_allowed=None)
audit_gazepoint_gsr_quality¶
audit_gazepoint_gsr_quality(data, value_column=None, validity_column='GSRV', min_value=0, max_value=100, jump_threshold=None)
audit_gazepoint_gsr_units¶
audit_gazepoint_gsr_units(dat, gsr_col='GSR', convert=False, output_col=None, resistance_to_us_factor=1000000)
baseline_correct_gazepoint_gsr¶
baseline_correct_gazepoint_gsr(data, baseline_rows, value_column=None, validity_column='GSRV', group_columns=None, output_column=None, summary='mean', exclude_zero=True)
classify_gazepoint_eda_response_pattern¶
classify_gazepoint_eda_response_pattern(data, response_col=None, group_cols=None, summary_function='max_abs', no_response_threshold=0.01, low_response_threshold=0.05, moderate_response_threshold=0.2)
classify_gazepoint_scr_intervals¶
classify_gazepoint_scr_intervals(dat, response_time_col=None, stimulus_onset_col=None, latency_col=None, output_col='scr_interval', latency_output_col='scr_latency_s', fir=(1, 4), sir=(4, 7), tir=(7, 10))
combine_gazepoint_marker_channels_pspm_style¶
combine_gazepoint_marker_channels_pspm_style(data, marker_cols=None, time_col=None, sampling_rate_hz=None, group_cols=None, combined_col='pspm_marker')
compute_gazepoint_scr_habituation¶
compute_gazepoint_scr_habituation(data, amplitude_col=None, trial_col=None, subject_col=None, method='linear', min_trials=3)
compute_gazepoint_scr_latency¶
compute_gazepoint_scr_latency(data, events, time_col=None, eda_col=None, event_time_col=None, event_id_col=None, group_cols=None, baseline_window_s=(-1, 0), response_window_s=(0, 5), onset_threshold=0.01, recovery_fraction=0.5)
convert_gazepoint_gsr_to_conductance¶
convert_gazepoint_gsr_to_conductance(data, gsr_col=None, output_col='GSR_US', input_unit='auto', overwrite=False)
correct_gazepoint_eda_temperature¶
correct_gazepoint_eda_temperature(dat, eda_col='GSR_US', temperature_cols=None, group_cols=None, time_col=None, output_col='eda_temperature_adjusted', fitted_col='eda_temperature_fitted', model_by_group=True, add_intercept_mean=True)
create_gazepoint_eda_analysis_pipeline¶
create_gazepoint_eda_analysis_pipeline(include_external_bridges=True, include_model_templates=True, include_reporting_guidance=True, style='compact')
create_gazepoint_pspm_glm_design¶
create_gazepoint_pspm_glm_design(events, time, time_col=None, onset_col='onset_time_s', condition_col='condition', duration_col=None, response='scr', response_length_s=20, include_derivative=False, add_intercept=True)
decompose_gazepoint_eda¶
decompose_gazepoint_eda(data, signal_col=None, tonic_col=None, phasic_col=None, time_col=None, group_cols=None, window_size=31, output_prefix='eda', overwrite=False)
denoise_gazepoint_eda_autoencoder¶
denoise_gazepoint_eda_autoencoder(dat, eda_col='GSR_US', time_col=None, group_cols=None, model=None, window_samples=128, output_col=None, overwrite=False)
denoise_gazepoint_eda_wavelet¶
denoise_gazepoint_eda_wavelet(dat, eda_col='GSR_US', group_cols=None, output_col=None, levels=3, threshold_multiplier=1, overwrite=False)
detect_gazepoint_scr_events¶
detect_gazepoint_scr_events(data, phasic_col=None, signal_col=None, time_col=None, group_cols=None, threshold=None, min_peak_distance=10, window_size=31)
detect_gazepoint_scr_peaks¶
detect_gazepoint_scr_peaks(data, signal_col=None, phasic_col=None, time_col=None, group_cols=None, prefer_vendor_phasic=True, amplitude_min=0.01, recovery_fraction=0.5, smooth_width=1, min_peak_distance=1)
epoch_gazepoint_scr¶
epoch_gazepoint_scr(data, events, pre, post, time_col=None, signal_col=None, event_time_col=None, event_id_col=None, event_group_cols=None, baseline_window=None, response_window=None, min_amplitude=0.01, min_distance_s=1)
estimate_gazepoint_eda_recovery_times¶
estimate_gazepoint_eda_recovery_times(data, events=None, signal_col=None, time_col=None, group_cols=None, sampling_rate_hz=None, recovery_prop=0.5, max_recovery_seconds=10)
export_gazepoint_pspm_model_estimates¶
extract_gazepoint_bilateral_eda_asymmetry¶
extract_gazepoint_bilateral_eda_asymmetry(dat, left_col, right_col, time_col=None, group_cols=None, output_prefix='beda')
extract_gazepoint_eda_complexity¶
extract_gazepoint_eda_complexity(dat: 'pd.DataFrame', eda_col: 'str' = 'GSR_US', group_cols: 'Iterable[str] | None' = None, min_samples: 'int' = 32, sampen_m: 'int' = 2, sampen_r_multiplier: 'float' = 0.2)
extract_gazepoint_eda_events_biosppy_style¶
extract_gazepoint_eda_events_biosppy_style(data, signal_col=None, time_col=None, group_cols=None, sampling_rate_hz=None, smoothing_seconds=1, min_amplitude=None, min_distance_seconds=1, onset_window_seconds=4)
extract_gazepoint_eda_spectral_power¶
extract_gazepoint_eda_spectral_power(dat, eda_col='GSR_US', time_col=None, group_cols=None, sampling_rate=None, band=(0.045, 0.25), min_samples=32, detrend=True)
extract_gazepoint_eda_tvsymp¶
extract_gazepoint_eda_tvsymp(dat, eda_col='GSR_US', time_col='CNT', group_cols=None, sampling_rate=None, band=(0.08, 0.24), window_seconds=60, step_seconds=5, min_valid_fraction=0.7, normalise=True)
extract_gazepoint_markerinfo_pspm_style¶
extract_gazepoint_markerinfo_pspm_style(data, marker_cols=None, time_col=None, sampling_rate_hz=None, group_cols=None, edge='rising', nonzero_only=True)
extract_gazepoint_scr_recovery_times¶
extract_gazepoint_scr_recovery_times(dat, eda_col='GSR_US', time_col='CNT', event_onset_col=None, group_cols=None, pre_onset_baseline_s=2, peak_window_s=5, recovery_window_s=20)
extract_gazepoint_segments_pspm_style¶
extract_gazepoint_segments_pspm_style(data, events, signal_col, time_col=None, event_time_col='onset_time_s', event_id_col=None, condition_col=None, pre_s=1, post_s=5, baseline_window=(-1, 0), baseline_correct=True)
flag_kleckner_eda_artifacts¶
flag_kleckner_eda_artifacts(dat, eda_col='GSR_US', time_col=None, group_cols=None, min_us=0.01, max_us=100, max_abs_percent_change_per_second=20, transition_padding=1, output_prefix='kleckner')
merge_gazepoint_recordings_pspm_style¶
merge_gazepoint_recordings_pspm_style(recordings, time_col=None, gap_seconds=1, recording_col='pspm_recording', reset_first_time=True)
model_gazepoint_eda_point_process¶
model_gazepoint_eda_point_process(dat, eda_col='GSR_US', time_col='CNT', group_cols=None, event_time_col=None, event_indicator_col=None, derivative_mad_multiplier=6, min_event_distance_s=1)
normalize_gazepoint_scr¶
normalize_gazepoint_scr(amplitudes, method='z', amplitude_col=None, group_cols=None, output_col='scr_amplitude_normalized', na_rm=True)
optimize_gazepoint_cvxeda_tau¶
optimize_gazepoint_cvxeda_tau(dat, eda_col='GSR_US', time_col='CNT', group_cols=None, tau0_grid=array([2. , 2.25, 2.5 , 2.75, 3. , 3.25, 3.5 , 3.75, 4. ]), tau1=0.7, sampling_rate=None, ridge_lambda=0.01, max_irf_seconds=20)
plot_gazepoint_eda_decomposition¶
plot_gazepoint_eda_decomposition(data, time_col=None, signal_cols=None, group_cols=None, standardise=False, max_points=5000, title=None)
plot_gazepoint_eda_gram¶
plot_gazepoint_eda_gram(dat, eda_col='GSR_US', time_col='CNT', group_cols=None, group_id_to_plot=None, sampling_rate=None, window_seconds=30, step_seconds=5, frequency_range=(0.01, 0.5), frequency_bins=64, log_power=True, plot=True, main='EDA-gram')
plot_gazepoint_scr_events¶
plot_gazepoint_scr_events(data, scr_peaks, event_windows=None, events=None, time_col=None, signal_col=None, phasic_col=None, group_cols=None, show_events=True, max_points=5000, title=None)
plot_gazepoint_scr_specification_curve¶
plot_gazepoint_scr_specification_curve(x, estimate_col=None, specification_col='specification_id', add_zero_line=True, main='SCR specification curve')
prepare_gazepoint_cvxeda_input¶
prepare_gazepoint_ledalab_input¶
prepare_gazepoint_neurokit_eda_input¶
prepare_gazepoint_neurokit_eda_input(data, eda_col='GSR_US', time_col=None, group_cols=None, sampling_rate=None, output_dir=None, prefix='gazepoint_neurokit_eda')
prepare_gazepoint_pspm_dcm_input¶
prepare_gazepoint_pspm_dcm_input(dat, eda_col='GSR_US', time_col='CNT', event_onset_col=None, event_duration_col=None, event_name_col=None, participant_col=None, session_col=None, sampling_rate=None, output_dir=None, prefix='gazepoint_pspm_dcm')
prepare_gazepoint_pspm_input¶
prepare_gazepoint_scr_hurdle_model_data¶
prepare_gazepoint_scr_hurdle_model_data(scr_event_windows, response_col='response_flag', amplitude_col='scr_amplitude', latency_col='scr_latency', rise_time_col='scr_rise_time', recovery_time_col='scr_recovery_time', predictor_cols=None, factor_cols=None, numeric_cols=None, group_cols=None, event_id_col='event_id', amplitude_transform='none', amplitude_offset=1e-06, drop_missing_predictors=True)
preprocess_gazepoint_scr_pspm_style¶
preprocess_gazepoint_scr_pspm_style(data, signal_col=None, time_col=None, sampling_rate_hz=None, range=(0, 50), slope_limit_per_s=10, clipping_tolerance=1e-05, clipping_seconds=0.5, min_valid_island_seconds=1, artifact_epoch_seconds=0.25, smoothing_seconds=0.25)
run_gazepoint_biosppy_eda¶
run_gazepoint_biosppy_eda(data, signal_col=None, time_col=None, group_cols=None, sampling_rate_hz=None, smoothing_seconds=4)
run_gazepoint_eda_analysis_pipeline¶
run_gazepoint_eda_analysis_pipeline(data=None, path=None, eda_col=None, time_col=None, group_cols=None, signal_cols=None, sampling_rate=None, baseline_window=None, event_windows=None, event_data=None, lag_signal_pair=None, convert_resistance_to_us=False, prepare_external_bridges=True, bridge_methods=('neurokit', 'cvxeda', 'ledalab', 'pspm'), prepare_model_data=True, create_reports=True, output_dir=None, prefix='gazepoint_eda_pipeline', continue_on_error=True)
run_gazepoint_neurokit_eda_crosscheck¶
run_gazepoint_neurokit_eda_crosscheck(data, eda_col='GSR_US', time_col=None, group_cols=None, sampling_rate=None, execute=False, python='python', output_dir=None, prefix='gazepoint_neurokit_crosscheck', keep_files=False)
run_gazepoint_scr_multiverse¶
run_gazepoint_scr_multiverse(dat, signal_col='GSR_US', time_col='time', trial_cols=None, condition_col=None, participant_col=None, event_time_col=None, latency_windows=((1, 3), (1, 4), (1, 5)), thresholds=(0.01, 0.05), baseline_methods=('median', 'mean'), baseline_window=(-1, 0), response_metrics=('max_minus_baseline',), model_function=None)
run_gazepoint_scr_threshold_sensitivity¶
run_gazepoint_scr_threshold_sensitivity(data, phasic_col=None, signal_col=None, time_col=None, group_cols=None, amplitude_min_values=(0.005, 0.01, 0.02, 0.03), min_peak_distance_values=(1, 5, 10, 20, 30), recovery_fraction=0.5, smooth_width=1, events=None, event_time_col=None, event_id_col=None, event_label_col=None, ttl_cols=None, ttl_valid_col=None, event_detection='rising', analysis_window=(0, 6), response_window=(1, 4), peak_selection='largest_amplitude', collapse_simultaneous_events=False, include_event_windows=True, keep_objects=False)
screen_gazepoint_eda_nonresponders¶
screen_gazepoint_eda_nonresponders(x, group_cols=None, response_col='response_flag', amplitude_col='scr_amplitude', min_events=1, min_response_events=1, min_response_rate=0.05, min_detected_peaks=1)
split_gazepoint_sessions_pspm_style¶
split_gazepoint_sessions_pspm_style(data, time_col=None, gap_seconds=None, session_col='pspm_session', reset_time=True)
summarise_gazepoint_gsr_tonic_phasic¶
summarise_gazepoint_gsr_tonic_phasic(data, gsr_col=None, group_cols=None, time_col=None, window_n=15, peak_threshold=None, output_prefix='gsr')
summarise_gazepoint_gsr_windows¶
summarise_gazepoint_gsr_windows(data, group_columns=None, value_column=None, validity_column='GSRV', exclude_zero=True)
summarise_gazepoint_scr_event_windows¶
summarise_gazepoint_scr_event_windows(data=None, scr_peaks=None, events=None, time_col=None, event_time_col=None, event_id_col=None, event_label_col=None, group_cols=None, ttl_cols=None, ttl_valid_col=None, event_detection='rising', analysis_window=(0, 6), response_window=(1, 4), amplitude_col='amplitude', peak_time_col='peak_time', onset_time_col='onset_time', rise_time_col='rise_time', recovery_time_col='recovery_time_after_peak', peak_status_col='status', peak_selection='largest_amplitude', collapse_simultaneous_events=False)
summarize_gazepoint_scr_recovery¶
summarize_gazepoint_scr_recovery(data, events, pre=1, post=6, time_col=None, signal_col=None, event_time_col=None, event_id_col=None, baseline_window=None, peak_window=(0.5, 4), recovery_fraction=0.5)