diff options
Diffstat (limited to 'src/argaze/GazeAnalysis/NGram.py')
| -rw-r--r-- | src/argaze/GazeAnalysis/NGram.py | 21 |
1 files changed, 11 insertions, 10 deletions
diff --git a/src/argaze/GazeAnalysis/NGram.py b/src/argaze/GazeAnalysis/NGram.py index bee9767..a19974a 100644 --- a/src/argaze/GazeAnalysis/NGram.py +++ b/src/argaze/GazeAnalysis/NGram.py @@ -1,11 +1,6 @@ #!/usr/bin/env python -"""Implementation of N-Gram algorithm as proposed in: - - **Lounis C., Peysakhovich V., Causse M. (2021).** - *Visual scanning strategies in the cockpit are modulated by pilots’ expertise: A flight simulator study.* - PLoS ONE (16(2), 6). - [https://doi.org/10.1371/journal.pone.0247061](https://doi.org/10.1371/journal.pone.0247061) +"""N-Gram module. """ __author__ = "Théo de la Hogue" @@ -20,14 +15,19 @@ from argaze import GazeFeatures @dataclass class AOIScanPathAnalyzer(GazeFeatures.AOIScanPathAnalyzer): - """ - Parameters: - n_min: minimal grams length to search. - n_max: maximal grams length to search. + """Implementation of N-Gram algorithm as proposed in: + + **Lounis C., Peysakhovich V., Causse M. (2021).** + *Visual scanning strategies in the cockpit are modulated by pilots’ expertise: A flight simulator study.* + PLoS ONE (16(2), 6). + [https://doi.org/10.1371/journal.pone.0247061](https://doi.org/10.1371/journal.pone.0247061) """ n_min: int = field(default=2) + """Minimal grams length to search.""" + n_max: int = field(default=2) + """Maximal grams length to search.""" def __post_init__(self): @@ -53,6 +53,7 @@ class AOIScanPathAnalyzer(GazeFeatures.AOIScanPathAnalyzer): @property def ngrams_count(self) -> dict: + """N-Grams count.""" return self.__ngrams_count
\ No newline at end of file |