ep.eye_display_steps: Display Steps for Eye-Tracking Data Processing

In PennStateDEPENdLab/experiment_pipeline: Generates data markdown for NeuroMap Task

Display Steps for Eye-Tracking Data Processing

Description

This function displays the various steps involved in processing eye-tracking data. Each step includes a keyword, the function invoked, example arguments for the function, and a description of the step.

Usage

ep.eye_display_steps()

Value

None. This function prints the steps to the console.

Steps

1. Keyword: config

Function Invoked:

ep.eye_setup_proc_config

Function Arguments:

"edf_raw, file_path, header"

Description:

Processes user-supplied configuration yaml

2. Keyword: init

Function Invoked:

ep.eye_initialize

Function Arguments:

"config_path"

Description:

Initializes the eye-tracking data using configurations from a YAML file.

3. Keyword: parse

Function Invoked:

ep.eye_setup_proc_config

Function Arguments:

"event_functions_path"

Description:

Parses task-specific events from the eye-tracking data.

4. Keyword: gaze_preproc

Function Invoked:

ep.eye_setup_proc_config

Function Arguments:

"aoi, downsample"

Description:

Preprocesses gaze data including filtering, downsampling, etc.

5. Keyword: pupil_preproc

Function Invoked:

ep.eye_setup_proc_config

Function Arguments:

"blink_corr, filter, interpolate, baseline_correction"

Description:

Preprocesses pupil data including blink correction, filtering, etc.

6. Keyword: cleanup

Function Invoked:

ep.eye_setup_proc_config

Function Arguments:

"globals"

Description:

Cleans up processed data and prepares it for export.

Author(s)

Nate Hall

Examples

ep.eye_display_steps()

PennStateDEPENdLab/experiment_pipeline documentation built on Nov. 27, 2024, 4:56 a.m.