From a3eb35c5a3725ba589663c6a8992b48b6743eb11 Mon Sep 17 00:00:00 2001
From: Théo de la Hogue
Date: Tue, 3 Sep 2024 12:27:18 +0200
Subject: Explaining how to setup aruco_markers_pipeline.json file depending on
 the context.

---
 docs/user_guide/utils/demonstrations_scripts.md | 55 +++++++++++++++++++++----
 1 file changed, 46 insertions(+), 9 deletions(-)

(limited to 'docs/user_guide/utils')

diff --git a/docs/user_guide/utils/demonstrations_scripts.md b/docs/user_guide/utils/demonstrations_scripts.md
index 59df85b..277f380 100644
--- a/docs/user_guide/utils/demonstrations_scripts.md
+++ b/docs/user_guide/utils/demonstrations_scripts.md
@@ -40,7 +40,7 @@ python -m argaze load ./src/argaze/utils/demo/opencv_movie_context.json
 
 ### Camera context
 
-Edit **aruco_markers_pipeline.json** file as to adapt the *size* to the camera resolution and to reduce the value of the *sides_mask*.
+Edit **aruco_markers_pipeline.json** file as to adapt the *size* to the camera resolution and to set a consistent *sides_mask* value.
 
 Edit **opencv_camera_context.json** file as to select camera device identifier (default is 0).
 
@@ -57,7 +57,9 @@ python -m argaze load ./src/argaze/utils/demo/opencv_camera_context.json
 !!! note
     This demonstration requires to print **A3_demo.pdf** file located in *./src/argaze/utils/demo/* folder on A3 paper sheet.
 
-Edit **tobii_live_stream_context.json** file as to select exisiting IP *address*, *project* or *participant* names and setup Tobii *configuration* parameters:
+Edit **aruco_markers_pipeline.json** file as to adapt the *size* to the camera resolution ([1920, 1080]) and to set *sides_mask* value to 420.
+
+Edit **tobii_g2_live_stream_context.json** file as to select exisiting IP *address*, *project* or *participant* names and setup Tobii *configuration* parameters:
 
 ```json
 {
@@ -80,15 +82,17 @@ Edit **tobii_live_stream_context.json** file as to select exisiting IP *address*
 }
 ```
 
-Then, load **tobii_live_stream_context.json** file to find ArUco marker into camera image and, project gaze positions into AOI:
+Then, load **tobii_g2_live_stream_context.json** file to find ArUco marker into camera image and, project gaze positions into AOI:
 
 ```shell
-python -m argaze load ./src/argaze/utils/demo/tobii_live_stream_context.json
+python -m argaze load ./src/argaze/utils/demo/tobii_g2_live_stream_context.json
 ```
 
 ### Segment playback context
 
-Edit **tobii_segment_playback_context.json** file to select an existing Tobii *segment* folder:
+Edit **aruco_markers_pipeline.json** file as to adapt the *size* to the camera resolution ([1920, 1080]) and to set *sides_mask* value to 420.
+
+Edit **tobii_g2_segment_playback_context.json** file to select an existing Tobii *segment* folder:
 
 ```json
 {
@@ -100,12 +104,28 @@ Edit **tobii_segment_playback_context.json** file to select an existing Tobii *s
 }
 ```
 
-Then, load **tobii_segment_playback_context.json** file to find ArUco marker into camera image and, project gaze positions into AOI:
+Then, load **tobii_g2_segment_playback_context.json** file to find ArUco marker into camera image and, project gaze positions into AOI:
+
+```shell
+python -m argaze load ./src/argaze/utils/demo/tobii_g2_segment_playback_context.json
+```
+
+## Tobii Pro Glasses 3
+
+### Live stream context
+
+!!! note
+    This demonstration requires to print **A3_demo.pdf** file located in *./src/argaze/utils/demo/* folder on A3 paper sheet.
+
+Edit **aruco_markers_pipeline.json** file as to adapt the *size* to the camera resolution ([1920, 1080]) and to set *sides_mask* value to 420.
+
+Load **tobii_g3_live_stream_context.json** file to find ArUco marker into camera image and, project gaze positions into AOI:
 
 ```shell
-python -m argaze load ./src/argaze/utils/demo/tobii_segment_playback_context.json
+python -m argaze load ./src/argaze/utils/demo/tobii_g3_live_stream_context.json
 ```
 
+
 ## Pupil Invisible
 
 ### Live stream context
@@ -113,8 +133,25 @@ python -m argaze load ./src/argaze/utils/demo/tobii_segment_playback_context.jso
 !!! note
     This demonstration requires to print **A3_demo.pdf** file located in *./src/argaze/utils/demo/* folder on A3 paper sheet.
 
-Load **pupillabs_live_stream_context.json** file to find ArUco marker into camera image and, project gaze positions into AOI:
+Edit **aruco_markers_pipeline.json** file as to adapt the *size* to the camera resolution ([1088, 1080]) and to set *sides_mask* value to 4.
+
+Load **pupillabs_invisible_live_stream_context.json** file to find ArUco marker into camera image and, project gaze positions into AOI:
+
+```shell
+python -m argaze load ./src/argaze/utils/demo/pupillabs_invisible_live_stream_context.json
+```
+
+## Pupil Neon
+
+### Live stream context
+
+!!! note
+    This demonstration requires to print **A3_demo.pdf** file located in *./src/argaze/utils/demo/* folder on A3 paper sheet.
+
+Edit **aruco_markers_pipeline.json** file as to adapt the *size* to the camera resolution ([1600, 1200]) and to set *sides_mask* value to 200.
+
+Load **pupillabs_neon_live_stream_context.json** file to find ArUco marker into camera image and, project gaze positions into AOI:
 
 ```shell
-python -m argaze load ./src/argaze/utils/demo/pupillabs_live_stream_context.json
+python -m argaze load ./src/argaze/utils/demo/pupillabs_neon_live_stream_context.json
 ```
-- 
cgit v1.1