initial commit for v3 (not yet ready)

main change is that all functionality is moved to glassesTools (except the make_video() function)
logic has also changed, offset from gaze data to target is now only computed for matched targets, not for all gaze samples and all targets, so much quicker and not generating large mostly useless file
fixed some bugs in the process

Author: dcnieho

README.md

@@ -1,5 +1,4 @@
 glassesTools[GUI]==1.15.0   # pulls in various other dependencies such as imgui_bundle, matplotlib, numpy, opencv, pandas, polars
-I2MC>=2.2.6
 aiosqlite
 uvloop ; sys_platform != "win32"
 pyobjc-framework-Cocoa ; sys_platform == "darwin"

requirements.txt

@@ -10,14 +10,15 @@
 
 from glassesTools import async_thread, platform, recording
 from glassesTools.eyetracker import EyeTracker, eye_tracker_names
+eye_tracker_names = [e for e in eye_tracker_names if e!=EyeTracker.Generic.value]
 from glassesTools.gui import msg_box, recording_table, utils as gui_utils
+from glassesTools.validation import config, DataQualityType, export
 
 from .structs import JobDescription, Recording
 from . import globals, db, gui, process_pool
 from ...utils import Task, get_next_task
 from ...preprocess import make_fs_dirname
-from ... import config, preprocess, process, utils as gv_utils
-from ...process import DataQualityType, collect_data_quality, summarize_and_store_data_quality
+from ... import preprocess, process, utils as gv_utils
 
 
 
@@ -64,7 +65,7 @@ async def deploy_config(project_path: str|pathlib.Path, config_dir: str):
         gui_utils.push_popup(globals, msg_box.msgbox, "Deploy configuration", f"The folder {conf_dir} already exist. Do you want to deploy a configuration to this folder,\npotentially overwriting any configuration that is already there?", msg_box.MsgBox.warn, buttons)
 
 async def deploy_poster_pdf(dir: str|pathlib.Path):
-    config.poster.deploy_default_pdf(dir)
+    config.plane.deploy_default_pdf(dir)
 
 async def remove_recording_working_dir(rec: Recording):
     if rec.working_directory and rec.working_directory.is_dir():
@@ -191,18 +192,18 @@ async def process_recording(rec: Recording, task: Task=None, chain=True):
             args = tuple()
             kwargs['rec_info'] = rec
             kwargs['copy_scene_video'] = globals.settings.copy_scene_video
-        case Task.Coded | Task.Markers_Detected | Task.Gaze_Tranformed_To_Poster | Task.Target_Offsets_Computed | Task.Fixation_Intervals_Determined | Task.Data_Quality_Calculated | Task.Make_Video:
+        case Task.Coded | Task.Markers_Detected | Task.Gaze_Tranformed_To_Plane | Task.Fixations_Classified | Task.Fixation_Assigned | Task.Data_Quality_Calculated | Task.Make_Video:
             match task:
                 case Task.Coded:
                     fun = process.code_marker_interval
                 case Task.Markers_Detected:
                     fun = process.detect_markers
-                case Task.Gaze_Tranformed_To_Poster:
-                    fun = process.gaze_to_poster
-                case Task.Target_Offsets_Computed:
-                    fun = process.compute_offsets_to_targets
-                case Task.Fixation_Intervals_Determined:
-                    fun = process.determine_fixation_intervals
+                case Task.Gaze_Tranformed_To_Plane:
+                    fun = process.gaze_to_plane
+                case Task.Fixations_Classified:
+                    fun = process.classify_fixations
+                case Task.Fixation_Assigned:
+                    fun = process.assign_fixations
                     kwargs['do_global_shift'] = globals.settings.fix_assign_do_global_shift
                     kwargs['max_dist_fac']    = globals.settings.fix_assign_max_dist_fac
                 case Task.Data_Quality_Calculated:
@@ -267,7 +268,7 @@ async def cancel_processing_recordings(ids: list[int]):
 async def export_data_quality(ids: list[int]):
     # 1. collect all data quality from the selected recordings
     rec_dirs = [globals.recordings[id].working_directory for id in ids]
-    df, default_dq_type, targets = collect_data_quality(rec_dirs)
+    df, default_dq_type, targets = export.collect_data_quality(rec_dirs)
     if df is None:
         gui_utils.push_popup(globals, msg_box.msgbox, "Export error", "There is no data quality for the selected recordings. Did you code any validation intervals (see manual)?", msg_box.MsgBox.error)
         return
@@ -317,4 +318,4 @@ def show_config_popup():
 async def _export_data_quality(df: pd.DataFrame, pop_data: dict):
     dq_types = [dq for i,dq in enumerate(pop_data['dq_types']) if pop_data['dq_types_sel'][i]]
     targets  = [t for i,t in enumerate(pop_data['targets']) if pop_data['targets_sel'][i]]
-    summarize_and_store_data_quality(df, globals.project_path, dq_types, targets, pop_data['targets_avg'], pop_data['include_data_loss'])
+    export.summarize_and_store_data_quality(df, globals.project_path, dq_types, targets, pop_data['targets_avg'], pop_data['include_data_loss'])

