psychopy 2024.1.3__py3-none-any.whl → 2024.2.0__py3-none-any.whl

psychopy/experiment/components/mouse/__init__.py

@@ -150,13 +150,22 @@ class MouseComponent(BaseComponent):
             "        gotValidClick = True\n")
         buff.writeIndentedLines(code % self.params)
 
-        buff.setIndentLevel(+2, relative=True)
-        code = ''
+        # store clicked object if there was one
+        code = ""
         for paramName in self._clickableParamsList:
-            code += "%s.clicked_%s.append(obj.%s)\n" %(self.params['name'],
-                                                     paramName, paramName)
+            code += (
+                    f"        %(name)s.clicked_{paramName}.append(obj.{paramName})\n"
+                )
+        buff.writeIndentedLines(code % self.params)
+
+        # if storing every click and got an invalid click, store None for all params when there was no valid click
+        if self.params['saveMouseState'].val not in ['on valid click', 'never']:
+            code = "if not gotValidClick:\n"
+            for paramName in self._clickableParamsList:
+                code += (
+                    f"    %(name)s.clicked_{paramName}.append(None)\n"
+                )
         buff.writeIndentedLines(code % self.params)
-        buff.setIndentLevel(-2, relative=True)
 
     def _writeCorrectAnsCode(self, buff):
         code = (
@@ -183,7 +192,7 @@ class MouseComponent(BaseComponent):
             "// check whether click was in correct object\n"
             "if (gotValidClick) {\n"
             "    corr = 0;\n"
-            "    corrAns = %(correctAns)s;\n"
+            "    corrAns = eval( %(correctAns)s);\n"
             "    for (let obj of [corrAns]) {\n"
             "        if (obj.contains(%(name)s)) {\n"
             "            corr = 1;\n"
@@ -211,22 +220,35 @@ class MouseComponent(BaseComponent):
         code = (
             "// check if the mouse was inside our 'clickable' objects\n"
             "gotValidClick = false;\n"
-            "for (const obj of [{clickable}]) {{\n"
-            "  if (obj.contains({name})) {{\n"
-            "    gotValidClick = true;\n")
-        buff.writeIndentedLines(code.format(name=self.params['name'],
-                                            clickable=self.params['clickable'].val))
-        buff.setIndentLevel(+2, relative=True)
-        dedent = 2
-        code = ''
+            "%(name)s.clickableObjects = eval(%(clickable)s)\n;"
+            "// make sure the mouse's clickable objects are an array\n"
+            "if (!Array.isArray(%(name)s.clickableObjects)) {\n"
+            "    %(name)s.clickableObjects = [%(name)s.clickableObjects];\n"
+            "}\n"
+            "// iterate through clickable objects and check each\n"
+            "for (const obj of %(name)s.clickableObjects) {\n"
+            "    if (obj.contains(%(name)s)) {\n"
+            "        gotValidClick = true;\n"
+        )
         for paramName in self._clickableParamsList:
-            code += "%s.clicked_%s.push(obj.%s)\n" % (self.params['name'],
-                                                        paramName, paramName)
+            code += (
+                f"        %(name)s.clicked_{paramName}.push(obj.{paramName});\n"
+            )
+        code += (
+            "    }\n"
+            "}\n"
+        )
+        buff.writeIndentedLines(code % self.params)
 
+        # if storing every click and got an invalid click, store None for all params when there was no valid click
+        if self.params['saveMouseState'].val not in ['on valid click', 'never']:
+            code = "if (!gotValidClick) {\n"
+            for paramName in self._clickableParamsList:
+                code += (
+                    f"    %(name)s.clicked_{paramName}.push(null);\n"
+                )
+            code += "}\n"
         buff.writeIndentedLines(code % self.params)
