Complete Parameters test; parameters deals with strings better; added test for repelems

k1o0 · k1o0 · commit ad16e6f302c9 · 2019-03-12T21:37:48.000+02:00
diff --git a/+exp/Parameters.m b/+exp/Parameters.m
@@ -81,6 +81,17 @@ function set(obj, name, value, description, units)
     end
     
     function str = title(obj, name)
+      % TITLE Turns param struct field name into title for UI label
+      %  Input name must be a fieldname in Struct or cell array thereof.
+      %  The returned str is the fieldname with a space inserted between
+      %  upper case letters, and the first letter capitalized.  If units
+      %  field is present, the unit is added to the string in brackets
+      %
+      %  Example:
+      %    obj.title('numRepeats') % returns 'Num repeats'
+      %    obj.title({'numRepeats', 'rewardVolume'}) 
+      %    % returns {'Num repeats', 'Reward volume (ul)'}
+      % See also INDIVTITLE
       if iscell(name)
         str = mapToCell(@obj.indivTitle, name);
       else
@@ -126,7 +137,7 @@ function makeTrialSpecific(obj, name)
       n = numTrialConditions(obj); % Number of trial conditions (table rows)
       if n < 1; n = 2; end % If there are none, let's add two conditions
       % Repeat value accross all trial conditions
-      if isnumeric(currValue) || islogical(currValue)
+      if isnumeric(currValue) || islogical(currValue) || isstring(currValue)
         newValue = repmat(currValue, 1, n);
       else
         newValue = repmat({currValue}, 1, n);
@@ -167,7 +178,7 @@ function makeGlobal(obj, name, newValue)
     end
     
     function [globalParams, trialParams] = assortForExperiment(obj)
-      % divide into global and trial-specific parameter structures
+      % Divide into global and trial-specific parameter structures
 
       %% group trial-specific parameters into a struct with length of parameters
       % the second dimension (number of columns) specifies parameters for
@@ -219,6 +230,9 @@ function makeGlobal(obj, name, newValue)
     end
 
     function [ctrl, label] = ui(obj, name, parent)
+      % FIXME method not used at all(?)
+      % Seems to reuse code put into indivTitle method
+      % Doesn't return uicontrols if units aren't '�' or 's'
       ctrl = [];
       label = [];
       unitField = [name 'Units'];
diff --git a/cb-tools/burgbox/repelems.m b/cb-tools/burgbox/repelems.m
@@ -4,6 +4,8 @@
 %   specified by the corresponding element of 'n'. e.g.
 %     REPELEMS([0 1 2], [2 1 3]) % returns [0 0 1 2 2 2]
 %
+% See also exp.Parameters/toConditionServer
+%
 % Part of Burgbox
 
 % 2013-06 CB created
diff --git a/tests/ParamEditorTest.m b/tests/ParamEditorTest.m
@@ -14,44 +14,40 @@
   end
   
   methods (TestClassSetup)
-    function killFigures(testCase)
+    function setup(testCase)
+      % Hide figures and add teardown function to restore settings
       testCase.FigureVisibleDefault = get(0,'DefaultFigureVisible');
 %       set(0,'DefaultFigureVisible','off');
-    end
-    
-    function loadData(testCase)
+      testCase.addTearDown(@set, 0, 'DefaultFigureVisible', testCase.FigureVisibleDefault);
+      testCase.addTearDown(@close, testCase.Figure);
+      
       % Loads validation data
       %  Graph data is a cell array where each element is the graph number
       %  (1:3) and within each element is a cell of X- and Y- axis values
       %  respecively
-%       load('data/parameters.mat', 'parameters')
       testCase.Parameters = exp.choiceWorldParams;
-    end
-    
-    function setupEditor(testCase)
+      
       % Check paths file
       assert(endsWith(which('dat.paths'), fullfile('tests','+dat','paths.m')));
       % Create stand-alone panel
+      testCase.startMeasuring();
       testCase.ParamEditor = eui.ParamEditor;
+      testCase.stopMeasuring();
       testCase.Figure = gcf();
       testCase.fatalAssertTrue(isa(testCase.ParamEditor, 'eui.ParamEditor'))
     end
+    
   end
-  
-  methods (TestClassTeardown)
-    function restoreFigures(testCase)
-      set(0,'DefaultFigureVisible',testCase.FigureVisibleDefault);
-      close(testCase.Figure)
-    end
-  end
-  
+    
   methods (TestMethodSetup)
     function buildParams(testCase)
       % Re-build the parameters before each test so that changes in
       % previous test don't persist
       PE = testCase.ParamEditor;
       pars = exp.Parameters(testCase.Parameters);
+      testCase.startMeasuring();
       PE.buildUI(pars);