src/glassesValidator/GUI/_impl/callbacks.py

@@ -147,6 +147,7 @@ async def connect():
             "start_time":                   f'INTEGER DEFAULT 0',
             "duration":                     f'INTEGER DEFAULT 0',
             "eye_tracker":                  f'TEXT    DEFAULT "{EyeTracker.Unknown.value}"',
+            "eye_tracker_name":             f'TEXT    DEFAULT ""',
             "project":                      f'TEXT    DEFAULT ""',
             "participant":                  f'TEXT    DEFAULT ""',
             "firmware_version":             f'TEXT    DEFAULT ""',

src/glassesValidator/GUI/_impl/db.py

@@ -1,5 +1,4 @@
 import concurrent.futures
-from typing import Tuple
 import configparser
 import platform
 import asyncio
@@ -15,17 +14,18 @@
 import io
 
 from glassesTools.eyetracker import EyeTracker, eye_tracker_names
+eye_tracker_names = [e for e in eye_tracker_names if e!=EyeTracker.Generic.value]
 from glassesTools.gui import file_picker, msg_box, recording_table, utils as gui_utils
 from glassesTools.gui.utils import my_checkbox, my_combo, handle_popup_stack
 from glassesTools.utils import hex_to_rgba_0_1
 from glassesTools import async_thread, platform as pltfrm, recording as gt_recording
+from glassesTools.validation import DataQualityType, get_DataQualityType_explanation
 import glassesTools
 
 from .structs import DefaultStyleDark, DefaultStyleLight, Filter, FilterMode, ProcessState, Recording, TaskSimplified, filter_mode_names, get_simplified_task_state, simplified_task_names
 from . import globals, callbacks, db, process_pool, utils
 from .. import _general_imgui
 from ...utils import Task, Status, get_task_name_friendly, get_next_task, task_names, get_last_finished_step, get_recording_status, update_recording_status
-from ...process import DataQualityType, get_DataQualityType_explanation
 
 imgui.io = None
 imgui.style = None
@@ -620,11 +620,11 @@ def update_recordings(self, subset=None):
         if not subset:
             subset = globals.recordings
         for recid in subset:
-            rec_info = gt_recording.Recording.load_from_json(globals.recordings[recid].working_directory)
-            if rec_info.duration!=globals.recordings[recid].duration:
-                globals.recordings[recid].duration = rec_info.duration
-                async_thread.run(db.update_recording(globals.recordings[recid], "duration"))
             if globals.recordings[recid].task not in [Task.Not_Imported, Task.Unknown]:
+                rec_info = gt_recording.Recording.load_from_json(globals.recordings[recid].working_directory)
+                if rec_info.duration!=globals.recordings[recid].duration:
+                    globals.recordings[recid].duration = rec_info.duration
+                    async_thread.run(db.update_recording(globals.recordings[recid], "duration"))
                 last_task = get_last_finished_step(get_recording_status(globals.recordings[recid].working_directory))
                 globals.recordings[recid].task = last_task
                 async_thread.run(db.update_recording(globals.recordings[recid], "task"))
@@ -1632,7 +1632,7 @@ def draw_sidebar(self):
             imgui.text("Use global shift:")
             imgui.same_line()
             gui_utils.draw_hover_text(
-                "If selected, for each validation interval the mean position will be removed from the gaze data and the targets, removing any overall shift of the data. This improves the matching of fixations to targets when there is a significant overall offset in the data. It may fail (backfire) if there are data samples far outside the range of the validation targets, or if there is no data for some targets."
+                "If selected, for each validation interval the median position will be removed from the gaze data and mean from the targets, removing any overall shift of the data. This improves the matching of fixations to targets when there is a significant overall offset in the data. It may fail (backfire) if there are data samples far outside the range of the validation targets, or if there is no data for some targets."
             )
             imgui.table_next_column()
             imgui.set_cursor_pos_x(imgui.get_cursor_pos_x() + checkbox_offset)

src/glassesValidator/GUI/_impl/gui.py

@@ -76,7 +76,7 @@ def get_simplified_task_state(task: Task):
         case Task.Imported:
             return TaskSimplified.Imported
         # after stage 2 / during stage 3
-        case Task.Coded | Task.Markers_Detected | Task.Gaze_Tranformed_To_Poster | Task.Target_Offsets_Computed | Task.Fixation_Intervals_Determined:
+        case Task.Coded | Task.Markers_Detected | Task.Gaze_Tranformed_To_Plane | Task.Fixations_Classified | Task.Fixation_Assigned:
             return TaskSimplified.Coded
         # after stage 3:
         case Task.Data_Quality_Calculated:

src/glassesValidator/GUI/_impl/structs.py

@@ -1,6 +1,5 @@
 # -*- coding: utf-8 -*-
 
-from . import config
 from . import GUI
 from . import preprocess
 from . import process