From d1cdae406d349023eb9e221fd226c05744064dfd Mon Sep 17 00:00:00 2001
From: Théo de la Hogue
Date: Wed, 31 May 2023 12:31:16 +0200
Subject: Commenting analysis with paper reference.

---
 .../GazeAnalysis/DispersionThresholdIdentification.py     | 15 +++++++--------
 src/argaze/GazeAnalysis/TransitionMatrix.py               | 14 +++++++++-----
 .../GazeAnalysis/VelocityThresholdIdentification.py       |  8 +++++++-
 3 files changed, 23 insertions(+), 14 deletions(-)

(limited to 'src')

diff --git a/src/argaze/GazeAnalysis/DispersionThresholdIdentification.py b/src/argaze/GazeAnalysis/DispersionThresholdIdentification.py
index 18c9c49..48ada31 100644
--- a/src/argaze/GazeAnalysis/DispersionThresholdIdentification.py
+++ b/src/argaze/GazeAnalysis/DispersionThresholdIdentification.py
@@ -1,6 +1,12 @@
 #!/usr/bin/env python
 
-""" """
+"""Implementation of the I-DT algorithm as described in:
+        
+    Dario D. Salvucci and Joseph H. Goldberg. 2000. 
+    Identifying fixations and saccades in eye-tracking protocols. 
+    In Proceedings of the 2000 symposium on Eye tracking research & applications, ETRA '00, 71-78.
+    [DOI=http://dx.doi.org/10.1145/355017.355028](DOI=http://dx.doi.org/10.1145/355017.355028)
+"""
 
 __author__ = "Théo de la Hogue"
 __credits__ = []
@@ -92,13 +98,6 @@ class Saccade(GazeFeatures.Saccade):
 
 @dataclass
 class GazeMovementIdentifier(GazeFeatures.GazeMovementIdentifier):
-    """Implementation of the I-DT algorithm as described in:
-        
-            Dario D. Salvucci and Joseph H. Goldberg. 2000. Identifying fixations and
-            saccades in eye-tracking protocols. In Proceedings of the 2000 symposium
-            on Eye tracking research & applications (ETRA '00). ACM, New York, NY, USA,
-            71-78. [DOI=http://dx.doi.org/10.1145/355017.355028](DOI=http://dx.doi.org/10.1145/355017.355028)
-    """
 
     deviation_max_threshold: int|float
     """Maximal distance allowed to consider a gaze movement as a fixation."""
diff --git a/src/argaze/GazeAnalysis/TransitionMatrix.py b/src/argaze/GazeAnalysis/TransitionMatrix.py
index 7294bc9..c413072 100644
--- a/src/argaze/GazeAnalysis/TransitionMatrix.py
+++ b/src/argaze/GazeAnalysis/TransitionMatrix.py
@@ -1,14 +1,20 @@
 #!/usr/bin/env python
 
-""" """
+"""Implementation of transition matrix probabilities and density algorithm as described in:
+
+    K Krejtz, T Szmidt, AT Duchowski. 2014. 
+    Entropy-based statistical analysis of eye movement transitions. 
+    In Proceedings of the Symposium on Eye Tracking Research and Applications, ETRA '14, 159-166. 
+    [DOI=https://doi.org/10.1145/2578153.2578176](DOI=https://doi.org/10.1145/2578153.2578176)
+"""
 
 __author__ = "Théo de la Hogue"
 __credits__ = []
 __copyright__ = "Copyright 2023, Ecole Nationale de l'Aviation Civile (ENAC)"
 __license__ = "BSD"
 
-from typing import TypeVar, Tuple, Any
-from dataclasses import dataclass, field
+from typing import Tuple
+from dataclasses import dataclass
 
 from argaze import GazeFeatures
 
@@ -17,8 +23,6 @@ import numpy
 
 @dataclass
 class AOIScanPathAnalyzer(GazeFeatures.AOIScanPathAnalyzer):
-    """Implementation of transition matrix probabilities and density algorithm as described in Krejtz et al., 2014
-    """
 
     def __post_init__(self):
 
diff --git a/src/argaze/GazeAnalysis/VelocityThresholdIdentification.py b/src/argaze/GazeAnalysis/VelocityThresholdIdentification.py
index 1cf7859..e819522 100644
--- a/src/argaze/GazeAnalysis/VelocityThresholdIdentification.py
+++ b/src/argaze/GazeAnalysis/VelocityThresholdIdentification.py
@@ -1,6 +1,12 @@
 #!/usr/bin/env python
 
-""" """
+"""Implementation of the I-VT algorithm as described in:
+        
+    Dario D. Salvucci and Joseph H. Goldberg. 2000. 
+    Identifying fixations and saccades in eye-tracking protocols. 
+    In Proceedings of the 2000 symposium on Eye tracking research & applications, ETRA '00, 71-78.
+    [DOI=http://dx.doi.org/10.1145/355017.355028](DOI=http://dx.doi.org/10.1145/355017.355028)
+"""
 
 __author__ = "Théo de la Hogue"
 __credits__ = []
-- 
cgit v1.1