-
-
Notifications
You must be signed in to change notification settings - Fork 27
/
Copy pathopticka.m
1951 lines (1803 loc) · 63.9 KB
/
opticka.m
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
% ======================================================================
%> @class opticka
%> @brief Stimulus generator GUI
%>
%> Opticka is an object-oriented experiment manager wrapping the Psychophysics
%> toolbox See http://iandol.github.com/opticka/ for more details. This
%> class builds and controls the GUI.
%>
%> @todo expose maskStimulus settings in the optickaGUI
%> @todo improve the variable list editor: live updating
%> @todo add trialVar and blockVar from taskSequene to the GUI
%> @todo make a html-based help button for different parts of the GUI
%> @todo more flexible specification for arduino settings
%>
%> Copyright ©2014-2022 Ian Max Andolina — released: LGPL3, see LICENCE.md
% ======================================================================
classdef opticka < optickaCore
properties
%> this is the main runExperiment object
r runExperiment
%> run in verbose mode?
verbose = false
end
properties (SetAccess = public, GetAccess = public, Transient = true)
%> general store for misc properties
store struct = struct()
%> initialise UI?
initUI logical = true
end
properties (SetAccess = protected, GetAccess = public, Transient = true)
%> all of the handles to the opticka_ui GUI
h
end
properties (SetAccess = protected, GetAccess = public)
%> version number
optickaVersion char = '2.06'
%> history of display objects
history
%> is this a remote instance?
remote = 0
%> omniplex connection, via TCP
oc
end
properties (SetAccess = private, GetAccess = private)
%> spash screen handle
ss
%> used to sanitise passed values on construction
allowedProperties char = 'verbose|initUI'
%> which UI settings should be saved locally to the machine?
uiPrefsList cell = {'OKOmniplexIP','OKMonitorDistance','OKpixelsPerCm',...
'OKbackgroundColour','OKAntiAliasing','OKbitDepth','OKUseRetina',...
'OKHideFlash','OKUsePhotoDiode','OKTrainingResearcherName',...
'OKTrainingName','OKarduinoPort','OKdPPMode','OKDebug',...
'OKOpenGLBlending','OKCalEditField','OKValEditField',...
'OKTrackerDropDown','OKWindowSize','OKUseDummy'}
end
%=======================================================================
methods %------------------PUBLIC METHODS
%=======================================================================
% ===================================================================
%> @brief Class constructor
%>
%> @param varargin are passed as a structure of properties which is
%> parsed.
%> @return instance of opticka class.
% ===================================================================
function me = opticka(varargin)
args = optickaCore.addDefaults(varargin,struct('name','opticka'));
me=me@optickaCore(args); %superclass constructor
me.parseArgs(args,me.allowedProperties);
if me.cloning == false
if ~exist('OKStartTask_image.png','file');addOptickaToPath;end
if me.initUI
me.initialiseUI;
end
end
end
% ===================================================================
%> @brief Route to private methods
%>
%> @param in switch to route to correct method.
%> @param vars additional vars to pass.
% ===================================================================
function router(me,in,vars)
% router(me,in,vars)
if ~exist('vars','var')
vars=[];
end
switch in
case 'saveData'
me.saveData();
case 'saveProtocol'
me.saveProtocol(vars);
case 'loadProtocol'
me.loadProtocol(vars);
case 'deleteProtocol'
me.deleteProtocol()
case 'LoadStateInfo'
me.loadStateInfo();
end
end
% ===================================================================
%> @brief Check if we are remote by checking existance of UI
%>
%> @param me self object
% ===================================================================
function amIRemote(me)
if ~ishandle(me.h.output)
me.remote = true;
end
end
% ===================================================================
%> @brief connectToOmniplex
%> Gets the settings from the UI and connects to omniplex
%> @param
% ===================================================================
function connectToOmniplex(me)
rPort = me.gn(me.h.OKOmniplexPort);
rAddress = me.gs(me.h.OKOmniplexIP);
status = me.ping(rAddress);
if status > 0
set(me.h.OKOmniplexStatus,'Value','Omniplex: machine ping ERROR!')
errordlg('Cannot ping Omniplex machine, please ensure it is connected!!!')
error('Cannot ping Omniplex, please ensure it is connected!!!')
end
if isempty(me.oc)
in = struct('verbosity',0,'rPort',rPort,'rAddress',rAddress,'protocol','tcp');
me.oc = dataConnection(in);
else
me.oc.rPort = me.gn(me.h.OKOmniplexPort);
me.oc.rAddress = me.gs(me.h.OKOmniplexIP);
end
if me.oc.checkStatus < 1
loop = 1;
while loop <= 10
me.oc.close('conn',1);
fprintf('\nTrying to connect...\n');
me.oc.open;
if me.oc.checkStatus > 0
break
end
pause(0.1);
end
me.oc.write('--ping--');
loop = 1;
while loop < 8
in = me.oc.read(0);
fprintf('\n{opticka said: %s}\n',in)
if regexpi(in,'(opened|ping)')
fprintf('\nWe can ping omniplex master on try: %d\n',loop)
set(me.h.OKOmniplexStatus,'Value','Omniplex: connected via TCP')
break
else
fprintf('\nOmniplex master not responding, try: %d\n',loop)
set(me.h.OKOmniplexStatus,'Value','Omniplex: not responding')
end
loop=loop+1;
pause(0.2);
end
%drawnow;
end
end
% ===================================================================
%> @brief sendOmniplexStimulus
%> Gets the settings from the UI and connects to omniplex
%> @param
% ===================================================================
function sendOmniplexStimulus(me,sendLog)
if ~exist('sendLog','var')
sendLog = false;
end
if me.oc.checkStatus > 0
%flush read buffer
data = me.oc.read('all');
tLog=[];
if me.oc.checkStatus > 0 %check again to make sure we are still open
me.oc.write('--readStimulus--');
pause(0.25);
tic
if sendLog == false
if ~isempty(me.r.runLog);tLog = me.r.runLog;end
me.r.deleteRunLog; %so we don't send too much data over TCP
end
tmpobj=me.r;
me.oc.writeVar('o',tmpobj);
if sendLog == false
if ~isempty(tLog);me.r.restoreRunLog(tLog);end
end
fprintf('>>>Opticka: It took %g seconds to write and send stimulus to Omniplex machine\n',toc);
loop = 1;
while loop < 10
in = me.oc.read(0);
fprintf('\n{omniplex said: %s}\n',in)
if regexpi(in,'(stimulusReceived)')
set(me.h.OKOmniplexStatus,'Value','Omniplex: connected+stimulus received')
break
elseif regexpi(in,'(stimulusFailed)')
set(me.h.OKOmniplexStatus,'Value','Omniplex: connected, stimulus ERROR!')
end
loop=loop+1;
pause(0.2);
end
end
end
end
end % END PUBLIC METHODS
%========================================================
methods (Hidden = true) %these have to be available publically, but lets hide them from obvious view
%========================================================
% ===================================================================
%> @brief Start the UI
%>
%> @param
% ===================================================================
function initialiseUI(me)
try
me.ss = SplashScreen(['Opticka V' me.optickaVersion],'opticka.png');
if isdeployed
me.ss.addText( 10, 30, ['Loading Opticka [D] V' me.optickaVersion '…'], 'FontSize', 20, 'Color', [1 0.8 0.5] )
else
me.ss.addText( 10, 30, ['Loading Opticka V' me.optickaVersion '…'], 'FontSize', 20, 'Color', [1 0.8 0.5] )
end
me.paths.whoami = mfilename;
me.paths.whereami = fileparts(which(mfilename));
me.paths.startServer = [me.paths.whereami filesep 'udpserver' filesep 'launchDataConnection'];
if ismac
me.store.serverCommand = ['!osascript -e ''tell application "Terminal"'' -e ''activate'' -e ''do script "matlab -nodesktop -r \"runServer\""'' -e ''end tell'''];
else
me.store.serverCommand = '!matlab -nodesktop -nosplash -r "d=dataConnection(struct(''autoServer'',1,''lPort'',5678));" &';
end
if ismac || isunix
me.paths.temp=tempdir;
if ~exist([me.paths.home filesep 'MatlabFiles' filesep 'Protocols'],'dir')
mkdir([me.paths.home filesep 'MatlabFiles' filesep 'Protocols']);
end
if ~isdeployed && ~exist([me.paths.home filesep 'MatlabFiles' filesep 'Protocols' filesep 'CoreProtocols'],'dir')
src = [me.paths.whereami filesep 'CoreProtocols'];
dst = [me.paths.home filesep 'MatlabFiles' filesep 'Protocols' filesep];
cmd = ['!ln -s ' src ' ' dst];
eval(cmd);
end
me.paths.protocols = [me.paths.home filesep 'MatlabFiles' filesep 'Protocols'];
cd(me.paths.protocols);
me.paths.currentPath = pwd;
if ~exist([me.paths.home filesep 'MatlabFiles' filesep 'Calibration'],'dir')
mkdir([me.paths.home filesep 'MatlabFiles' filesep 'Calibration']);
end
me.paths.calibration = [me.paths.home filesep 'MatlabFiles' filesep 'Calibration'];
if ~exist([me.paths.temp 'History'],'dir')
mkdir([me.paths.temp 'History']);
end
me.paths.historypath=[me.paths.temp 'History'];
if ~exist([me.paths.home filesep 'MatlabFiles' filesep 'SavedData'],'dir')
mkdir([me.paths.home filesep 'MatlabFiles' filesep 'SavedData']);
end
me.paths.savedData = [me.paths.home filesep 'MatlabFiles' filesep 'SavedData'];
elseif ispc
root = me.paths.parent;
me.paths.temp=tempdir;
if ~exist([root 'Protocols'],'dir')
mkdir([root 'Protocols'])
end
me.paths.protocols = [root 'Protocols'];
cd(me.paths.protocols);
me.paths.currentPath = pwd;
if ~exist([root 'Calibration'],'dir')
mkdir([root 'Calibration'])
end
me.paths.calibration = [root 'Calibration'];
if ~exist([root 'History'],'dir')
mkdir([root 'History']);
end
me.paths.historypath=[root 'History'];
if ~exist([root 'SavedData'],'dir')
mkdir([root 'SavedData']);
end
me.paths.savedData = [root 'SavedData'];
end
me.h = opticka_ui(me); %our GUI file
WaitSecs(3)
me.loadPrefs();
me.getScreenVals();
me.getTaskVals();
me.loadCalibration();
me.refreshProtocolsList();
OKTobiiUpdate(me.h);
%addlistener(me.r,'abortRun',@me.abortRunEvent);
%addlistener(me.r,'endAllRuns',@me.endRunEvent);
%addlistener(me.r,'runInfo',@me.runInfoEvent);
if exist([me.paths.protocols filesep 'DefaultStateInfo.m'],'file')
me.paths.stateInfoFile = [me.paths.protocols filesep 'DefaultStateInfo.m'];
me.r.stateInfoFile = me.paths.stateInfoFile;
elseif ~isdeployed
me.paths.stateInfoFile = [me.paths.whereami filesep 'DefaultStateInfo.m'];
me.r.stateInfoFile = me.paths.stateInfoFile;
end
me.r.researcherName = me.h.OKTrainingResearcherName.Value;
me.r.subjectName = me.h.OKTrainingName.Value;
getStateInfo(me);
pause(0.1);
if ~isempty(me.ss); delete(me.ss); me.ss = []; end
catch ME
try close(me.h.OKRoot); me.h = []; end %#ok<*TRYNC>
warning('Problem initialising Opticka UI, please check errors on the commandline!');
rethrow(ME);
end
end
% ===================================================================
%> @brief getScreenVals
%> Gets the settings from the UI and updates our runExperiment object
%> @param
% ===================================================================
function getScreenVals(me)
if isempty(me.r)
if ~isdeployed || ~ismcc
olds = me.h.OKOptickaVersion.Text;
me.h.OKOptickaVersion.Text = 'Initialising Stimulus and Task objects...';
%drawnow
end
me.r = runExperiment();
initialise(me.r); % set up the runExperiment object
s=cell(me.r.screen.maxScreen+1,1);
for i=0:me.r.screen.maxScreen
s{i+1} = num2str(i);
end
if ~isdeployed || ~ismcc
me.h.OKSelectScreen.Items = s;
me.h.OKSelectScreen.Value = s{end};
clear s;
me.h.OKOptickaVersion.Text = olds;
end
end
me.r.screen.screen = me.gd(me.h.OKSelectScreen);
me.r.screen.distance = me.gd(me.h.OKMonitorDistance);
me.r.screen.pixelsPerCm = me.gd(me.h.OKpixelsPerCm);
me.r.screen.screenXOffset = me.gd(me.h.OKscreenXOffset);
me.r.screen.screenYOffset = me.gd(me.h.OKscreenYOffset);
me.r.screen.srcMode = me.gv(me.h.OKGLSrc);
me.r.screen.dstMode = me.gv(me.h.OKGLDst);
me.r.screen.bitDepth = me.gv(me.h.OKbitDepth);
me.r.screen.blend = me.gv(me.h.OKOpenGLBlending);
value = me.gp(me.h.OKUseGamma);
if isprop(me.r.screen,'gammaTable') && isa(me.r.screen.gammaTable,'calibrateLuminance') && ~isempty(me.r.screen.gammaTable)
me.r.screen.gammaTable.choice = value - 1;
end
s=str2num(me.gv(me.h.OKWindowSize)); %#ok<ST2NM>
if isempty(s)
me.r.screen.windowed = false;
else
me.r.screen.windowed = s;
end
me.r.logFrames = logical(me.gv(me.h.OKlogFrames));
me.r.benchmark = logical(me.gv(me.h.OKbenchmark));
me.r.screen.hideFlash = logical(me.gv(me.h.OKHideFlash));
me.r.screen.useRetina = logical(me.gv(me.h.OKUseRetina));
me.r.dummyMode = logical(me.gv(me.h.OKUseDummy));
if strcmpi(me.r.screen.bitDepth,'8bit')
me.h.OKAntiAliasing.Value = '0';
end
me.r.screen.antiAlias = me.gd(me.h.OKAntiAliasing);
me.r.screen.photoDiode = logical(me.gv(me.h.OKUsePhotoDiode));
me.r.screen.movieSettings.record = logical(me.gv(me.h.OKrecordMovie));
me.r.verbose = logical(me.gv(me.h.OKVerbose)); %set method
me.verbose = me.r.verbose;
me.r.screen.debug = logical(me.gv(me.h.OKDebug));
me.r.debug = me.r.screen.debug;
me.r.screen.visualDebug = me.r.screen.debug;
me.r.screen.backgroundColour = me.gn(me.h.OKbackgroundColour);
%deprecated me.r.screen.nativeBeamPosition = logical(me.gv(me.h.OKNativeBeamPosition));
if me.h.OKuseLabJackStrobe.Checked == true
me.r.useLabJackStrobe = true;
me.r.useLabJackTStrobe = false;
else
me.r.useLabJackStrobe = false;
end
if me.h.OKuseLabJackTStrobe.Checked == true
me.r.useLabJackTStrobe = true;
me.r.useLabJackStrobe = false;
else
me.r.useLabJackTStrobe = false;
end
if me.h.OKuseDataPixx.Checked == true
me.r.useDataPixx = true;
else
me.r.useDataPixx = false;
end
if me.h.OKuseDisplayPP.Checked == true
me.r.useDisplayPP = true;
%me.r.dPPMode = get(me.h.OKdPPMode,'Value');
else
me.r.useDisplayPP = false;
end
if me.h.OKuseArduino.Checked == true
me.r.useArduino = true;
me.r.arduinoPort = me.gv(me.h.OKarduinoPort);
else
me.r.useArduino = false;
end
if me.h.OKuseLabJackReward.Checked == true
me.r.useLabJackReward = true;
else
me.r.useLabJackReward = false;
end
if me.h.OKuseEyelink.Checked == true
me.r.useEyeLink = true;
me.r.useTobii = false;
me.h.OKuseTobii.Checked = false;
else
me.r.useEyeLink = false;
end
if me.h.OKuseTobii.Checked == true
me.r.useTobii = true;
me.r.useEyeLink = false;
e.h.OKuseEyelink.Checked = false;
else
me.r.useTobii = false;
end
if me.h.OKuseEyeOccluder.Enable == true && me.h.OKuseEyeOccluder.Checked == true
me.r.useEyeOccluder = true;
else
me.r.useEyeOccluder = false;
end
end
% ===================================================================
%> @brief getTaskVals
%> Gets the settings from the UI and updates our task object
%> @param randomise do we run randomiseTask()? [default=FALSE]
% ===================================================================
function getTaskVals(me, randomise)
if ~exist('randomise','var'); randomise = true; end
if isempty(me.r.task)
me.r.task = taskSequence;
me.r.task.initialise;
end
if isfield(me.r.screenVals,'fps')
me.r.task.fps = me.r.screenVals.fps;
end
me.r.task.trialTime = me.gd(me.h.OKtrialTime);
me.r.task.randomSeed = me.gn(me.h.OKRandomSeed);
me.r.task.randomGenerator = me.gs(me.h.OKrandomGenerator);
me.r.task.ibTime = me.gn(me.h.OKibTime);
me.r.task.randomise = logical(me.gv(me.h.OKRandomise));
me.r.task.isTime = me.gn(me.h.OKisTime);
me.r.task.nBlocks = me.gd(me.h.OKnBlocks);
me.r.task.realTime = logical(me.gv(me.h.OKrealTime));
if ~isempty(me.r.task.blockVar)
me.r.task.blockVar.values = me.ge(me.h.OKBlockValues);
me.r.task.blockVar.probability = me.gn(me.h.OKBlockProbability);
if length(me.r.task.blockVar.values) ~= length(me.r.task.blockVar.probability)
randomise = false;
end
end
if ~isempty(me.r.task.trialVar)
me.r.task.trialVar.values = me.ge(me.h.OKTrialValues);
me.r.task.trialVar.probability = me.gn(me.h.OKTrialProbability);
if length(me.r.task.trialVar.values) ~= length(me.r.task.trialVar.probability)
randomise = false;
end
end
if isempty(me.r.task.taskStream); me.r.task.initialiseGenerator; end
if randomise; me.r.task.randomiseTask; end
end
% ===================================================================
%> @brief getStateInfo Load the training state info file into the UI
%>
%> @param
% ===================================================================
function getStateInfo(me)
if ~isempty(me.r.paths.stateInfoFile) && ischar(me.r.paths.stateInfoFile)
if ~exist(me.r.paths.stateInfoFile,'file')
if ~isempty(regexpi(me.r.paths.stateInfoFile,'^\w:\\')) %is it a windows path?
f = split(me.r.paths.stateInfoFile,'\');
f = f{end};
else
[~,f,e] = fileparts(me.r.paths.stateInfoFile);
f = [f e];
end
me.r.paths.stateInfoFile = [pwd filesep f];
end
if exist(me.r.paths.stateInfoFile,'file')
fid = fopen(me.r.paths.stateInfoFile);
tline = fgetl(fid);
i=1;
while ischar(tline)
o.store.statetext{i} = tline;
tline = fgetl(fid);
i=i+1;
end
fclose(fid);
set(me.h.OKTrainingText,'Value',o.store.statetext);
set(me.h.OKTrainingFileName,'Text',['FileName:' me.r.paths.stateInfoFile]);
else
set(me.h.OKTrainingText,'Value','');
set(me.h.OKTrainingFileName,'Text','No File Specified...');
end
end
end
% ===================================================================
%> @brief clearStimulusList
%> Erase any stimuli in the list.
%> @param
% ===================================================================
function clearStimulusList(me)
if ~isempty(me.r)
if isempty(me.r.stimuli)
me.r.stimuli = metaStimulus();
end
end
fn = fieldnames(me.store);
for i = 1:length(fn)
if isa(me.store.(fn{i}),'baseStimulus')
try closePanel(me.store.(fn{i})); end
try me.store = rmfield(me.store, fn{i}); end
end
end
ch = get(me.h.OKPanelStimulus,'Children');
for i = 1:length(ch)
if strcmpi(get(ch(i),'Type'),'uipanel')
delete(ch(i));
end
end
me.h.OKStimList.Items = {}; me.h.OKStimList.Value = {};
end
% ===================================================================
%> @brief getScreenVals
%> Gets the settings from th UI and updates our runExperiment object
%> @param
% ===================================================================
function clearVariableList(me)
if ~isempty(me.r)
if ~isempty(me.r.task) && me.r.task.nVars > 0
me.r.task = taskSequence();
end
end
refreshVariableList(me);
end
% ===================================================================
%> @brief addStimulus
%> Run when we've added a new stimulus
%> @param
% ===================================================================
function addStimulus(me)
me.refreshStimulusList;
nidx = me.r.stimuli.n;
me.h.OKStimList.Value = me.h.OKStimList.Items{end};
if isfield(me.store,'evnt') %delete our previous event
delete(me.store.evnt);
me.store = rmfield(me.store,'evnt');
end
me.store.evnt = addlistener(me.r.stimuli{nidx},'readPanelUpdate',@me.readPanel);
if isfield(me.store,'visibleStimulus')
if ~strcmp(me.r.stimuli{nidx}.uuid,me.store.visibleStimulus.uuid) || ~me.store.visibleStimulus.isGUI
me.store.visibleStimulus.closePanel();
makePanel(me.r.stimuli{nidx},me.h.OKPanelStimulus);
me.store.visibleStimulus = me.r.stimuli{nidx};
else
me.store.visibleStimulus.showPanel;
end
else
makePanel(me.r.stimuli{nidx},me.h.OKPanelStimulus);
me.store.visibleStimulus = me.r.stimuli{nidx};
end
end
% ===================================================================
%> @brief deleteStimulus
%>
%> @param
% ===================================================================
function deleteStimulus(me)
if ~isempty(me.r.stimuli.n) && me.r.stimuli.n > 0
v=me.gp(me.h.OKStimList);
if isfield(me.store,'visibleStimulus')
if strcmp(me.store.visibleStimulus.uuid,me.r.stimuli{v}.uuid)
closePanel(me.r.stimuli{v});
me.store.visibleStimulus = [];
end
end
me.r.stimuli(v) = [];
if me.r.stimuli.n > 0
v = v - 1;
if v == 0; v = 1; end
me.h.OKStimList.Value = me.h.OKStimList.Items{v};
me.store.visibleStimulus = me.r.stimuli{v};
if ~isempty(me.store.visibleStimulus) && ~me.store.visibleStimulus.isGUI
makePanel(me.r.stimuli{v},me.h.OKPanelStimulus);
me.store.visibleStimulus = me.r.stimuli{v};
else
me.store.visibleStimulus.showPanel;
end
end
me.refreshStimulusList;
end
end
% ===================================================================
%> @brief readPanel
%>
%> @param
% ===================================================================
function readPanel(me,src,varargin)
me.salutation('readPanel',['Triggered by: ' src.fullName],true);
me.refreshStimulusList;
end
% ===================================================================
%> @brief editStimulus
%> Gets the settings from the UI and updates our runExperiment object
%> @param
% ===================================================================
function editStimulus(me)
if me.r.stimuli.n > 0
skip = false;
if ~isfield(me.store,'visibleStimulus') || ~isa(me.store.visibleStimulus,'baseStimulus')
v = 1;
me.store.visibleStimulus = me.r.stimuli{1};
else
v = me.gp(me.h.OKStimList);
if isempty(v) || v==0;v=1;end
if strcmpi(me.r.stimuli{v}.uuid,me.store.visibleStimulus.uuid)
skip = true;
end
end
if v <= me.r.stimuli.n && ~skip
if isfield(me.store,'evnt')
delete(me.store.evnt);
me.store = rmfield(me.store,'evnt');
end
if me.r.stimuli{v}.isGUI
hidePanel(me.store.visibleStimulus);
showPanel(me.r.stimuli{v});
else
hidePanel(me.store.visibleStimulus);
makePanel(me.r.stimuli{v},me.h.OKPanelStimulus);
end
me.store.evnt = addlistener(me.r.stimuli{v},'readPanelUpdate',@me.readPanel);
me.store.visibleStimulus = me.r.stimuli{v};
me.refreshStimulusList;
end
end
end
% ===================================================================
%> @brief modifyStimulus
%> Gets the settings from th UI and updates our runExperiment object
%> @param
% ===================================================================
function modifyStimulus(me)
me.refreshStimulusList;
end
% ===================================================================
%> @brief addVariable
%> Gets the settings from th UI and updates our runExperiment object
%> @param
% ===================================================================
function addVariable(me)
validate(me.r.task);
revertN = me.r.task.nVars;
try
me.r.task.nVar(revertN+1).name = me.gs(me.h.OKVariableName);
s = me.gs(me.h.OKVariableValues);
if isempty(regexpi(s,'^\{'))
me.r.task.nVar(revertN+1).values = str2num(s);
else
me.r.task.nVar(revertN+1).values = eval(s);
end
me.r.task.nVar(revertN+1).stimulus = me.gn(me.h.OKVariableStimuli);
offset = eval(['{' me.h.OKVariableOffset.Value '}']);
if isempty(offset) || (iscell(offset) && isempty(offset{1}))
me.r.task.nVar(revertN+1).offsetstimulus = [];
me.r.task.nVar(revertN+1).offsetvalue = [];
else
me.r.task.nVar(revertN+1).offsetstimulus = offset{1};
me.r.task.nVar(revertN+1).offsetvalue = offset{2};
end
try
me.r.task.randomiseTask;
validate(me.r.task);
catch
warndlg('There is a problem with the stimulus variables, please check!')
end
me.refreshVariableList;
catch ME
getReport(ME)
rethrow(ME);
end
end
% ===================================================================
%> @brief updateVariable
%> Gets the values from the UI and updates that var
%> @param
% ===================================================================
function updateVariable(me)
try
pos = me.gp(me.h.OKVarList);
if isempty(pos) || pos == 0; return; end
me.r.task.nVar(pos).name = me.gs(me.h.OKVariableName);
s = me.gs(me.h.OKVariableValues);
if isempty(regexpi(s,'^\{', 'once'))
me.r.task.nVar(pos).values = str2num(s);
else
me.r.task.nVar(pos).values = eval(s);
end
me.r.task.nVar(pos).stimulus = me.gn(me.h.OKVariableStimuli);
offset = eval(['{' me.h.OKVariableOffset.Value '}']);
if isempty(offset) || (iscell(offset) && isempty(offset{1}))
me.r.task.nVar(pos).offsetstimulus = [];
me.r.task.nVar(pos).offsetvalue = [];
else
me.r.task.nVar(pos).offsetstimulus = offset{1};
me.r.task.nVar(pos).offsetvalue = offset{2};
end
try
me.r.task.randomiseTask;
validate(me.r.task);
catch
warndlg('There is a problem with the stimulus variables, please check!')
end
me.refreshVariableList;
catch ME
getReport(ME);
rethrow(ME);
end
end
% ===================================================================
%> @brief editVariable
%> Gets the settings from the UI and updates our runExperiment object
%> @param
% ===================================================================
function editVariable(me)
if isobject(me.r.task) && me.r.task.nVars > 0
pos = me.gp(me.h.OKVarList);
me.h.OKVariableName.Value = me.r.task.nVar(pos).name;
v=me.r.task.nVar(pos).values;
if iscell(v)
v = me.cellAsString(v);
else
v = num2str(me.r.task.nVar(pos).values);
end
str = v;
str = regexprep(str,'\s+',' ');
me.h.OKVariableValues.Value = str;
str = num2str(me.r.task.nVar(pos).stimulus);
str = regexprep(str,'\s+',' ');
me.h.OKVariableStimuli.Value = str;
if isnumeric(me.r.task.nVar(pos).offsetvalue)
str=[num2str(me.r.task.nVar(pos).offsetstimulus) '; ' num2str(me.r.task.nVar(pos).offsetvalue)];
else
str=[num2str(me.r.task.nVar(pos).offsetstimulus) '; ''' me.r.task.nVar(pos).offsetvalue ''''];
end
me.h.OKVariableOffset.Value = str;
end
end
% ===================================================================
%> @brief deleteVariable
%> Gets the settings from the UI and updates our runExperiment object
%> @param
% ===================================================================
function deleteVariable(me)
if isobject(me.r.task)
nV = me.r.task.nVar;
pos = me.gp(me.h.OKVarList);
if isempty(pos) || pos < 1; return; end
if pos <= me.r.task.nVars
nV(pos)=[];
me.r.task.nVar = [];
me.r.task.nVar = nV;
if me.r.task.nVars > 0
me.r.task.randomiseTask;
end
end
me.refreshVariableList;
end
end
% ===================================================================
%> @brief copyVariable
%> Gets the settings from the UI and updates our runExperiment object
%> @param
% ===================================================================
function copyVariable(me)
if isobject(me.r.task)
val = me.gv(me.h.OKVarList);
me.r.task.nVar(end+1)=me.r.task.nVar(val);
me.refreshVariableList;
end
end
% ===================================================================
%> @brief Load calibration file, better that this is manual...
%>
% ===================================================================
function loadCalibration(me)
d = dir(me.paths.calibration);
for i = 1:length(d)
if isempty(regexp(d(i).name,'^\.+', 'once')) && d(i).isdir == false && d(i).bytes > 0
ftime(i) = d(i).datenum;
else
ftime(i) = 0;
end
end
if max(ftime) > 0
[~,idx]=max(ftime);
disp(['===>>> Opticka has found a potential calibration file: ' [me.paths.calibration filesep d(idx).name]]);
%tmp = load([me.paths.calibration filesep d(idx).name]);
%if isstruct(tmp)
% fn = fieldnames(tmp);
% tmp = tmp.(fn{1});
%end
%if isa(tmp,'calibrateLuminance')
% tmp.filename = [me.paths.calibration filesep d(idx).name];
% if isa(me.r,'runExperiment') && isa(me.r.screen,'screenManager')
% me.r.screen.gammaTable = tmp;
% me.h.OKUseGamma.Items =[ {'None'}; {'Gamma'}; me.r.screen.gammaTable.analysisMethods{:}']';
% me.r.screen.gammaTable.choice = 2;
% end
%end
end
end
% ===================================================================
%> @brief
%>
% ===================================================================
function saveCalibration(me)
if isa(me.r.screen.gammaTable,'calibrateLuminance')
saveThis = true;
tmp = me.r.screen.gammaTable;
d = dir(me.paths.calibration);
for i = 1:length(d)
if isempty(regexp(d(i).name,'^\.+', 'once')) && d(i).isdir == false && d(i).bytes > 0
if strcmp(d(i).name, tmp.filename)
saveThis = false;
end
end
end
if saveThis == true
save([me.paths.calibration filesep 'calibration-' date],'tmp');
end
end
end
% ===================================================================
%> @brief loadPrefs Load prefs better left local to the machine
%>
% ===================================================================
function loadPrefs(me)
anyLoaded = false; prefnames = '';
if ~ispref('opticka'); return; end
for i = 1:length(me.uiPrefsList)
prfname = me.uiPrefsList{i};
if ispref('opticka',prfname) %pref exists
if isprop(me.h, prfname) %ui widget exists
myhandle = me.h.(prfname);
prf = getpref('opticka',prfname);
uiType = myhandle.Type;
thisVal = '';
switch uiType
case 'uieditfield'
if ischar(prf)
myhandle.Value = prf;
thisVal = prf;
else
myhandle.Value = num2str(prf);
thisVal = myhandle.Value;
end
case 'uicheckbox'
if islogical(prf) || isnumeric(prf)
myhandle.Value = prf;
thisVal = num2str(prf);
end
case 'uidropdown'
str = myhandle.Items;
if ischar(prf) && any(contains(prf,str))
myhandle.Value = prf;
thisVal = prf;
end
end
prefnames = [prefnames ' ' prfname '«' thisVal '»'];
if ~anyLoaded; anyLoaded = true; end
end
end
end
if anyLoaded; fprintf('\n===>>> Opticka loaded its local preferences: %s \n',prefnames); end
end
% ===================================================================
%> @brief savePrefs Save prefs better left local to the machine
%>
% ===================================================================
function savePrefs(me)
if ispref('opticka'); rmpref('opticka'); end
anySaved = false; prefnames = '';
for i = 1:length(me.uiPrefsList)
prfname = me.uiPrefsList{i};
if ~isprop(me.h,prfname); continue; end
myhandle = me.h.(prfname);
uiType = myhandle.Type;
switch uiType
case 'uieditfield'
prf = myhandle.Value;
setpref('opticka', prfname, prf);
case 'uicheckbox'
prf = myhandle.Value;
if ~islogical(prf); prf=logical(prf);end
setpref('opticka', prfname, prf);
case 'uidropdown'
prf = myhandle.Value;
setpref('opticka', prfname, prf);
end
prefnames = [prefnames ' ' prfname '«' num2str(prf) '»'];
if ~anySaved; anySaved = true; end
end
if anySaved; fprintf('\n===>>> Opticka saved its local preferences: %s\n', prefnames); end
end
end
%========================================================
methods ( Access = private ) %----------PRIVATE METHODS
%========================================================
% ===================================================================
%> @brief Delete Protocol
%> Delete Protocol
%> @param
% ===================================================================
function deleteProtocol(me)
v = me.gv(me.h.OKProtocolsList);
file = me.gs(me.h.OKProtocolsList,v);
me.paths.currentPath = pwd;
cd(me.paths.protocols);
out=questdlg(['Are you sure you want to delete ' file '?'],'Protocol Delete');
if strcmpi(out,'yes')
delete(file);
end