+      testCase.stopMeasuring();
       % Number of global parameters: find all text labels
       nGlobalLabels = numel(findobj(testCase.Figure, 'Style', 'text'));
       nGlobalInput = numel(findobj(testCase.Figure, 'Style', 'checkbox', '-or', 'Style', 'edit'));
@@ -87,8 +83,10 @@ function test_makeConditional(testCase)
       % Set the focused object to one of the parameter labels
       set(testCase.Figure, 'CurrentObject', ...
         findobj(testCase.Figure, 'String', 'rewardVolume'))
+      testCase.startMeasuring();
       testCase.verifyWarningFree(c.MenuSelectedFcn, ...
         'Problem making parameter conditional');
+      testCase.stopMeasuring();
       % Verify change in UI elements
       testCase.verifyTrue(numel(gLabels()) == nGlobalLabels-1, ...
         'Global parameter UI element not removed')
diff --git a/tests/ParametersTest.m b/tests/ParametersTest.m
@@ -3,6 +3,7 @@
   properties
     % Parameters object
     Parameters
+    nConditional = 6
   end
   
   properties %(MethodSetupParameter)
@@ -13,78 +14,226 @@
   methods (TestClassSetup)
     
     function loadData(testCase)
-      % Loads validation data
-      %  Graph data is a cell array where each element is the graph number
-      %  (1:3) and within each element is a cell of X- and Y- axis values
-      %  respecively
-%       load('data/parameters.mat', 'parameters')
-      testCase.ParamStruct = exp.choiceWorldParams;
+      % Sets a test parameter structure
+      % testCase.ParamStruct = exp.choiceWorldParams;
+      n = testCase.nConditional;
+      testCase.ParamStruct = struct(...
+        'numRepeats', repmat(100,1,n),...
+        'numRepeatsUnits', '#',...
+        'numRepeatsDescription', 'No. of repeats of each condition',...
+        'charParam', 'test',...
+        'charParamUnits', 'normalised',...
+        'charParamDescription', 'test char array parameter',...
+        'strParam', "testStr",...
+        'arrayParam', magic(n),...
+        'arrayParamUnits', 'mW',...
+        'logicalArrayParam', true(1,n),...
+        'logicalParam', false,...
+        'logicalParamUnits', 'logical',...
+        'doubleParam', 3,...
+        'functionParam', @(pars,rig)exp.configureChoiceExperiment(exp.ChoiceWorld,pars,rig));
     end
     
     function setupClass(testCase)
       % Check paths file
       assert(endsWith(which('dat.paths'), fullfile('tests','+dat','paths.m')));
       % Create stand-alone panel
+      testCase.startMeasuring('gen_empty_obj');
       testCase.Parameters = exp.Parameters();
-      testCase.fatalAssertTrue(isa(testCase.ParamEditor, 'exp.Parameters'))
+      testCase.stopMeasuring('gen_empty_obj');
+      testCase.fatalAssertTrue(isa(testCase.Parameters, 'exp.Parameters'))
     end
   end
     
   methods (TestMethodSetup)
     function buildParams(testCase)
-      % Re-build the parameters before each test so that changes in
+      % Re-load the param structure before each test so that changes in
       % previous test don't persist
-      PE = testCase.ParamEditor;
-      pars = exp.Parameters(testCase.Parameters);
-      PE.buildUI(pars);
-      % Number of global parameters: find all text labels
-      nGlobalLabels = numel(findobj(testCase.Figure, 'Style', 'text'));
-      nGlobalInput = numel(findobj(testCase.Figure, 'Style', 'checkbox', '-or', 'Style', 'edit'));
-      % Find Condition Table
-      conditionTable = findobj(testCase.Figure, '-property', 'ColumnName');
-      % Ensure all global params have UI input and label
-      testCase.fatalAssertTrue(nGlobalLabels == numel(PE.Parameters.GlobalNames))
-      testCase.fatalAssertTrue(nGlobalInput == numel(PE.Parameters.GlobalNames))
-      % Ensure all conditional params have column in table
-      testCase.fatalAssertTrue(isequal(size(conditionTable.Data), ...
-        [PE.Parameters.numTrialConditions, numel(PE.Parameters.TrialSpecificNames)]))
+      testCase.startMeasuring('setStruct');
+      testCase.Parameters.Struct = testCase.ParamStruct;
+      testCase.stopMeasuring('setStruct');
+      testCase.fatalAssertTrue(length(testCase.Parameters.TrialSpecificNames) == 3)
+      testCase.fatalAssertTrue(length(testCase.Parameters.GlobalNames) == 5)
+      testCase.fatalAssertTrue(length(testCase.Parameters.Names) == 8)
     end
   end
   
   methods (Test)
     
     function test_isTrialSpecific(testCase)
