aboutsummaryrefslogtreecommitdiff
path: root/src/argaze/GazeAnalysis/LempelZivComplexity.py
diff options
context:
space:
mode:
Diffstat (limited to 'src/argaze/GazeAnalysis/LempelZivComplexity.py')
-rw-r--r--src/argaze/GazeAnalysis/LempelZivComplexity.py16
1 files changed, 10 insertions, 6 deletions
diff --git a/src/argaze/GazeAnalysis/LempelZivComplexity.py b/src/argaze/GazeAnalysis/LempelZivComplexity.py
index 82ef05f..50c7a90 100644
--- a/src/argaze/GazeAnalysis/LempelZivComplexity.py
+++ b/src/argaze/GazeAnalysis/LempelZivComplexity.py
@@ -1,11 +1,6 @@
#!/usr/bin/env python
-"""Implementation of Lempel-Ziv complexity algorithm as described in:
-
- **Lounis C., Peysakhovich V., Causse M. (2020).**
- *Lempel-Ziv Complexity of dwell sequences: visual scanning pattern differences between novice and expert aircraft pilots.*
- Proceedings of the 1st International Workshop on Eye-Tracking in Aviation (ETAVI'20, 61-68).
- [https://doi.org/10.3929/ethz-b-000407653](https://doi.org/10.3929/ethz-b-000407653)
+"""Lempel-Ziv complexity module.
"""
__author__ = "Théo de la Hogue"
@@ -22,6 +17,14 @@ from lempel_ziv_complexity import lempel_ziv_complexity
@dataclass
class AOIScanPathAnalyzer(GazeFeatures.AOIScanPathAnalyzer):
+ """Implementation of Lempel-Ziv complexity algorithm as described in:
+
+ **Lounis C., Peysakhovich V., Causse M. (2020).**
+ *Lempel-Ziv Complexity of dwell sequences: visual scanning pattern differences between novice and expert aircraft pilots.*
+ Proceedings of the 1st International Workshop on Eye-Tracking in Aviation (ETAVI'20, 61-68).
+ [https://doi.org/10.3929/ethz-b-000407653](https://doi.org/10.3929/ethz-b-000407653)
+ """
+
def __post_init__(self):
super().__init__()
@@ -37,6 +40,7 @@ class AOIScanPathAnalyzer(GazeFeatures.AOIScanPathAnalyzer):
@property
def lempel_ziv_complexity(self) -> int:
+ """Lempel-Ziv complexity."""
return self.__lempel_ziv_complexity
\ No newline at end of file