aboutsummaryrefslogtreecommitdiff
path: root/src/argaze/GazeAnalysis/DeviationCircleCoverage.py
diff options
context:
space:
mode:
authorThéo de la Hogue2023-08-29 14:19:22 +0200
committerThéo de la Hogue2023-08-29 14:19:22 +0200
commit9d032ca858646f985de27c16d9acc62ac1f51c92 (patch)
tree2eb13d616d92b6ea67b73632190817ff8f9ee149 /src/argaze/GazeAnalysis/DeviationCircleCoverage.py
parent82e8082dde2bbfd8d02af926364344c2fc931a89 (diff)
downloadargaze-9d032ca858646f985de27c16d9acc62ac1f51c92.zip
argaze-9d032ca858646f985de27c16d9acc62ac1f51c92.tar.gz
argaze-9d032ca858646f985de27c16d9acc62ac1f51c92.tar.bz2
argaze-9d032ca858646f985de27c16d9acc62ac1f51c92.tar.xz
Improving gaze analysis modules documentation.
Diffstat (limited to 'src/argaze/GazeAnalysis/DeviationCircleCoverage.py')
-rw-r--r--src/argaze/GazeAnalysis/DeviationCircleCoverage.py7
1 files changed, 4 insertions, 3 deletions
diff --git a/src/argaze/GazeAnalysis/DeviationCircleCoverage.py b/src/argaze/GazeAnalysis/DeviationCircleCoverage.py
index 8e7acef..bde486d 100644
--- a/src/argaze/GazeAnalysis/DeviationCircleCoverage.py
+++ b/src/argaze/GazeAnalysis/DeviationCircleCoverage.py
@@ -1,6 +1,6 @@
#!/usr/bin/env python
-"""Matching algorithm based on fixation's deviation circle coverage over AOI
+"""Module for matching algorithm based on fixation's deviation circle coverage over AOI.
"""
__author__ = "Théo de la Hogue"
@@ -22,9 +22,10 @@ GazeMovementType = TypeVar('GazeMovement', bound="GazeMovement")
@dataclass
class AOIMatcher(GazeFeatures.AOIMatcher):
+ """Matching algorithm based on fixation's deviation circle coverage over AOI."""
- coverage_threshold: int|float
- """ """
+ coverage_threshold: float
+ """Minimal coverage ratio to consider a fixation over an AOI (1 means that whole fixation's deviation circle have to be over the AOI)."""
def __post_init__(self):
"""Init looked aoi data."""