Merge pull request #1984 from pupil-labs/support-pi-headset-worn-classifier-data

Support PI headset on/off classifier data

Author: papr

pupil_src/shared_modules/pupil_recording/update/invisible.py

@@ -28,7 +28,7 @@
 
 logger = logging.getLogger(__name__)
 
-NEWEST_SUPPORTED_VERSION = Version("1.2")
+NEWEST_SUPPORTED_VERSION = Version("1.3")
 
 
 def transform_invisible_to_corresponding_new_style(rec_dir: str):
@@ -144,14 +144,15 @@ def _convert_gaze(recording: PupilRecording):
         "topic": "gaze.pi",
         "norm_pos": None,
         "timestamp": None,
-        "confidence": 1.0,
+        "confidence": None,
     }
     with fm.PLData_Writer(recording.rec_dir, "gaze") as writer:
-        for ((x, y), ts) in pi_gaze_items(root_dir=recording.rec_dir):
+        for ((x, y), ts, conf) in pi_gaze_items(root_dir=recording.rec_dir):
             template_datum["timestamp"] = ts
             template_datum["norm_pos"] = m.normalize(
                 (x, y), size=(width, height), flip_y=True
             )
+            template_datum["confidence"] = conf
             writer.append(template_datum)
         logger.info(f"Converted {len(writer.ts_queue)} gaze positions.")
 

pupil_src/shared_modules/video_capture/utils.py

@@ -468,6 +468,16 @@ def find_raw_path(timestamps_path):
         assert raw_path.exists(), f"The file does not exist at path: {raw_path}"
         return raw_path
 
+    def find_worn_path(timestamps_path):
+        worn_name = timestamps_path.name
+        worn_name = worn_name.replace("gaze", "worn")
+        worn_name = worn_name.replace("_timestamps", "")
+        worn_path = timestamps_path.with_name(worn_name).with_suffix(".raw")
+        if worn_path.exists():
+            return worn_path
+        else:
+            return None
+
     def load_timestamps_data(path):
         timestamps = np.load(str(path))
         return timestamps
@@ -478,6 +488,13 @@ def load_raw_data(path):
         raw_data.shape = (-1, 2)
         return np.asarray(raw_data, dtype=raw_data_dtype)
 
+    def load_worn_data(path):
+        if not (path and path.exists()):
+            return None
+
+        confidences = np.fromfile(str(path), "<u1") / 255.0
+        return np.clip(confidences, 0.0, 1.0)
+
     # This pattern will match any filename that:
     # - starts with "gaze ps"
     # - is followed by one or more digits
@@ -496,4 +513,16 @@ def load_raw_data(path):
             size = min(len(raw_data), len(timestamps))
             raw_data = raw_data[:size]
             timestamps = timestamps[:size]
-        yield from zip(raw_data, timestamps)
+
+        conf_data = load_worn_data(find_worn_path(timestamps_path))
+        if conf_data is not None and len(conf_data) != len(timestamps):
+            logger.warning(
+                f"There is a mismatch between the number of confidence data ({len(conf_data)}) "
+                f"and the number of timestamps ({len(timestamps)})! Not using confidence data."
+            )
+            conf_data = None
+
+        if conf_data is None:
+            conf_data = (1.0 for _ in range(len(timestamps)))
+
+        yield from zip(raw_data, timestamps, conf_data)