-
Notifications
You must be signed in to change notification settings - Fork 3
/
CANLab_PsychoPy_Utilities.py
1260 lines (1100 loc) · 57.9 KB
/
CANLab_PsychoPy_Utilities.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""
CANLab PsychoPy Utilities 1.0.0
Michael Sun, Ph.D.
"""
# Import Libraries
from __future__ import absolute_import, division
from psychopy import locale_setup
from psychopy import prefs
prefs.hardware['audioLib'] = ['PTB'] # Set a preferred audio library to PsychToolBox (best), so psychopy doesn't yell at you.
from psychopy import sound, gui, visual, core, data, event, logging, clock
from psychopy.constants import (NOT_STARTED, STARTED, PLAYING, PAUSED,
STOPPED, FINISHED, PRESSED, RELEASED, FOREVER)
import numpy as np # whole numpy lib is available, prepend 'np.'
from numpy import (sin, cos, tan, log, log10, pi, average,
sqrt, std, deg2rad, rad2deg, linspace, asarray)
from numpy.random import random, randint, normal, shuffle
import os # handy system and path functions
import sys # to get file system encoding
from psychopy.hardware import keyboard
from builtins import str
from builtins import range
import pandas as pd
import collections
try:
from collections import OrderedDict
except ImportError:
OrderedDict=dict
import random
from datetime import datetime
from CANLab_PsychoPy_Config import *
def subjectInfoBox(name, expInfo=None):
"""Show a dialog box asking for subject information with [OK] and [Cancel] buttons.
Args:
name (str): String name of the dialog box being shown. e.g., "Input Brain Study Information".
expInfo (dict): A dictionary list of keys, indicating the information you want to collect in order. Gives some reasonable defaults if none is supplied.
Returns:
dict: The resulting expInfo key-value dictionary for use in the rest of your study, along with a 'date' key and value recording the day in which data is collected.
"""
if expInfo is None:
# Some handy defaults
expInfo = {
'DBIC Number': '',
'gender': '',
'session': '',
'handedness': '',
'scanner': ''
}
dlg = gui.DlgFromDict(title=name, dictionary=expInfo, sortKeys=False)
if dlg.OK == False:
core.quit() # user pressed cancel
expInfo['date'] = data.getDateStr() # add a simple timestamp
return expInfo
def setupWindow(res=[1920, 1080], bg=[-1,-1,-1], showMouse=False):
"""Sets up the window object that you will use to flip and display stimuli to your subject.
Troubleshooting Tips:
If you get window-related errors, make sure to downgrade pyglet to 1.4.1:
pip uninstall pyglet
pip install pyglet==1.4.1
Args:
res (list, optional): Input a [width, height] list of one's display resolution. Defaults to [1920, 1080] for full high-definition (FHD), but if debugging, will be [1280, 720] in windowed mode.
bg (list or keyword string, optional): An [r,g,b] list of the background color. Psychopy keywords for color can also work. Defaults to [-1,-1,-1] for a black screen.
showMouse (bool, optional): Choose whether or not to keep the mouse visible during the duration of the study. Defaults to False.
Returns:
visual.Window object: This is the window object that other scripts will draw stimuli onto.
"""
if debug == 1:
win = visual.Window(
size=[1280, 720], fullscr=False,
screen=0, # Change this to the appropriate display
winType='pyglet', allowGUI=True, allowStencil=False,
monitor='testMonitor', color=bg, colorSpace='rgb',
blendMode='avg', useFBO=True,
units='height')
else:
win = visual.Window(
size=res, fullscr=True,
screen=-1, # Change this to the appropriate fMRI projector
winType='pyglet', allowGUI=True, allowStencil=False,
monitor='testMonitor', color=bg, colorSpace='rgb',
blendMode='avg', useFBO=True,
units='height')
win.mouseVisible = showMouse # Make the mouse invisible for the remainder of the experiment
return win
def confirmRunStart(win, text=start_msg, TR=0.46):
"""Show a run start message, listen for TRs and return the time the run starts. Sets the global fmriStart time.
Args:
win (visual.Window): Pass in the Window to draw text to.
text (str, optional): The message to display in win. Defaults to whatever is assigned to start_msg in your config.py.
TR (float, optional): Length of the repetition time for neuroimage acquisition. Defaults to 0.46 seconds.
"""
start = visual.TextStim(win, text=text, height=.05, color=win.rgb + 0.5)
start.draw() # Automatically draw every frame
win.flip()
global fmriStart
fmriStart=globalClock.getTime() # Start the clock
if autorespond != 1:
continueRoutine = True
event.clearEvents()
while continueRoutine == True:
if 's' in event.getKeys(keyList = 's'): # experimenter start key - safe key before fMRI trigger
s_confirm = visual.TextStim(win, text=s_text, height =.05, color="green", pos=(0.0, -.3))
start.draw()
s_confirm.draw()
win.flip()
event.clearEvents()
while continueRoutine == True:
if '5' in event.getKeys(keyList = '5'): # fMRI trigger
fmriStart = globalClock.getTime() # Start the clock
timer = core.CountdownTimer() # Wait 6 TRs, Dummy Scans
timer.add(TR*6)
while timer.getTime() > 0:
continue
continueRoutine = False
return fmriStart
def nextRun(win, advanceKey='e', text=in_between_run_msg, biopacCode=between_run_msg):
"""Show a message prior to beginning the next run.
Args:
win (visual.Window): Pass in the Window to draw text to.
advanceKey (str, optional): Keypress required to end the display of text and advance. Defaults to 'e'.
text (str, optional): The message to display in win. Defaults to whatever is assigned to start_msg in your config.py.
biopacCode (int, optional): Integer representing the 8-bit digital channel to toggle for biopac Acqknowledge Software. Defaults to None.
noRecord (bool, optional): Don't return the Dictionary of onset and duration. Defaults to False.
"""
message = visual.TextStim(win, text=in_between_run_msg, height=0.05, units='height')
message.draw()
win.callOnFlip(print, text)
if biopac_exists:
win.callOnFlip(biopac.setData, biopac,0)
win.callOnFlip(biopac.setData, biopac,biopacCode)
win.flip()
# Autoresponder
if autorespond != 1:
continueRoutine = True
event.clearEvents()
while continueRoutine == True:
if advanceKey in event.getKeys(keyList = advanceKey):
continueRoutine = False
return
def endScan(win, advanceKey='e', text=end_msg, biopacCode=end_task):
"""Wrapper function for ending the scan.
Args:
win (visual.Window): Pass in the Window to draw text to.
advanceKey (str, optional): Keypress required to end the display of text and advance. Defaults to 'e'.
text (str, optional): Text string to display as your end scan message. Defaults to whatever is assigned to end_msg in your config.py.
"""
showText(win, "EndScan", text, advanceKey=advanceKey, noRecord=True, biopacCode=biopacCode)
if biopac_exists == 1:
biopac.close() # Close the labjack U3 device to end communication with the Biopac MP150
win.close() # close the window
core.quit()
def wait(name, time=None, advanceKey=None, noRecord=False):
if noRecord==False:
global fmriStart
onset = globalClock.getTime() - fmriStart
continueRoutine=True
while continueRoutine == True:
timer = core.CountdownTimer()
timer.add(time)
while timer.getTime() > 0:
if advanceKey in event.getKeys(keyList = advanceKey): # experimenter start key - safe key before fMRI trigger
break
continue
continueRoutine = False
if noRecord==False:
bids_trial={'onset': onset, 'duration': globalClock.getTime()-(onset+fmriStart), 'condition': name}
return bids_trial
else:
return
def showText(win, name, text, strColor='white', fontSize=.05, strPos=(0, 0), time=None, advanceKey='space', biopacCode=None, noRecord=False):
"""Show some text, press a key to advance or wait a certain amount of time. By default returns the onset and timings as a dictionary to be concatenated to your BIDS datafile, but this is optional.
You're responsible for your own word-wrapping! Use \n or something.
Warning: Either 'time' or 'advanceKey' should be initialized, or you will be stuck and you need to press ['esc'].
Args:
win (visual.Window): Pass in the Window to draw text to.
name (str): String name of the textblock being shown. e.g., "Instructions".
text (str): Text string to display to the Window.
strColor (list or str, optional): [r,g,b] color list or PsychoPy color keyword string. Defaults to 'white'.
fontSize (float, optional): Size of the text in PsychoPy height. Defaults to .05% of the screen.
strPos (tuple, optional): Tuple of (x, y) coordinates of where on the screen the text should appear. Defaults to the middle of the screen at (0, 0).
time (int, optional): Time to display the stimuli on screen. Defaults to None.
advanceKey (str, optional): Keypress required to end the display of text and advance. Defaults to 'space'.
biopacCode (int, optional): Integer representing the 8-bit digital channel to toggle for biopac Acqknowledge Software. Defaults to None.
noRecord (bool, optional): Don't return the Dictionary of onset and duration. Defaults to False.
Returns:
dict: The dictionary of onset, duration, and condition to be concatenated into your BIDS datafile.
"""
## Intialize the Objects
TextClock = core.Clock()
TextKB = keyboard.Keyboard()
Text = visual.TextStim(win, name='Text',
text=text,
font = 'Arial',
pos=strPos, height=fontSize, wrapWidth=1.6, ori=0,
color=strColor, colorSpace='rgb', opacity=1,
languageStyle='LTR',
depth=0.0,
anchorHoriz='center')
# ------Prepare to start Routine "Text"-------
routineTimer.reset()
if time is not None:
routineTimer.add(time)
continueRoutine = True
# update component parameters for each repeat
TextKB.keys = []
TextKB.rt = []
_TextKB_allKeys = []
# Update instructions and cues based on current run's body-sites:
# keep track of which components have finished
TextComponents = [Text, TextKB]
for thisComponent in TextComponents:
thisComponent.tStart = None
thisComponent.tStop = None
thisComponent.tStartRefresh = None
thisComponent.tStopRefresh = None
if hasattr(thisComponent, 'status'):
thisComponent.status = NOT_STARTED
# reset timers
t = 0
_timeToFirstFrame = win.getFutureFlipTime(clock="now")
TextClock.reset(-_timeToFirstFrame) # t0 is time of first possible flip
frameN = -1
# -------Run Routine "Text"-------
# Record onset time
if noRecord==False:
global fmriStart
onset = globalClock.getTime() - fmriStart
while continueRoutine:
# get current time
t = TextClock.getTime()
tThisFlip = win.getFutureFlipTime(clock=TextClock)
tThisFlipGlobal = win.getFutureFlipTime(clock=None)
frameN = frameN + 1 # number of completed frames (so 0 is the first frame)
# update/draw components on each frame
# *Text* updates
if Text.status == NOT_STARTED and tThisFlip >= 0.0-frameTolerance:
# keep track of start time/frame for later
Text.frameNStart = frameN # exact frame index
Text.tStart = t # local t and not account for scr refresh
Text.tStartRefresh = tThisFlipGlobal # on global time
win.timeOnFlip(Text, 'tStartRefresh') # time at next scr refresh
Text.setAutoDraw(True)
if Text.status == STARTED:
# is it time to stop? (based on global clock, using actual start)
if time is not None and tThisFlipGlobal > Text.tStartRefresh + time-frameTolerance:
# keep track of stop time/frame for later
Text.tStop = t # not accounting for scr refresh
Text.frameNStop = frameN # exact frame index
win.timeOnFlip(TextKB, 'tStopRefresh') # time at next scr refresh
Text.setAutoDraw(False)
# *TextKB* updates
waitOnFlip = False
if TextKB.status == NOT_STARTED and tThisFlip >= 0.0-frameTolerance:
# keep track of start time/frame for later
TextKB.frameNStart = frameN # exact frame index
TextKB.tStart = t # local t and not account for scr refresh
TextKB.tStartRefresh = tThisFlipGlobal # on global time
win.timeOnFlip(TextKB, 'tStartRefresh') # time at next scr refresh
TextKB.status = STARTED
# keyboard checking is just starting
waitOnFlip = True
win.callOnFlip(print, "Showing "+name)
if biopac_exists == 1 and biopacCode is not None:
win.callOnFlip(print, "Cueing Off All Biopac Channels")
win.callOnFlip(biopac.setData, biopac, 0)
win.callOnFlip(print, "Cueing Biopac Channel: " + str(biopacCode))
win.callOnFlip(biopac.setData, biopac, biopacCode)
win.callOnFlip(TextKB.clock.reset) # t=0 on next screen flip
win.callOnFlip(TextKB.clearEvents, eventType='keyboard') # clear events on next screen flip
if TextKB.status == STARTED and not waitOnFlip:
if advanceKey is not None:
theseKeys = TextKB.getKeys(keyList=advanceKey, waitRelease=False)
_TextKB_allKeys.extend(theseKeys)
if len(_TextKB_allKeys):
TextKB.keys = _TextKB_allKeys[-1].name # just the last key pressed
TextKB.rt = _TextKB_allKeys[-1].rt
# a response ends the routine
continueRoutine = False
# is it time to stop? (based on global clock, using actual start)
if time is not None and tThisFlipGlobal > TextKB.tStartRefresh + time-frameTolerance:
# keep track of stop time/frame for later
TextKB.tStop = t # not accounting for scr refresh
TextKB.frameNStop = frameN # exact frame index
win.timeOnFlip(TextKB, 'tStopRefresh') # time at next scr refresh
continueRoutine = False
# Autoresponder
if t >= thisSimKey.rt and autorespond == 1:
_TextKB_allKeys.extend([thisSimKey])
# check for quit (typically the Esc key)
if endExpNow or defaultKeyboard.getKeys(keyList=["escape"]):
core.quit()
# check if all components have finished
if not continueRoutine: # a component has requested a forced-end of Routine
break
continueRoutine = False # will revert to True if at least one component still running
for thisComponent in TextComponents:
if hasattr(thisComponent, "status") and thisComponent.status != FINISHED:
continueRoutine = True
break # at least one component has not yet finished
# refresh the screen
if continueRoutine: # don't flip if this routine is over or we'll get a blank screen
win.flip()
# -------Ending Routine "Text"-------
print("Offset " + name)
if biopac_exists == 1 and biopacCode is not None:
print("CueOff Channel: " + str(biopacCode))
biopac.setData(biopac, 0)
for thisComponent in TextComponents:
if hasattr(thisComponent, "setAutoDraw"):
thisComponent.setAutoDraw(False)
# the Routine "Text" was not non-slip safe, so reset the non-slip timer
routineTimer.reset()
# check responses
if TextKB.keys in ['', [], None]: # No response was made
TextKB.keys = None
if noRecord==False:
bids_trial={'onset': onset,'duration': t,'condition': name, 'biopac_channel': biopacCode}
if TextKB.keys != None: # we had a response
bids_trial['keys'] = TextKB.keys
bids_trial['rt']=TextKB.rt
return bids_trial
else:
return
def showImg(win, name, imgPath, imgPos=[0,0], imgSize=(.5, .5), time=None, advanceKey=None, biopacCode=None, noRecord=False):
"""Show an image, press a key to advance or wait a certain amount of time. By default returns the onset and timings as a dictionary to be concatenated to your BIDS datafile, but this is optional.
Warning: Either 'time' or 'advanceKey' should be initialized, or you will be stuck and you need to press ['esc'].
Args:
win (visual.Window): Pass in the Window to draw text to.
name (str): String name of the image being shown. e.g., "Instructional Image".
imgPath (str): String path to the image file.
imgPos (list, optional): List of [x, y] coordinates of where on the screen the image should appear. Defaults to the middle of the screen, [0,0].
imgSize (tuple, optional): Tuple (x, y) in Psychopy height for how large the image should be. Defaults to a (.05%, .05%) of the screen image.
time (int, optional): Time to display the stimuli on screen. Defaults to None.
advanceKey (str, optional): Keypress required to end the display of text and advance. Defaults to 'space'.
biopacCode (int, optional): Integer representing the 8-bit digital channel to toggle for biopac Acqknowledge Software. Defaults to None.
noRecord (bool, optional): Don't return the Dictionary of onset and duration. Defaults to False.
Returns:
Dict: The Dictionary of onset, duration, and condition to be concatenated into your BIDS datafile.
"""
## Intialize the Objects
ImageClock = core.Clock()
ImageKB = keyboard.Keyboard()
Img = visual.ImageStim(
win=win,
name=name,
image=imgPath,
mask=None,
ori=0,
pos=imgPos,
size=imgSize,
color=[1,1,1], colorSpace='rgb', opacity=1,
flipHoriz=False, flipVert=False,
texRes=512, interpolate=True, depth=0.0)
# ------Prepare to start Routine "Image"-------
routineTimer.reset()
if time is not None:
routineTimer.add(time)
continueRoutine = True
# update component parameters for each repeat
ImageKB.keys = []
ImageKB.rt = []
_ImageKB_allKeys = []
# Update instructions and cues based on current run's body-sites:
# keep track of which components have finished
if advanceKey is None:
ImageComponents = [Img]
else:
ImageComponents = [Img, ImageKB]
for thisComponent in ImageComponents:
thisComponent.tStart = None
thisComponent.tStop = None
thisComponent.tStartRefresh = None
thisComponent.tStopRefresh = None
if hasattr(thisComponent, 'status'):
thisComponent.status = NOT_STARTED
# reset timers
t = 0
_timeToFirstFrame = win.getFutureFlipTime(clock="now")
ImageClock.reset(-_timeToFirstFrame) # t0 is time of first possible flip
frameN = -1
# -------Run Routine "ImageClock"-------
# Record onset time
if noRecord==False:
global fmriStart
onset = globalClock.getTime() - fmriStart
while continueRoutine:
# get current time
t = ImageClock.getTime()
tThisFlip = win.getFutureFlipTime(clock=ImageClock)
tThisFlipGlobal = win.getFutureFlipTime(clock=None)
frameN = frameN + 1 # number of completed frames (so 0 is the first frame)
# update/draw components on each frame
# *Img* updates
if Img.status == NOT_STARTED and tThisFlip >= 0.0-frameTolerance:
# keep track of start time/frame for later
Img.frameNStart = frameN # exact frame index
Img.tStart = t # local t and not account for scr refresh
Img.tStartRefresh = tThisFlipGlobal # on global time
win.timeOnFlip(Img, 'tStartRefresh') # time at next scr refresh
Img.setAutoDraw(True)
win.callOnFlip(print, "Showing "+name)
if biopac_exists == 1 and biopacCode is not None:
win.callOnFlip(print, "Cueing Off All Biopac Channels")
win.callOnFlip(biopac.setData, biopac, 0)
win.callOnFlip(print, "Cueing Biopac Channel: " + str(biopacCode))
win.callOnFlip(biopac.setData, biopac, biopacCode)
if Img.status == STARTED:
# is it time to stop? (based on global clock, using actual start)
if time is not None and tThisFlipGlobal > Img.tStartRefresh + time-frameTolerance:
# keep track of stop time/frame for later
Img.tStop = t # not accounting for scr refresh
Img.frameNStop = frameN # exact frame index
win.timeOnFlip(Img, 'tStopRefresh') # time at next scr refresh
Img.setAutoDraw(False)
if advanceKey is not None:
# *ImageKB* updates
waitOnFlip = False
if ImageKB.status == NOT_STARTED and tThisFlip >= 0.0-frameTolerance:
# keep track of start time/frame for later
ImageKB.frameNStart = frameN # exact frame index
ImageKB.tStart = t # local t and not account for scr refresh
ImageKB.tStartRefresh = tThisFlipGlobal # on global time
win.timeOnFlip(ImageKB, 'tStartRefresh') # time at next scr refresh
if ImageKB.status == STARTED and not waitOnFlip:
# keyboard checking is just starting
waitOnFlip = True
win.callOnFlip(ImageKB.clock.reset) # t=0 on next screen flip
win.callOnFlip(ImageKB.clearEvents, eventType='keyboard') # clear events on next screen flip
# is it time to stop? (based on global clock, using actual start)
if time is not None and tThisFlipGlobal > ImageKB.tStartRefresh + time-frameTolerance:
# keep track of stop time/frame for later
ImageKB.tStop = t # not accounting for scr refresh
ImageKB.frameNStop = frameN # exact frame index
win.timeOnFlip(ImageKB, 'tStopRefresh') # time at next scr refresh
continueRoutine = False
theseKeys = ImageKB.getKeys(keyList=advanceKey, waitRelease=False)
_ImageKB_allKeys.extend(theseKeys)
if len(_ImageKB_allKeys):
ImageKB.keys = _ImageKB_allKeys[-1].name # just the last key pressed
ImageKB.rt = _ImageKB_allKeys[-1].rt
# a response ends the routine
continueRoutine = False
# Autoresponder
if t >= thisSimKey.rt and autorespond == 1:
_ImageKB_allKeys.extend([thisSimKey])
# check for quit (typically the Esc key)
if endExpNow or defaultKeyboard.getKeys(keyList=["escape"]):
core.quit()
# check if all components have finished
if not continueRoutine: # a component has requested a forced-end of Routine
break
continueRoutine = False # will revert to True if at least one component still running
for thisComponent in ImageComponents:
if hasattr(thisComponent, "status") and thisComponent.status != FINISHED:
continueRoutine = True
break # at least one component has not yet finished
# refresh the screen
if continueRoutine: # don't flip if this routine is over or we'll get a blank screen
win.flip()
# -------Ending Routine "Image"-------
print("Offset " + name)
if biopac_exists == 1 and biopacCode is not None:
print("CueOff Channel: " + str(biopacCode))
biopac.setData(biopac, 0)
for thisComponent in ImageComponents:
if hasattr(thisComponent, "setAutoDraw"):
thisComponent.setAutoDraw(False)
# the Routine "Image" was not non-slip safe, so reset the non-slip timer
routineTimer.reset()
# check responses
if ImageKB.keys in ['', [], None]: # No response was made
ImageKB.keys = None
if noRecord==False:
bids_trial={'onset': onset,'duration': t,'condition': name, 'biopac_channel': biopacCode}
if ImageKB.keys != None: # we had a response
bids_trial['keys'] = ImageKB.keys
bids_trial['rt']=ImageKB.rt
return bids_trial
else:
return
def preloadMovie(win, name, movPath):
"""It's recommended that you preload Movies prior to playing them because Initializes and returns the visual.MovieStim3 file. Prepares the movie to be played a single time, in the middle of the screen.
Args:
win (visual.Window): Pass in the Window to draw text to.
name (str): String name of the movie being shown. e.g., "Inscapes".
movPath (str): String path to the image file.
Returns:
visual.MovieStim3: The resulting movie file.
"""
movie = visual.MovieStim3(
win=win, name=name,
noAudio = False,
filename=movPath,
ori=0, pos=(0, 0), opacity=1,
loop=False,
depth=-1.0
)
return movie
def showMovie(win, movie, name=None, biopacCode=None, noRecord=False):
"""Play the movie. It will only play for 10 seconds in debug mode. By default returns the onset and timings as a dictionary to be concatenated to your BIDS datafile, but this is optional.
Args:
win (visual.Window): Pass in the Window to draw text to.
movie (visual.MovieStim3): Play a preloaded movie.
name (str): String name of the movie being shown. e.g., "Inscapes".
biopacCode (int, optional): Integer representing the 8-bit digital channel to toggle for biopac Acqknowledge Software. Defaults to None.
noRecord (bool, optional): Don't return the Dictionary of onset and duration. Defaults to False.
Returns:
dict: The Dictionary of onset, duration, and condition to be concatenated into your BIDS datafile.
"""
if debug==1:
movie_duration=10
if name==None:
name = movie.name
MovieClock = core.Clock()
# ------Prepare to start Routine "Movie"-------
continueRoutine = True
movie_duration = movie.duration
if debug==1:
movie_duration = 10 # debugging
routineTimer.reset()
routineTimer.add(movie_duration)
# keep track of which components have finished
MovieComponents = [movie]
for thisComponent in MovieComponents:
thisComponent.tStart = None
thisComponent.tStop = None
thisComponent.tStartRefresh = None
thisComponent.tStopRefresh = None
if hasattr(thisComponent, 'status'):
thisComponent.status = NOT_STARTED
# reset timers
t = 0
_timeToFirstFrame = win.getFutureFlipTime(clock="now")
MovieClock.reset(-_timeToFirstFrame) # t0 is time of first possible flip
frameN = -1
# -------Run Routine "Movie"-------
# Record onset time
if noRecord==False:
global fmriStart
onset = globalClock.getTime() - fmriStart
while continueRoutine and routineTimer.getTime() > 0:
# get current time
t = MovieClock.getTime()
tThisFlip = win.getFutureFlipTime(clock=MovieClock)
tThisFlipGlobal = win.getFutureFlipTime(clock=None)
frameN = frameN + 1 # number of completed frames (so 0 is the first frame)
# update/draw components on each frame
# *movie* updates
if movie.status == NOT_STARTED and tThisFlip >= 0.0-frameTolerance:
# keep track of start time/frame for later
movie.frameNStart = frameN # exact frame index
movie.tStart = t # local t and not account for scr refresh
movie.tStartRefresh = tThisFlipGlobal # on global time
win.timeOnFlip(movie, 'tStartRefresh') # time at next scr refresh
movie.setAutoDraw(True)
win.callOnFlip(print, "Showing "+name)
if biopac_exists == 1 and biopacCode is not None:
win.callOnFlip(print, "Cueing Off All Biopac Channels")
win.callOnFlip(biopac.setData, biopac, 0)
win.callOnFlip(print, "Cueing Biopac Channel: " + str(biopacCode))
win.callOnFlip(biopac.setData, biopac, biopacCode)
# if movie.status == STARTED: # one frame should pass before updating params and completing
# updating other components during *movie*
# movie.setMovie(movieOrder[0]['runseq'][runLoop.thisTrialN+1]['moviefile'])
if tThisFlipGlobal > movie.tStartRefresh + movie_duration-frameTolerance:
# keep track of stop time/frame for later
movie.tStop = t # not accounting for scr refresh
movie.frameNStop = frameN # exact frame index
win.timeOnFlip(movie, 'tStopRefresh') # time at next scr refresh
movie.setAutoDraw(False)
if movie.status == FINISHED: # force-end the routine
continueRoutine = False
# check for quit (typically the Esc key)
if endExpNow or defaultKeyboard.getKeys(keyList=["escape"]):
core.quit()
# check if all components have finished
if not continueRoutine: # a component has requested a forced-end of Routine
break
continueRoutine = False # will revert to True if at least one component still running
for thisComponent in MovieComponents:
if hasattr(thisComponent, "status") and thisComponent.status != FINISHED:
continueRoutine = True
break # at least one component has not yet finished
# refresh the screen
if continueRoutine: # don't flip if this routine is over or we'll get a blank screen
win.flip()
# -------Ending Routine "Movie"-------
movie.stop()
print("Offset " + name)
if biopac_exists == 1 and biopacCode is not None:
print("CueOff Channel: " + str(biopacCode))
biopac.setData(biopac, 0)
for thisComponent in MovieComponents:
if hasattr(thisComponent, "setAutoDraw"):
thisComponent.setAutoDraw(False)
# the Routine "Movie" was not non-slip safe, so reset the non-slip timer
routineTimer.reset()
if noRecord==False:
bids_trial={'onset': onset,'duration': t,'condition': name, 'biopac_channel': biopacCode}
return bids_trial
else:
return
def showFixation(win, name, type='big', size=None, pos=(0, 0), col='white', time=5, biopacCode=None, noRecord=False):
"""Wrapper function for creating a fixation cross for a a set period. Set the position, size, color, and time to offset. By default returns the onset and timings as a dictionary to be concatenated to your BIDS datafile, but this is optional.
Args:
win (visual.Window): Pass in the Window to draw the fixation cross on to.
name (str): name of the fixation cross condition, e.g., "pre-stimulus jitter"
type (str, optional): 'big' which is size=.05 or 'small' which is size=.01. Defaults to 'big'.
size (float, optional): Size of the fixation cross in PsychoPy height. Defaults to None.
pos (tuple, optional): Tuple of (x, y) coordinates of where on the screen the image should appear. Defaults to the middle of the screen, (0,0).
col (str or list, optional): [r,g,b] color list or PsychoPy color keyword string. Defaults to 'white'.
time (int, optional): Time to offset. Defaults to 5 seconds.
biopacCode (int, optional): Integer representing the 8-bit digital channel to toggle for biopac Acqknowledge Software. Defaults to None.
noRecord (bool, optional): Don't return the Dictionary of onset and duration. Defaults to False.
Returns:
dict: The Dictionary of onset, duration, and condition to be concatenated into your BIDS datafile.
"""
if size is not None:
return showText(win, name, '+', strColor=col, fontSize=size, strPos=pos, time=time, advanceKey=None, biopacCode=biopacCode, noRecord=noRecord)
if type == 'big':
size = .1
elif type == 'small':
size = .05
return showText(win, name, '+', strColor=col, fontSize=size, strPos=pos, time=time, advanceKey=None, biopacCode=biopacCode, noRecord=noRecord)
def showTextAndImg(win, name, text, imgPath, strColor='white', fontSize=.05, strPos=(0, -.25), imgSize=(.40,.40), imgPos=(0, .2), time=None, advanceKey='space', biopacCode=None, noRecord=False):
"""Show an image with text together, press a key to advance or wait a certain amount of time. By default returns the onset and timings as a dictionary to be concatenated to your BIDS datafile, but this is optional.
You are responsible for your own word-wrapping! Use \n judiciously.
Warning: Either 'time' or 'advanceKey' should be initialized, or you will be stuck and you need to press ['esc'].
Args:
win (visual.Window): Pass in the Window to draw text to.
name (str): String name of the condition being shown. e.g., "Image with Instructions".
text (str): String text to be displayed onscreen.
imgPath (str): String path to the image file.
strColor (str, optional): _description_. Defaults to 'white'.
fontSize (float, optional): _description_. Defaults to .05.
strPos (tuple, optional): Tuple of (x, y) coordinates of where on the screen the text should appear. Defaults to (0, .5).
imgSize (tuple, optional): _description_. Defaults to (.40,.40).
imgPos (tuple, optional): Tuple of (x, y) coordinates of where on the screen the image should appear. Defaults to the middle of the screen, (0,0).
time (int, optional): Time to display the stimuli on screen in seconds. Defaults to None.
advanceKey (str, optional): Keypress required to end the display of text and advance. Defaults to 'space'.
biopacCode (int, optional): Integer representing the 8-bit digital channel to toggle for biopac Acqknowledge Software. Defaults to None.
noRecord (bool, optional): Don't return the Dictionary of onset and duration. Defaults to False.
Returns:
dict: The Dictionary of onset, duration, and condition to be concatenated into your BIDS datafile.
"""
## Intialize the Objects
TextImageClock = core.Clock()
TextImageKB = keyboard.Keyboard()
Text = visual.TextStim(win, name='Text',
text=text,
font = 'Arial',
pos=strPos, height=fontSize, wrapWidth=1.6, ori=0,
color=strColor, colorSpace='rgb', opacity=1,
languageStyle='LTR',
depth=0.0,
anchorHoriz='center')
Img = visual.ImageStim(
win=win,
name='Image',
image=imgPath,
mask=None,
ori=0,
pos=imgPos,
size=imgSize,
color=[1,1,1], colorSpace='rgb', opacity=1,
flipHoriz=False, flipVert=False,
texRes=512, interpolate=True, depth=0.0)
# ------Prepare to start Routine "TextImage"-------
routineTimer.reset()
if time is not None:
routineTimer.add(time)
continueRoutine = True
# update component parameters for each repeat
TextImageKB.keys = []
TextImageKB.rt = []
_TextImageKB_allKeys = []
# Update instructions and cues based on current run's body-sites:
# keep track of which components have finished
TextImageComponents = [Text, Img, TextImageKB]
for thisComponent in TextImageComponents:
thisComponent.tStart = None
thisComponent.tStop = None
thisComponent.tStartRefresh = None
thisComponent.tStopRefresh = None
if hasattr(thisComponent, 'status'):
thisComponent.status = NOT_STARTED
# reset timers
t = 0
_timeToFirstFrame = win.getFutureFlipTime(clock="now")
TextImageClock.reset(-_timeToFirstFrame) # t0 is time of first possible flip
frameN = -1
# -------Run Routine "TextImage"-------
# Record onset time
if noRecord==False:
global fmriStart
onset = globalClock.getTime() - fmriStart
while continueRoutine:
# get current time
t = TextImageClock.getTime()
tThisFlip = win.getFutureFlipTime(clock=TextImageClock)
tThisFlipGlobal = win.getFutureFlipTime(clock=None)
frameN = frameN + 1 # number of completed frames (so 0 is the first frame)
# update/draw components on each frame
# *Text* updates
if Text.status == NOT_STARTED and tThisFlip >= 0.0-frameTolerance:
# keep track of start time/frame for later
Text.frameNStart = frameN # exact frame index
Text.tStart = t # local t and not account for scr refresh
Text.tStartRefresh = tThisFlipGlobal # on global time
win.timeOnFlip(Text, 'tStartRefresh') # time at next scr refresh
Text.setAutoDraw(True)
if Text.status == STARTED:
# is it time to stop? (based on global clock, using actual start)
if time is not None and tThisFlipGlobal > Text.tStartRefresh + time-frameTolerance:
# keep track of stop time/frame for later
Text.tStop = t # not accounting for scr refresh
Text.frameNStop = frameN # exact frame index
win.timeOnFlip(TextImageKB, 'tStopRefresh') # time at next scr refresh
Text.setAutoDraw(False)
# *Img* updates
if Img.status == NOT_STARTED and tThisFlip >= 0.0-frameTolerance:
# keep track of start time/frame for later
Img.frameNStart = frameN # exact frame index
Img.tStart = t # local t and not account for scr refresh
Img.tStartRefresh = tThisFlipGlobal # on global time
win.timeOnFlip(Img, 'tStartRefresh') # time at next scr refresh
Img.setAutoDraw(True)
if Img.status == STARTED:
# is it time to stop? (based on global clock, using actual start)
if time is not None and tThisFlipGlobal > Img.tStartRefresh + time-frameTolerance:
# keep track of stop time/frame for later
Img.tStop = t # not accounting for scr refresh
Img.frameNStop = frameN # exact frame index
win.timeOnFlip(TextImageKB, 'tStopRefresh') # time at next scr refresh
Img.setAutoDraw(False)
# *TextImageKB* updates
waitOnFlip = False
if TextImageKB.status == NOT_STARTED and tThisFlip >= 0.0-frameTolerance:
# keep track of start time/frame for later
TextImageKB.frameNStart = frameN # exact frame index
TextImageKB.tStart = t # local t and not account for scr refresh
TextImageKB.tStartRefresh = tThisFlipGlobal # on global time
win.timeOnFlip(TextImageKB, 'tStartRefresh') # time at next scr refresh
TextImageKB.status = STARTED
# keyboard checking is just starting
waitOnFlip = True
win.callOnFlip(print, "Showing "+name)
if biopac_exists == 1 and biopacCode is not None:
win.callOnFlip(print, "Cueing Off All Biopac Channels")
win.callOnFlip(biopac.setData, biopac, 0)
win.callOnFlip(print, "Cueing Biopac Channel: " + str(biopacCode))
win.callOnFlip(biopac.setData, biopac, biopacCode)
if biopac_exists == 1:
win.callOnFlip(biopac.setData, biopac, 0)
win.callOnFlip(biopac.setData, biopac, biopacCode)
win.callOnFlip(TextImageKB.clock.reset) # t=0 on next screen flip
win.callOnFlip(TextImageKB.clearEvents, eventType='keyboard') # clear events on next screen flip
if TextImageKB.status == STARTED and not waitOnFlip:
if advanceKey is not None:
theseKeys = TextImageKB.getKeys(keyList=advanceKey, waitRelease=False)
_TextImageKB_allKeys.extend(theseKeys)
if len(_TextImageKB_allKeys):
TextImageKB.keys = _TextImageKB_allKeys[-1].name # just the last key pressed
TextImageKB.rt = _TextImageKB_allKeys[-1].rt
# a response ends the routine
continueRoutine = False
# is it time to stop? (based on global clock, using actual start)
if time is not None and tThisFlipGlobal > TextImageKB.tStartRefresh + time-frameTolerance:
# keep track of stop time/frame for later
TextImageKB.tStop = t # not accounting for scr refresh
TextImageKB.frameNStop = frameN # exact frame index
win.timeOnFlip(TextImageKB, 'tStopRefresh') # time at next scr refresh
continueRoutine = False
# Autoresponder
if t >= thisSimKey.rt and autorespond == 1:
_TextImageKB_allKeys.extend([thisSimKey])
# check for quit (typically the Esc key)
if endExpNow or defaultKeyboard.getKeys(keyList=["escape"]):
core.quit()
# check if all components have finished
if not continueRoutine: # a component has requested a forced-end of Routine
break
continueRoutine = False # will revert to True if at least one component still running
for thisComponent in TextImageComponents:
if hasattr(thisComponent, "status") and thisComponent.status != FINISHED:
continueRoutine = True
break # at least one component has not yet finished
# refresh the screen
if continueRoutine: # don't flip if this routine is over or we'll get a blank screen
win.flip()
# -------Ending Routine "TextImage"-------
print("Offset " + name)
if biopac_exists == 1 and biopacCode is not None:
print("CueOff Channel: " + str(biopacCode))
biopac.setData(biopac, 0)
for thisComponent in TextImageComponents:
if hasattr(thisComponent, "setAutoDraw"):
thisComponent.setAutoDraw(False)
# check responses
if TextImageKB.keys in ['', [], None]: # No response was made
TextImageKB.keys = None
if noRecord==False:
bids_trial={'onset': onset,'duration': t,'condition': name, 'biopac_channel': biopacCode}
if TextImageKB.keys != None: # we had a response
bids_trial['keys'] = TextImageKB.keys
bids_trial['rt']=TextImageKB.rt
return bids_trial
else:
return
# Initialize components for each Rating
TIME_INTERVAL = 0.005 # Speed at which slider ratings udpate
ratingScaleWidth=1.5
ratingScaleHeight=.4
sliderMin = -.75
sliderMax = .75
bipolar_verts = [(sliderMin, .2), # left point
(sliderMax, .2), # right point
(0, -.2)] # bottom-point
unipolar_verts = [(sliderMin, .2), # left point
(sliderMax, .2), # right point
(sliderMin, -.2)] # bottom-point, # bottom-point
def showRatingScale(win, name, questionText, imgPath, type="bipolar", time=5, biopacCode=None, noRecord=False, nofMRI=False):
"""Show a binary, unipolar, or bipolar rating scale, mouseclick to submit response or wait a certain amount of time. By default returns the onset and timings as a dictionary to be concatenated to your BIDS datafile, but this is optional.
You are responsible for your own word-wrapping! Use \n judiciously.
Warning: Either 'time' or 'advanceKey' should be initialized, or you will be stuck and you need to press ['esc'].
Args:
win (visual.Window): Pass in the Window to draw text to.
name (str): String name of the condition being shown. e.g., "Heat Intensity Rating".
questionText (str): String text to be displayed onscreen.
imgPath (str): String path to the image file.
type (str, optional): Select type of of rating scale: 'binary', 'unipolar', or 'bipolar'. Defaults to "bipolar".
time (int, optional): Time to display the rating scale on screen in seconds. Defaults to 5 seconds.
biopacCode (int, optional): Integer representing the 8-bit digital channel to toggle for biopac Acqknowledge Software. Defaults to None.
noRecord (bool, optional): Don't return the Dictionary of onset and duration. Defaults to False.
nofMRI (bool, optional): Don't look for onset or duration times. Defaults to False.
Raises:
Exception: Type exception if string type specified is not 'binary', 'unipolar', or 'bipolar'.
Returns:
dict: The Dictionary of onset, duration, and condition to be concatenated into your BIDS datafile.
"""
if type not in ["binary", "unipolar", "bipolar"]:
raise Exception("Specified an invalid rating type. Please specify type = 'binary', 'unipolar', or 'bipolar' as a string")
# Initialize components for Routine "Rating"
RatingClock = core.Clock()
RatingMouse = event.Mouse(win=win)
RatingMouse.mouseClock = core.Clock()
Rating = visual.Rect(win, height=ratingScaleHeight, width=abs(sliderMin), pos= [sliderMin/2, -.1], fillColor='red', lineColor='black')
rt = None
if type is not "binary":
BlackTriangle = visual.ShapeStim(
win,
fillColor='black', lineColor='black')
if type=="unipolar":
BlackTriangle.vertices=unipolar_verts
if type=="bipolar":
BlackTriangle.vertices=bipolar_verts
RatingAnchors = visual.ImageStim(
win=win,
image= imgPath,
name=name+'Anchors',
mask=None,
ori=0, pos=(0, -0.09), size=(1.5, .4),
color=[1,1,1], colorSpace='rgb', opacity=1,
flipHoriz=False, flipVert=False,
texRes=512, interpolate=True, depth=0.0)