aboutsummaryrefslogtreecommitdiff
path: root/docs/user_guide/utils/demonstrations_scripts.md
diff options
context:
space:
mode:
authorThéo de la Hogue2023-08-23 13:58:16 +0200
committerThéo de la Hogue2023-08-23 13:58:16 +0200
commite88fe8f8c2b0bffee3d67b73200381cde2351dab (patch)
tree51028d813b3abad0e5c03767fe123593dc4f81bd /docs/user_guide/utils/demonstrations_scripts.md
parent2c7562e6d64dcd34529f105bfd4d007f2d1addf9 (diff)
downloadargaze-e88fe8f8c2b0bffee3d67b73200381cde2351dab.zip
argaze-e88fe8f8c2b0bffee3d67b73200381cde2351dab.tar.gz
argaze-e88fe8f8c2b0bffee3d67b73200381cde2351dab.tar.bz2
argaze-e88fe8f8c2b0bffee3d67b73200381cde2351dab.tar.xz
Adding gaze analysis pipeline user guide section. Hidding older user guide sections.
Diffstat (limited to 'docs/user_guide/utils/demonstrations_scripts.md')
-rw-r--r--docs/user_guide/utils/demonstrations_scripts.md32
1 files changed, 16 insertions, 16 deletions
diff --git a/docs/user_guide/utils/demonstrations_scripts.md b/docs/user_guide/utils/demonstrations_scripts.md
index 6666bb0..2bf04aa 100644
--- a/docs/user_guide/utils/demonstrations_scripts.md
+++ b/docs/user_guide/utils/demonstrations_scripts.md
@@ -9,23 +9,9 @@ Collection of command-line scripts for demonstration purpose.
!!! note
*Use -h option to get command arguments documentation.*
-## AR environment demonstration
+## ArFrame and ArLayer demonstration
-Load AR environment from **setup.json** file, detect ArUco markers into a demo video source and estimate environment pose.
-
-```shell
-python ./src/argaze/utils/demo_ar_features_run.py ./src/argaze/utils/demo_environment/demo_ar_features_setup.json -s ./src/argaze/utils/demo_environment/demo.mov
-```
-
-!!! note
- To reproduce this demonstration with live video source, camera calibration have to be done and exported into **./src/argaze/utils/demo_environment/optic_parameters.json** file.
-
-!!! note
- To reproduce this demonstration with live video source, print **A3_demo.pdf** file located in *./src/argaze/utils/demo_environment/* folder on A3 paper sheet.
-
-## Gaze features demonstration
-
-Simulate gaze position using mouse pointer to illustrate gaze features.
+Load ArFrame with a single ArLayer from **demo_gaze_features_setup.json** file then, simulate gaze position using mouse pointer to illustrate gaze features.
```shell
python ./src/argaze/utils/demo_gaze_features_run.py ./src/argaze/utils/demo_environment/demo_gaze_features_setup.json
@@ -39,3 +25,17 @@ A picture is saved by pressing escape key.
```shell
python ./src/argaze/utils/demo_heatmap_run.py
```
+
+## ArEnvironment demonstration
+
+Load ArEnvironment from **demo_ar_features_setup.json** file then, detect ArUco markers into a demo video source and estimate environment pose.
+
+```shell
+python ./src/argaze/utils/demo_ar_features_run.py ./src/argaze/utils/demo_environment/demo_ar_features_setup.json -s ./src/argaze/utils/demo_environment/demo.mov
+```
+
+!!! note
+ To reproduce this demonstration with live video source, camera calibration have to be done and exported into **./src/argaze/utils/demo_environment/optic_parameters.json** file.
+
+!!! note
+ To reproduce this demonstration with live video source, print **A3_demo.pdf** file located in *./src/argaze/utils/demo_environment/* folder on A3 paper sheet.