Merge pull request #330 from CAMBI-tech/calib-task-refactor

Calibration task refactor

Author: lawhead

bcipy/display/main.py

@@ -23,9 +23,11 @@ class Display(ABC):
     stimuli_colors: List[str] = None
     stimuli_timing: List[float] = None
     task = None
+    info_text: List[Any] = None
+    first_stim_time: float = None
 
     @abstractmethod
-    def do_inquiry(self) -> List[float]:
+    def do_inquiry(self) -> List[Tuple[str, float]]:
         """Do inquiry.
 
         Animates an inquiry of stimuli and returns a list of stimuli trigger timing.

bcipy/display/paradigm/matrix/display.py

@@ -115,12 +115,12 @@ def __init__(self,
         self.should_prompt_target = should_prompt_target
 
         self.logger.info(
-            f"Symbol positions ({display_container.units} units):\n{self._stim_positions}"
+            f"Symbol positions ({display_container.units} units):\n{self.stim_positions}"
         )
         self.logger.info(f"Matrix center position: {display_container.center}")
 
     @property
-    def _stim_positions(self) -> Dict[str, Tuple[float, float]]:
+    def stim_positions(self) -> Dict[str, Tuple[float, float]]:
         """Returns a dict with the position for each stim"""
         assert self.stim_registry, "stim_registry not yet initialized"
         return {

bcipy/display/paradigm/rsvp/display.py

@@ -1,22 +1,17 @@
 import logging
 import os.path as path
-from typing import Optional, List, Tuple
+from typing import List, Optional, Tuple
 
-from psychopy import core, visual, event
+from psychopy import core, event, visual
 
-from bcipy.helpers.clock import Clock
-from bcipy.helpers.task import get_key_press
-from bcipy.helpers.symbols import SPACE_CHAR
-from bcipy.display import (
-    BCIPY_LOGO_PATH,
-    Display,
-    InformationProperties,
-    PreviewInquiryProperties,
-    StimuliProperties
-)
+from bcipy.display import (BCIPY_LOGO_PATH, Display, InformationProperties,
+                           PreviewInquiryProperties, StimuliProperties)
 from bcipy.display.components.task_bar import TaskBar
+from bcipy.helpers.clock import Clock
 from bcipy.helpers.stimuli import resize_image
+from bcipy.helpers.symbols import SPACE_CHAR
 from bcipy.helpers.system_utils import get_screen_info
+from bcipy.helpers.task import get_key_press
 from bcipy.helpers.triggers import TriggerCallback, _calibration_trigger
 
 
@@ -131,7 +126,7 @@ def schedule_to(self,
         self.stimuli_timing = timing or []
         self.stimuli_colors = colors or []
 
-    def do_inquiry(self, preview_calibration: bool = False) -> List[float]:
+    def do_inquiry(self, preview_calibration: bool = False) -> List[Tuple[str, float]]:
         """Do inquiry.
 
         Animates an inquiry of flashing letters to achieve RSVP.

bcipy/helpers/stimuli.py

@@ -89,6 +89,16 @@ class InquirySchedule(NamedTuple):
     durations: Union[List[List[float]], List[float]]
     colors: Union[List[List[str]], List[str]]
 
+    def inquiries(self) -> Iterator[Tuple]:
+        """Generator that iterates through each Inquiry. Yields tuples of
+        (stim, duration, color)."""
+        count = len(self.stimuli)
+        index = 0
+        while index < count:
+            yield (self.stimuli[index], self.durations[index],
+                   self.colors[index])
+            index += 1
+
 
 class Reshaper(ABC):