-        for dents in range(dedent):
-            buff.setIndentLevel(-1, relative=True)
-            buff.writeIndented('}\n')
 
     def writeInitCode(self, buff):
         code = ("%(name)s = event.Mouse(win=win)\n"
@@ -746,14 +768,7 @@ class MouseComponent(BaseComponent):
                     mouseDataProps.append("clicked_{}".format(paramName))
             # use that set of properties to create set of addData commands
             for property in mouseDataProps:
-                if store == 'every frame' or forceEnd in ["never", "correct click"]:
-                    code = ("psychoJS.experiment.addData('%s.%s', %s.%s);\n" %
-                            (name, property, name, property))
-                    buff.writeIndented(code)
-                else:
-                    # we only had one click so don't return a list
-                    code = ("if (%s.%s) {"
-                            "  psychoJS.experiment.addData('%s.%s', %s.%s[0])};\n"
-                            % (name, property, name, property, name, property))
-                    buff.writeIndented(code)
+                code = ("psychoJS.experiment.addData('%s.%s', %s.%s);\n" %
+                        (name, property, name, property))
+                buff.writeIndented(code)
             buff.writeIndentedLines("\n")

psychopy/experiment/components/movie/__init__.py

@@ -80,7 +80,7 @@ class MovieComponent(BaseVisualComponent):
 
         msg = _translate("How loud should audio be played?")
         self.params["volume"] = Param(
-            volume, valType='num', inputType="float", categ='Playback',
+            volume, valType='num', inputType="single", categ='Playback',
             hint=msg,
             label=_translate("Volume"))
 

psychopy/experiment/components/polygon/__init__.py

@@ -26,6 +26,7 @@ class PolygonComponent(BaseVisualComponent):
                  fillColor='white', fillColorSpace='rgb',
                  shape='triangle', nVertices=4, vertices="",
                  pos=(0, 0), size=(0.5, 0.5), ori=0,
+                 draggable=False,
                  startType='time (s)', startVal=0.0,
                  stopType='duration (s)', stopVal=1.0,
                  startEstim='', durationEstim=''):
@@ -90,6 +91,14 @@ class PolygonComponent(BaseVisualComponent):
             updates='constant',
             hint=_translate("Which point on the stimulus should be anchored to its exact position?"),
             label=_translate("Anchor"))
+        self.params['draggable'] = Param(
+            draggable, valType="code", inputType="bool", categ="Layout",
+            updates="constant",
+            label=_translate("Draggable?"),
+            hint=_translate(
+                "Should this stimulus be moveble by clicking and dragging?"
+            )
+        )
 
         msg = _translate("What shape is this? With 'regular polygon...' you "
                          "can set number of vertices and with 'custom "
@@ -129,6 +138,14 @@ class PolygonComponent(BaseVisualComponent):
             "first value is used, for triangle and rect the [w,h] is as "
             "expected,\n but for higher-order polygons it represents the "
             "[w,h] of the ellipse that the polygon sits on!! ")
+        
+        self.depends.append({
+            'dependsOn': "shape",  # if...
+            'condition': "=='line'",  # is...
+            'param': "anchor",  # then...
+            'true': "hide",  # should...
+            'false': "show",  # otherwise...
+        })
 
         del self.params['color']
 
@@ -155,7 +172,7 @@ class PolygonComponent(BaseVisualComponent):
         if vertices in ['line', '2']:
             code = ("%s = visual.Line(\n" % inits['name'] +
                     "    win=win, name='%s',%s\n" % (inits['name'], unitsStr) +
-                    "    start=(-%(size)s[0]/2.0, 0), end=(+%(size)s[0]/2.0, 0),\n" % inits)
+                    "    size=%(size)s,\n" % inits)
         elif vertices in ['triangle', '3']:
             code = ("%s = visual.ShapeStim(\n" % inits['name'] +
                     "    win=win, name='%s',%s\n" % (inits['name'], unitsStr) +
@@ -186,9 +203,9 @@ class PolygonComponent(BaseVisualComponent):
                     "    win=win, name='%s', vertices=%s,%s\n" % (inits['name'], vertices, unitsStr) +
                     "    size=%(size)s,\n" % inits)
 
