Eyetracker-Scripts-HowTo.md

@@ -55,6 +55,7 @@ For example, `AOI hit [Set 1 - 6S - Model 7 - Blocks]`.
    * `video_metadata_fn`: Path to Excel file that stores participant and task data for all videos.
    * `out_dir`: Stores the output of this script documented below.
 
+
    **OUTPUT:**
    Generates a CSV for each video named with the recording number. Each file contains basic participant and recording information. These CSVs also have timestamps for all eye movements for each particular recording, as well as any event tags and the AOI for each timestamp.
 
@@ -79,6 +80,7 @@ For example, `AOI hit [Set 1 - 6S - Model 7 - Blocks]`.
    * `debug`: Optional flag. If `True`, this script writes human-readable versions of all eye-tracking labels to the output directory in CSV format. Default is `False`.
    * `out_dir`: Stores the output of this script documented below.
 
+
    **OUTPUT:**
    Generates a CSV for each annotated video in the study. Each CSV is named with the recording number and annotator name. Each file contains the original annotated actions from the overhead video. The first two columns are indices that correspond to the timestamps from the eye-tracking recording that mark the beginning and end of the coded action. In addition, the file also contains event IDs, integer IDs for the object, and the target of each action. Finally, the file contains stud information for placement events for both target and object.
 
@@ -90,7 +92,7 @@ For example, `AOI hit [Set 1 - 6S - Model 7 - Blocks]`.
 4. Move segmented Tobii export files and eye tracker label files to the remote server.
 
    **EXAMPLE:** 
-   See run.sh code for stage 4.
+   (See `egs/prepare_eyetracker_data/run.sh`, stage 4)
 
 5. [TO DO: FINISH DESCRIPTION]
 Parse annotations and compute action times. 
@@ -112,6 +114,7 @@ Parse annotations and compute action times.
    * `Age`: Optional filter. What age of participants the script will run on. Corresponds to a column name in blocks_file_index.xlsx.
    * `Gender`: Optional filter. What gender of participants the script will run on. Corresponds to a column name in blocks_file_index.xlsx.
 
+
    **OUTPUT:**
    [TO DO: FINISH DESCRIPTION]
    Generates a CSV that contains 
@@ -139,6 +142,7 @@ Parse annotations and compute action times.
    * `normalize`: Boolean option of whether or not generated histogram will be normalized.
    * `out_dir`: Stores the output of this script documented below.
 
+
    **OUTPUT:**
    Generates a data folder and a gaze-figures folder. The data folder contains a CSV file with the appended hit strings (documented above) for each overhead video action. The CSV contains participant and recording information as well as the eye-tracking indices and timestamps for the events, in addition to action type, state ID, and index. The gaze-figures folder is organized by task ID and within each folder are histograms of common hit strings and individual gaze data for each individual video for the tasks.