aboutsummaryrefslogtreecommitdiff
path: root/docs/user_guide/eye_tracking_context/context_modules/file.md
diff options
context:
space:
mode:
authorThéo de la Hogue2024-09-04 18:04:00 +0200
committerThéo de la Hogue2024-09-04 18:04:00 +0200
commit49d7beef84526e3498d53bc8bcfe387786d5de88 (patch)
treec495f60ab6a60d837fdcee72e65f42df9b4019a8 /docs/user_guide/eye_tracking_context/context_modules/file.md
parent4cb92dc5b72b8514fd63ccba9661444fd1e4e9db (diff)
downloadargaze-49d7beef84526e3498d53bc8bcfe387786d5de88.zip
argaze-49d7beef84526e3498d53bc8bcfe387786d5de88.tar.gz
argaze-49d7beef84526e3498d53bc8bcfe387786d5de88.tar.bz2
argaze-49d7beef84526e3498d53bc8bcfe387786d5de88.tar.xz
Improving File CSV context to parse file with left and right eyes data. Documenting the new feature.
Diffstat (limited to 'docs/user_guide/eye_tracking_context/context_modules/file.md')
-rw-r--r--docs/user_guide/eye_tracking_context/context_modules/file.md44
1 files changed, 42 insertions, 2 deletions
diff --git a/docs/user_guide/eye_tracking_context/context_modules/file.md b/docs/user_guide/eye_tracking_context/context_modules/file.md
index 8a66b83..5b5c8e9 100644
--- a/docs/user_guide/eye_tracking_context/context_modules/file.md
+++ b/docs/user_guide/eye_tracking_context/context_modules/file.md
@@ -19,13 +19,15 @@ Read more about [ArContext base class in code reference](../../../argaze.md/#arg
::: argaze.utils.contexts.File.CSV
-### JSON sample
+### JSON sample: splitted case
+
+To use when gaze position coordinates are splitted in two separated columns.
```json
{
"argaze.utils.contexts.File.CSV": {
"name": "CSV file data playback",
- "path": "./src/argaze/utils/demo/gaze_positions.csv",
+ "path": "./src/argaze/utils/demo/gaze_positions_splitted.csv",
"timestamp_column": "Timestamp (ms)",
"x_column": "Gaze Position X (px)",
"y_column": "Gaze Position Y (px)",
@@ -33,3 +35,41 @@ Read more about [ArContext base class in code reference](../../../argaze.md/#arg
}
}
```
+
+### JSON sample: joined case
+
+To use when gaze position coordinates are joined as a list in one single column.
+
+```json
+{
+ "argaze.utils.contexts.File.CSV" : {
+ "name": "CSV file data playback",
+ "path": "./src/argaze/utils/demo/gaze_positions_xy_joined.csv",
+ "timestamp_column": "Timestamp (ms)",
+ "xy_column": "Gaze Position (px)",
+ "pipeline": ...
+ }
+}
+```
+
+### JSON sample: left and right eyes
+
+To use when gaze position coordinates and validity are given for each eye in six separated columns.
+
+```json
+{
+ "argaze.utils.contexts.File.CSV": {
+ "name": "CSV file data playback",
+ "path": "./src/argaze/utils/demo/gaze_positions_left_right_eyes.csv",
+ "timestamp_column": "Timestamp (ms)",
+ "left_eye_x_column": "Left eye X",
+ "left_eye_y_column": "Left eye Y",
+ "left_eye_validity_column": "Left eye validity",
+ "right_eye_x_column": "Right eye X",
+ "right_eye_y_column": "Right eye Y",
+ "right_eye_validity_column": "Right eye validity",
+ "rescale_to_pipeline_size": true,
+ "pipeline": ...
+ }
+}
+```