-        code += ("    ori=%(ori)s, pos=%(pos)s, anchor=%(anchor)s,\n"
-                 "    lineWidth=%(lineWidth)s, "
-                 "    colorSpace=%(colorSpace)s,  lineColor=%(lineColor)s, fillColor=%(fillColor)s,\n"
+        code += ("    ori=%(ori)s, pos=%(pos)s, draggable=%(draggable)s, anchor=%(anchor)s,\n"
+                 "    lineWidth=%(lineWidth)s,\n"
+                 "    colorSpace=%(colorSpace)s, lineColor=%(lineColor)s, fillColor=%(fillColor)s,\n"
                  "    opacity=%(opacity)s, " % inits)
 
         depth = -self.getPosInRoutine()
@@ -276,7 +293,9 @@ class PolygonComponent(BaseVisualComponent):
         if self.params['interpolate'].val != 'linear':
             interpolate = 'false'
 
-        code += ("  ori: {ori}, pos: {pos},\n"
+        code += ("  ori: {ori}, \n"
+                 "  pos: {pos}, \n"
+                 "  draggable: {draggable}, \n"
                  "  anchor: {anchor},\n"
                  "  lineWidth: {lineWidth}, \n"
                  "  colorSpace: {colorSpace},\n")      
@@ -310,5 +329,6 @@ class PolygonComponent(BaseVisualComponent):
                                             depth=depth,
                                             interpolate=interpolate,
                                             nVertices=inits['nVertices'],
-                                            vertices=inits['vertices']
+                                            vertices=inits['vertices'],
+                                            draggable=inits['draggable']
                                             ))

psychopy/experiment/components/progress/__init__.py

@@ -24,7 +24,7 @@ class ProgressComponent(BaseVisualComponent):
                  progress=0,
                  color="white", fillColor="None", borderColor="white", colorSpace="rgb",
                  opacity=1, lineWidth=4,
-                 pos=(0, 0), size=(0.5, 0.5), anchor="center left", ori=0, units="height",
+                 pos=(0, 0), size=(0.5, 0.5), anchor="center-left", ori=0, units="height",
                  disabled=False):
 
         self.exp = exp  # so we can access the experiment if necess

psychopy/experiment/components/roi/__init__.py

@@ -301,6 +301,11 @@ class RegionOfInterestComponent(PolygonComponent):
                 f"if {name}.numLooks:\n"
                 f"   {currLoop.params['name']}.addData('{name}.timesOn', {name}.timesOn{index})\n"
                 f"   {currLoop.params['name']}.addData('{name}.timesOff', {name}.timesOff{index})\n"
+                f"   # calculate and store dwell times i.e. the duration between look onsets and offsets\n"
+                f"   {name}.dwellTime = 0.0\n"
+                f"   for i in range(len({name}.timesOn)):\n"
+                f"       {name}.dwellTime += {name}.timesOff[i] - {name}.timesOn[i]\n"
+                f"   {currLoop.params['name']}.addData('{name}.dwellTime', {name}.dwellTime)\n"
                 f"else:\n"
                 f"   {currLoop.params['name']}.addData('{name}.timesOn', \"\")\n"
                 f"   {currLoop.params['name']}.addData('{name}.timesOff', \"\")\n"

psychopy/experiment/components/routineSettings/__init__.py

@@ -19,9 +19,10 @@ class RoutineSettingsComponent(BaseComponent):
             self, exp, parentName,
             # Basic
             name='',
-            skipIf="",
-            # Description
             desc="",
+            # Flow
+            skipIf="",
+            forceNonSlip=False,
             # Window
             useWindowParams=False,
             color="$[0,0,0]",
@@ -65,6 +66,17 @@ class RoutineSettingsComponent(BaseComponent):
         self.params['durationEstim'].categ = "Flow"
 
         # --- Flow params ---
