MultiTaskBattery 1.3.0__py3-none-any.whl

MultiTaskBattery/screen.py

@@ -0,0 +1,152 @@
+# created 2023: Bassel Arafat, Jorn Diedrichsen, Ince Husain
+from psychopy import visual, monitors
+from pyglet.canvas import get_display
+
+class Screen:
+    def __init__(self, const):
+        """    A class to create a screen for the experiment
+
+               Args:
+                    const (module):
+                        local constants.py module (see example_experiment/constants.py) as example
+                Returns:
+                    self (object):
+                        an instance of the Screen class
+        """
+        self.fullscr  = const['fullscr']
+        self.units    = 'deg'
+        self.color    = '#808080'
+        self.size     = const['size'] #[800, 800] #[1440, 900]
+        # physical width of the screen and eye-to-screen distance (cm); used to convert deg / cm to pixels.
+        # Required: the window works in degrees, so a guessed value would silently change stimulus sizes.
+        missing = [key for key in ('width', 'distance') if const.get(key) is None]
+        if missing:
+            raise ValueError(
+                f"{' and '.join(f'screen[{k!r}]' for k in missing)} missing from constants.py. "
+                "Set screen['width'] to the physical width of the screen image in cm (measure it) "
+                "and screen['distance'] to the eye-to-screen distance in cm.")
+        self.distance = const['distance']
+        self.width    = const['width']
+        self.allowGUI = True
+        self.screen_number = const['number']
+        self.monitor  = monitors.Monitor(
+                "stimulus",
+                distance = self.distance,
+                width = self.width,
+        )
+        self.monitor.setSizePix(self.size) # screen size (not window!) look in display prefs
+        self.monitor.saveMon()
+
+        self.check_monitors()
+
+        self.window   = visual.Window(size = self.size,
+                             screen = self.screen_number,
+                             monitor = self.monitor,
+                             fullscr = self.fullscr,
+                             units = self.units,
+                             color = self.color,
+                             allowGUI = self.allowGUI, allowStencil=True)
+
+    def check_monitors(self):
+
+        display = get_display()
+        screens = display.get_screens()
+
+        if self.fullscr and len(screens) <= 1:
+            print("Warning: Fullscreen mode is enabled, but you have no external monitor connected.")
+            print("Change the constants to not use fullscreen mode or connect an external monitor.")
+            print("Quitting the experiment to avoid a frozen screen....")
+            exit(1)
+
+
+    def start_screen(self, color='white', height=None, wrap_width=None):
+        """    A method to draw a start screen on the screen
+        """
+        loading_msg = visual.TextStim(self.window, text="Preparing experiment...", color=color, height=height or 2, wrapWidth=wrap_width or 30)
+        loading_msg.draw()
+        self.window.flip()
+
+    def fixation_cross(self, color='white', flip=True):
+        """    A method to draw a fixation cross on the screen
+
+               Args:
+                    color (str):
+                        color of the fixation cross
+                    flip (bool):
+                        whether to flip the screen after drawing the fixation cross
+                Returns:
+                    None
+        """
+        # Draw the fixation cross
+        fixation = visual.ShapeStim(self.window,
+            vertices=((0, -0.06), (0, 0.06), (0,0), (-0.04,0), (0.04, 0)),
+            lineWidth=20,
+            closeShape=False,
+            lineColor=color,
+            units='norm'
+        )
+        fixation.draw()
+
+        # Flip the screen only if flip is True
+        if flip:
+            self.window.flip()
+
+    def check_mark(self, color='green', flip=True):
+        """    A method to draw a check mark on the screen
+
+               Args:
+                    color (str):
+                        color of the check mark
+                    flip (bool):
+                        whether to flip the screen after drawing the check mark
+                Returns:
+                    None
+        """
+        # Draw the check mark as a filled outline (two thick lines leave a notch
+        # where they meet), in height units so it keeps its shape on any screen
+        check = visual.ShapeStim(self.window,
+            vertices=((-0.030, 0.012), (-0.011, -0.009), (0.034, 0.045),
+                      (0.051, 0.031), (-0.010, -0.042), (-0.046, -0.003)),
+            fillColor=color,
+            lineColor=None,
+            units='height'
+        )
+        check.draw()
+
+        # Flip the screen only if flip is True
+        if flip:
+            self.window.flip()
+
+    def error_cross(self, color='red', flip=True):
+        """    A method to draw an error cross on the screen
+
+               Args:
+                    color (str):
+                        color of the error cross
+                    flip (bool):
+                        whether to flip the screen after drawing the error cross
+                Returns:
+                    None
+        """
+        # Draw the fixation cross
+        cross_leg1 = visual.ShapeStim(self.window,
+            vertices=((-0.04, -0.06), (0.04, 0.06)),
+            lineWidth=20,
+            closeShape=False,
+            lineColor=color,
+            units='norm'
+        )
+        cross_leg1.draw()
+
+        cross_leg2 = visual.ShapeStim(self.window,
+            vertices=((-0.04, 0.06), (0.04, -0.06)),
+            lineWidth=20,
+            closeShape=False,
+            lineColor=color,
+            units='norm'
+        )
+        cross_leg2.draw()
+
+        # Flip the screen only if flip is True
+        if flip:
+            self.window.flip()