diff options
Diffstat (limited to 'src/argaze/GazeAnalysis/ExploitExploreRatio.py')
| -rw-r--r-- | src/argaze/GazeAnalysis/ExploitExploreRatio.py | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/src/argaze/GazeAnalysis/ExploitExploreRatio.py b/src/argaze/GazeAnalysis/ExploitExploreRatio.py index 0c55170..f35561f 100644 --- a/src/argaze/GazeAnalysis/ExploitExploreRatio.py +++ b/src/argaze/GazeAnalysis/ExploitExploreRatio.py @@ -1,16 +1,6 @@ #!/usr/bin/env python -"""Implementation of exploit vs explore ratio algorithm as described in: - - **Goldberg J. H., Kotval X. P. (1999).** - *Computer interface evaluation using eye movements: methods and constructs.* - International Journal of Industrial Ergonomics (631–645). - [https://doi.org/10.1016/S0169-8141(98)00068-7](https://doi.org/10.1016/S0169-8141\\(98\\)00068-7) - - **Dehais F., Peysakhovich V., Scannella S., Fongue J., Gateau T. (2015).** - *Automation surprise in aviation: Real-time solutions.* - Proceedings of the 33rd annual ACM conference on Human Factors in Computing Systems (2525–2534). - [https://doi.org/10.1145/2702123.2702521](https://doi.org/10.1145/2702123.2702521) +"""Exploit/Explore ratio module. """ __author__ = "Théo de la Hogue" @@ -26,12 +16,21 @@ import numpy @dataclass class ScanPathAnalyzer(GazeFeatures.ScanPathAnalyzer): - """ - Parameters: - short_fixation_duration_threshold: time below which a fixation is considered to be short and so as exploratory. + """Implementation of exploit vs explore ratio algorithm as described in: + + **Goldberg J. H., Kotval X. P. (1999).** + *Computer interface evaluation using eye movements: methods and constructs.* + International Journal of Industrial Ergonomics (631–645). + [https://doi.org/10.1016/S0169-8141(98)00068-7](https://doi.org/10.1016/S0169-8141\\(98\\)00068-7) + + **Dehais F., Peysakhovich V., Scannella S., Fongue J., Gateau T. (2015).** + *Automation surprise in aviation: Real-time solutions.* + Proceedings of the 33rd annual ACM conference on Human Factors in Computing Systems (2525–2534). + [https://doi.org/10.1145/2702123.2702521](https://doi.org/10.1145/2702123.2702521) """ short_fixation_duration_threshold: float = field(default=0.) + """Time below which a fixation is considered to be short and so as exploratory.""" def __post_init__(self): @@ -70,6 +69,7 @@ class ScanPathAnalyzer(GazeFeatures.ScanPathAnalyzer): @property def exploit_explore_ratio(self) -> float: + """Exploit/Explore ratio.""" return self.__exploit_explore_ratio
\ No newline at end of file |