Merge pull request #108 from Remi-Gau/update_config_FOV

[DOC] Update for a non centered field of view

Author: Remi-Gau

cfgMST.m

@@ -12,4 +12,33 @@
     % on macs is 0.3
     cfg.timing.eventDuration = 0.6; % 0.6 seconds
 
+    %% variable FOV info
+    % in case the field of view is not properly centered or obstructed
+    %
+    % see https://github.com/cpp-lln-lab/estimate_visual_FOV.git
+    %
+    % set up configuration: ensure that the following fields are the same
+    % as when you ran the estimate_visual_FOV script
+    %
+    % cfg.testingDevice
+    % cfg.screen.monitorDistance
+    % cfg.screen.monitorWidth
+
+    % fixation cross displacement in degrees of visual angles
+    % this will also shift the whole FOV relative to the center of the screen
+    % Note: negative values will move things to the left and up.
+    cfg.fixation.xDisplacement = 0;
+    cfg.fixation.yDisplacement = 0;
+
+    % determines position of the fixation cross on the right / left
+    % should be a bit less than the: ( width of FOV ) / 2
+    cfg.design.xDisplacementFixation = 3;
+
+    % determines position of the dots on the left /
+    % should be a bit less than the: ( width of FOV ) / 2
+    cfg.design.xDisplacementAperture = 7;
+
+    % determines the width of the dot circle
+    cfg.aperture.width = 7;
+
 end

cfgMT.m

@@ -4,7 +4,7 @@
 
     cfg.design.localizer = 'MT';
 
-    cfg.pacedByTriggers.do = true;
+    cfg.pacedByTriggers.do = false;
 
     cfg.timing.triggerIBI = 4;
 
@@ -18,4 +18,23 @@
     % in mcas is 0.43
     cfg.timing.eventDuration = 0.79; % .86 second
 
+    %% variable FOV info
+    % in case the field of view is not properly centered or obstructed
+    %
+    % see https://github.com/cpp-lln-lab/estimate_visual_FOV.git
+    %
+    % set up configuration: ensure that the following fields are the same
+    % as when you ran the estimate_visual_FOV script
+    %
+    % cfg.testingDevice
+    % cfg.screen.monitorDistance
+    % cfg.screen.monitorWidth
+
+    % fixation cross displacement in degrees of visual angles
+    % this will also shift the whole FOV relative to the center of the screen
+    % Note: negative values will move things to the left and up.
+
+    cfg.fixation.xDisplacement = 0;
+    cfg.fixation.yDisplacement = 0;
+
 end

lib/CPP_PTB

@@ -13,8 +13,8 @@
 
 cfg.verbose = 1;
 
-cfg.debug.do = false;
-cfg.debug.transpWin = false;
+cfg.debug.do = true;
+cfg.debug.transpWin = true;
 cfg.debug.smallWin = false;
 
 cfg.audio.devIdx = 5;
@@ -24,10 +24,10 @@
 cfg.dot.speed = 7.5;
 
 %% Run MT+ localizer
-cfg = cfgMT(cfg);
+% cfg = cfgMT(cfg);
 
 %% Run MT/MST localizer
-% cfg = cfgMST(cfg);
+cfg = cfgMST(cfg);
 
 cfg = checkParameters(cfg);
 

main.m

@@ -177,7 +177,7 @@
 
             fieldsToSet.aperture.type = 'circle';
             fieldsToSet.aperture.width = 7; % if left empty it will take the screen height
-            fieldsToSet.aperture.xPos = fieldsToSet.design.xDisplacementAperture;
+            fieldsToSet.aperture.xPos = 0;
 
         case 'mt'
 

subfun/defaults/checkParameters.m

@@ -10,4 +10,17 @@
 
     cfg = postInitDots(cfg);
 
