forked from jamesmcm/StimScripts
-
Notifications
You must be signed in to change notification settings - Fork 0
/
stimuliclass.py
1023 lines (861 loc) · 58.4 KB
/
stimuliclass.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
# last mod 2013-01-29 11:22 KS
from ctypes import c_float
from psychopy import visual
from psychopy import event
import math
import time
import mondrian
import Image
import numpy as np
import eizoGS320
from tub_stimuli import (cornsweet, todorovic, whites_illusion_bmcc,
whites_illusion_gil, square_wave)
from achrolab.printing import CalibDataFile
from achrolab.eyeone import eyeone, constants
class BaseMonitorTesting(object):
"""
BaseMonitorTesting provides the basic methods for monitor testing - i.e.
collecting data from the EyeOne, and presenting stimuli from images.
All the other stimuli classes inherit from this.
Arguments for initialisation
----------------------------
========== ========== =========== =======================================================================================================
Name Kind Default Description
========== ========== =========== =======================================================================================================
usingeizo Boolean False Set to True if using or producing stimuli for the black and white monitor.
measuring Boolean False Set to True if you wish to measure data.
calibrate Boolean True If True then will ask to calibrate the EyeOne.
prefix String "data" This is the prefix for the filename that the data will be written to. Writes like prefix+date_time.
waittime Float 0.01 This is the waiting time between iterations of the runningLoop. So effectively sets the framerate.
========== ========== =========== =======================================================================================================
The assumed monitor sizes are 1024x1536 for the black and white monitor
(due to the halving of the size with the graphics card) and 1024x768 if not
using this monitor (i.e. for testing).
"""
def __init__(self, usingeizo=False, measuring=False, calibrate=True,
prefix="D:/software/achrolabutils/calibdata/measurements/data", waittime=0.01):
self.measuring=measuring
self.usingeizo=usingeizo
self.calibrate=calibrate
self.prefix=prefix
self.waittime=waittime
if usingeizo==False:
self.monitorsize=[1024,768]
self.monitornum=0
self.EyeOne = eyeone.EyeOne(dummy=True)
else:
#self.monitorsize=[1024, 1536] #size of Eizo screen (half actualy monitor width)
self.monitorsize=[2048, 1536] #size of Eizo screen (half actualy monitor width)
self.monitornum=1
self.EyeOne = eyeone.EyeOne(dummy=False) # Actual EyeOne Object
if measuring==True:
if(self.EyeOne.I1_SetOption(constants.I1_MEASUREMENT_MODE,
constants.I1_SINGLE_EMISSION) == constants.eNoError):
print("Measurement mode set to single emission.")
else:
print("Failed to set measurement mode.")
if(self.EyeOne.I1_SetOption(constants.COLOR_SPACE_KEY,
constants.COLOR_SPACE_CIExyY) == constants.eNoError):
print("Color space set to CIExyY.")
else:
print("Failed to set color space.")
# Initialization of spectrum and colorspace
self.colorspace = (c_float * constants.TRISTIMULUS_SIZE)()
self.spectrum = (c_float * constants.SPECTRUM_SIZE)()
self.checkCalibrate()
def checkCalibrate(self):
"""
This method is called to calibrate the EyeOne. Takes no arguments.
"""
if (self.calibrate or (self.EyeOne.I1_TriggerMeasurement() ==
constants.eDeviceNotCalibrated)):
# Calibration of EyeOne
print("\nPlease put EyeOne Pro on calibration plate and press \n key to start calibration.")
while(self.EyeOne.I1_KeyPressed() != constants.eNoError):
time.sleep(0.1)
if (self.EyeOne.I1_Calibrate() == constants.eNoError):
print("Calibration done.")
else:
print("Calibration failed.")
def showStimuliFromPNG(self, inputfilename, bgcolor=0):
"""
This method displays the provided PNG image in a window, which has a
black background by default.
This function rewrites self.drawFunction to work with the generic
runningLoop.
Arguments
---------
============== ========== =========== =======================================================================================================
Name Kind Default Description
============== ========== =========== =======================================================================================================
inputfilename String N/A The path to the PNG file which is to be displayed.
bgcolor Integer 0 The background color of the window, defaultly 0 (black). Must be between 0 and 1023.
============== ========== =========== =======================================================================================================
"""
self.window = visual.Window(self.monitorsize, monitor="mymon", color=eizoGS320.encode_color(bgcolor,bgcolor), screen=self.monitornum, colorSpace="rgb255", allowGUI=False, units="pix")
self.imagestim=visual.SimpleImageStim(self.window, image=inputfilename, units='norm', pos=(0.0, 0.0), contrast=1.0, opacity=1.0, flipHoriz=False, flipVert=False, name='imagestim', autoLog=True)
#Return function which handles drawing of stimuli, so we can write a general loop for all stimuli drawing/measurement
#self.grayvals=None # specify in subclasses
def drawFunction():
self.imagestim.draw()
self.window.flip()
self.drawFunction = drawFunction
def collectData(self, datafile):
"""
This method collects the tristimulus data from the EyeOne photometer
and writes it to the provided datafile (which should be a CalibDataFile
object from the achrolab.printing class.
Arguments
---------
============== =============== =========== =======================================================================================================
Name Kind Default Description
============== =============== =========== =======================================================================================================
datafile CalibDataFile N/A A CalibDataFile object to which the measurement data will be written.
============== =============== =========== =======================================================================================================
"""
if(self.EyeOne.I1_TriggerMeasurement() != constants.eNoError):
print("Measurement failed.")
# retrieve Color Space
if(self.EyeOne.I1_GetTriStimulus(self.colorspace, 0) != constants.eNoError):
print("Failed to get color space.")
else:
print("Color Space " + str(self.colorspace[:]) + "\n")
datafile.write_data_txt(grayvals=self.grayvals, rgb=None, xyY=self.colorspace, voltage=None, spec_list=None, delimiter="\t")
def runningLoop(self):
"""
This method provides the runningLoop in its abstract form which is used
by all the stimuli classes. The different stimuli classes simply
provide different functions over self.drawFunction(). Takes no
arguments, but depending on the stimuli, the correct object variables
must be set.
"""
running = True
if self.measuring:
with CalibDataFile(prefix=self.prefix) as datafile:
while running:
self.keys = event.getKeys()
for thiskey in self.keys:
if thiskey in ['q', 'escape']:
running = False
break
self.drawFunction()
self.collectData(datafile)
time.sleep(self.waittime)
else:
while running:
self.keys = event.getKeys()
for thiskey in self.keys:
if thiskey in ['q', 'escape']:
running = False
break
self.drawFunction()
time.sleep(self.waittime)
class CRTTest(BaseMonitorTesting):
"""
CRTTest produces a patch of a certain luminance in the centre of the
screen, and modulates the surround according to a sin function.
TUB notes:
Small region test at the centre of CRT, check min, middle, max,
luminance. Then,sin wave modulation of the rest of the screen while
measuring centre. This is a powersupply issue. Modulate sin wave
frequency to measure responsiveness. Square waves are even harsher on
the CRT. Allowing naked eye testing is also good, since the frequency
of modulation may be intense for crappy photometers.
This class inherits from BaseMonitorTesting.
Arguments for initialisation
----------------------------
================ ========== =========== =======================================================================================================
Name Kind Default Description
================ ========== =========== =======================================================================================================
usingeizo Boolean False Set to True if using or producing stimuli for the black and white monitor.
measuring Boolean False Set to True if you wish to measure data.
calibrate Boolean True If True then will ask to calibrate the EyeOne.
prefix String "data" This is the prefix for the filename that the data will be written to. Writes like prefix+date_time.
waittime Float 0.01 This is the waiting time between iterations of the runningLoop. So effectively sets the framerate.
patchsize Float 0.5 This is the size of the patch in the centre in normalised units.
centralstimgray Integer 400 This is the fixed gray value of the central patch.
sinamplitude Integer 1023 This is the amplitude of the sin wave, so effectively the maximum gray value of the background.
freq Float 0.01 This sets the size of the steps of sampling of the sin function.
sinoffset Integer 0 This is an offset which is added to the sin wave, default 0.
================ ========== =========== =======================================================================================================
Note that unlike most other stimuli, this does not rely on or produce any
PNG files.
Example Code
------------
To display the test on the eizo black and white monitor::
>>> test = CRTTest(usingeizo=True)
>>> test.run()
"""
def __init__(self, usingeizo=False, measuring=False, calibrate=True,prefix="D:/software/achrolabutils/calibdata/measurements/data", waittime=0.1, patchsize=0.5, centralstimgray=400, sinamplitude=1023, freq=0.01, sinoffset=0):
BaseMonitorTesting.__init__(self, usingeizo=usingeizo, measuring=measuring, calibrate=calibrate, prefix=prefix, waittime=waittime)
self.patchsize=patchsize
self.centralstimgray=centralstimgray
self.sinamplitude=sinamplitude
self.freq=freq
self.sinoffset=sinoffset
self.graystim=0
self.n=0
def initdraw(self):
"""
This method creates the window and stimuli, ready for drawing. Takes no
arguments. Is called prior to starting the runningLoop.
Of particular importance is the setting of the self.grayvals list,
which is a two item list containing the relevant gray color variables
to be saved in measurements.
"""
self.window = visual.Window(self.monitorsize, monitor="mymon", color=eizoGS320.encode_color(0,0), winType="pygame", screen=self.monitornum, colorSpace="rgb255", allowGUI=False, units="pix")
self.bgstim = visual.GratingStim(self.window, tex=None, units='norm', pos=(0, 0), size=2, colorSpace=self.window.colorSpace, color=eizoGS320.encode_color(0, 0))
self.centralstim = visual.GratingStim(self.window, tex=None, units='norm', pos=(0, 0), size=self.patchsize, colorSpace=self.window.colorSpace, color=eizoGS320.encode_color(self.centralstimgray, self.centralstimgray))
self.n = 0
self.grayvals = [self.graystim, self.centralstimgray]
def drawFunction(self):
"""
This is the drawFunction method as specified by CRTTest. It takes no
arguments but depends upon the properties being set correctly from the
arguments passed in initialisation of the CRTTest object.
"""
#sinamplitude, freq, sinoffset
self.graystim=(self.sinamplitude*abs(math.sin(2*math.pi*self.freq*self.n)))+self.sinoffset
color=eizoGS320.encode_color(self.graystim, self.graystim)
#color = [x/128.-1 for x in color]
#mywin.setColor(color, 'rgb255')
self.bgstim.setColor(color)
self.n+=1
self.n = self.n % (1./self.freq)
self.bgstim.draw()
self.centralstim.draw()
self.window.flip()
def run(self):
self.initdraw()
self.runningLoop()
class Mondrian(BaseMonitorTesting):
'''
This class is a wrapper for the Mondrian generation code from TU Berlin. It
produces a Mondrian to a PNG if no PNG file is provided in the pngfile
argument, otherwise it will display the Mondrian with run().
TU Berlin notes:
Create a mondrian on which the difference between desired color
distribution and actual color distribution is smaller than some
accuracy value. If no randomly created mondrian fulfills this criterion
before some cycle count is reached, the best mondrian generated so far
is returned.
.. warning::
Note one must manually set the image size to (2048, 1536) if producing
stimuli for the black and white monitor.
This class inherits from BaseMonitorTesting.
Arguments for initialisation
----------------------------
================ ================= =========== ========================================================================================================================
Name Kind Default Description
================ ================= =========== ========================================================================================================================
usingeizo Boolean False Set to True if using or producing stimuli for the black and white monitor.
measuring Boolean False Set to True if you wish to measure data.
calibrate Boolean True If True then will ask to calibrate the EyeOne.
prefix String "data" This is the prefix for the filename that the data will be written to. Writes like prefix+date_time.
waittime Float 0.01 This is the waiting time between iterations of the runningLoop. So effectively sets the framerate.
highgray Integer 1023 This is the maximum gray value in the Mondrian (should be between 0 and 1023).
lowgray Integer 0 This is the minimum gray value in the Mondrian (should be between 0 and 1023).
step Integer 1 This is the step between the maximum and minimum gray values which creates the range for the color list.
meanlength Float 5 The mean length of the edges of the Mondrian rectangles.
weights List(Floats) None List of floats which define the probabilities of the colors in the Mondrian. Default None gives equal probabilities.
accuracy Float 0.05 The maximally allowed deviation between the relative frequency of a color and its specified weight.
max_cycles Integer 1000 The maximal number of mondrians created before the function aborts and returns the best mondrian so far.
write Boolean False Whether the Mondrian array should be saved, usually is False.
seed Hashable Object 1 This allows the seed to be set, so multiple Mondrians can be generated with the same background.
pngfile String None The path to the pre-made PNG file if one wishes to display a pre-made Mondrian.
imagesize List(2*Integer) None The size of the Mondrian to be generated, as a 2 element list [X,Y]. If None uses defined monitor size.
encode Boolean True Sets whether to encode the black and white monitor or not.
saveimage Boolean True Whether to save an image of the generated Mondrian. Set to false if generating to inset in another image.
================ ================= =========== ========================================================================================================================
Example Image
-------------
.. image:: doc/figures/mondrian20120713_1126.png
:height: 200px
:width: 200px
Code Example
------------
To produce encoded unweighted Mondrian stimuli for eizo monitor::
>>> test = Mondrian(usingeizo=True, encode=True)
'''
def __init__(self, usingeizo=False, measuring=False, calibrate=True,prefix="D:/software/achrolabutils/calibdata/measurements/data", waittime=0.1, highgray=1023, lowgray=0, step=1, meanlength=5, weights=None, accuracy=0.05, max_cycles=1000, write=False, seed=1, pngfile=None, imagesize=None, encode=True, saveimage=True):
BaseMonitorTesting.__init__(self, usingeizo=usingeizo, measuring=measuring, calibrate=calibrate, prefix=prefix, waittime=waittime)
self.grayvals=[highgray, lowgray]
if imagesize==None:
mondriansize=self.monitorsize
else:
#mondriansize=imagesize
mondriansize = []
mondriansize.extend(imagesize)
mondriansize.reverse()
#Create mondrian if no PNG file provided
if (pngfile==None) or (pngfile==""):
colorlist=range(lowgray, highgray, step)
nparray=mondrian.create_mondrian(mondriansize, meanlength, colorlist, weights, accuracy, max_cycles, write, seed)
self.mondrianarray=nparray
if saveimage==True:
if encode==True:
nparray=eizoGS320.encode_np_array(nparray)
else:
(N, M) = np.shape(nparray)
newarray = np.zeros((N, M, 3), dtype=np.uint8)
newarray[:,:,0]=np.uint8(nparray[:,:]/4)
newarray[:,:,1]=np.uint8(nparray[:,:]/4)
newarray[:,:,2]=np.uint8(nparray[:,:]/4)
#nparray.dtype = np.uint8
nparray=newarray
pil_im = Image.fromarray(nparray)
self.pngfile="mondrian"+time.strftime("%Y%m%d_%H%M")+".png"
pil_im.save(self.pngfile)
else:
self.pngfile=pngfile
def run(self):
self.showStimuliFromPNG(self.pngfile)
self.runningLoop()
class Cornsweet(BaseMonitorTesting):
"""
This class is a wrapper for the Cornsweet generation code from TU
Berlin. It produces a form of the Cornsweet illusion to PNG if no PNG
file is provided in the pngfile argument, otherwise it will display the
stimuli provided. Still need to fix the unencoded version.
TU Berlin notes:
Create a matrix containing a rectangular Cornsweet edge stimulus.
The 2D luminance profile of the stimulus is defined as L = L_mean
+/- (1 - X / w) ** a * L_mean * C/2 for the ramp and L = L_mean for
the area beyond the ramp.
X is the distance to the edge, w is the width of the ramp, a is a
variable determining the steepness of the ramp, and C is the
contrast at the edge, defined as C = (L_max-L_min) / L_mean.
This class inherits from BaseMonitorTesting.
Arguments for initialisation
----------------------------
================ ================= =========== ========================================================================================================================
Name Kind Default Description
================ ================= =========== ========================================================================================================================
usingeizo Boolean False Set to True if using or producing stimuli for the black and white monitor.
measuring Boolean False Set to True if you wish to measure data.
calibrate Boolean True If True then will ask to calibrate the EyeOne.
prefix String "data" This is the prefix for the filename that the data will be written to. Writes like prefix+date_time.
waittime Float 0.01 This is the waiting time between iterations of the runningLoop. So effectively sets the framerate.
visualdegrees List(Floats) None List [X,Y] of size of stimuli in visual degrees. Default None instead calculates this from ppd and monitorsize.
ppd Integer 128 Number of pixels per visual degree.
contrast Float 1 Value between 0 and 1. The contrast of the grating, defined as (max_luminance - min_luminance) / mean_luminance.
ramp_width Float 3 The width of the luminance ramp in degrees of visual angle.
exponent Float 2.75 Determines the steepness of the ramp. An exponent value of 0 leads to a stimulus with uniform flanks.
mean_lum Integer 511 The mean luminance of the stimulus, i.e. the value outside of the ramp area.
pngfile String None The path to the pre-made PNG file if one wishes to display a pre-made stimuli
encode Boolean True Sets whether to encode the black and white monitor or not.
================ ================= =========== ========================================================================================================================
References (from TU Berlin)
---------------------------
The formula and default values are taken from Boyaci, H., Fang, F.,
Murray, S.O., Kersten, D. (2007). Responses to Lightness Variations in
Early Human Visual Cortex. Current Biology 17, 989-993.
Example Image
-------------
.. image:: doc/figures/cornsweet20120814_1705.png
:height: 200px
:width: 200px
Example code
------------
Produce and display small Cornsweet Illusion image on normal monitor (be
careful of the image size and monitor size when you make these stimuli)::
>>> test = Cornsweet(usingeizo=False, encode=False, visualdegrees=[3,3]) #Create png file
>>> test = Cornsweet(pngfile="cornsweet20120831_1101.png") #Load png file
>>> test.run() #Display stimuli
"""
def __init__(self, usingeizo=False, measuring=False, calibrate=True,prefix="D:/software/achrolabutils/calibdata/measurements/data", waittime=0.1, visualdegrees=None, ppd=128, contrast=1, ramp_width=3, exponent=2.75, mean_lum=511, pngfile=None, encode=True):
BaseMonitorTesting.__init__(self, usingeizo=usingeizo, measuring=measuring, calibrate=calibrate, prefix=prefix, waittime=waittime)
self.grayvals=[mean_lum, exponent]
if pngfile==None:
if visualdegrees==None:
visualdegrees=[]
visualdegrees.append(int(self.monitorsize[1]/ppd))
visualdegrees.append(int(self.monitorsize[0]/ppd))
nparray=cornsweet(visualdegrees, ppd, contrast, ramp_width, exponent, mean_lum)
if encode==True:
nparray=eizoGS320.encode_np_array(nparray)
else:
(N, M) = np.shape(nparray)
newarray = np.zeros((N, M, 3), dtype=np.uint8)
newarray[:,:,0]=np.uint8(nparray[:,:]/4)
newarray[:,:,1]=np.uint8(nparray[:,:]/4)
newarray[:,:,2]=np.uint8(nparray[:,:]/4)
#nparray.dtype = np.uint8
nparray=newarray
pil_im = Image.fromarray(nparray)
self.pngfile="cornsweet"+time.strftime("%Y%m%d_%H%M")+".png"
pil_im.save(self.pngfile)
else:
self.pngfile=pngfile
def run(self):
"""
This is the main loop for presenting the stimuli, so after
initialising the stimuli, call object.run() to present it.
"""
self.showStimuliFromPNG(self.pngfile)
self.runningLoop()
class Todorovic(BaseMonitorTesting):
"""
This class is a wrapper for the Todorovic checkerboard generation code
from TU Berlin. It produces a form of the Torodovic checkerboard
illusion to PNG if no PNG file is provided in the pngfile argument,
otherwise it will display the stimuli provided. Still need to fix the
unencoded version.
Note that it works by first producing an appropriate Cornsweet stimulus
and then repeating this.
TU Berlin notes:
Create a checkerboard illusion by appropriately aligning COC
stimuli, in the way demonstrated by Todorovic (1987).
This class inherits from BaseMonitorTesting.
Arguments for initialisation
----------------------------
================ ================= =========== =====================================================================================================================================
Name Kind Default Description
================ ================= =========== =====================================================================================================================================
usingeizo Boolean False Set to True if using or producing stimuli for the black and white monitor.
measuring Boolean False Set to True if you wish to measure data.
calibrate Boolean True If True then will ask to calibrate the EyeOne.
prefix String "data" This is the prefix for the filename that the data will be written to. Writes like prefix+date_time.
waittime Float 0.01 This is the waiting time between iterations of the runningLoop. So effectively sets the framerate.
visualdegrees List(Floats) None List [X,Y] of size of stimuli in visual degrees. Default None instead calculates this from ppd and monitorsize.
ppd Integer 128 Number of pixels per visual degree.
contrast Float 1 Value between 0 and 1. The contrast of the grating, defined as (max_luminance - min_luminance) / mean_luminance.
ramp_width Float 3 The width of the luminance ramp in degrees of visual angle, used for generating the Cornsweet stimulus.
exponent Float 2.75 Determines the steepness of the ramp. An exponent value of 0 leads to a stimulus with uniform flanks. Used for Cornsweet Stimulus.
mean_lum Integer 511 The mean luminance of the stimulus, i.e. the value outside of the ramp area. Used for Cornsweet stimulus.
vert_rep Integer 3 The number of vertical repetitions (i.e. rows) in the Todorovic checkerboard.
horz_rep Integer 5 The number of horizontal repetitions (i.e. columns) in the Todorovic checkerboard.
encode Boolean True Sets whether to encode the black and white monitor or not.
================ ================= =========== =====================================================================================================================================
References (from TU Berlin)
---------------------------
Todorovic, D. (1987). The Craik-O'Brien-Cornsweet effect: new varieties and
their theoretical implications. Perception & psychophysics, 42(6), 545-60,
Plate 4.
Example Image
-------------
.. image:: doc/figures/todorovic20120814_1705.png
:height: 200px
:width: 200px
Code Example
------------
To produce encoded Todorovic stimuli for eizo monitor::
>>> test = Todorovic(usingeizo=True, encode=True)
"""
def __init__(self, usingeizo=False, measuring=False, calibrate=True,prefix="D:/software/achrolabutils/calibdata/measurements/data", waittime=0.1, visualdegrees=None, ppd=128, contrast=1, ramp_width=3, exponent=2.75, mean_lum=511, vert_rep=3, horz_rep=5, pngfile=None, encode=True):
BaseMonitorTesting.__init__(self, usingeizo=usingeizo, measuring=measuring, calibrate=calibrate, prefix=prefix, waittime=waittime)
self.grayvals=[mean_lum, exponent]
if pngfile==None:
if visualdegrees==None:
visualdegrees=[]
visualdegrees.append(int((self.monitorsize[1]/ppd)/vert_rep))
visualdegrees.append(int((self.monitorsize[0]/ppd)/horz_rep))
nparray=cornsweet(visualdegrees, ppd, contrast, ramp_width, exponent, mean_lum)
nparray=todorovic(nparray, vert_rep, horz_rep)
if encode==True:
nparray=eizoGS320.encode_np_array(nparray)
else:
(N, M) = np.shape(nparray)
newarray = np.zeros((N, M, 3), dtype=np.uint8)
newarray[:,:,0]=np.uint8(nparray[:,:]/4)
newarray[:,:,1]=np.uint8(nparray[:,:]/4)
newarray[:,:,2]=np.uint8(nparray[:,:]/4)
#nparray.dtype = np.uint8
nparray=newarray
pil_im = Image.fromarray(nparray)
self.pngfile="todorovic"+time.strftime("%Y%m%d_%H%M")+".png"
pil_im.save(self.pngfile)
else:
self.pngfile=pngfile
def run(self):
self.showStimuliFromPNG(self.pngfile)
self.runningLoop()
class WhiteIllusion(BaseMonitorTesting):
"""
This class is a wrapper for the White's Illusion generation code from TU
Berlin. It produces a form of the White's illusion on a square wave to PNG
if no PNG file is provided in the pngfile argument, otherwise it will
display the stimuli provided. Still need to fix the unencoded version.
Produces both kind="bmcc": in the style used by Blakeslee and McCourt
(1999), and kind="gil": in the style used by Gilchrist (2006, p. 281).
This class inherits from BaseMonitorTesting.
Arguments for initialisation
----------------------------
================ ================= =========== ========================================================================================================================
Name Kind Default Description
================ ================= =========== ========================================================================================================================
usingeizo Boolean False Set to True if using or producing stimuli for the black and white monitor.
measuring Boolean False Set to True if you wish to measure data.
calibrate Boolean True If True then will ask to calibrate the EyeOne.
prefix String "data" This is the prefix for the filename that the data will be written to. Writes like prefix+date_time.
waittime Float 0.01 This is the waiting time between iterations of the runningLoop. So effectively sets the framerate.
kind String "bmcc" This sets the style of White's Illumination stimuli to be produced, valid values: "bmcc" or "gil".
visualdegrees List(Floats) None List [X,Y] of size of stimuli in visual degrees. Default None instead calculates this from ppd and monitorsize.
ppd Integer 128 Number of pixels per visual degree.
contrast Float 1 Value between 0 and 1. The contrast of the grating, defined as (max_luminance - min_luminance) / mean_luminance.
frequency Float 5 The spatial frequency of the wave in cycles per degree.
mean_lum Integer 511 The mean luminance of the stimulus, i.e. the value outside of the ramp area.
start String "high" Specifies if the wave starts with a high or low value, can be "high" or "low".
pngfile String None The path to the pre-made PNG file if one wishes to display a pre-made stimuli
encode Boolean True Sets whether to encode the black and white monitor or not.
================ ================= =========== ========================================================================================================================
References (from TU Berlin)
---------------------------
Blakeslee B, McCourt ME (1999). A multiscale spatial filtering account of
the White effect, simultaneous brightness contrast and grating induction.
Vision research 39(26):4361-77.
Gilchrist A (2006). Seeing Black and White. New York, New York, USA: Oxford
University Press.
Example Image
-------------
Gilchrist:
.. image:: doc/figures/whiteillusiongil20120815_1138.png
:height: 200px
:width: 200px
Blakeslee, McCourt:
.. image:: doc/figures/whiteillusionbmcc20120814_1705.png
:height: 200px
:width: 200px
"""
def __init__(self, usingeizo=False, measuring=False, calibrate=True,prefix="D:/software/achrolabutils/calibdata/measurements/data", waittime=0.1, kind="bmcc", visualdegrees=None, ppd=128, contrast=1, frequency=5, mean_lum=511, start='high', pngfile=None, encode=True):
BaseMonitorTesting.__init__(self, usingeizo=usingeizo, measuring=measuring, calibrate=calibrate, prefix=prefix, waittime=waittime)
self.grayvals=[mean_lum, contrast]
if pngfile==None:
if visualdegrees==None:
visualdegrees=[]
visualdegrees.append(int(self.monitorsize[1]/ppd))
visualdegrees.append(int(self.monitorsize[0]/ppd))
if kind=="bmcc":
nparray=whites_illusion_bmcc(visualdegrees, ppd, contrast, frequency, mean_lum=mean_lum, start=start)
if kind=="gil":
nparray=whites_illusion_gil(visualdegrees, ppd, contrast, frequency, mean_lum=mean_lum, start=start)
if encode==True:
nparray=eizoGS320.encode_np_array(nparray)
else:
(N, M) = np.shape(nparray)
newarray = np.zeros((N, M, 3), dtype=np.uint8)
newarray[:,:,0]=np.uint8(nparray[:,:]/4)
newarray[:,:,1]=np.uint8(nparray[:,:]/4)
newarray[:,:,2]=np.uint8(nparray[:,:]/4)
#nparray.dtype = np.uint8
nparray=newarray
pil_im = Image.fromarray(nparray)
self.pngfile="whiteillusion"+kind+time.strftime("%Y%m%d_%H%M")+".png"
pil_im.save(self.pngfile)
else:
self.pngfile=pngfile
def run(self):
self.showStimuliFromPNG(self.pngfile)
self.runningLoop()
class SquareWave(BaseMonitorTesting):
"""
This class is a wrapper for the Square Wave generation code from TU Berlin.
It produces a form of a square wave to PNG if no PNG file is provided in
the pngfile argument, otherwise it will display the stimuli provided. Still
need to fix the unencoded version.
TU Berlin notes:
Create a horizontal square wave of given spatial frequency.
This class inherits from BaseMonitorTesting.
Arguments for initialisation
----------------------------
================ ================= =========== ===============================================================================================================================================================================================================================================================
Name Kind Default Description
================ ================= =========== ===============================================================================================================================================================================================================================================================
usingeizo Boolean False Set to True if using or producing stimuli for the black and white monitor.
measuring Boolean False Set to True if you wish to measure data.
calibrate Boolean True If True then will ask to calibrate the EyeOne.
prefix String "data" This is the prefix for the filename that the data will be written to. Writes like prefix+date_time.
waittime Float 0.01 This is the waiting time between iterations of the runningLoop. So effectively sets the framerate.
visualdegrees List(Floats) None List [X,Y] of size of stimuli in visual degrees. Default None instead calculates this from ppd and monitorsize.
ppd Integer 128 Number of pixels per visual degree.
contrast Float 1 Value between 0 and 1. The contrast of the grating, defined as (max_luminance - min_luminance) / mean_luminance.
frequency Float 5 The spatial frequency of the wave in cycles per degree.
period String "ignore" Specifies if the period of the wave is taken into account when determining exact stimulus dimensions. 'ignore' simply converts degrees to pixels, 'full' rounds down to guarantee a full period, 'half' adds a half period to the size 'full' would yield.
mean_lum Integer 511 The mean luminance of the stimulus, i.e. the value outside of the ramp area.
start String "high" Specifies if the wave starts with a high or low value, can be "high" or "low".
pngfile String None The path to the pre-made PNG file if one wishes to display a pre-made stimuli
encode Boolean True Sets whether to encode the black and white monitor or not.
================ ================= =========== ===============================================================================================================================================================================================================================================================
"""
def __init__(self, usingeizo=False, measuring=False, calibrate=True,prefix="D:/software/achrolabutils/calibdata/measurements/data", waittime=0.1, visualdegrees=None, ppd=512, contrast=1, frequency=5, mean_lum=511, period='ignore', start='high', pngfile=None, encode=True):
BaseMonitorTesting.__init__(self, usingeizo=usingeizo, measuring=measuring, calibrate=calibrate, prefix=prefix, waittime=waittime)
self.grayvals=[mean_lum, contrast]
if pngfile==None:
if visualdegrees==None:
visualdegrees=[]
visualdegrees.append(int(self.monitorsize[1]/ppd))
visualdegrees.append(int(self.monitorsize[0]/ppd))
nparray=square_wave(visualdegrees, ppd, contrast, frequency, mean_lum, period=period, start=start)
if encode==True:
nparray=eizoGS320.encode_np_array(nparray)
else:
(N, M) = np.shape(nparray)
newarray = np.zeros((N, M, 3), dtype=np.uint8)
newarray[:,:,0]=np.uint8(nparray[:,:]/4)
newarray[:,:,1]=np.uint8(nparray[:,:]/4)
newarray[:,:,2]=np.uint8(nparray[:,:]/4)
#nparray.dtype = np.uint8
nparray=newarray
pil_im = Image.fromarray(nparray)
self.pngfile="squarewave"+time.strftime("%Y%m%d_%H%M")+".png"
pil_im.save(self.pngfile)
else:
self.pngfile=pngfile
def run(self):
self.showStimuliFromPNG(self.pngfile)
self.runningLoop()
class Lines(BaseMonitorTesting):
"""
This class produces horizontally and vertically oriented lines of a specified width (to test whether there is the same luminance in both directions). It is similar to the SquareWave stimuli code from TU Berlin. It produces the line stimuli to PNG files if no PNG files are provided in the pngfiles list argument, otherwise it will display the stimuli provided. Still need to fix the unencoded version.
.. warning::
Note one must manually set the monitor size argument to (2048, 1536) if producing stimuli for the black and white monitor.
This class inherits from BaseMonitorTesting.
Arguments for initialisation
----------------------------
================ ================= =========== ===============================================================================================================================================================================================================================================================
Name Kind Default Description
================ ================= =========== ===============================================================================================================================================================================================================================================================
usingeizo Boolean False Set to True if using or producing stimuli for the black and white monitor.
measuring Boolean False Set to True if you wish to measure data.
calibrate Boolean True If True then will ask to calibrate the EyeOne.
prefix String "data" This is the prefix for the filename that the data will be written to. Writes like prefix+date_time.
waittime Float 0.01 This is the waiting time between iterations of the runningLoop. So effectively sets the framerate.
pngfiles List(Strings) None The paths to the pre-made PNG files if one wishes to display pre-made stimuli. If None then generates new stimuli files.
encode Boolean True Sets whether to encode the black and white monitor or not.
monitorsize List(Integers) None List of monitor size values [X,Y] to produce stimuli for. If None then determines values from defaults.
lowgray Integer 0 The gray value of the lines.
highgray Integer 1023 The gray value of the space between the lines.
linewidth Integer 8 The width of the lines in pixels. Note this must be a divisor of your monitor size for the stimuli to display correctly.
================ ================= =========== ===============================================================================================================================================================================================================================================================
"""
def __init__(self, usingeizo=False, measuring=False, calibrate=True,prefix="D:/software/achrolabutils/calibdata/measurements/data", waittime=0.1, pngfiles=None, encode=True, monitorsize=None, lowgray=0, highgray=1023, linewidth=8):
BaseMonitorTesting.__init__(self, usingeizo=usingeizo, measuring=measuring, calibrate=calibrate, prefix=prefix, waittime=waittime)
self.linepngs=[]
self.grayvals=[highgray, lowgray]
if pngfiles==None:
if monitorsize==None:
#monitorsize=self.monitorsize
monitorsize = []
monitorsize.extend(self.monitorsize)
monitorsize.reverse()
nparrayx=np.ones(monitorsize, dtype=np.uint16)
nparrayx*=512
nparrayy=np.ones(monitorsize, dtype=np.uint16)
nparrayy*=512
i=0
color=lowgray
#x-loop
while i<monitorsize[0]:
if i%linewidth==0:
if color==lowgray:
color=highgray
else:
color=lowgray
nparrayx[i, :]=color
i+=1
i=0
#y-loop
while i<monitorsize[1]:
if i%linewidth==0:
if color==lowgray:
color=highgray
else:
color=lowgray
nparrayy[:,i]=color
i+=1
if encode==True:
nparrayx=eizoGS320.encode_np_array(nparrayx)
nparrayy=eizoGS320.encode_np_array(nparrayy)
else:
(N, M) = np.shape(nparrayx)
newarrayx = np.zeros((N, M, 3), dtype=np.uint8)
newarrayx[:,:,0]=np.uint8(nparrayx[:,:]/4)
newarrayx[:,:,1]=np.uint8(nparrayx[:,:]/4)
newarrayx[:,:,2]=np.uint8(nparrayx[:,:]/4)
#nparray.dtype = np.uint8
nparrayx=newarrayx
(N, M) = np.shape(nparrayy)
newarrayy = np.zeros((N, M, 3), dtype=np.uint8)
newarrayy[:,:,0]=np.uint8(nparrayy[:,:]/4)
newarrayy[:,:,1]=np.uint8(nparrayy[:,:]/4)
newarrayy[:,:,2]=np.uint8(nparrayy[:,:]/4)
#nparray.dtype = np.uint8
nparrayy=newarrayy
pil_imx = Image.fromarray(nparrayx)
pil_imy = Image.fromarray(nparrayy)
timem=str(time.strftime("%Y%m%d_%H%M"))
self.linepngs.append(str(linewidth)+"linesx"+timem+".png")
self.linepngs.append(str(linewidth)+"linesy"+timem+".png")
pil_imx.save(self.linepngs[0])
pil_imy.save(self.linepngs[1])
else:
self.linepngs=pngfiles
def drawFunction(self):
if self.n%2 == 0:
self.linesx.draw()
print("Horizontal lines drawn")
else:
self.linesy.draw()
print("Vertical lines drawn")
self.n+=1
self.n = self.n % 2
self.window.flip()
def run(self):
self.window = visual.Window(self.monitorsize, monitor="mymon", color=eizoGS320.encode_color(0,0), screen=self.monitornum, colorSpace="rgb255", allowGUI=False, units="pix")
self.linesx=visual.SimpleImageStim(self.window, image=self.linepngs[0], units='norm', pos=(0.0, 0.0), contrast=1.0, opacity=1.0, flipHoriz=False, flipVert=False, name='linesx', autoLog=True)
self.linesy=visual.SimpleImageStim(self.window, image=self.linepngs[1], units='norm', pos=(0.0, 0.0), contrast=1.0, opacity=1.0, flipHoriz=False, flipVert=False, name='linesy', autoLog=True)
self.n=0
if self.measuring==True:
print("\nPlease put EyeOne Pro in measurement position and press \n key to start measurement.")
while(self.EyeOne.I1_KeyPressed() != constants.eNoError):
time.sleep(0.1)
print("Starting measurement...")
self.runningLoop()
class SinGrating(BaseMonitorTesting):
"""
Produces a sin-wave based stimuli across the screen, which is then shifted
to anti-phase and re-presented rapidly.
TUB notes:
Two stimuli, superimposed mean luminance is equal to background. At high
enough frequencies, the stimuli should be invisible. The photometer will
probably be fine with this, but if one's eyes are moving too much, it will
look terrible. Look through a tube and the effect will probably go away.
Anyway, the point is, is that this is a great test for frame dropping.
.. warning::
Note one must manually set the monitor size argument to (2048, 1536) if
producing stimuli for the black and white monitor.
This class inherits from BaseMonitorTesting.
Arguments for initialisation
----------------------------
================ ================= =========== ===============================================================================================================================================================================================================================================================
Name Kind Default Description
================ ================= =========== ===============================================================================================================================================================================================================================================================
usingeizo Boolean False Set to True if using or producing stimuli for the black and white monitor.
measuring Boolean False Set to True if you wish to measure data.
calibrate Boolean True If True then will ask to calibrate the EyeOne.
prefix String "data" This is the prefix for the filename that the data will be written to. Writes like prefix+date_time.
waittime Float 0.01 This is the waiting time between iterations of the runningLoop. So effectively sets the framerate.
pngfiles List(Strings) None The paths to the pre-made PNG files if one wishes to display pre-made stimuli. If None then generates new stimuli files.
encode Boolean True Sets whether to encode the black and white monitor or not.
monitorsize List(Integers) None List of monitor size values [X,Y] to produce stimuli for. If None then determines values from defaults.
gratingheight Integer 20 Height of the grating from the centre, in pixels.
sinamplitude Integer 512 The middle gray value of the sin grating.
sinoffset Integer 512 The offset for the sin grating, with default values this is set to 512 such that the maximal value is 1024.
================ ================= =========== ===============================================================================================================================================================================================================================================================
Note this stimuli does not yet appear to work as intended, in that the sin
wave never appears invisible even at very high refresh rates.
"""
def __init__(self, usingeizo=False, measuring=False, calibrate=True,prefix="D:/software/achrolabutils/calibdata/measurements/data", waittime=0.1, pngfiles=None, encode=True, monitorsize=None, gratingheight=20, sinamplitude=512, sinoffset=512):
BaseMonitorTesting.__init__(self, usingeizo=usingeizo, measuring=measuring, calibrate=calibrate, prefix=prefix, waittime=waittime)
self.grayvals=[sinamplitude, sinoffset]
self.sinpngs=[]
if pngfiles==None:
if monitorsize==None:
#monitorsize=self.monitorsize
monitorsize = []
monitorsize.extend(self.monitorsize)
monitorsize.reverse()
nparray0=np.ones(monitorsize, dtype=np.uint16)
nparray0*=512
nparray180=np.ones(monitorsize, dtype=np.uint16)
nparray180*=512
i=0
#x-loop
while i<monitorsize[1]:
nparray0[int(monitorsize[0]/2)-gratingheight:int(monitorsize[0]/2)+gratingheight, i]=(sinamplitude*math.sin((((2.0*math.pi)/(monitorsize[1]))*i) +0.00001)) + sinoffset
nparray180[int(monitorsize[0]/2)-gratingheight:int(monitorsize[0]/2)+gratingheight, i]=(sinamplitude*math.sin((((2.0*math.pi)/(monitorsize[1]))*i) +0.00001 + math.pi)) + sinoffset
i+=1
if encode==True:
nparray0=eizoGS320.encode_np_array(nparray0)
nparray180=eizoGS320.encode_np_array(nparray180)
else:
(N, M) = np.shape(nparray0)
newarray0 = np.zeros((N, M, 3), dtype=np.uint8)
newarray0[:,:,0]=np.uint8(nparray0[:,:]/4)
newarray0[:,:,1]=np.uint8(nparray0[:,:]/4)
newarray0[:,:,2]=np.uint8(nparray0[:,:]/4)
#nparray.dtype = np.uint8
nparray0=newarray0
(N, M) = np.shape(nparray180)
newarray180 = np.zeros((N, M, 3), dtype=np.uint8)
newarray180[:,:,0]=np.uint8(nparray180[:,:]/4)
newarray180[:,:,1]=np.uint8(nparray180[:,:]/4)
newarray180[:,:,2]=np.uint8(nparray180[:,:]/4)
#nparray.dtype = np.uint8
nparray180=newarray180
pil_im0 = Image.fromarray(nparray0)
pil_im180 = Image.fromarray(nparray180)
timem=str(time.strftime("%Y%m%d_%H%M"))
self.sinpngs.append("singrating0p"+timem+".png")
self.sinpngs.append("singrating180p"+timem+".png")
pil_im0.save(self.sinpngs[0])
pil_im180.save(self.sinpngs[1])
else:
self.sinpngs=pngfiles
def drawFunction(self):
if self.n%2 == 0:
self.sin0.draw()
print("0 phase sin grating drawn")
else:
self.sin180.draw()
print("180 phase sin grating drawn")
self.n+=1
self.n = self.n % 2
self.window.flip()
def run(self):
self.window = visual.Window(self.monitorsize, monitor="mymon", color=eizoGS320.encode_color(0,0), screen=self.monitornum, colorSpace="rgb255", allowGUI=False, units="pix")
self.sin0=visual.SimpleImageStim(self.window, image=self.sinpngs[0], units='norm', pos=(0.0, 0.0), contrast=1.0, opacity=1.0, flipHoriz=False, flipVert=False, name='phase0', autoLog=True)
self.sin180=visual.SimpleImageStim(self.window, image=self.sinpngs[1], units='norm', pos=(0.0, 0.0), contrast=1.0, opacity=1.0, flipHoriz=False, flipVert=False, name='phase180', autoLog=True)
self.n=0
self.runningLoop()
class PatchBrightnessTest(BaseMonitorTesting):
'''
Compare luminance of big patch and small patch, on CRT big patch should
always be less bright. Can use up and down arrow keys to modify the size of
the patch whilst running.
This class inherits from BaseMonitorTesting.
Arguments for initialisation
----------------------------
================ ================= =========== ===============================================================================================================================================================================================================================================================
Name Kind Default Description
================ ================= =========== ===============================================================================================================================================================================================================================================================
usingeizo Boolean False Set to True if using or producing stimuli for the black and white monitor.
measuring Boolean False Set to True if you wish to measure data.
calibrate Boolean True If True then will ask to calibrate the EyeOne.
prefix String "data" This is the prefix for the filename that the data will be written to. Writes like prefix+date_time.
waittime Float 0.01 This is the waiting time between iterations of the runningLoop. So effectively sets the framerate.
encode Boolean True Sets whether to encode the black and white monitor or not.
monitorsize List(Integers) None List of monitor size values [X,Y] to present the stimuli on. If None then determines values from defaults.
patchsize Float 0.5 The initial size of the central patch in normalised units.
bggray Integer 512 The fixed value of the background gray.
patchgray Integer 800 The fixed value of the patch gray.
patchstep Float 0.1 The amount by which one button press Up or Down changes the central patch size.
================ ================= =========== ===============================================================================================================================================================================================================================================================
'''
def __init__(self, usingeizo=False, measuring=False, calibrate=True,prefix="D:/software/achrolabutils/calibdata/measurements/data", waittime=0.1, encode=True, monitorsize=None, patchsize=0.5, bggray=511, patchgray=800, patchstep=0.1):
BaseMonitorTesting.__init__(self, usingeizo=usingeizo, measuring=measuring, calibrate=calibrate, prefix=prefix, waittime=waittime)
self.grayvals=[patchgray, bggray]
self.patchsize=patchsize
self.bggray=bggray
self.patchgray=patchgray
self.patchstep=patchstep