Pupil / gaze / fixation / AOI¶
Pupil cleaning, blink handling, gaze validation, fixation/saccade processing, AOI assignment, scanpaths, and eye-tracking ecosystem bridges.
30 functions from the frozen 406-function contract are routed here by the documentation classifier.
Recommended articles¶
Functions¶
assign_gazepoint_aoi¶
assign_gazepoint_aoi(data, aois, x_col=None, y_col=None, aoi_label_col='aoi', format='auto', aoi_id_col=None, data_match_cols=None, aoi_match_cols=None, xmin_col='xmin', xmax_col='xmax', ymin_col='ymin', ymax_col='ymax', vertex_x_col='vertex_x', vertex_y_col='vertex_y', priority_col=None, overlap='priority', boundary='inside', output_col='AOI', match_count_col='aoi_match_count', ambiguous_col='aoi_ambiguous', status_col='aoi_assignment_status', all_separator='|', overwrite=False)
audit_gazepoint_pupil_luminance¶
audit_gazepoint_pupil_luminance(data, pupil_col=None, luminance_col=None, group_cols=None, threshold=0.3, method='pearson')
baseline_correct_gazepoint_pupil¶
baseline_correct_gazepoint_pupil(dat, pupil_col=None, time_col='time', stimulus_onset_col=None, trial_cols=None, baseline_window=(-250, -50), baseline_function='median', correction='subtract', suffix='_baseline_corrected', min_baseline_rows=2, overwrite=False)
build_gazepoint_aoi_timecourse¶
build_gazepoint_aoi_timecourse(data, time_col=None, aoi_col=None, x_col=None, y_col=None, aoi_definitions=None, group_cols=None, bin_width_s=0.1, valid_col=None, include_empty=True)
clean_gazepoint_pupil¶
clean_gazepoint_pupil(data, pupil_cols=None, time_col=None, blink_col=None, max_gap_s=None, method='linear', suffix='_clean', prefer_existing=False, **kwargs)
clean_gazepoint_pupil_signal¶
clean_gazepoint_pupil_signal(data, pupil_cols=None, time_col=None, group_cols=None, validity_cols=None, method='linear', max_gap=inf, spike_mad=6, combine='all', min_blink_samples=1, suffix='_clean', keep_flags=True)
create_gazepoint_eye_methods_text¶
create_gazepoint_eye_methods_text(sampling_rate_hz, device_model='Gazepoint GP3', calibration_points=9, binocular=True, software='Gazepoint Analysis', screen_resolution=None, viewing_distance_cm=None, coordinate_space=None, preprocessing=None, fixation_detection=None, aoi_definition=None, synchronization=None, exclusions=None, tense='past', include_package_version=True)
detect_gazepoint_fixations¶
detect_gazepoint_fixations(data, time_col=None, x_col=None, y_col=None, group_cols=None, valid_col=None, valid_values=(1, True), time_unit='seconds', sampling_rate_hz=None, coordinate_unit='native', velocity_threshold=None, min_fixation_duration_ms=100, min_saccade_duration_ms=10, max_gap_ms=100, velocity_col='gaze_velocity', class_col='gaze_class', event_id_col='gaze_event_id', overwrite=False)
detect_gazepoint_pupil_blinks¶
detect_gazepoint_pupil_blinks(data, pupil_cols=None, time_col=None, group_cols=None, validity_cols=None, invalid_values=(0,), nonpositive_is_missing=True, combine='all', min_blink_samples=1, return_='intervals', **kwargs)
detect_gazepoint_saccades¶
filter_gazepoint_gaze¶
filter_gazepoint_gaze(data, x_col=None, y_col=None, time_col=None, group_cols=None, screen_bounds=(0, 1, 0, 1), max_velocity=inf, drop_invalid=False, suffix='_filtered')
interpolate_gazepoint_pupil_blinks¶
interpolate_gazepoint_pupil_blinks(data, pupil_cols=None, time_col=None, blink_col=None, max_gap_s=None, method='linear', suffix='_interp')
plot_gazepoint_aoi_biometrics¶
plot_gazepoint_aoi_biometrics(x, value_col='mean_value', aoi_col='aoi_label', signal_col='signal', group_col=None, plot_type='boxplot', title=None)
plot_gazepoint_saccade_main_sequence¶
plot_gazepoint_saccade_main_sequence(dat, amplitude_col=None, peak_velocity_col=None, group_col=None, log_axes=True, add_smoother=True, main='Gazepoint saccade main-sequence diagnostic')
prepare_gazepoint_aoi_biometrics_model_data¶
prepare_gazepoint_aoi_biometrics_model_data(x, outcome_col='mean_value', predictor_cols=('aoi_label', 'signal'), factor_cols=('aoi_label', 'signal'), numeric_cols=None, group_cols=None, drop_missing_outcome=True, min_rows=None, standardise_outcome=False, standardise_within='signal')
prepare_gazepoint_eyetrackingr_input¶
prepare_gazepoint_eyetrackingr_input(data, participant_col=None, trial_col=None, time_col=None, time_unit='auto', sampling_rate_hz=None, rezero_time=False, trackloss_col=None, validity_col=None, valid_values=None, x_col=None, y_col=None, aoi_col=None, aoi_cols=None, aoi_levels=None, outside_aoi_values=('', 'none', 'no_aoi', 'outside', 'outside_aoi', 'non_aoi', 'background'), allow_aoi_overlap=False, item_cols=None, predictor_cols=None, treat_non_aoi_looks_as_missing=True, sampling_tolerance=0.05, irregular='error', create_object=False)
prepare_gazepoint_gazer_input¶
prepare_gazepoint_gazer_input(data, participant_col=None, trial_col=None, time_col=None, time_unit='auto', sampling_rate_hz=None, rezero_time=False, x_col=None, y_col=None, x_left_col=None, y_left_col=None, x_right_col=None, y_right_col=None, pupil_col=None, pupil_left_col=None, pupil_right_col=None, validity_col=None, validity_left_col=None, validity_right_col=None, valid_values=None, blink_col=None, blink_left_col=None, blink_right_col=None, invalid_coordinate_values=None, invalid_pupil_values=None, mask_invalid=False, other_cols=None, sampling_tolerance=0.05, irregular='error', create_object=False)
prepare_gazepoint_pupillometryr_input¶
prepare_gazepoint_pupillometryr_input(data, participant_col=None, trial_col=None, time_col=None, condition_col=None, pupil_left_col=None, pupil_right_col=None, pupil_col=None, time_unit='auto', sampling_rate_hz=None, rezero_time=False, invalid_pupil_values=None, validity_cols=None, valid_values=None, blink_cols=None, mask_invalid=False, create_mean_pupil=True, other_cols=None, sampling_tolerance=0.05, irregular='error', create_object=False)
regress_gazepoint_pupil_luminance¶
regress_gazepoint_pupil_luminance(dat, pupil_col, luminance_col, group_cols=None, time_col=None, output_col='pupil_luminance_adjusted', fitted_col='pupil_luminance_fitted', include_quadratic=True, model_by_group=True, add_intercept_mean=True)
simulate_gazepoint_eye_data¶
smooth_gazepoint_pupil¶
smooth_gazepoint_pupil(data, pupil_cols=None, id_cols=None, window=5, suffix='_smooth', min_nonmissing=1)
summarise_gazepoint_aoi_biometrics¶
summarise_gazepoint_aoi_biometrics(data, aoi_col='AOI', signal_cols=None, group_cols=None, time_col=None, valid_aoi_values=None, drop_missing_aoi=True, min_rows=1)
summarise_gazepoint_fixations_by_aoi¶
summarise_gazepoint_fixations_by_aoi(fixations, aoi_col=None, participant_col=None, trial_col=None, group_cols=None, start_col=None, end_col=None, duration_col=None, event_onset_col=None, time_unit='auto', duration_unit='auto', sampling_rate_hz=None, include_unassigned=False, unassigned_label='UNASSIGNED')
summarize_gazepoint_aoi_dwell¶
summarize_gazepoint_aoi_dwell(data, time_col=None, aoi_col=None, duration_col=None, group_cols=None, valid_col=None)
summarize_gazepoint_fixations¶
summarize_gazepoint_fixations(fixDF, duration_col=None, x_col=None, y_col=None, participant_col=None, trial_col=None, aoi_col=None, group_cols=None, duration_unit='auto')
summarize_gazepoint_fixations_by_aoi¶
summarize_gazepoint_pupil_events¶
summarize_gazepoint_pupil_events(data, events, pre=1, post=3, time_col=None, pupil_col=None, event_time_col=None, event_id_col=None, baseline_window=None, response_window=(0, 3))
summarize_gazepoint_scanpath_metrics¶
summarize_gazepoint_scanpath_metrics(data, x_col=None, y_col=None, time_col=None, aoi_col=None, fixation_id_col=None, group_cols=None, min_saccade_distance=0.02)
sync_gazepoint_biometrics_with_gaze¶
validate_gazepoint_gaze¶
validate_gazepoint_gaze(data, time_col=None, x_col=None, y_col=None, validity_cols=None, group_cols=None, coordinate_system='auto', screen_width_px=None, screen_height_px=None, time_unit='auto', sampling_rate_hz=None, expected_sampling_rate_hz=None, sampling_tolerance=0.2, missing_threshold=0.2, gap_multiplier=3)