blob: 55c74810ea97d9161b578b45305e4af4f2d31fe3 (
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
52
53
54
55
56
57
58
59
60
61
|
An open-source python toolkit to deal with dynamic Areas Of Interest (AOI) and gaze tracking in Augmented Reality (AR) environnement.
## Architecture
The ArGaze toolkit provides some generics data structures and algorithms to build AR environement with dynamic AOI and so allow gaze tracking with mobil eye tracker devices. It is divided in submodules dedicated to various specifics features:
* ArUcoMarkers: ArUco markers generator, traking, camera calibration, ...
* AreaOfInterest: Area Of Interest (AOI) scene management for 2D and 3D environment.
* TobiiGlassesPro2: A gaze tracking device interface.
* GazeFeatures: Generic gaze data structures definitions.
* utils: Collection of command-line high level features scripts based on ArGaze toolkit.
## Installation
Consider that all inline commands below needs to be executed into ArGaze root folder.
- Install build tool package:
```
pip install build
```
- Then, build argaze package:
```
python -m build
```
- Then, install argaze package (replace VERSION by what has been built into dist folder):
```
pip install ./dist/argaze-VERSION.whl
```
*As Argaze library developper, you should prefer to install the package in developer mode to test live code changes:*
```
pip install -e .
```
## Documentation
To generate html documentation using [pdoc](https://pdoc.dev/),
- Install 'pdoc' package:
```
pip install pdoc
```
- Then, build documentation into doc folder:
```
pdoc -o ./doc ./src/argaze/
```
*As Argaze library developper, you should prefer to create a local html server to watch live documentation changes:*
```
pdoc ./src/argaze/
```
|
