def __init__(self, exp, parentName, name='bbox',
active="(0,1,2,3,4,5,6,7)", store='first button',
forceEndRoutine=True, storeCorrect=False, correctAns="0",
discardPrev=True, lights=True, lightsOff=False,
startType='time (s)', startVal=0.0,
stopType='duration (s)', stopVal=1.0,
startEstim='', durationEstim=''):
super(ioLabsButtonBoxComponent, self).__init__(
exp, parentName, name=name,
store=store, discardPrev=discardPrev, correctAns=correctAns,
forceEndRoutine=forceEndRoutine, storeCorrect=storeCorrect,
startType=startType, startVal=startVal,
stopType=stopType, stopVal=stopVal,
startEstim=startEstim, durationEstim=durationEstim)
self.type = 'ioLabsButtonBox'
self.url = "http://www.psychopy.org/builder/components/ioLabs.html"
self.exp.requirePsychopyLibs(['hardware'])
del self.params['allowedKeys']
# NB name and timing params always come 1st
self.order = ['forceEndRoutine', 'active', 'lights', 'store',
'storeCorrect', 'correctAns']
msg = _translate(
"What is the 'correct' response? NB, buttons are labelled 0 to "
"7 on a 8-button box. Enter 'None' (no quotes) if withholding "
"a response is correct. Might be helpful to add a correctAns "
"column and use $correctAns to compare to the key press.")
self.params['correctAns'].hint = msg
self.params['store'].allowedVals = ['last button', 'first button',
'all buttons', 'nothing']
msg = _translate(
'Choose which (if any) responses to store at end of a trial')
self.params['store'].hint = msg
msg = _translate("Active buttons, such as '1,6', '(1,2,5,6)' or '0' "
"(without quotes)")
self.params['active'] = Param(
active, valType='code', allowedTypes=[],
updates='constant',
allowedUpdates=['constant', 'set every repeat'],
hint=msg,
label=_localized['active'])
self.params['lights'] = Param(
lights, valType='bool', allowedTypes=[],
updates='constant', allowedUpdates=[],
hint=_translate("Turn ON the lights for the active buttons?"),
label=_localized['lights'])
self.params['lights off'] = Param(
lightsOff, valType='bool', allowedTypes=[],
updates='constant', allowedUpdates=[],
hint=_translate("Turn OFF all lights at the end of each routine?"),
label=_localized['lights off'])
from builtins import super # provides Py3-style super() using python-future
from psychopy.localization import _localized as __localized
_localized = __localized.copy()
from os import path
from psychopy.experiment.components.keyboard import KeyboardComponent, Param, _translate
from psychopy.experiment.utils import valid_var_re
__author__ = 'Jeremy Gray'
# abs path to the folder containing this path
thisFolder = path.abspath(path.dirname(__file__))
iconFile = path.join(thisFolder, 'ioLabs.png')
tooltip = _translate('ioLabs ButtonBox: check and record response buttons on '
'ioLab Systems ButtonBox')
# only use _localized values for label values, nothing functional:
_localized.update({
'active': _translate('Active buttons'),
'lights': _translate('Lights'),
'lights off': _translate('Lights off')
})
class ioLabsButtonBoxComponent(KeyboardComponent):
"""An event class for checking an ioLab Systems buttonbox.
This is based on keyboard component, several important differences:
- no special response class analogous to event.BuilderKeyResponse()
- enabled responses (active buttons) are handled by the hardware device
class ioLabsButtonBoxComponent(KeyboardComponent):
"""An event class for checking an ioLab Systems buttonbox.
This is based on keyboard component, several important differences:
- no special response class analogous to event.BuilderKeyResponse()
- enabled responses (active buttons) are handled by the hardware device
More than one component in a routine will produce conflicts between
components over which active buttons (for responses and lights).
"""
categories = ['Responses'] # which section(s) in the components panel
targets = ['PsychoPy']
iconFile = Path(__file__).parent / 'ioLabs.png'
tooltip = _translate(
'ioLabs ButtonBox: check and record response buttons on '
'ioLab Systems ButtonBox')
def __init__(self,
exp,
parentName,
name='bbox',
active="(0,1,2,3,4,5,6,7)",
store='first button',
forceEndRoutine=True,
storeCorrect=False,
correctAns="0",
discardPrev=True,
lights=True,
lightsOff=False,
startType='time (s)',
startVal=0.0,
stopType='duration (s)',
stopVal=1.0,
startEstim='',
durationEstim=''):
super(ioLabsButtonBoxComponent,
self).__init__(exp,
parentName,
name=name,
store=store,
discardPrev=discardPrev,
correctAns=correctAns,
forceEndRoutine=forceEndRoutine,
storeCorrect=storeCorrect,
startType=startType,
startVal=startVal,
stopType=stopType,
stopVal=stopVal,
startEstim=startEstim,
durationEstim=durationEstim)
self.type = 'ioLabsButtonBox'
self.url = "https://www.psychopy.org/builder/components/ioLabs.html"
self.exp.requirePsychopyLibs(['hardware'])
del self.params['allowedKeys']
# NB name and timing params always come 1st
self.order += [
'forceEndRoutine', # Basic tab
'allowedKeys',
'store',
'storeCorrect',
'correctAns' # Data tab
]
#self.order = ['forceEndRoutine', 'active', 'lights', 'store',
# 'storeCorrect', 'correctAns']
msg = _translate(
"What is the 'correct' response? NB, buttons are labelled 0 to "
"7 on a 8-button box. Enter 'None' (no quotes) if withholding "
"a response is correct. Might be helpful to add a correctAns "
"column and use $correctAns to compare to the key press.")
self.params['correctAns'].hint = msg
self.params['store'].allowedVals = [
'last button', 'first button', 'all buttons', 'nothing'
]
msg = _translate(
'Choose which (if any) responses to store at end of a trial')
self.params['store'].hint = msg
msg = _translate("Active buttons, such as '1,6', '(1,2,5,6)' or '0' "
"(without quotes)")
self.params['active'] = Param(
active,
valType='code',
inputType="single",
allowedTypes=[],
categ='Data',
updates='constant',
allowedUpdates=['constant', 'set every repeat'],
hint=msg,
label=_localized['active'])
self.params['lights'] = Param(
lights,
valType='bool',
inputType="bool",
allowedTypes=[],
categ='Hardware',
updates='constant',
allowedUpdates=[],
hint=_translate("Turn ON the lights for the active buttons?"),
label=_localized['lights'])
self.params['lights off'] = Param(
lightsOff,
valType='bool',
inputType="bool",
allowedTypes=[],
categ='Hardware',
updates='constant',
allowedUpdates=[],
hint=_translate("Turn OFF all lights at the end of each routine?"),
label=_localized['lights off'])
def writeStartCode(self, buff):
# avoid duplicates; ok for init but not safe to do in routine, frame,
# etc
code = ("# connect to ioLabs bbox, turn lights off\n"
"from psychopy.hardware import iolab\n"
"iolab.ButtonBox().standby()\n")
if code not in buff.getvalue():
buff.writeIndentedLines(code)
def writeInitCode(self, buff):
lines = "%(name)s = iolab.ButtonBox()\n"
if lines % self.params not in buff.getvalue(): # avoid duplicates
buff.writeIndentedLines(lines % self.params)
def writeRoutineStartCode(self, buff):
if self.params['discard previous'].val:
buff.writeIndented('%(name)s.clearEvents()\n' % self.params)
active = self.params['active'].val.strip(')], ').lstrip('([, ')
if not valid_var_re.match(active):
if ',' not in active:
active += ',' # to turn an int into tuple
active = '(' + active + ')'
code = ('%(name)s.active = ' +
'%s # tuple or list of int 0..7\n' % active +
'%(name)s.setEnabled(%(name)s.active)\n')
if self.params['lights'].val:
code += '%(name)s.setLights(%(name)s.active)\n'
if (self.params['store'].val != 'nothing'
or self.params['storeCorrect'].val):
code += (
"%(name)s.btns = [] # responses stored in .btns and .rt\n" +
"%(name)s.rt = []\n")
buff.writeIndentedLines(code % self.params)
def writeFrameCode(self, buff):
"""Write the code that will be called every frame.
"""
# some shortcuts
store = self.params['store'].val
storeCorr = self.params['storeCorrect'].val
forceEnd = self.params['forceEndRoutine'].val
active = self.params['active'].val
# if just now starting on this frame:
buff.writeIndented("# *%(name)s* updates\n" % self.params)
# writes an if statement to determine whether to draw etc
self.writeStartTestCode(buff)
code = "%(name)s.status = STARTED\n"
if self.params['discard previous'].val:
code += "%(name)s.clearEvents()\n"
# ioLabs bbox handles active internally, via setEnable(active)
# this is not the same as keyboard components, which have to handle
# their own allowedKeys
code += "# buttonbox checking is just starting\n"
if store != 'nothing':
code += (
"%(name)s.resetClock() # set bbox hardware internal clock to 0.000; ms accuracy\n"
)
buff.writeIndentedLines(code % self.params)
# to get out of the if statement
buff.setIndentLevel(-1, relative=True)
# test for stop (only if there was some setting for duration or stop)
if self.params['stopVal'].val not in ['', None, -1, 'None']:
# writes an if statement to determine whether to draw etc
self.writeStopTestCode(buff)
buff.writeIndented("%(name)s.status = FINISHED\n" % self.params)
buff.setIndentLevel(-2, True)
buff.writeIndented("if %(name)s.status == STARTED:\n" % self.params)
buff.setIndentLevel(1, relative=True) # to get out of the if statement
dedentAtEnd = 1 # keep track of how far to dedent later
# check for button presses
code = "theseButtons = %(name)s.getEvents()\n" % self.params
buff.writeIndented(code)
# store something?
if store != 'nothing' or forceEnd:
code = "if theseButtons: # at least one button was pressed this frame\n"
buff.writeIndented(code)
buff.setIndentLevel(1, True)
dedentAtEnd += 1
"""theseButtons[0] is an iolabs button event
- event.rt is in sec, as recorded on the bbox unit (ms accuracy)
- event.key is type str: , '0'..'7'
two things ignored here:
- bbox events have evt.direction (+1 press down, -1 release up)
- bbox evt.key can be 'voice' (for "voice-key was triggered", button 64)
"""
if store == 'first button':
code = "if %(name)s.btns == []: # True if the first\n" % self.params
buff.writeIndented(code)
buff.setIndentLevel(1, True)
dedentAtEnd += 1
code = (
"%(name)s.btns = theseButtons[0].key # just the first button\n"
"%(name)s.rt = theseButtons[0].rt\n")
buff.writeIndentedLines(code % self.params)
elif store == 'last button':
code = (
"%(name)s.btns = theseButtons[-1].key # just the last button\n"
"%(name)s.rt = theseButtons[-1].rt\n")
buff.writeIndentedLines(code % self.params)
elif store == 'all buttons':
code = (
"%(name)s.btns.extend([evt.key for evt in theseButtons]) # all buttons\n"
"%(name)s.rt.extend([evt.rt for evt in theseButtons])\n # all RT (timed by bbox)"
)
buff.writeIndentedLines(code % self.params)
# each bbox event is time-stamped, unlike keys in keyboard
# component
code = ''
if storeCorr:
code += ("# was this 'correct'?\n"
"if %(name)s.btns == str(%(correctAns)s):\n"
" %(name)s.corr = 1\n"
"else:\n %(name)s.corr=0\n")
if forceEnd:
code += ("# a response forces the end of the routine\n"
"continueRoutine = False\n")
buff.writeIndentedLines(code % self.params)
buff.setIndentLevel(-(dedentAtEnd), relative=True)
def writeRoutineEndCode(self, buff):
# some shortcuts
name = self.params['name']
store = self.params['store'].val
if store == 'nothing':
return
if len(self.exp.flow._loopList):
currLoop = self.exp.flow._loopList[-1] # last (outer-most) loop
else:
currLoop = self.exp._expHandler
# write the actual code
code = ''
if self.params['lights off'].val:
code += '%(name)s.setLights(None)\n'
code += ("# store ioLabs bbox data for %s (%s)\n" %
(name, currLoop.type))
code += ("if len(%(name)s.btns) == 0: # no ioLabs responses\n"
" %(name)s.btns = None\n")
if self.params['storeCorrect'].val: # check for correct NON-repsonse
code += (
" # was no response the correct answer?\n"
" if str(%(correctAns)s).lower() == 'none':\n"
" %(name)s.corr = 1 # correct non-response\n"
" else:\n %(name)s.corr = 0 # failed to withhold a response\n"
)
buff.writeIndentedLines(code % self.params)
if currLoop.type == 'StairHandler':
# StairHandler only needs correct-ness
if self.params['storeCorrect'].val:
buff.writeIndented("%s.addData(%s.corr)\n" %
(currLoop.params['name'], name))
else:
# TrialHandler gets button and RT info:
loopnamename = (currLoop.params['name'], name, name)
code = "%s.addData('%s.btns', %s.btns)\n" % loopnamename
buff.writeIndented(code)
if self.params['storeCorrect'].val:
code = "%s.addData('%s.corr', %s.corr)\n" % loopnamename
buff.writeIndented(code)
code = (
"if %(name)s.btns != None: # add RTs if there are responses\n"
% self.params +
" %s.addData('%s.rt', %s.rt)\n" % loopnamename)
buff.writeIndentedLines(code)
# get parent to write code too (e.g. store onset/offset times)
super().writeRoutineEndCode(buff)
if currLoop.params['name'].val == self.exp._expHandler.name:
buff.writeIndented("%s.nextEntry()\n" % self.exp._expHandler.name)
def writeExperimentEndCode(self, buff):
buff.writeIndented('%(name)s.standby() # lights out etc\n' %
self.params)
# Distributed under the terms of the GNU General Public License (GPL).
from psychopy.localization import _localized as __localized
_localized = __localized.copy()
from os import path
from pathlib import Path
from psychopy.experiment.components.keyboard import KeyboardComponent, Param, _translate
from psychopy.experiment.utils import valid_var_re
__author__ = 'Jeremy Gray'
# only use _localized values for label values, nothing functional:
_localized.update({
'active': _translate('Active buttons'),
'lights': _translate('Lights'),
'lights off': _translate('Lights off')
})
class ioLabsButtonBoxComponent(KeyboardComponent):
"""An event class for checking an ioLab Systems buttonbox.
This is based on keyboard component, several important differences:
- no special response class analogous to event.BuilderKeyResponse()
- enabled responses (active buttons) are handled by the hardware device
More than one component in a routine will produce conflicts between
components over which active buttons (for responses and lights).
"""
# Distributed under the terms of the GNU General Public License (GPL).
from __future__ import absolute_import, print_function
from builtins import super # provides Py3-style super() using python-future
from os import path
from psychopy.experiment.components.keyboard import KeyboardComponent, Param, _translate
from psychopy.experiment.utils import valid_var_re
__author__ = 'Jeremy Gray'
# abs path to the folder containing this path
thisFolder = path.abspath(path.dirname(__file__))
iconFile = path.join(thisFolder, 'ioLabs.png')
tooltip = _translate('ioLabs ButtonBox: check and record response buttons on '
'ioLab Systems ButtonBox')
# only use _localized values for label values, nothing functional:
_localized = {'active': _translate('Active buttons'),
'lights': _translate('Lights'),
'lights off': _translate('Lights off')}
class ioLabsButtonBoxComponent(KeyboardComponent):
"""An event class for checking an ioLab Systems buttonbox.
This is based on keyboard component, several important differences:
- no special response class analogous to event.BuilderKeyResponse()
- enabled responses (active buttons) are handled by the hardware device
More than one component in a routine will produce conflicts between
from __future__ import absolute_import, print_function
from builtins import super # provides Py3-style super() using python-future
from psychopy.localization import _localized as __localized
_localized = __localized.copy()
from os import path
from pathlib import Path
from psychopy.experiment.components.keyboard import KeyboardComponent, Param, _translate
from psychopy.experiment.utils import valid_var_re
__author__ = 'Jeremy Gray'
# only use _localized values for label values, nothing functional:
_localized.update({'active': _translate('Active buttons'),
'lights': _translate('Lights'),
'lights off': _translate('Lights off')})
class ioLabsButtonBoxComponent(KeyboardComponent):
"""An event class for checking an ioLab Systems buttonbox.
This is based on keyboard component, several important differences:
- no special response class analogous to event.BuilderKeyResponse()
- enabled responses (active buttons) are handled by the hardware device
More than one component in a routine will produce conflicts between
components over which active buttons (for responses and lights).
"""
categories = ['Responses'] # which section(s) in the components panel