+      p = testCase.Parameters;
+      % Verfy that array with n columns > 1 is trial specific
+      testCase.verifyTrue(p.isTrialSpecific('numRepeats'))
+      % Verify that array with n columns == 1 is not trial specific
+      testCase.verifyTrue(~p.isTrialSpecific('doubleParam'))
+      testCase.verifyTrue(~p.isTrialSpecific('charParam'))
     end
     
     function test_numTrialConditions(testCase)
+      p = testCase.Parameters;
+      testCase.verifyTrue(p.numTrialConditions == testCase.nConditional)
+      testCase.verifyTrue(p.numTrialConditions == size(p.Struct.numRepeats,2))
     end
     
     function test_title(testCase)
+      p = testCase.Parameters;
+      % Test single param title
+      testCase.verifyEqual(p.title('numRepeats'), 'Num repeats')
+      % Test array of param titles, including those with units
+      testCase.startMeasuring('title');
+      str = p.title({'numRepeats', 'charParam', 'arrayParam', 'logicalParam'});
+      testCase.stopMeasuring('title');
+      expected = {'Num repeats', 'Char param', 'Array param (mW)', 'Logical param'};
+      testCase.verifyTrue(isequal(str, expected))
     end
     
     function test_assortForExperiment(testCase)
+      p = testCase.Parameters;
+      testCase.startMeasuring('assort');
+      [globalParams, trialParams] = testCase.verifyWarningFree(@()p.assortForExperiment);
+      testCase.stopMeasuring('assort');
+      testCase.verifyTrue(isstruct(globalParams))
+      testCase.verifyTrue(isequal(fieldnames(globalParams), p.GlobalNames))
+      testCase.verifyTrue(isequal(size(trialParams), [1 testCase.nConditional]))
+      testCase.verifyTrue(isequal(fieldnames(trialParams), p.TrialSpecificNames))
     end
     
     function test_makeGlobal(testCase)
