aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorThéo de la Hogue2023-03-14 09:45:35 +0100
committerThéo de la Hogue2023-03-14 09:45:35 +0100
commit7c9827ba0c1e965c64eaf3ead1ce7b662d82d20c (patch)
treec1b126e74ace0ae79948a6b1e0e4838327d7d1ec /README.md
parentcd5f11aa32063f8608356065ffc6214f37c9990b (diff)
downloadargaze-7c9827ba0c1e965c64eaf3ead1ce7b662d82d20c.zip
argaze-7c9827ba0c1e965c64eaf3ead1ce7b662d82d20c.tar.gz
argaze-7c9827ba0c1e965c64eaf3ead1ce7b662d82d20c.tar.bz2
argaze-7c9827ba0c1e965c64eaf3ead1ce7b662d82d20c.tar.xz
Improving ArFeatures and general library overview.
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 6 insertions, 3 deletions
diff --git a/README.md b/README.md
index d4972c5..4ed74b1 100644
--- a/README.md
+++ b/README.md
@@ -2,12 +2,15 @@ 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 tracker 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 wearable eye tracker devices.
-* `argaze.ArUcoMarkers`: ArUco markers generator, detector, camera calibration, ...
-* `argaze.AreaOfInterest`: Area Of Interest (AOI) scene management for 2D and 3D environment.
+ArGaze is divided in submodules dedicated to various specifics features:
+
+* `argaze.ArFeatures`: Main classes used to load and manage AR environement assets.
* `argaze.GazeFeatures`: Generic gaze data structures definitions.
* `argaze.GazeAnalysis`: Class interface to work with various gaze analysis algorithms.
+* `argaze.ArUcoMarkers`: ArUco markers generator, detector, camera calibration, ...
+* `argaze.AreaOfInterest`: Area Of Interest (AOI) scene management for 2D and 3D environment.
* `argaze.TobiiGlassesPro2`: A gaze tracking device interface.
* `argaze.utils`: Collection of command-line high level features scripts based on ArGaze toolkit.