From 3a45608841aadb5a7b363df55d523592389ad8c0 Mon Sep 17 00:00:00 2001 From: Théo de la Hogue Date: Thu, 7 Apr 2022 01:21:45 +0200 Subject: Updating documentation --- README.md | 2 +- src/argaze/ArUcoMarkers/ArUcoCamera.py | 2 +- src/argaze/TobiiGlassesPro2/README.md | 2 +- src/argaze/TobiiGlassesPro2/TobiiController.py | 3 ++- 4 files changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 567a88c..07ccc8f 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ An open-source python toolkit to deal with gaze tracking and analysis in Augment ## Architecture -The ArGaze toolkit some generics data structures and algorithms to process gaze analysis and it is divided in submodules dedicated to various specifics features: +The ArGaze toolkit provides some generics data structures and algorithms to process gaze analysis and it is divided in submodules dedicated to various specifics features: * ArUcoMarkers: ArUco markers generator, traking, camera calibration, ... * RegionOfInterest: Region Of Interest (ROI) scene management for 2D and 3D environment. diff --git a/src/argaze/ArUcoMarkers/ArUcoCamera.py b/src/argaze/ArUcoMarkers/ArUcoCamera.py index 3b5fcea..3871d77 100644 --- a/src/argaze/ArUcoMarkers/ArUcoCamera.py +++ b/src/argaze/ArUcoMarkers/ArUcoCamera.py @@ -5,7 +5,7 @@ import numpy import cv2.aruco as aruco class ArUcoCamera(): - """Camera with optical parameters with: + """Handle optical parameters with: - camera matrix as K, - camera distorsion coefficients as D.""" diff --git a/src/argaze/TobiiGlassesPro2/README.md b/src/argaze/TobiiGlassesPro2/README.md index 7a2d9e1..ce546fb 100644 --- a/src/argaze/TobiiGlassesPro2/README.md +++ b/src/argaze/TobiiGlassesPro2/README.md @@ -1,5 +1,5 @@ Class interface to handle Tobbi Glasses Pro 2 device. -This work is greatly inspired by the David de Tommaso and Agnieszka Wykowska [TobiiGlassesPySuite](https://arxiv.org/pdf/1912.09142.pdf) package as TobiiController class inherits from [tobiiglassesctrl.TobiiGlassesController](https://github.com/ddetommaso/TobiiGlassesPyController/blob/master/tobiiglassesctrl/controller.py) class. +This work is greatly inspired by the David de Tommaso and Agnieszka Wykowska [TobiiGlassesPySuite](https://arxiv.org/pdf/1912.09142.pdf). * [Tobii Glasses Pro 2 device user manual](https://www.tobiipro.com/siteassets/tobii-pro/user-manuals/tobii-pro-glasses-2-user-manual.pdf). diff --git a/src/argaze/TobiiGlassesPro2/TobiiController.py b/src/argaze/TobiiGlassesPro2/TobiiController.py index 1f4e302..c77738d 100644 --- a/src/argaze/TobiiGlassesPro2/TobiiController.py +++ b/src/argaze/TobiiGlassesPro2/TobiiController.py @@ -13,7 +13,8 @@ DEFAULT_PARTICIPANT_NAME = 'DefaultParticipant' DEFAULT_RECORD_NAME = 'DefaultRecord' class TobiiController(TobiiNetworkInterface.TobiiNetworkInterface): - """Handle Tobii glasses Pro 2 device using network interface.""" + """Handle Tobii glasses Pro 2 device using network interface. + It is a major rewrite of [tobiiglassesctrl/controller.py](https://github.com/ddetommaso/TobiiGlassesPyController/blob/master/tobiiglassesctrl/controller.py).""" project_name = None """Project name.""" -- cgit v1.1