aboutsummaryrefslogtreecommitdiff
path: root/src/argaze.test/GazeAnalysis/VelocityThresholdIdentification.py
blob: 262cfc0f2f70254b8cd38aaf94f062ba93770279 (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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
#!/usr/bin/env python

""" """

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

import unittest
import random
import time
import math

from argaze import GazeFeatures
from argaze.GazeAnalysis import VelocityThresholdIdentification

import numpy

def build_gaze_fixation(size: int, center: tuple, deviation_max: float, min_time: float, max_time: float, start_ts: float = 0., validity: list = []):
    """ Generate N TimeStampedGazePsoitions dispersed around a center point for testing purpose.
        Timestamps are current time after random sleep (second).
        GazePositions are random values.
    """
    ts_gaze_positions = GazeFeatures.TimeStampedGazePositions()

    start_time = time.time()

    for i in range(0, size):

        # Sleep a random time
        sleep_time = random.random() * (max_time - min_time) + min_time
        time.sleep(sleep_time)

        # Check position validity
        valid = True
        if len(validity) > i:

             valid = validity[i]

        if valid:

            # Edit gaze position
            random_x = center[0] + deviation_max * (random.random() - 0.5) / math.sqrt(2)
            random_y = center[1] + deviation_max * (random.random() - 0.5) / math.sqrt(2)
            gaze_position = GazeFeatures.GazePosition((random_x, random_y))

        else:

            gaze_position = GazeFeatures.GazePosition()

        # Timestamp gaze position
        gaze_position.timestamp = time.time() - start_time + start_ts

        # Store gaze position
        ts_gaze_positions.append(gaze_position)

    return ts_gaze_positions

def build_gaze_saccade(size: int, center_A: tuple, center_B: tuple, min_time: float, max_time: float, start_ts: float = 0., validity: list = []):
    """ Generate N TimeStampedGazePsoitions between 2 center points for testing purpose.
        Timestamps are current time after random sleep (second).
        GazePositions are random values.
    """
    ts_gaze_positions = GazeFeatures.TimeStampedGazePositions()

    start_time = time.time()

    for i in range(0, size):

        # Sleep a random time
        sleep_time = random.random() * (max_time - min_time) + min_time
        time.sleep(sleep_time)

        # Check position validity
        valid = True
        if len(validity) > i:

             valid = validity[i]

        if valid:

            # Edit gaze position
            move_x = center_A[0] + (center_B[0] - center_A[0]) * (i / size)
            move_y = center_A[1] + (center_B[1] - center_A[1]) * (i / size)
            gaze_position = GazeFeatures.GazePosition((move_x, move_y))

        else:

            gaze_position = GazeFeatures.GazePosition()

        # Timestamp gaze position
        gaze_position.timestamp = time.time() - start_time + start_ts

        # Store gaze position
        ts_gaze_positions.append(gaze_position)

    return ts_gaze_positions

class TestVelocityThresholdIdentificationClass(unittest.TestCase):
    """Test VelocityThresholdIdentification class."""

    def test_fixation_identification(self):
        """Test VelocityThresholdIdentification fixation identification."""

        size = 10
        center = (0, 0)
        deviation_max = 10
        min_time = 0.05
        max_time = 0.1
        velocity_max = deviation_max / min_time

        ts_gaze_positions = build_gaze_fixation(size, center, deviation_max, min_time, max_time)
        gaze_movement_identifier = VelocityThresholdIdentification.GazeMovementIdentifier(velocity_max_threshold=velocity_max, duration_min_threshold=max_time*2)
        ts_fixations, ts_saccades, ts_status = gaze_movement_identifier.browse(ts_gaze_positions)

        # Check result size
        self.assertEqual(len(ts_fixations), 1)
        self.assertEqual(len(ts_saccades), 0)
        self.assertEqual(len(ts_status), size - 1)

        # Check fixation
        fixation = ts_fixations.pop(0)

        self.assertEqual(len(fixation), size - 1)
        self.assertGreaterEqual(fixation.duration, (size - 2) * min_time)
        self.assertLessEqual(fixation.duration, (size - 2) * max_time)
        self.assertLessEqual(fixation.finished, True)

    def test_fixation_and_direct_saccade_identification(self):
        """Test VelocityThresholdIdentification fixation and saccade identification."""

        size = 10
        center_A = (0, 0)
        center_B = (500, 500)
        deviation_max = 10
        min_time = 0.05
        max_time = 0.1
        velocity_max = deviation_max / min_time
        
        ts_gaze_positions_A = build_gaze_fixation(size, center_A, deviation_max, min_time, max_time)
        ts_gaze_positions_B = build_gaze_fixation(size, center_B, deviation_max, min_time, max_time, start_ts=ts_gaze_positions_A[-1].timestamp)

        ts_gaze_positions = ts_gaze_positions_A + ts_gaze_positions_B

        gaze_movement_identifier = VelocityThresholdIdentification.GazeMovementIdentifier(velocity_max_threshold=velocity_max, duration_min_threshold=max_time*2)
        ts_fixations, ts_saccades, ts_status = gaze_movement_identifier.browse(ts_gaze_positions)

        # Check result size
        self.assertEqual(len(ts_fixations), 2)
        self.assertEqual(len(ts_saccades), 1)
        self.assertEqual(len(ts_status), size * 2 - 1)

        # Check first fixation
        fixation = ts_fixations.pop(0)

        self.assertEqual(len(fixation), size - 1)
        self.assertGreaterEqual(fixation.duration, (size - 2) * min_time)
        self.assertLessEqual(fixation.duration, (size - 2) * max_time)
        self.assertLessEqual(fixation.finished, True)

        # Check first saccade
        saccade = ts_saccades.pop(0)

        self.assertEqual(len(saccade), 2)
        self.assertGreaterEqual(saccade.duration, min_time)
        self.assertLessEqual(saccade.duration, max_time)
        self.assertLessEqual(saccade.finished, True)

        # Check that last position of a movement is equal to first position of next movement
        self.assertEqual(fixation[-1].timestamp, saccade[0].timestamp)
        self.assertEqual(fixation[-1].value, saccade[0].value)

        # Check second fixation
        fixation = ts_fixations.pop(0)

        self.assertEqual(len(fixation), size)
        self.assertGreaterEqual(fixation.duration, (size - 1) * min_time)
        self.assertLessEqual(fixation.duration, (size - 1) * max_time)
        self.assertLessEqual(fixation.finished, True)

        # Check that last position of a movement is equal to first position of next movement
        self.assertEqual(saccade[-1].timestamp, fixation[0].timestamp)
        self.assertEqual(saccade[-1].value, fixation[0].value)

    def test_fixation_and_short_saccade_identification(self):
        """Test VelocityThresholdIdentification fixation and saccade identification."""

        size = 10
        move = 2
        center_A = (0, 0)
        out_A = (10, 10)
        center_B = (50, 50)
        deviation_max = 10
        min_time = 0.05
        max_time = 0.1
        velocity_max = deviation_max / min_time
        
        ts_gaze_positions_A = build_gaze_fixation(size, center_A, deviation_max, min_time, max_time)
        ts_move_positions = build_gaze_saccade(move, out_A, center_B, min_time, min_time, start_ts=ts_gaze_positions_A[-1].timestamp)
        ts_gaze_positions_B = build_gaze_fixation(size, center_B, deviation_max, min_time, max_time, start_ts=ts_move_positions[-1].timestamp)

        ts_gaze_positions = ts_gaze_positions_A + ts_move_positions + ts_gaze_positions_B

        gaze_movement_identifier = VelocityThresholdIdentification.GazeMovementIdentifier(velocity_max_threshold=velocity_max, duration_min_threshold=max_time*2)
        ts_fixations, ts_saccades, ts_status = gaze_movement_identifier.browse(ts_gaze_positions)

        # Check result size
        self.assertEqual(len(ts_fixations), 2)
        self.assertEqual(len(ts_saccades), 1)
        self.assertEqual(len(ts_status), 2 * size + move - 1)

        # Check first fixation
        fixation = ts_fixations.pop(0)

        self.assertEqual(len(fixation), size - 1) # BUG: NOT ALWAYS TRUE !!! 
        self.assertGreaterEqual(fixation.duration, (size - 2) * min_time)
        self.assertLessEqual(fixation.duration, (size - 2) * max_time)
        self.assertLessEqual(fixation.finished, True)

        # Check first saccade
        saccade = ts_saccades.pop(0)

        self.assertEqual(len(saccade), move + 2)
        self.assertGreaterEqual(saccade.duration, (move + 1) * min_time)
        self.assertLessEqual(saccade.duration, (move + 1) * max_time)
        self.assertLessEqual(saccade.finished, True)

        # Check that last position of a movement is equal to first position of next movement
        self.assertEqual(fixation[-1].timestamp, saccade[0].timestamp)
        self.assertEqual(fixation[-1].value, saccade[0].value)

        # Check second fixation
        fixation = ts_fixations.pop(0)

        self.assertEqual(len(fixation), size)
        self.assertGreaterEqual(fixation.duration, (size - 1) * min_time)
        self.assertLessEqual(fixation.duration, (size - 1) * max_time)
        self.assertLessEqual(fixation.finished, True)

        # Check that last position of a movement is equal to first position of next movement
        self.assertEqual(saccade[-1], fixation[0])
        self.assertEqual(saccade[-1].value, fixation[0].value)

    def test_invalid_gaze_position(self):
        """Test VelocityThresholdIdentification fixation and saccade identification with invalid gaze position."""

        size = 15
        center = (0, 0)
        deviation_max = 10
        min_time = 0.05
        max_time = 0.1
        velocity_max = deviation_max / min_time
        validity = [True, True, True, True, True, True, True, False, False, False, True, True, True, True, True]
        
        ts_gaze_positions = build_gaze_fixation(size, center, deviation_max, min_time, max_time, validity=validity)

        gaze_movement_identifier = VelocityThresholdIdentification.GazeMovementIdentifier(velocity_max_threshold=velocity_max, duration_min_threshold=max_time*2)
        ts_fixations, ts_saccades, ts_status = gaze_movement_identifier.browse(ts_gaze_positions)

        # Check result size
        self.assertEqual(len(ts_fixations), 2)
        self.assertEqual(len(ts_saccades), 0)
        self.assertEqual(len(ts_status), len(validity)-5)

        # Check first fixation
        fixation = ts_fixations.pop(0)

        self.assertEqual(len(fixation), 6)
        self.assertGreaterEqual(fixation.duration, 5 * min_time)
        self.assertLessEqual(fixation.duration, 5 * max_time)
        self.assertLessEqual(fixation.finished, True)

        # Check second fixation
        fixation = ts_fixations.pop(0)

        self.assertEqual(len(fixation), 4)
        self.assertGreaterEqual(fixation.duration, 3 * min_time)
        self.assertLessEqual(fixation.duration, 3 * max_time)
        self.assertLessEqual(fixation.finished, True)

    def test_identification_browsing(self):
        """Test VelocityThresholdIdentification identification browsing."""

        size = 10
        center_A = (0, 0)
        center_B = (50, 50)
        deviation_max = 10
        min_time = 0.01
        max_time = 0.1
        velocity_max = deviation_max / min_time
        
        ts_gaze_positions_A = build_gaze_fixation(size, center_A, deviation_max, min_time, max_time)
        ts_gaze_positions_B = build_gaze_fixation(size, center_B, deviation_max, min_time, max_time, start_ts=ts_gaze_positions_A[-1].timestamp)

        ts_gaze_positions = ts_gaze_positions_A + ts_gaze_positions_B

        gaze_movement_identifier = VelocityThresholdIdentification.GazeMovementIdentifier(velocity_max_threshold=velocity_max, duration_min_threshold=max_time*2)

        # Iterate on gaze positions
        for gaze_position in ts_gaze_positions:

            finished_gaze_movement = gaze_movement_identifier.identify(gaze_position.timestamp, gaze_position, terminate=(gaze_position.timestamp == ts_gaze_positions[-1]))

            # Check that last gaze position date is not equal to given gaze position date
            if finished_gaze_movement:

                self.assertNotEqual(finished_gaze_movement[-1].timestamp, gaze_position.timestamp)

            # Check that last gaze position date of current movement is equal to given gaze position date
            current_gaze_movement = gaze_movement_identifier.current_gaze_movement
            if current_gaze_movement:

                self.assertEqual(current_gaze_movement[-1].timestamp, gaze_position.timestamp)

if __name__ == '__main__':

    unittest.main()