aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: a7fcfc853e5259193d7b09fcea89ee819cfa11c8 (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
# ArGaze library

_An open-source python toolkit to deal with gaze tracking and analysis in Augmented Reality (AR) environnement._

## Installation

In the ArGaze root folder: 

```console
python -m build
```

Then, 

```console
pip install dist/argaze<VERSION>.whl
```

(Replace <VERSION> by what will be built into dist folder)

## Architecture

The ArGaze toolkit is divided in submodules dedicated to various purposes:

* ArUcoMarkers: ArUco markers generator, traking, camera calibration, ...
* RegionOfInterest: Region Of Interest (ROI) scene management for 2D and 3D environment.
* TobiiGlassesPro2: a gaze tracking device interface.
* _..._

## Examples

The ArGaze toolkit provides a set of python scripts to undertand how the submodules can be used together.