aboutsummaryrefslogtreecommitdiff
path: root/src/argaze/GazeAnalysis/NearestNeighborIndex.py
blob: 6a53d4525aae2aa5ad7c9efa9138f4a1f345c319 (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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
"""Nearest Neighbor Index module.
"""

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

from typing import TypeVar, Tuple, Any
from dataclasses import dataclass, field

from argaze import GazeFeatures, DataFeatures

import numpy
from scipy.spatial.distance import cdist

@dataclass
class ScanPathAnalyzer(GazeFeatures.ScanPathAnalyzer):
    """Implementation of Nearest Neighbor Index algorithm as described in:

        **Di Nocera F., Terenzi M., Camilli M. (2006).**  
        *Another look at scanpath: distance to nearest neighbour as a measure of mental workload.*  
        Developments in Human Factors in Transportation, Design, and Evaluation.  
        [https://www.researchgate.net](https://www.researchgate.net/publication/239470608_Another_look_at_scanpath_distance_to_nearest_neighbour_as_a_measure_of_mental_workload)
    """

    size: tuple[float, float]
    """Frame dimension."""

    def __post_init__(self):

        super().__init__()

        self.__nearest_neighbor_index = 0

    @DataFeatures.PipelineStepMethod
    def analyze(self, scan_path: GazeFeatures.ScanPathType):

        assert(len(scan_path) > 1)

        # Gather fixations focus points
        fixations_focus = []
        for step in scan_path:
            fixations_focus.append(step.first_fixation.focus)

        # Compute inter fixation distances
        distances = cdist(fixations_focus, fixations_focus)

        # Find minimal distances between each fixations
        minimums = numpy.apply_along_axis(lambda row: numpy.min(row[numpy.nonzero(row)]), 1, distances)

        # Average of minimun distances
        dNN = numpy.sum(minimums / len(fixations_focus))

        # Mean random distance
        dran = 0.5 * numpy.sqrt(self.size[0] * self.size[1] / len(fixations_focus))

        self.__nearest_neighbor_index = dNN / dran

    @property
    def nearest_neighbor_index(self) -> float:
        """Nearest Neighbor Index."""
        
        return self.__nearest_neighbor_index