+      p = testCase.Parameters;
+      testCase.startMeasuring('makeGlobal');
+      p.makeGlobal('numRepeats')
+      testCase.stopMeasuring('makeGlobal');
+      testCase.verifyTrue(~p.isTrialSpecific('numRepeats'))
+      testCase.verifyTrue(numel(p.Struct.numRepeats)==1)
+      p.makeGlobal('arrayParam')
+      expected = magic(testCase.nConditional);
+      expected = expected(:,1);
+      testCase.verifyTrue(isequal(p.Struct.arrayParam, expected))
+      p.makeGlobal('logicalArrayParam', false)
+      testCase.verifyEqual(p.Struct.logicalArrayParam, false)
+      try
+        p.makeGlobal('numRepeats')
+      catch ex
+        testCase.verifyEqual(ex.message, '''numRepeats'' is already global')
+      end
     end
     
     function test_removeConditions(testCase)
+      p = testCase.Parameters;
+      testCase.startMeasuring('removeConditions');
+      p.removeConditions([2,4,6]);
+      testCase.stopMeasuring('removeConditions');
+      % Expected result for arrayParam
+      expected = magic(testCase.nConditional);
+      expected = expected(:,[1,3,5]);
+      
+      testCase.verifyTrue(p.numTrialConditions == 3)
+      testCase.verifyTrue(isequal(p.Struct.arrayParam, expected))
     end
     
     function test_description(testCase)
+      p = testCase.Parameters;
+      testCase.verifyEqual(p.description('numRepeats'), 'No. of repeats of each condition')
+      testCase.verifyTrue(isempty(p.description('arrayParam')))
+      testCase.verifyTrue(numel(p.description({'numRepeats', 'charParam'}))==2)
     end
     
     function test_toConditionServer(testCase)
+      % Test behaviour when numRepeats is conditional
+      p = testCase.Parameters;
+      testCase.startMeasuring('toConditionServer');
+      [cs, globalParams, trialParams] = p.toConditionServer;
+      testCase.stopMeasuring('toConditionServer');
+      testCase.verifyTrue(isa(cs, 'exp.PresetConditionServer'))
+      testCase.verifyTrue(isstruct(globalParams))
+      testCase.verifyTrue(isequal(fieldnames(globalParams), p.GlobalNames))
+      testCase.verifyTrue(isequal(size(trialParams), [1 sum(p.Struct.numRepeats)]))
+      % Verify randomised
+      noneRandom = magic(testCase.nConditional);
+      noneRandom = [repmat(noneRandom(:,1),1,p.Struct.numRepeats(1)) ...
+        repmat(noneRandom(:,2),1,p.Struct.numRepeats(2))];
+      result = [trialParams.arrayParam];
+      testCase.verifyTrue(~isequal(result(:,1:size(noneRandom,2)), noneRandom), ...
+        'Trial conditions likely not randomised by default')
+      % Verify that numRepeats was removed
+      testCase.verifyTrue(strcmp('numRepeats', setdiff(p.TrialSpecificNames,fieldnames(trialParams))))
+      
+      % Test behaviour when numRepeats is global
+      p.makeGlobal('numRepeats', 20)
+      [~, globalParams, trialParams] = p.toConditionServer;
+      testCase.verifyTrue(isequal(size(trialParams), [1 20*testCase.nConditional]))
+      testCase.verifyTrue(strcmp('numRepeats', setdiff(p.GlobalNames,fieldnames(globalParams))))
+
+      % Test behaviour when randomiseConditions is set
+      p.set('randomiseConditions', false, ...
+        'Flag for whether to randomise trial conditions', 'logical')
+      [~, ~, trialParams] = p.toConditionServer;
+      result = [trialParams.arrayParam];
+      noneRandom = repmat(magic(testCase.nConditional), 1, 20);
+      testCase.verifyTrue(isequal(result, noneRandom), ...
+        'Trial conditions randomised')
+      % Test param overide
+      [~, ~, trialParams] = p.toConditionServer(true);
+      result = [trialParams.arrayParam];
+      testCase.verifyTrue(~isequal(result, noneRandom), ...
+        'Expected trial conditions to be randomised')
     end
     
     function test_makeTrialSpecific(testCase)
+      p = testCase.Parameters;
+      % Test making simply numerical param trial specific
+      testCase.startMeasuring('makeTrialSpecific');
+      p.makeTrialSpecific('doubleParam')
+      testCase.stopMeasuring('makeTrialSpecific');
+      testCase.verifyTrue(p.isTrialSpecific('doubleParam'))
+      testCase.verifyTrue(isequal(p.Struct.doubleParam, repmat(3,1,testCase.nConditional)))
+      testCase.verifyTrue(ismember('doubleParam', p.TrialSpecificNames))
+      % Test making char array trial specific
+      p.makeTrialSpecific('charParam')
+      testCase.verifyTrue(p.isTrialSpecific('charParam'))
+      testCase.verifyEqual(numel(p.Struct.charParam), testCase.nConditional)
+      testCase.verifyTrue(iscell(p.Struct.charParam))
+      % Test making string trial specific
+      p.makeTrialSpecific('strParam')
+      testCase.verifyTrue(p.isTrialSpecific('strParam'))
+      testCase.verifyTrue(isequal(size(p.Struct.strParam), [1 6]))
+      testCase.verifyTrue(isstring(p.Struct.strParam))
+      try
+        p.makeTrialSpecific('numRepeats')
+      catch ex
+        testCase.verifyEqual(ex.message, '''numRepeats'' is already trial-specific')
+      end
     end
     
     function test_set(testCase)
+      p = testCase.Parameters;
+      % Test setting simple param with units and description
+      testCase.startMeasuring('setPar');
+      p.set('randomiseConditions', true, ...
+        'Flag for whether to randomise trial conditions', 'logical')
+      testCase.stopMeasuring('setPar');
+      testCase.verifyTrue(ismember('randomiseConditions', p.GlobalNames))
+      testCase.verifyTrue(p.Struct.randomiseConditions == true)
+      testCase.verifyTrue(isfield(p.Struct, 'randomiseConditionsDescription'))
+      testCase.verifyTrue(isfield(p.Struct, 'randomiseConditionsUnits'))
+      
+      % Test setting a conditional parameter
+      p.set('conditionPar', eye(testCase.nConditional))
+      testCase.verifyTrue(ismember('conditionPar', p.TrialSpecificNames))
+      testCase.verifyTrue(isfield(p.Struct, 'conditionParDescription') ...
+        && isempty(p.Struct.conditionParDescription))
+      testCase.verifyTrue(~isfield(p.Struct, 'conditionParUnits'))
+      
+      % Test setting various arrays
+      p.set('globalPar', true(testCase.nConditional, 1))
+      testCase.verifyTrue(ismember('globalPar', p.GlobalNames))
+      p.set('globalPar', false(1, testCase.nConditional+1))
+      testCase.verifyTrue(ismember('globalPar', p.TrialSpecificNames))
     end
     
-    function test_ui(testCase)
-    end
+%     function test_ui(testCase)
+%       p = testCase.Parameters;
+%     end
     
   end
   
diff --git a/tests/repelems_test.m b/tests/repelems_test.m

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,8 @@`
`4`	`4`	`% specified by the corresponding element of 'n'. e.g.`
`5`	`5`	`% REPELEMS([0 1 2], [2 1 3]) % returns [0 0 1 2 2 2]`
`6`	`6`	`%`
	`7`	`+% See also exp.Parameters/toConditionServer`
	`8`	`+%`
`7`	`9`	`% Part of Burgbox`
`8`	`10`
`9`	`11`	`% 2013-06 CB created`