diff options
Diffstat (limited to 'docs/user_guide/utils/demonstrations_scripts.md')
| -rw-r--r-- | docs/user_guide/utils/demonstrations_scripts.md | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/docs/user_guide/utils/demonstrations_scripts.md b/docs/user_guide/utils/demonstrations_scripts.md new file mode 100644 index 0000000..5c4ef2b --- /dev/null +++ b/docs/user_guide/utils/demonstrations_scripts.md @@ -0,0 +1,41 @@ +Demonstrations scripts +====================== + +Collection of command-line scripts for demonstration purpose. + +!!! note + *Consider that all inline commands below have to be executed at the root of ArGaze package folder.* + +!!! note + *Use -h option to get command arguments documentation.* + +## AR environment demonstration + +Load AR environment from **setup.json** file, detect ArUco markers into camera device (-d DEVICE) frames and estimate envirnoment pose. + +```shell +python ./src/argaze/utils/demo_ar_features_run.py -d DEVICE +``` + +!!! warning + This demonstration assumes that camera calibration step is done and a **calibration.json** has been exported into *./src/argaze/utils/demo_environment/* folder. + +!!! note + Use **A3_demo.pdf** file located in *./src/argaze/utils/demo_environment/* folder ready to be printed on A3 paper sheet. + +## Gaze features demonstration + +Simulate gaze position using mouse pointer to illustrate gaze features. + +```shell +python ./src/argaze/utils/demo_gaze_features_run.py +``` + +## Heatmap demonstration + +Simulate gaze position using mouse pointer to produce heatmap picture. +A picture is saved by pressing escape key. + +```shell +python ./src/argaze/utils/demo_heatmap_run.py +``` |