diff options
| -rw-r--r-- | README.md | 10 | ||||
| -rw-r--r-- | src/argaze/ArUcoMarkers/README.md | 5 | ||||
| -rw-r--r-- | src/argaze/AreaOfInterest/README.md | 4 | ||||
| -rw-r--r-- | src/argaze/DataStructures.py | 2 | ||||
| -rw-r--r-- | src/argaze/GazeAnalysis/README.md | 8 | ||||
| -rw-r--r-- | src/argaze/__init__.py | 2 |
6 files changed, 15 insertions, 16 deletions
@@ -8,13 +8,13 @@ Further, tracked gaze can be projected onto AR environment for live or post **ga 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.ArUcoMarkers`: ArUco markers generator, detector, camera calibration, scene description, ... * `argaze.AreaOfInterest`: Area Of Interest (AOI) scene management for 2D and 3D environment. +* `argaze.ArFeatures`: Load and manage AR environement assets. +* `argaze.GazeFeatures`: Generic gaze data and class definitions. +* `argaze.GazeAnalysis`: Various gaze analysis algorithms. * `argaze.DataStructures`: Timestamped data features. -* `argaze.utils`: Collection of command-line high level features scripts based on ArGaze toolkit. +* `argaze.utils`: Collection of command-line high level features scripts. # Installation diff --git a/src/argaze/ArUcoMarkers/README.md b/src/argaze/ArUcoMarkers/README.md index 931ee4b..29ab36b 100644 --- a/src/argaze/ArUcoMarkers/README.md +++ b/src/argaze/ArUcoMarkers/README.md @@ -1,9 +1,8 @@ Class interface to work with [OpenCV ArUco markers](https://docs.opencv.org/4.x/d5/dae/tutorial_aruco_detection.html). -## ArUco markers dictionary +## Wiki -To work with ArUco markers, you need to choose a marker dictionary which have specific the format, the numbers of markers or the difference between each markers to avoid error in detection. -Here is more [about ArUco markers dictionaries](https://docs.opencv.org/3.4/d9/d6a/group__aruco.html#gac84398a9ed9dd01306592dd616c2c975) +Read [ArGaze wiki page dedicated to ArUco markers](https://git.recherche.enac.fr/projects/argaze/wiki/ArUco_markers) submodule. ## Utils diff --git a/src/argaze/AreaOfInterest/README.md b/src/argaze/AreaOfInterest/README.md index 59041eb..d53c189 100644 --- a/src/argaze/AreaOfInterest/README.md +++ b/src/argaze/AreaOfInterest/README.md @@ -1,3 +1,5 @@ Class interface to manage Areas of Interest (AOI). -AOIFeatures defines generics 2D/3D AOI data structures which could be gathered inside 2D/3D scenes.
\ No newline at end of file +## Wiki + +Read [ArGaze wiki page dedicated to Areas Of Interest](https://git.recherche.enac.fr/projects/argaze/wiki/Areas_Of_Interest) submodule.
\ No newline at end of file diff --git a/src/argaze/DataStructures.py b/src/argaze/DataStructures.py index 6bc0b3a..a7ad308 100644 --- a/src/argaze/DataStructures.py +++ b/src/argaze/DataStructures.py @@ -21,8 +21,10 @@ TimeStampedBufferType = TypeVar('TimeStampedBuffer', bound="TimeStampedBuffer") # Type definition for type annotation convenience class JsonEncoder(json.JSONEncoder): + """Specific ArGaze JSON Encoder.""" def default(self, obj): + """default implementation to serialize object.""" # numpy cases if isinstance(obj, numpy.integer): diff --git a/src/argaze/GazeAnalysis/README.md b/src/argaze/GazeAnalysis/README.md index fd778e4..3084c15 100644 --- a/src/argaze/GazeAnalysis/README.md +++ b/src/argaze/GazeAnalysis/README.md @@ -1,9 +1,5 @@ Class interface to work with various gaze analysis algorithms. -# Gaze movements identification algorithms +## Wiki -*"The act of classifying eye movements into distinct events is, on a general level, driven by a desire to isolate different intervals of the data stream strongly correlated with certain oculomotor or cognitive properties."* Citation from ["One algorithm to rule them all? An evaluation and discussion of ten eye movement event-detection algorithms"](https://link.springer.com/article/10.3758/s13428-016-0738-9) article. - -## Dispersion based gaze movement identifier (I-DT) - -The code is based on the implementation of the I-DT algorithm as described in ["Identifying fixations and saccades in eye-tracking protocols"](http://dx.doi.org/10.1145/355017.355028) article.
\ No newline at end of file +Read [ArGaze wiki page dedicated to gaze analysis](https://git.recherche.enac.fr/projects/argaze/wiki/Gaze_analysis) submodule.
\ No newline at end of file diff --git a/src/argaze/__init__.py b/src/argaze/__init__.py index ef75dd2..e55cf92 100644 --- a/src/argaze/__init__.py +++ b/src/argaze/__init__.py @@ -2,4 +2,4 @@ .. include:: ../../README.md """ __docformat__ = "restructuredtext" -__all__ = ['ArFeatures','GazeFeatures','GazeAnalysis','ArUcoMarkers','AreaOfInterest','DataStructures','utils']
\ No newline at end of file +__all__ = ['ArUcoMarkers','AreaOfInterest','ArFeatures','GazeFeatures','GazeAnalysis','DataStructures','utils']
\ No newline at end of file |