From 8fc18a434da400f0fe82707e23838d6cc40a787d Mon Sep 17 00:00:00 2001
From: Théo de la Hogue
Date: Wed, 3 Jul 2024 17:14:43 +0200
Subject: Rewriting eye tracking context and gaze analysis sections.

---
 .../eye_tracking_context/context_modules/opencv.md | 47 +++++++++++++++++
 .../context_modules/pupil_labs.md                  | 32 ++++++++++++
 .../eye_tracking_context/context_modules/random.md | 32 ++++++++++++
 .../context_modules/tobii_pro_glasses_2.md         | 59 ++++++++++++++++++++++
 4 files changed, 170 insertions(+)
 create mode 100644 docs/user_guide/eye_tracking_context/context_modules/opencv.md
 create mode 100644 docs/user_guide/eye_tracking_context/context_modules/pupil_labs.md
 create mode 100644 docs/user_guide/eye_tracking_context/context_modules/random.md
 create mode 100644 docs/user_guide/eye_tracking_context/context_modules/tobii_pro_glasses_2.md

(limited to 'docs/user_guide/eye_tracking_context/context_modules')

diff --git a/docs/user_guide/eye_tracking_context/context_modules/opencv.md b/docs/user_guide/eye_tracking_context/context_modules/opencv.md
new file mode 100644
index 0000000..7244cd4
--- /dev/null
+++ b/docs/user_guide/eye_tracking_context/context_modules/opencv.md
@@ -0,0 +1,47 @@
+OpenCV
+======
+
+ArGaze provides a ready-made contexts to process cursor position over Open CV window and process movie images.
+
+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).
+
+## Cursor
+
+::: argaze.utils.contexts.OpenCV.Cursor
+
+### JSON sample
+
+```json
+{
+    "argaze.utils.contexts.OpenCV.Cursor": {
+        "name": "Open CV cursor",
+        "pipeline": ...
+    }
+}
+```
+
+## Movie
+
+::: argaze.utils.contexts.OpenCV.Movie
+
+### JSON sample
+
+```json
+{
+    "argaze.utils.contexts.OpenCV.Movie": {
+        "name": "Open CV cursor",
+        "path": "./src/argaze/utils/demo/tobii_record/segments/1/fullstream.mp4",
+        "pipeline": ...
+    }
+}
+```
diff --git a/docs/user_guide/eye_tracking_context/context_modules/pupil_labs.md b/docs/user_guide/eye_tracking_context/context_modules/pupil_labs.md
new file mode 100644
index 0000000..d2ec336
--- /dev/null
+++ b/docs/user_guide/eye_tracking_context/context_modules/pupil_labs.md
@@ -0,0 +1,32 @@
+Pupil Labs
+==========
+
+ArGaze provides a ready-made context to work with Pupil Labs devices.
+
+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).
+
+## Live Stream
+
+::: argaze.utils.contexts.PupilLabs.LiveStream
+
+### JSON sample
+
+```json
+{
+	"argaze.utils.contexts.PupilLabs.LiveStream": {
+		"name": "Pupil Labs live stream",
+		"project": "my_experiment",
+		"pipeline": ...
+	}
+}
+```
diff --git a/docs/user_guide/eye_tracking_context/context_modules/random.md b/docs/user_guide/eye_tracking_context/context_modules/random.md
new file mode 100644
index 0000000..89d7501
--- /dev/null
+++ b/docs/user_guide/eye_tracking_context/context_modules/random.md
@@ -0,0 +1,32 @@
+Random
+======
+
+ArGaze provides a ready-made context to generate random gaze positions.
+
+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).
+
+## Gaze Position Generator
+
+::: argaze.utils.contexts.Random.GazePositionGenerator
+
+### JSON sample
+
+```json
+{
+    "argaze.utils.contexts.Random.GazePositionGenerator": {
+        "name": "Random gaze position generator",
+        "range": [1280, 720],
+        "pipeline": ...
+    }
+}
+```
diff --git a/docs/user_guide/eye_tracking_context/context_modules/tobii_pro_glasses_2.md b/docs/user_guide/eye_tracking_context/context_modules/tobii_pro_glasses_2.md
new file mode 100644
index 0000000..fba6931
--- /dev/null
+++ b/docs/user_guide/eye_tracking_context/context_modules/tobii_pro_glasses_2.md
@@ -0,0 +1,59 @@
+Tobii Pro Glasses 2
+===================
+
+ArGaze provides a ready-made context to work with Tobii Pro Glasses 2 devices.
+
+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).
+
+## Live Stream
+
+::: argaze.utils.contexts.TobiiProGlasses2.LiveStream
+
+### JSON sample
+
+```json
+{
+	"argaze.utils.contexts.TobiiProGlasses2.LiveStream": {
+		"name": "Tobii Pro Glasses 2 live stream",
+		"address": "10.34.0.17",
+		"project": "my_experiment",
+		"participant": "subject-A",
+		"configuration": {
+			"sys_ec_preset": "Indoor",
+			"sys_sc_width": 1920,
+			"sys_sc_height": 1080,
+			"sys_sc_fps": 25,
+			"sys_sc_preset": "Auto",
+			"sys_et_freq": 50,
+			"sys_mems_freq": 100
+		},
+		"pipeline": ...
+	}
+}
+```
+
+## Post Processing
+
+::: argaze.utils.contexts.TobiiProGlasses2.PostProcessing
+
+### JSON sample
+
+```json
+{
+    "argaze.utils.contexts.TobiiProGlasses2.PostProcessing" : {
+        "name": "Tobii Pro Glasses 2 post-processing",
+        "segment": "./src/argaze/utils/demo/tobii_record/segments/1",
+        "pipeline": ...
+    }
+}
+```
-- 
cgit v1.1