From 1a4e3283623afc065bbe6b46722f468fe7ea1779 Mon Sep 17 00:00:00 2001
From: Théo de la Hogue
Date: Wed, 22 Mar 2023 16:54:50 +0100
Subject: Improving documentation.

---
 src/argaze/GazeAnalysis/DispersionBasedGazeMovementIdentifier.py | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

(limited to 'src')

diff --git a/src/argaze/GazeAnalysis/DispersionBasedGazeMovementIdentifier.py b/src/argaze/GazeAnalysis/DispersionBasedGazeMovementIdentifier.py
index 4cece04..cb29055 100644
--- a/src/argaze/GazeAnalysis/DispersionBasedGazeMovementIdentifier.py
+++ b/src/argaze/GazeAnalysis/DispersionBasedGazeMovementIdentifier.py
@@ -51,7 +51,7 @@ class Fixation(GazeFeatures.Fixation):
         object.__setattr__(self, 'deviation_max', max(deviations_array))
 
     def overlap(self, fixation) -> bool:
-        """Does a gaze position from another fixation have a deviation to this fixation centroïd smaller than maximal deviation?"""
+        """Does a gaze position from another fixation having a deviation to this fixation centroïd smaller than maximal deviation?"""
 
         points = fixation.positions.values()
         points_x, points_y = [p[0] for p in points], [p[1] for p in points]
@@ -100,6 +100,10 @@ class GazeMovementIdentifier(GazeFeatures.GazeMovementIdentifier):
         self.__saccade_positions = GazeFeatures.TimeStampedGazePositions()
 
     def identify(self, ts, gaze_position, terminate=False):
+        """Identify gaze movement from successive timestamped gaze positions.
+
+            The optional *terminate* argument allows to notify identification algorithm that given gaze position will be the last one.
+        """
 
         # Ignore non valid gaze position
         if not gaze_position.valid:
-- 
cgit v1.1