+        self.order += [
+            "forceNonSlip",
+            "skipIf",
+        ]
+        self.params['forceNonSlip'] = Param(
+            forceNonSlip, valType="code", inputType="bool", categ="Flow",
+            hint=_translate(
+                "If this Routine ended by hitting its max duration, reset the timer by subtracting the max duration rather than resetting to 0. Only tick this if you're sure you know how long the Routine is going to take, otherwise you'll get incorrect timestamps in the next Routine!"
+            ),
+            label=_translate("Non-slip timing")
+        )
         self.params['skipIf'] = Param(
             skipIf, valType='code', inputType="single", categ='Flow',
             updates='constant',
@@ -146,17 +158,34 @@ class RoutineSettingsComponent(BaseComponent):
     def writeRoutineStartCode(self, buff):
         # Sanitize
         params = self.params.copy()
-        # Store Routine start time (UTC)
+        if params['stopVal'] in ("None", None, ""):
+            params['stopVal'].val = "None"
+        # store start times
+        code = (
+            "# store start times for %(name)s\n"
+            "%(name)s.tStartRefresh = win.getFutureFlipTime(clock=globalClock)\n"
+            "%(name)s.tStart = globalClock.getTime(format='float')\n"
+            "%(name)s.status = STARTED\n"
+        )
+        buff.writeIndentedLines(code % self.params)
+        # add to data file if requested
         if self.params['saveStartStop']:
             code = (
-                "thisExp.addData('%(name)s.started', globalClock.getTime(format='float'))\n"
+            "thisExp.addData('%(name)s.started', %(name)s.tStart)\n"
+            )
+            buff.writeIndentedLines(code % params)
+        # calculate expected Routine duration
+        if self.params['stopType'] == "duration (s)":
+            code = (
+                "%(name)s.maxDuration = %(stopVal)s\n"
             )
             buff.writeIndentedLines(code % params)
         # Skip Routine if condition is met
         if params['skipIf'].val not in ('', None, -1, 'None'):
             code = (
-                "# skip this Routine if its 'Skip if' condition is True\n"
-                "continueRoutine = continueRoutine and not (%(skipIf)s)\n"
+                "# skip Routine %(name)s if its 'Skip if' condition is True\n"
+                "%(name)s.skipped = continueRoutine and not (%(skipIf)s)\n"
+                "continueRoutine = %(name)s.skipped\n"
             )
             buff.writeIndentedLines(code % params)
         # Change window appearance for this Routine (if requested)
@@ -172,6 +201,8 @@ class RoutineSettingsComponent(BaseComponent):
     def writeRoutineStartCodeJS(self, buff):
         # Sanitize
         params = self.params.copy()
+        if params['stopVal'] in ("None", None, ""):
+            params['stopVal'].val = "None"
         # Store Routine start time (UTC)
         if self.params['saveStartStop']:
             code = (
@@ -183,6 +214,13 @@ class RoutineSettingsComponent(BaseComponent):
             code = (
                 "// skip this Routine if its 'Skip if' condition is True\n"
                 "continueRoutine = continueRoutine && !(%(skipIf)s);\n"
+                "maxDurationReached = false\n"
+            )
+            buff.writeIndentedLines(code % params)
+        # calculate expected Routine duration
+        if self.params['stopType'] == "duration (s)":
+            code = (
+                "%(name)sMaxDuration = %(stopVal)s\n"
             )
             buff.writeIndentedLines(code % params)
         # Change window appearance for this Routine (if requested)
@@ -224,7 +262,8 @@ class RoutineSettingsComponent(BaseComponent):
                 # Stop after given number of seconds
                 code = (
                     f"# is it time to end the Routine? (based on local clock)\n"
-                    f"if tThisFlip > %(stopVal)s-frameTolerance:\n"
+                    f"if tThisFlip > %(name)s.maxDuration-frameTolerance:\n"
+                    f"    %(name)s.maxDurationReached = True\n"
                 )
             elif self.params['stopType'].val == 'frame N':
                 # Stop at given frame num
@@ -261,7 +300,8 @@ class RoutineSettingsComponent(BaseComponent):
                 # Stop after given number of seconds
                 code = (
                     f"// is it time to end the Routine? (based on local clock)\n"
-                    f"if (t > %(stopVal)s) {{\n"
+                    f"if (t > %(name)sMaxDuration) {{\n"
+                    f"    %(name)sMaxDurationReached = true\n"
                 )
             elif self.params['stopType'].val == 'frame N':
                 # Stop at given frame num
@@ -287,10 +327,17 @@ class RoutineSettingsComponent(BaseComponent):
 
     def writeRoutineEndCode(self, buff):
         params = self.params.copy()
-        # Store Routine start time (UTC)
+        # store stop times
+        code = (
+            "# store stop times for %(name)s\n"
+            "%(name)s.tStop = globalClock.getTime(format='float')\n"
+            "%(name)s.tStopRefresh = tThisFlipGlobal\n"
+        )
+        buff.writeIndentedLines(code % params)
+        # add to data file if requested
         if self.params['saveStartStop']:
             code = (
-                "thisExp.addData('%(name)s.stopped', globalClock.getTime(format='float'))\n"
+                "thisExp.addData('%(name)s.stopped', %(name)s.tStop)\n"
             )
             buff.writeIndentedLines(code % params)
         # Restore window appearance after this Routine (if changed)