refactor defaults setting

Author: Remi-Gau

src/defaultCFG.m

@@ -1,9 +1,9 @@
-function cfg = setDefaultsPTB(cfg)
+function cfg = checkDefaultsPTB(cfg)
     % Set some defaults values if none have been set before.
     %
     % USAGE::
     %
-    %   cfg = setDefaultsPTB(cfg)
+    %   cfg = checkDefaultsPTB(cfg)
     %
     % :param cfg:
     % :type cfg: structure
@@ -16,7 +16,7 @@
         cfg = struct;
     end
 
-    fieldsToSet = defaultCFG();
+    fieldsToSet = cppPtbDefaults('all');
 
     if isfield(cfg, 'audio') && cfg.audio.do
 
@@ -47,24 +47,16 @@
     end
 
     if isfield(cfg, 'eyeTracker') && cfg.eyeTracker.do
-
         % Calibration environment
-        fieldsToSet.eyeTracker.defaultCalibration = true;
-        fieldsToSet.eyeTracker.backgroundColor = [192 192 192];
-        fieldsToSet.eyeTracker.fontColor = [0 0 0];
-        fieldsToSet.eyeTracker.calibrationTargetColor = [0 0 0];
-        fieldsToSet.eyeTracker.calibrationTargetSize = 1;
-        fieldsToSet.eyeTracker.calibrationTargetWidth = 0.5;
-        fieldsToSet.eyeTracker.displayCalResults = 1;
-
+        fieldsToSet.eyeTracker = cppPtbDefaults('eyeTracker');
     end
 
     if isfield(cfg, 'testingDevice') && strcmpi(cfg.testingDevice, 'mri')
         fieldsToSet.bids.mri.RepetitionTime = [];
         fieldsToSet.pacedByTriggers.do = false;
     end
 
-    cfg = setDefaults(cfg, fieldsToSet);
+    cfg = setDefaultFields(cfg, fieldsToSet);
 
     %% checks
     if cfg.debug.do
@@ -77,6 +69,10 @@
     elseif cfg.skipSyncTests == true
         cfg.skipSyncTests = 1;
     end
+    
+    if ~ismember(cfg.fixation.type, {'cross', 'dot', 'bestFixation'})
+      error('cfg.fixation.type must be one of ''cross'', ''dot'', ''bestFixation''');
+    end
 
     % sort fields alphabetically
     cfg = orderfields(cfg);

src/utils/setDefaultsPTB.m renamed to src/defaults/checkDefaultsPTB.m

@@ -0,0 +1,66 @@
+function value = cppPtbDefaults(type)
+  %
+  % USAGE::
+  %
+  %   value = cppPtbDefaults(type)
+  %
+  % (C) Copyright 2022 CPP_PTB developers
+  
+  value = [];
+  
+  switch lower(type)
+    
+    case 'all'
+      value =  struct('testingDevice', 'pc', ...
+        'color',  struct('background', [0 0 0]), ...
+        'skipSyncTests', 0);
+      
+      value.aperture.type = 'none';
+      
+      value.debug = cppPtbDefaults('debug');
+      value.text = cppPtbDefaults('text');
+      value.screen = cppPtbDefaults('screen');
+      value.fixation = cppPtbDefaults('fixation');
+      value.keyboard = cppPtbDefaults('keyboard');
+      
+    case 'debug'
+      value.do = true;
+      value.transpWin = true;
+      value.smallWin = true;
+      
+    case 'keyboard'
+      value.keyboard = [];
+      value.responseBox = [];
+      value.responseKey = {};
+      value.escapeKey = 'ESCAPE';
+      
+    case 'text'
+      value.font = 'Courier New';
+      value.size = 18;
+      value.style = 1;
+      
+    case 'fixation'
+      value.type = 'cross';
+      value.xDisplacement = 0;
+      value.yDisplacement = 0;
+      value.color = [255 255 255];
+      value.width = 1;
+      value.lineWidthPix = 5;
+      
+    case 'screen'
+      value.monitorWidth = 42;
+      value.monitorDistance = 134;
+      value.resolution = {[], [], []};
+      
+    case 'eyetracker'
+      value.defaultCalibration = true;
+      value.backgroundColor = [192 192 192];
+      value.fontColor = [0 0 0];
+      value.calibrationTargetColor = [0 0 0];
+      value.calibrationTargetSize = 1;
+      value.calibrationTargetWidth = 0.5;
+      value.displayCalResults = 1;
+      
+  end
+  
+end

