aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorThéo de la Hogue2023-03-14 09:05:57 +0100
committerThéo de la Hogue2023-03-14 09:05:57 +0100
commitb4e497a1859081b4eabc02420b88949c65b63044 (patch)
treeb8bca3af5f70394bdd372442e316b557e691606d /README.md
parentb4ce337448a0edfad8d8112aeee81c33d39f3dcc (diff)
downloadargaze-b4e497a1859081b4eabc02420b88949c65b63044.zip
argaze-b4e497a1859081b4eabc02420b88949c65b63044.tar.gz
argaze-b4e497a1859081b4eabc02420b88949c65b63044.tar.bz2
argaze-b4e497a1859081b4eabc02420b88949c65b63044.tar.xz
Adding GazeAnalysis decription to library readme file.
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 4 insertions, 3 deletions
diff --git a/README.md b/README.md
index 4b0be1b..d4972c5 100644
--- a/README.md
+++ b/README.md
@@ -2,17 +2,18 @@ An open-source python toolkit to deal with dynamic Areas Of Interest (AOI) and g
# 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 detecter devices. It is divided in submodules dedicated to various specifics features:
+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:
-* `argaze.ArUcoMarkers`: ArUco markers generator, traking, camera calibration, ...
+* `argaze.ArUcoMarkers`: ArUco markers generator, detector, camera calibration, ...
* `argaze.AreaOfInterest`: Area Of Interest (AOI) scene management for 2D and 3D environment.
* `argaze.GazeFeatures`: Generic gaze data structures definitions.
+* `argaze.GazeAnalysis`: Class interface to work with various gaze analysis algorithms.
* `argaze.TobiiGlassesPro2`: A gaze tracking device interface.
* `argaze.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.
+Consider that all inline commands below have to be executed into ArGaze root folder.
- Install build tool package: