aboutsummaryrefslogtreecommitdiff
path: root/docs/user_guide/utils/demonstrations_scripts.md
blob: 64213eb700f911a4a77a98839b3e5af69190b1a1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
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) images and estimate envirnoment pose.

```shell
python ./src/argaze/utils/demo_ar_features_run.py ./src/argaze/utils/demo_environment/setup.json -d DEVICE
```

!!! warning
      This demonstration assumes that camera calibration step is done and a **optic_parameters.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
```