Output stim positions, capture screenshots, more cleanup (#303)

* stimuli position export + capture matrix grid

* update offline analysis and gaze visualization

* remove unneeded class variable

* dsi-flex and better starting parameters

* update the calibration tests to mock open and prevent testing issues on Windows

* revert parameter change

* update to workflow to fix Windows build

* revert actions change, lock a pyqt6 dep

* remove unneeded assertions and save the current task bar index before a screen capture

* add more info to output, update CHANGELOG

Author: tab-cmd

.coveragerc

@@ -6,6 +6,7 @@ omit =
         *tests*
         *test*
         *demo*
+        *exceptions.py
         */gui/*
 
 [report]

CHANGELOG.md

@@ -10,7 +10,7 @@ Our last release candidate before the official 2.0 release!
 - Model
     - Offline analysis to support multimodal fusion. Initial release of GazeModel, GazeReshaper, and Gaze Visualization #294
 - Stimuli
-    - Updates to ensure stimuli are presented at the same frequency #287
+    - Updates to ensure stimuli are presented at the same frequency #287 Output stimuli position, screen capture and monitor information after Matrix tasks #303
 - Dynamic Selection Window
     - Updated trial_length to trial_window to allow for greater control of window used after stimulus presentations #291
 - Parameters

bcipy/acquisition/tests/test_devices.py

@@ -27,7 +27,7 @@ def test_default_supported_devices(self):
         dsi = supported['DSI-24']
         self.assertEqual('EEG', dsi.content_type)
 
-        self.assertEqual(len(devices.with_content_type('EEG')), 3)
+        self.assertEqual(len(devices.with_content_type('EEG')), 4)
 
     def test_load_from_config(self):
         """Should be able to load a list of supported devices from a

bcipy/config.py

@@ -37,13 +37,17 @@
 DEFAULT_FIXATION_PATH = f'{STATIC_IMAGES_PATH}/main/PLUS.png'
 DEFAULT_TEXT_FIXATION = '+'
 
+MATRIX_IMAGE_FILENAME = 'matrix.png'
+DEFAULT_GAZE_IMAGE_PATH = f'{STATIC_IMAGES_PATH}/main/{MATRIX_IMAGE_FILENAME}'
+
 # core data configuration
 RAW_DATA_FILENAME = 'raw_data'
 EYE_TRACKER_FILENAME_PREFIX = 'eyetracker_data'
 TRIGGER_FILENAME = 'triggers.txt'
 SESSION_DATA_FILENAME = 'session.json'
 SESSION_SUMMARY_FILENAME = 'session.xlsx'
 LOG_FILENAME = 'bcipy_system_log.txt'
+STIMULI_POSITIONS_FILENAME = 'stimuli_positions.json'
 
 # misc configuration
 WAIT_SCREEN_MESSAGE = 'Press Space to start or Esc to exit'

bcipy/display/paradigm/matrix/display.py

@@ -5,6 +5,7 @@
 from psychopy import core, visual
 
 import bcipy.display.components.layout as layout
+from bcipy.config import MATRIX_IMAGE_FILENAME
 from bcipy.display import (BCIPY_LOGO_PATH, Display, InformationProperties,
                            StimuliProperties)
 from bcipy.display.components.task_bar import TaskBar
@@ -127,6 +128,23 @@ def _stim_positions(self) -> Dict[str, Tuple[float, float]]:
             for sym, stim in self.stim_registry.items()
         }
 
+    def capture_grid_screenshot(self, file_path: str) -> None:
+        """Capture Grid Screenshot.
+
+        Capture a screenshot of the current display and save it to the specified filename.
+        """
+        # draw the grid and flip the window
+        self.draw_grid(opacity=self.full_grid_opacity)
+        tmp_task_bar = self.task_bar.current_index
+        self.task_bar.current_index = 0
+        self.draw_static()
+        self.window.flip()
+
+        # capture the screenshot and save it to the specified file path
+        capture = self.window.getMovieFrame()
+        capture.save(f'{file_path}/{MATRIX_IMAGE_FILENAME}')
+        self.task_bar.current_index = tmp_task_bar
+
     def schedule_to(self, stimuli: list, timing: list, colors: list) -> None:
         """Schedule stimuli elements (works as a buffer).
 
@@ -158,13 +176,13 @@ def add_timing(self, stimuli: str):
 
         Useful as a callback function to register a marker at the time it is
         first displayed."""
-        self._timing.append([stimuli, self.experiment_clock.getTime()])
+        self._timing.append((stimuli, self.experiment_clock.getTime()))
 
     def reset_timing(self):
         """Reset the trigger timing."""
         self._timing = []
 
-    def do_inquiry(self) -> List[float]:
+    def do_inquiry(self) -> List[Tuple[str, float]]:
         """Animates an inquiry of stimuli and returns a list of stimuli trigger timing."""
         self.reset_timing()
         symbol_durations = self.symbol_durations()
@@ -187,11 +205,12 @@ def build_grid(self) -> Dict[str, visual.TextStim]:
         grid = {}
         for sym in self.symbol_set:
             pos_index = self.sort_order(sym)
+            pos = self.positions[pos_index]
             grid[sym] = visual.TextStim(win=self.window,
                                         text=sym,
                                         color=self.grid_color,
                                         opacity=self.start_opacity,
-                                        pos=self.positions[pos_index],
+                                        pos=pos,
                                         height=self.grid_stimuli_height)
         return grid
 
@@ -337,8 +356,6 @@ def update_task_bar(self, text: str = ''):
         PARAMETERS:
 
         text: text for task
-        color_list: list of the colors for each stimuli
-        pos: position of task
         """
         if self.task_bar:
             self.task_bar.update(text)

bcipy/feedback/demo/demo_level_feedback.py

@@ -6,13 +6,16 @@
 from pathlib import Path
 from shutil import copyfile
 from time import localtime, strftime
-from typing import Any, List, Union
+from typing import Any, Dict, List, Tuple, Union
 
 from bcipy.acquisition.devices import DeviceSpec
-from bcipy.config import (DEFAULT_ENCODING, DEFAULT_EXPERIMENT_ID,
+from bcipy.config import (DEFAULT_ENCODING,
+                          DEFAULT_EXPERIMENT_ID,
                           DEFAULT_LM_PARAMETERS_FILENAME,
                           DEFAULT_LM_PARAMETERS_PATH,
-                          DEFAULT_PARAMETER_FILENAME, SIGNAL_MODEL_FILE_SUFFIX)
+                          DEFAULT_PARAMETER_FILENAME,
+                          SIGNAL_MODEL_FILE_SUFFIX,
+                          STIMULI_POSITIONS_FILENAME)
 from bcipy.helpers.validate import validate_experiments
 from bcipy.signal.model.base_model import SignalModel
 
@@ -33,16 +36,26 @@ def save_json_data(data: Any, location: str, name: str) -> str:
     return str(path)
 
 
-def save_experiment_data(experiments, fields, location, name) -> str:
+def save_experiment_data(
+        experiments: dict,
+        fields: dict,
+        location: str,
+        name: str) -> str:
     validate_experiments(experiments, fields)
     return save_json_data(experiments, location, name)
 
 
-def save_field_data(fields, location, name) -> str:
+def save_field_data(
+        fields: dict,
+        location: str,
+        name: str) -> str:
     return save_json_data(fields, location, name)
 
 
-def save_experiment_field_data(data, location, name) -> str:
+def save_experiment_field_data(
+        data: dict,
+        location: str,
+        name: str) -> str:
     return save_json_data(data, location, name)
 
 
@@ -154,7 +167,7 @@ def _save_session_related_data(save_path: str, session_dictionary: dict) -> Any:
     return file
 
 
-def save_model(model: SignalModel, path: Union[Path, str]):
+def save_model(model: SignalModel, path: Union[Path, str]) -> None:
     """Save model weights (e.g. after training) to `path`
 
     Parameters
@@ -169,3 +182,27 @@ def save_model(model: SignalModel, path: Union[Path, str]):
         # It supports very large objects and some data format optimizations
         # making it appropriate for signal models.
         pickle.dump(model, file, protocol=4)
+
+
+def save_stimuli_position_info(
+        stimuli_position_info: Dict[str, Tuple[float, float]],
+        path: Union[Path, str],
+        screen_info: Dict[str, Any]) -> str:
+    """Save stimuli positions and screen info to `path`
+
+   stimuli_position_info: {'A': (0, 0)}
+   screen_info: {'screen_size_pixels': [1920, 1080], 'screen_refresh': 160}
+
+    Parameters
+    ----------
+        stimuli_position_info - stimuli position info to save to json
+        path - path to the file which will be created.
+        screen_info - screen info to save to json
+    """
+    # assert that screen_info is a dict with at least the key 'screen_resolution'
+    assert 'screen_size_pixels' in screen_info.keys(), \
+        'screen_size_pixels must be a key in screen_info'
+
+    # combine the dicts
+    all_data = {**stimuli_position_info, **screen_info}
+    return save_json_data(all_data, path, STIMULI_POSITIONS_FILENAME)