Update Eyetracker Scripts HowTo authored by afahey2's avatar afahey2
......@@ -100,7 +100,22 @@ For example, `AOI hit [Set 1 - 6S - Model 7 - Blocks]`.
5. Parse annotations and compute action times.
**INPUT:**
**PARAMETERS:**
* `name`: Path to where to save results. Results are saved in blocks/output/<name>.
* `default annotator`: Choose one of the entries in config/annotator_names.txt.
* `label type`: Are the actions labeled with reference to video or eyetracker samples? Accepted inputs are `eyetracker` and `video`. Default is `video`.
* `class exemplars file`: Location of serialized class exemplars, used for enforcing consistent state. Specify this path relative to the output directory, e.g. `<experiment-name>/class-exemplars.pkl`.
* `reference paths file`: Location of serialized reference paths. Specify this path relative to the output directory, e.g `<experiment-name>/reference-paths.pkl`.
* `figure image extension`: Extension specifying the filetype to be used when rendering figures. Default is `png`.
* `debug`: Optional flag. If `1`, this script writes human-readable versions of all eye-tracking labels to the output directory in CSV format. Default is `0`.
* `compute stats`:
* `visualize`: Optional flag. If `1` this script will generate visualizations of the script output documented below.
* `write data`:
* `DataSource`: Required filter. Must be one of the entries in config/study_names.txt.
* `GroupID`: Optional filter. What group of videos (e.g. `Child` and `adults2018`) the script will run on. Corresponds to a column name in blocks_file_index.xlsx.
* `TaskID`: Optional filter. What task the script will run on. Corresponds to a column name in blocks_file_index.xlsx.
* `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:**
......
......