aboutsummaryrefslogtreecommitdiff
path: root/src/argaze.test/PupilFeatures.py
blob: ecc94cdf894d93ecf9c8c7c2dd2f77a316870771 (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
#!/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

from argaze import PupilFeatures

import numpy

def random_pupil_diameters(size):
    """ Generate random TimeStampedPupilDiameters for testing purpose.
        Timestamps are current time.
        PupilDiameters are random values.
    """

    import random
    import time

    ts_pupil_diameters = PupilFeatures.TimeStampedPupilDiameters()
    
    for i in range(0, size):

        # Edit pupil diameter
        random_pupil_diameter = PupilFeatures.PupilDiameter(random.random())

        # Store pupil diameter
        ts_pupil_diameters[time.time()] = random_pupil_diameter

    return ts_pupil_diameters

class TestPupilDiameterClass(unittest.TestCase):
    """Test PupilDiameter class."""

    def test_new(self):
        """Test PupilDiameter creation."""
        
        # Check empty PupilDiameter
        empty_pupil_diameter = PupilFeatures.PupilDiameter()

        self.assertEqual(empty_pupil_diameter.value, 0.)
        self.assertEqual(empty_pupil_diameter.valid, False)

        # Check float PupilDiameter
        float_pupil_diameter = PupilFeatures.PupilDiameter(1.23)

        self.assertEqual(float_pupil_diameter.value, 1.23)
        self.assertEqual(float_pupil_diameter.valid, True)

    def test_properties(self):
        """Test PupilDiameter properties cannot be modified after creation."""

        pupil_diameter = PupilFeatures.PupilDiameter()

        # Check that pupil diameter value setting fails
        with self.assertRaises(AttributeError):

            pupil_diameter.value = 123

        self.assertNotEqual(pupil_diameter.value, 123)
        self.assertEqual(pupil_diameter.value, 0.)

    def test___repr__(self):
        """Test PupilDiameter string representation."""

        # Check empty PupilDiameter representation
        self.assertEqual(repr(PupilFeatures.PupilDiameter()), "{\"value\": 0.0}")

class TestUnvalidPupilDiameterClass(unittest.TestCase):
    """Test UnvalidPupilDiameter class."""

    def test_new(self):
        """Test UnvalidPupilDiameter creation."""

        unvalid_pupil_diameter = PupilFeatures.UnvalidPupilDiameter()

        self.assertEqual(unvalid_pupil_diameter.value, 0.)
        self.assertEqual(unvalid_pupil_diameter.valid, False)

    def test___repr__(self):
        """Test UnvalidPupilDiameter string representation."""

        self.assertEqual(repr(PupilFeatures.UnvalidPupilDiameter()), "{\"message\": null, \"value\": 0.0}")

class TestTimeStampedPupilDiametersClass(unittest.TestCase):
    """Test TimeStampedPupilDiameters class."""

    def test___setitem__(self):
        """Test __setitem__ method."""

        ts_pupil_diameters = PupilFeatures.TimeStampedPupilDiameters()
        ts_pupil_diameters[0] = PupilFeatures.PupilDiameter()
        ts_pupil_diameters[1] = PupilFeatures.UnvalidPupilDiameter()
        ts_pupil_diameters[2] = {"value": 1.23}

        # Check PupilDiameter is correctly stored and accessible as a PupilDiameter
        self.assertIsInstance(ts_pupil_diameters[0], PupilFeatures.PupilDiameter)
        self.assertEqual(ts_pupil_diameters[0].valid, False)

        # Check UnvalidPupilDiameter is correctly stored and accessible as a UnvalidPupilDiameter
        self.assertIsInstance(ts_pupil_diameters[1], PupilFeatures.UnvalidPupilDiameter)
        self.assertEqual(ts_pupil_diameters[1].valid, False)

        # Check dict with "value" and "precision" keys is correctly stored and accessible as a PupilDiameter
        self.assertIsInstance(ts_pupil_diameters[2], PupilFeatures.PupilDiameter)
        self.assertEqual(ts_pupil_diameters[2].valid, True)

        # Check that bad data type insertion fails
        with self.assertRaises(AssertionError):

            ts_pupil_diameters[3] = "This string is not a pupil diameter value."

        # Check that dict with bad keys insertion fails
        with self.assertRaises(AssertionError):

            ts_pupil_diameters[4] = {"bad_key": 0.}

    def test___repr__(self):
        """Test inherited string representation."""

        ts_pupil_diameters = PupilFeatures.TimeStampedPupilDiameters()

        self.assertEqual(repr(PupilFeatures.TimeStampedPupilDiameters()), "{}")

        ts_pupil_diameters[0] = PupilFeatures.PupilDiameter()
        
        self.assertEqual(repr(ts_pupil_diameters), "{\"0\": {\"value\": 0.0}}")

        ts_pupil_diameters[0] = PupilFeatures.UnvalidPupilDiameter()

        self.assertEqual(repr(ts_pupil_diameters), "{\"0\": {\"message\": null, \"value\": 0.0}}")

    def test_as_dataframe(self):
        """Test inherited as_dataframe method."""

        ts_pupil_diameters_dataframe = random_pupil_diameters(10).as_dataframe()

        # Check dataframe conversion
        self.assertEqual(ts_pupil_diameters_dataframe.index.name, "timestamp")
        self.assertEqual(ts_pupil_diameters_dataframe.index.size, 10)

        self.assertEqual(ts_pupil_diameters_dataframe.columns.size, 1)
        self.assertEqual(ts_pupil_diameters_dataframe.columns[0], "value")

        self.assertEqual(ts_pupil_diameters_dataframe["value"].dtype, 'float64')

        # Check unvalid diameter conversion
        ts_pupil_diameters = PupilFeatures.TimeStampedPupilDiameters()
        ts_pupil_diameters[0] = PupilFeatures.UnvalidPupilDiameter()
        ts_pupil_diameters_dataframe = ts_pupil_diameters.as_dataframe()

        self.assertEqual(ts_pupil_diameters_dataframe.index.name, "timestamp")
        self.assertEqual(ts_pupil_diameters_dataframe.index.size, 1)

        self.assertEqual(ts_pupil_diameters_dataframe.columns.size, 1)
        self.assertEqual(ts_pupil_diameters_dataframe.columns[0], "value")

        self.assertEqual(ts_pupil_diameters_dataframe["value"].dtype, 'float64')

if __name__ == '__main__':

    unittest.main()