write test for initFixation

Author: Remi-Gau

src/fixation/initFixation.m

@@ -1,39 +1,58 @@
 function cfg = initFixation(cfg)
-
+    % cfg = initFixation(cfg)
+    %
+    % prepare details for fixation "cross"
+    %
+    % the fixation has a width defined by
+    % cfg.fixation.width : in degrees of visual
+    %
+    % The horizontal and vertical offset (in degrees of visual) with respect to the center of the
+    % screen is defined by
+    % cfg.fixation.xDisplacement
+    % cfg.fixation.yDisplacement
+    %
+    % for cfg.fixation.type == 'bestFixation'            
+    % Code adapted from:
+    % "What is the best fixation target?"
+    % DOI 10.1016/j.visres.2012.10.012
+    %
+    
+    
     % Convert some values from degrees to pixels
     cfg.fixation = degToPix('width', cfg.fixation, cfg);
     cfg.fixation = degToPix('xDisplacement', cfg.fixation, cfg);
     cfg.fixation = degToPix('yDisplacement', cfg.fixation, cfg);
-
+    
     % Prepare fixation cross
     xLine = [-cfg.fixation.widthPix cfg.fixation.widthPix 0 0] / 2;
     yLine = [0 0 -cfg.fixation.widthPix cfg.fixation.widthPix] / 2;
-
+    
     cfg.fixation.xCoords =  xLine + cfg.fixation.xDisplacementPix;
     cfg.fixation.yCoords =  yLine + cfg.fixation.yDisplacementPix;
-
+    
     cfg.fixation.allCoords = [cfg.fixation.xCoords; cfg.fixation.yCoords];
-
+    
+    
     switch cfg.fixation.type
-
+        
         case 'bestFixation'
-
+            
             % Code adapted from:
             % What is the best fixation target?
             % DOI 10.1016/j.visres.2012.10.012
-
+            
             cfg.fixation.outerOval = [ ...
                 cfg.screen.center(1) - cfg.fixation.widthPix / 2, ...
                 cfg.screen.center(2) - cfg.fixation.widthPix / 2, ...
                 cfg.screen.center(1) + cfg.fixation.widthPix / 2, ...
                 cfg.screen.center(2) + cfg.fixation.widthPix / 2];
-
+            
             cfg.fixation.innerOval = [ ...
                 cfg.screen.center(1) - cfg.fixation.widthPix / 6, ...
                 cfg.screen.center(2) - cfg.fixation.widthPix / 6, ...
                 cfg.screen.center(1) + cfg.fixation.widthPix / 6, ...
                 cfg.screen.center(2) + cfg.fixation.widthPix / 6];
-
+            
     end
-
+    
 end

src/isOctave.m renamed to src/utils/isOctave.m

@@ -3,6 +3,10 @@ function waitForTrigger(varargin)
     %
     % Counts a certain number of triggers coming from the scanner before returning.
     %
+    % If you are not using the quietMode, it flips and waits for half a TR before starting to 
+    % check for the next trigger (unless this was the last trigger to wait for and in 
+    % this case it returns immediately). 
+    %
     % Will print the count down in the command line and on the PTB window if one is
     % opened.
     %

src/waitForTrigger.m

@@ -0,0 +1,70 @@
+function test_suite = test_initFixation %#ok<*STOUT>
+    try % assignment of 'localfunctions' is necessary in Matlab >= 2016
+        test_functions = localfunctions(); %#ok<*NASGU>
+    catch % no problem; early Matlab versions can use initTestSuite fine
+    end
+    initTestSuite;
+end
+
+function test_initFixationBasic()
+    
+    cfg.screen.ppd = 10;
+    cfg.fixation.type = 'cross';
+    cfg.fixation.width  = 1;
+    cfg.fixation.xDisplacement = 1;
+    cfg.fixation.yDisplacement = 1;
+    
+    cfg = initFixation(cfg);
+    
+    cfg.fixation
+
+    expectedStruct.screen.ppd = 10;
+    expectedStruct.fixation.type = 'cross';
+    expectedStruct.fixation.width = 1;
+    expectedStruct.fixation.xDisplacement = 1;
+    expectedStruct.fixation.yDisplacement = 1;
+    expectedStruct.fixation.widthPix = 10;
+    expectedStruct.fixation.xDisplacementPix = 10;
+    expectedStruct.fixation.yDisplacementPix = 10;
+    expectedStruct.fixation.xCoords = [5 15 10 10];
+    expectedStruct.fixation.yCoords = [10 10 5 15];
+    expectedStruct.fixation.allCoords = [5 15 10 10; 10 10 5 15];
+    
+    assertEqual(expectedStruct, cfg)
+
+     
+end
+
+
+function test_initFixationBestFixation()
+    
+    cfg.screen.ppd = 10;
+    cfg.screen.center = [100 100];
+    cfg.fixation.type = 'bestFixation';
+    cfg.fixation.width  = 1;
+    cfg.fixation.xDisplacement = 1;
+    cfg.fixation.yDisplacement = 1;
+    
+    cfg = initFixation(cfg);
+    
+    cfg.fixation
+
+    expectedStruct.screen.ppd = 10;
+    expectedStruct.screen.center = [100 100];
+    expectedStruct.fixation.type = 'bestFixation';
+    expectedStruct.fixation.width = 1;
+    expectedStruct.fixation.xDisplacement = 1;
+    expectedStruct.fixation.yDisplacement = 1;
+    expectedStruct.fixation.widthPix = 10;
+    expectedStruct.fixation.xDisplacementPix = 10;
+    expectedStruct.fixation.yDisplacementPix = 10;
+    expectedStruct.fixation.xCoords = [5 15 10 10];
+    expectedStruct.fixation.yCoords = [10 10 5 15];
+    expectedStruct.fixation.allCoords = [5 15 10 10; 10 10 5 15];
+    expectedStruct.fixation.outerOval = [95 95 105 105];
+    expectedStruct.fixation.innerOval = [100 - 10 / 6, 100 - 10 / 6, 100 + 10 / 6, 100 + 10 / 6];
+    
+    assertEqual(expectedStruct, cfg)
+
+     
+end