From bcfb82055c1736262ce974dc5dd10b365dda8d5c Mon Sep 17 00:00:00 2001 From: Théo de la Hogue Date: Wed, 10 Apr 2024 14:41:30 +0200 Subject: Improving annotations and documentation. --- docs/index.md | 2 +- docs/use_cases/simone_a320_cockpit_simulator.md | 2 +- .../gaze_analysis_pipeline/timestamped_gaze_positions_edition.md | 2 +- docs/user_guide/gaze_analysis_pipeline/visualisation.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) (limited to 'docs') diff --git a/docs/index.md b/docs/index.md index e257039..3c398ba 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,7 +2,7 @@ title: What is ArGaze? --- -# Build real time or post-processing eye tracking applications +# Build real-time or post-processing eye tracking applications **Useful links**: [Installation](installation.md) | [Source Repository](https://git.recherche.enac.fr/projects/argaze/repository) | [Issue Tracker](https://git.recherche.enac.fr/projects/argaze/issues) | [Contact](mailto:achil-contact@recherche.enac.fr) diff --git a/docs/use_cases/simone_a320_cockpit_simulator.md b/docs/use_cases/simone_a320_cockpit_simulator.md index 4a4bc4f..a3f2138 100644 --- a/docs/use_cases/simone_a320_cockpit_simulator.md +++ b/docs/use_cases/simone_a320_cockpit_simulator.md @@ -23,6 +23,6 @@ Finally, a python script connect Tobii eyetracker glasses to ArGaze toolkit. The ![AOI and gaze projection](../img/simone_projection.png) -A demonstration movie to see ArUco detection and AOI projection in real time +A demonstration movie to see ArUco detection and AOI projection in real-time ![type:video](http://achil.recherche.enac.fr/videos/marker_detection_and_aoi_projection.mp4) diff --git a/docs/user_guide/gaze_analysis_pipeline/timestamped_gaze_positions_edition.md b/docs/user_guide/gaze_analysis_pipeline/timestamped_gaze_positions_edition.md index afe4140..9a04bb6 100644 --- a/docs/user_guide/gaze_analysis_pipeline/timestamped_gaze_positions_edition.md +++ b/docs/user_guide/gaze_analysis_pipeline/timestamped_gaze_positions_edition.md @@ -28,7 +28,7 @@ for timestamped_gaze_position in ts_gaze_positions: ## Edit timestamped gaze positions from live stream -When gaze positions comes from a real time input, gaze position can be edited thanks to [GazePosition](../../argaze.md/#argaze.GazeFeatures.GazePosition) class. +When gaze positions comes from a real-time input, gaze position can be edited thanks to [GazePosition](../../argaze.md/#argaze.GazeFeatures.GazePosition) class. Besides, timestamps can be edited from the incoming data stream or, if not available, they can be edited thanks to the python [time package](https://docs.python.org/3/library/time.html). ``` python diff --git a/docs/user_guide/gaze_analysis_pipeline/visualisation.md b/docs/user_guide/gaze_analysis_pipeline/visualisation.md index a197f0c..b139f9b 100644 --- a/docs/user_guide/gaze_analysis_pipeline/visualisation.md +++ b/docs/user_guide/gaze_analysis_pipeline/visualisation.md @@ -1,7 +1,7 @@ Visualize pipeline steps ======================== -Visualisation is not a pipeline step but each [ArFrame](../../argaze.md/#argaze.ArFeatures.ArFrame) pipeline steps outputs can be drawn in real time or afterward, depending of application purpose. +Visualisation is not a pipeline step but each [ArFrame](../../argaze.md/#argaze.ArFeatures.ArFrame) pipeline steps outputs can be drawn in real-time or afterward, depending of application purpose. ![ArFrame visualisation](../../img/visualisation.png) -- cgit v1.1