src/defaults/cppPtbDefaults.m

@@ -1,10 +1,10 @@
-function structure = setDefaults(structure, fieldsToSet)
+function structure = setDefaultFields(structure, fieldsToSet)
     %
     % Recursively loop through the fields of a structure and sets a value if they don't exist.
     %
     % USAGE::
     %
-    %   structure = setDefaults(structure, fieldsToSet)
+    %   structure = setDefaultFields(structure, fieldsToSet)
     %
     % :param structure:
     % :type structure: structure
@@ -27,7 +27,7 @@
         if isfield(structure, names{i}) && isstruct(structure.(names{i}))
 
             structure.(names{i}) = ...
-                setDefaults( ...
+                setDefaultFields( ...
                             structure.(names{i}), ...
                             fieldsToSet.(names{i}) ...
                            );

src/utils/setDefaults.m renamed to src/defaults/setDefaultFields.m

@@ -11,10 +11,10 @@
 function test_setDefaultsPtb_basic()
 
     % set up
-    cfg = setDefaultsPTB;
+    cfg = checkDefaultsPTB();
 
     % test data
-    expectedCfg = defaultCFG();
+    expectedCfg = cppPtbDefaults('all');
     expectedCfg.eyeTracker.do = false;
     expectedCfg.skipSyncTests = 2;
 
@@ -26,10 +26,10 @@ function test_setDefaultsPtb_basic()
 function test_setDefaultsPtb_no_debug()
 
     % set up
-    cfg = setDefaultsPTB;
+    cfg = checkDefaultsPTB();
 
     % test data
-    expectedCfg = defaultCFG();
+    expectedCfg = cppPtbDefaults('all');
     expectedCfg.eyeTracker.do = false;
     expectedCfg.skipSyncTests = 2;
 
@@ -42,10 +42,10 @@ function test_setDefaultsPtb_overwrite()
 
     % set up
     cfg.screen.monitorWidth = 36;
-    cfg = setDefaultsPTB(cfg);
+    cfg = checkDefaultsPTB(cfg);
 
     % test data
-    expectedCfg = defaultCFG();
+    expectedCfg = cppPtbDefaults('all');
     expectedCfg.screen.monitorWidth = 36;
     expectedCfg.eyeTracker.do = false;
     expectedCfg.skipSyncTests = 2;
@@ -59,10 +59,10 @@ function test_setDefaultsPtb_audio()
 
     % set up
     cfg.audio.do = 1;
-    cfg = setDefaultsPTB(cfg);
+    cfg = checkDefaultsPTB(cfg);
 
     % test data
-    expectedCfg = defaultCFG();
+    expectedCfg = cppPtbDefaults('all');
     expectedCfg.audio = struct('do', true, ...
                                'devIdx', [], ...
                                'playbackMode', 1, ...
@@ -92,10 +92,10 @@ function test_setDefaultsPtb_mri()
 
     % set up
     cfg.testingDevice = 'mri';
-    cfg = setDefaultsPTB(cfg);
+    cfg = checkDefaultsPTB(cfg);
 
     % test data
-    expectedCfg = defaultCFG();
+    expectedCfg = cppPtbDefaults('all');
     expectedCfg.testingDevice = 'mri';
     expectedCfg.bids.mri.RepetitionTime = [];
     expectedCfg.pacedByTriggers.do = false;