aboutsummaryrefslogtreecommitdiff
path: root/src/argaze/GazeAnalysis/LempelZivComplexity.py
blob: 2e681622efaf3426805c1716a409d9dc3e3e5e69 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
"""Lempel-Ziv complexity module.
"""

__author__ = "Théo de la Hogue"
__credits__ = []
__copyright__ = "Copyright 2023, Ecole Nationale de l'Aviation Civile (ENAC)"
__license__ = "BSD"

from dataclasses import dataclass

from argaze import GazeFeatures, DataFeatures

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__()

        self.__lempel_ziv_complexity = 0

    @DataFeatures.PipelineStepMethod
    def analyze(self, aoi_scan_path: GazeFeatures.AOIScanPathType):

        assert(len(aoi_scan_path) > 1)

        self.__lempel_ziv_complexity = lempel_ziv_complexity(aoi_scan_path.letter_sequence)

    @property
    def lempel_ziv_complexity(self) -> int:
        """Lempel-Ziv complexity."""
        
        return self.__lempel_ziv_complexity