aboutsummaryrefslogtreecommitdiff
path: root/docs/user_guide/utils/demonstrations_scripts.md
blob: a91117317c4e37596c780e7af3c77ee9dee570e2 (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
42
43
44
45
46
47
48
49
50
51
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.*

## Gaze analysis pipeline demonstration

Load ArFrame with a single ArLayer from **demo_gaze_analysis_setup.json** file then, simulate gaze position using mouse pointer to illustrate gaze features.

```shell
python ./src/argaze/utils/demo_gaze_analysis_run.py ./src/argaze/utils/demo_data/demo_gaze_analysis_setup.json
```

## ArUco markers pipeline demonstration

Load ArUcoCamera from **demo_aruco_markers_setup.json** file then, detect ArUco markers into a demo video source and estimate camera pose.

```shell
python ./src/argaze/utils/demo_aruco_markers_run.py ./src/argaze/utils/demo_data/demo_aruco_markers_setup.json -s ./src/argaze/utils/demo_data/demo.mov
```

!!! note
      To reproduce this demonstration with live video source (-s <DEVICE_ID>), print **A3_demo.pdf** file located in *./src/argaze/utils/demo_data/* folder on A3 paper sheet.

## Worn device stream demonstration

Load ArUcoCamera from a configuration file then, stream and process gaze positions and image from any worn eye-tracker device.

### With Tobii Pro Glasses 2 device

To use a Tobii Pro Glasses 2 device, you need to edit **provider_setup.json** file as below with your own parameters values:

```shell
{
    "TobiiProGlasses2" : {
        "address": "10.34.0.17",
        "project": "MyProject",
        "participant": "NewParticipant"
    }
}
```

```shell
python ./src/argaze/utils/worn_device_stream.py ./src/argaze/utils/demo_data/demo_aruco_markers_setup.json
```