From 4e839f353700011457f52b305312ddf0217069a9 Mon Sep 17 00:00:00 2001
From: Théo de la Hogue
Date: Mon, 28 Aug 2023 15:13:36 +0200
Subject: Fixing missing type annotations.

---
 src/argaze/ArFeatures.py                    | 6 +++---
 src/argaze/AreaOfInterest/AOIFeatures.py    | 2 +-
 src/argaze/GazeAnalysis/Entropy.py          | 6 +-----
 src/argaze/GazeAnalysis/TransitionMatrix.py | 7 +------
 src/argaze/GazeFeatures.py                  | 4 ++--
 5 files changed, 8 insertions(+), 17 deletions(-)

(limited to 'src')

diff --git a/src/argaze/ArFeatures.py b/src/argaze/ArFeatures.py
index ad755e8..c9a6faa 100644
--- a/src/argaze/ArFeatures.py
+++ b/src/argaze/ArFeatures.py
@@ -119,7 +119,7 @@ class ArLayer():
 				self.__ts_logs[aoi_scan_path_analyzer_module_path] = DataStructures.TimeStampedBuffer()
 
 	@classmethod
-	def from_dict(self, layer_data, working_directory: str = None) -> ArLayerType:
+	def from_dict(self, layer_data: dict, working_directory: str = None) -> ArLayerType:
 		"""Load attributes from dictionary.
 
 		Parameters:
@@ -511,7 +511,7 @@ class ArFrame():
 		scan_path: scan path object
 		scan_path_analyzers: dictionary of scan path analyzers
 		heatmap: heatmap object
-		aoi_layers: dictionary of AOI layers
+		layers: dictionary of AOI layers
 		log: enable scan path analysis logging
 	"""
 
@@ -553,7 +553,7 @@ class ArFrame():
 				self.__ts_logs[scan_path_analyzer_module_path] = DataStructures.TimeStampedBuffer()
 
 	@classmethod
-	def from_dict(self, frame_data, working_directory: str = None) -> ArFrameType:
+	def from_dict(self, frame_data: dict, working_directory: str = None) -> ArFrameType:
 		"""Load attributes from dictionary.
 
 		Parameters:
diff --git a/src/argaze/AreaOfInterest/AOIFeatures.py b/src/argaze/AreaOfInterest/AOIFeatures.py
index 65470af..fbc6dc4 100644
--- a/src/argaze/AreaOfInterest/AOIFeatures.py
+++ b/src/argaze/AreaOfInterest/AOIFeatures.py
@@ -242,7 +242,7 @@ class AOIScene():
                 self[name] = AreaOfInterest(area)
 
     @classmethod
-    def from_dict(self, aoi_scene_data, working_directory: str = None) -> AOISceneType:
+    def from_dict(self, aoi_scene_data: dict, working_directory: str = None) -> AOISceneType:
         """Load attributes from dictionary.
 
         Parameters:
diff --git a/src/argaze/GazeAnalysis/Entropy.py b/src/argaze/GazeAnalysis/Entropy.py
index ba1c17c..c57900d 100644
--- a/src/argaze/GazeAnalysis/Entropy.py
+++ b/src/argaze/GazeAnalysis/Entropy.py
@@ -39,11 +39,7 @@ class AOIScanPathAnalyzer(GazeFeatures.AOIScanPathAnalyzer):
         self.__transition_entropy = -1
 
     def analyze(self, aoi_scan_path: GazeFeatures.AOIScanPathType):
-        """Analyze aoi scan path.
-
-        Returns:
-                stationary entropy
-                transition entropy"""
+        """Analyze aoi scan path."""
 
         assert(len(aoi_scan_path) > 1)
 
diff --git a/src/argaze/GazeAnalysis/TransitionMatrix.py b/src/argaze/GazeAnalysis/TransitionMatrix.py
index ab10989..1b2c41d 100644
--- a/src/argaze/GazeAnalysis/TransitionMatrix.py
+++ b/src/argaze/GazeAnalysis/TransitionMatrix.py
@@ -32,12 +32,7 @@ class AOIScanPathAnalyzer(GazeFeatures.AOIScanPathAnalyzer):
         self.__transition_matrix_density = 0.
 
     def analyze(self, aoi_scan_path: GazeFeatures.AOIScanPathType):
-        """Analyze aoi scan path.
-
-        Returns:
-                transition matrix probabilities
-                transition matrix density
-        """
+        """Analyze aoi scan path."""
 
         assert(len(aoi_scan_path) > 1)
 
diff --git a/src/argaze/GazeFeatures.py b/src/argaze/GazeFeatures.py
index 33fd562..2875c8e 100644
--- a/src/argaze/GazeFeatures.py
+++ b/src/argaze/GazeFeatures.py
@@ -398,12 +398,12 @@ class TimeStampedGazeStatus(DataStructures.TimeStampedBuffer):
 class GazeMovementIdentifier():
     """Abstract class to define what should provide a gaze movement identifier."""
 
-    def identify(self, ts, gaze_position, terminate=False) -> Tuple[GazeMovementType, GazeMovementType]:
+    def identify(self, timestamp: int|float, gaze_position: GazePosition, terminate:bool=False) -> Tuple[GazeMovementType, GazeMovementType]:
         """Identify gaze movement from successive timestamped gaze positions. 
         Each identified gaze movement should share its first/last gaze position with previous/next gaze movement.
 
         Parameters:
-            ts:
+            timestamp:
             gaze_position:
             terminate: allows to notify identification algorithm that given gaze position will be the last one.
         
-- 
cgit v1.1