+    % TODO transfer those if blocks into 'degToPix' (and similarly into pixToDeg)
+    % TODO this kind of generic post initialization can be done systematically at end of initPTB
+    if isfield(cfg.fixation, 'xDisplacement')
+        cfg.fixation = degToPix('xDisplacement', cfg.fixation, cfg);
+    end
+    if isfield(cfg.fixation, 'yDisplacement')
+        cfg.fixation = degToPix('yDisplacement', cfg.fixation, cfg);
+    end
+
+    if isfield(cfg.design, 'xDisplacementAperture')
+        cfg.design = degToPix('xDisplacementAperture', cfg.design, cfg);
+    end
+
 end

subfun/postInitializationSetup.m

@@ -34,26 +34,47 @@
 
         thisEvent.fixationPosition = cfg.design.blockFixationPosition{iBlock};
 
+        % This is necessary because where the dot aperture is drawn is set in cfg
+        % So we "reset" that pixel value from the value in degrees
+        cfg.aperture.xPos = cfg.design.xDisplacementAperture;
+        cfg.aperture = degToPix('xPos', cfg.aperture, cfg);
+
         switch thisEvent.fixationPosition
 
             case 'fixation_right'
                 cfg.aperture.xPosPix = -abs(cfg.aperture.xPosPix);
-
-                thisEvent.dotCenterXPosPix = cfg.aperture.xPosPix;
-
                 thisFixation.fixation.xDisplacement = cfg.design.xDisplacementFixation;
-                thisFixation = initFixation(thisFixation);
 
             case 'fixation_left'
                 cfg.aperture.xPosPix = +abs(cfg.aperture.xPosPix);
+                thisFixation.fixation.xDisplacement = -cfg.design.xDisplacementFixation;
 
-                thisEvent.dotCenterXPosPix = cfg.aperture.xPosPix;
+            otherwise
 
-                thisFixation.fixation.xDisplacement = -cfg.design.xDisplacementFixation;
-                thisFixation = initFixation(thisFixation);
+                error('WTF');
+
+        end
 
+        if isfield(cfg.fixation, 'xDisplacementPix')
+            cfg.aperture.xPosPix = cfg.aperture.xPosPix + cfg.fixation.xDisplacementPix;
+            thisFixation.fixation.xDisplacement = thisFixation.fixation.xDisplacement + ...
+              cfg.fixation.xDisplacement;
         end
 
+        if isfield(cfg.fixation, 'yDisplacementPix')
+            cfg.aperture.yPosPix = cfg.fixation.yDisplacementPix;
+            thisEvent.dotCenterYPosPix = cfg.aperture.yPosPix;
+        end
+
+        thisEvent.dotCenterXPosPix = cfg.aperture.xPosPix;
+
+        if isfield(cfg.fixation, 'yDisplacementPix')
+        end
+
+        thisFixation.fixation.allCoords;
+
+        thisFixation = initFixation(thisFixation);
+
     end
 
     varargout = {thisEvent, thisFixation, cfg};

subfun/preTrialSetup.m

@@ -112,8 +112,8 @@ function test_checkParameters_MT()
     cfg = removeDirFieldForGithubAction(cfg);
 
     % uncomment for update default config .mat
-    %     expected = cfg;
-    %     save(fullfile(fileparts(mfilename('fullpath')), 'data', 'config_MT.mat'), 'expected');
+    %       expected = cfg;
+    %       save(fullfile(fileparts(mfilename('fullpath')), 'data', 'config_MT.mat'), 'expected');
     load(fullfile(fileparts(mfilename('fullpath')), 'data', 'config_MT.mat'), 'expected');
 
     % test
@@ -132,8 +132,8 @@ function test_checkParameters_MT_MST()
     cfg = removeDirFieldForGithubAction(cfg);
 
     % uncomment for update default config .mat
-    %     expected = cfg;
-    %     save(fullfile(fileparts(mfilename('fullpath')), 'data', 'config_MT_MST.mat'), 'expected');
+    % expected = cfg;
+    % save(fullfile(fileparts(mfilename('fullpath')), 'data', 'config_MT_MST.mat'), 'expected');
     load(fullfile(fileparts(mfilename('fullpath')), 'data', 'config_MT_MST.mat'), 'expected');
 
     % test