aboutsummaryrefslogtreecommitdiff
path: root/src/argaze/utils/demo/recorders.py
blob: 82022cef50d9412048dfd4702a2a0212b26cb6f7 (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
""" """

"""
This program is free software: you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation, either version 3 of the License, or (at your option) any later
version.
This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with
this program. If not, see <https://www.gnu.org/licenses/>.
"""

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

import logging
import time
import pathlib

from argaze import DataFeatures, GazeFeatures
from argaze.ArUcoMarker import ArUcoMarkerGroup
from argaze.utils import UtilsFeatures

class FixationRecorder(UtilsFeatures.FileWriter):

	def __init__(self, **kwargs):

		super().__init__(**kwargs)

		self.header = "Timestamp (ms)", "Focus (px)", "Duration (ms)", "AOI"

		logging.info('%s writes into %s', DataFeatures.get_class_path(self), self.path)

	def on_look(self, timestamp, frame, exception):
		"""Log frame fixations."""

		# Log fixations
		if GazeFeatures.is_fixation(frame.last_gaze_movement()) and frame.last_gaze_movement().is_finished():

			log = (
				timestamp, 
				frame.last_gaze_movement().focus, 
				frame.last_gaze_movement().duration, 
				frame.layers['demo_layer'].last_looked_aoi_name()
			)

			self.write(log)

class ScanPathAnalysisRecorder(UtilsFeatures.FileWriter):
	
	def __init__(self, **kwargs):

		super().__init__(**kwargs)

		self.header = "Timestamp (ms)", "Duration (ms)", "Step", "K", "NNI", "XXR"

		logging.info('%s writes into %s', DataFeatures.get_class_path(self), self.path)

	def on_look(self, timestamp, frame, exception):
		"""Log frame scan path metrics."""

		if frame.is_analysis_available():

			analysis = frame.analysis()

			log = (
				timestamp, 
				analysis['argaze.GazeAnalysis.Basic.ScanPathAnalyzer'].path_duration, 
				analysis['argaze.GazeAnalysis.Basic.ScanPathAnalyzer'].steps_number, 
				analysis['argaze.GazeAnalysis.KCoefficient.ScanPathAnalyzer'].K, 
				analysis['argaze.GazeAnalysis.NearestNeighborIndex.ScanPathAnalyzer'].nearest_neighbor_index, 
				analysis['argaze.GazeAnalysis.ExploreExploitRatio.ScanPathAnalyzer'].explore_exploit_ratio
			)

			self.write(log)

class FrameImageRecorder(UtilsFeatures.VideoWriter):

	def __init__(self, **kwargs):

		super().__init__(**kwargs)

		logging.info('%s writes into %s', DataFeatures.get_class_path(self), self.path)
	
	def on_look(self, timestamp, frame, exception):
		"""Write frame image."""

		self.write(frame.image())

class AOIScanPathAnalysisRecorder(UtilsFeatures.FileWriter):

	def __init__(self, **kwargs):

		super().__init__(**kwargs)

		self.header = "Timestamp (ms)", "Duration (ms)", "Step", "K", "LZC"

		logging.info('%s writes into %s', DataFeatures.get_class_path(self), self.path)

	def on_look(self, timestamp, layer, exception):
		"""Log layer aoi scan path metrics"""

		if layer.is_analysis_available():

			analysis = layer.analysis()

			log = (
				timestamp,
				analysis['argaze.GazeAnalysis.Basic.AOIScanPathAnalyzer'].path_duration, 
				analysis['argaze.GazeAnalysis.Basic.AOIScanPathAnalyzer'].steps_number, 
				analysis['argaze.GazeAnalysis.KCoefficient.AOIScanPathAnalyzer'].K, 
				analysis['argaze.GazeAnalysis.LempelZivComplexity.AOIScanPathAnalyzer'].lempel_ziv_complexity
			)

			self.write(log)


class ArUcoMarkersPoseRecorder(DataFeatures.PipelineStepObject):

	@DataFeatures.PipelineStepInit
	def __init__(self, **kwargs):

		# Init private attributes
		self.__output_folder = None
		self.__size = None

	@property
	def output_folder(self) -> str:
		"""folder path where to write ArUco markers pose."""
		return self.__output_folder

	@output_folder.setter
	def output_folder(self, output_folder: str):

		self.__output_folder = output_folder

	@property
	def size(self) -> float:
		"""Expected size in centimeters of detected markers."""
		return self.__output_folder

	@size.setter
	def size(self, size: float):

		self.__size = size

	@property
	def ids(self) -> list:
		"""Ids of markers to estimate pose (default all)."""
		return self.__ids

	@ids.setter
	def ids(self, ids: list):

		self.__ids = ids

	def on_detect_markers(self, timestamp, aruco_detector, exception):

		logging.info('%s writes estimated markers pose into %s', DataFeatures.get_class_path(self), self.__output_folder)

		if self.__size is not None:

			# Estimate all detected markers pose
			aruco_detector.estimate_markers_pose(self.__size, ids = self.__ids)

			# Build ArUco markers group from detected markers
			aruco_markers_group = ArUcoMarkerGroup.ArUcoMarkerGroup(dictionary=aruco_detector.dictionary, places=aruco_detector.detected_markers())

		if self.__output_folder is not None:

			# Write ArUco markers group
			aruco_markers_group.to_obj(f'{self.__output_folder}/{int(timestamp)}-aruco_markers_group.obj')