From be8a44033bd490ea7f4ddb1514a9cc2888affb88 Mon Sep 17 00:00:00 2001
From: Théo de la Hogue
Date: Wed, 4 Sep 2024 13:56:36 +0200
Subject: Improving CVS file parsing. Documenting CSV file support.

---
 .../configuration_and_execution.md                 |  1 +
 .../eye_tracking_context/context_modules/file.md   | 35 ++++++++++++++++++++++
 2 files changed, 36 insertions(+)
 create mode 100644 docs/user_guide/eye_tracking_context/context_modules/file.md

(limited to 'docs/user_guide/eye_tracking_context')

diff --git a/docs/user_guide/eye_tracking_context/configuration_and_execution.md b/docs/user_guide/eye_tracking_context/configuration_and_execution.md
index 100ab5e..3deeb57 100644
--- a/docs/user_guide/eye_tracking_context/configuration_and_execution.md
+++ b/docs/user_guide/eye_tracking_context/configuration_and_execution.md
@@ -7,6 +7,7 @@ The [utils.contexts module](../../argaze.md/#argaze.utils.contexts) provides rea
 * [Tobii Pro Glasses 3](context_modules/tobii_pro_glasses_3.md) data capture context,
 * [Pupil Labs Invisible](context_modules/pupil_labs_invisible.md) data capture context,
 * [Pupil Labs Neon](context_modules/pupil_labs_neon.md) data capture context,
+* [File](context_modules/file.md) data playback contexts,
 * [OpenCV](context_modules/opencv.md) window cursor position capture and movie playback,
 * [Random](context_modules/random.md) gaze position generator.
 
diff --git a/docs/user_guide/eye_tracking_context/context_modules/file.md b/docs/user_guide/eye_tracking_context/context_modules/file.md
new file mode 100644
index 0000000..8a66b83
--- /dev/null
+++ b/docs/user_guide/eye_tracking_context/context_modules/file.md
@@ -0,0 +1,35 @@
+File
+======
+
+ArGaze provides a ready-made contexts to read data from various file format.
+
+To select a desired context, the JSON samples have to be edited and saved inside an [ArContext configuration](../configuration_and_execution.md) file.
+Notice that the *pipeline* entry is mandatory.
+
+```json
+{
+	JSON sample
+	"pipeline": ...
+}
+```
+
+Read more about [ArContext base class in code reference](../../../argaze.md/#argaze.ArFeatures.ArContext).
+
+## CSV
+
+::: argaze.utils.contexts.File.CSV
+
+### JSON sample
+
+```json
+{
+    "argaze.utils.contexts.File.CSV": {
+        "name": "CSV file data playback",
+        "path": "./src/argaze/utils/demo/gaze_positions.csv",
+        "timestamp_column": "Timestamp (ms)",
+        "x_column": "Gaze Position X (px)",
+        "y_column": "Gaze Position Y (px)",
+        "pipeline": ...
+    }
+}
+```
-- 
cgit v1.1