implemented a sanity check, to avoid failure of plotting routines if number or name of parameters or properties is not set

Author: paulstapor

plotConfidenceIntervals.m

@@ -88,6 +88,10 @@
         pIndexSet = allOptions.parameter_index;
     end
 end
+
+% Check, if pStruct has all necessary fieds
+pStruct = checkSanityOfStructs(pStruct, ['p' type(2:end)]);
+
 numP = length(pIndexSet);
 iMAP = allOptions.MAP_index;
 if isempty(iMAP)

plotMCMCdiagnosis.m

@@ -30,6 +30,10 @@
 % * 2016/10/10 Daniel Weindl
 
 %% Check and assign inputs
+
+% Check, if parameters has all necessary fieds
+parameters = checkSanityOfStructs(parameters, 'parameters');
+
 % Plot type
 type = 'parameters';
 if nargin >= 2 && ~isempty(varargin{1})

plotMultiStarts.m

@@ -28,6 +28,10 @@
 % * 2016/10/07 Daniel Weindl
 
 %% CHECK AND ASSIGN INPUTS
+
+% Check, if parameters has all necessary fieds
+parameters = checkSanityOfStructs(parameters, 'parameters');
+
 % Open figure
 if length(varargin) >= 1 && ~isempty(varargin{1}) && isvalid(varargin{1})
     fh = figure(varargin{1});

plotParameterUncertainty.m

@@ -58,6 +58,9 @@
     end
 end
 
+% Check, if parameters has all necessary fieds
+parameters = checkSanityOfStructs(parameters, 'parameters');
+
 % Open figure
 if length(varargin) >= 2 && ~isempty(varargin{2})
     fh = figure(varargin{2});

plotPropertyMultiStarts.m

@@ -28,6 +28,9 @@
     fh = figure('Name','plotPropertyMultiStarts');
 end
 
+% Check, if properties has all necessary fieds
+properties = checkSanityOfStructs(properties, 'properties');
+
 % Options
 if length(varargin) >= 2
     options = handlePlottingOptionArgument(varargin{2});

plotPropertyUncertainty.m

@@ -36,6 +36,9 @@
     end
 end
 
+% Check, if properties has all necessary fieds
+properties = checkSanityOfStructs(properties, 'properties');
+
 % Open figure
 if length(varargin) >= 2 && ~isempty(varargin{2})
     fh = figure(varargin{2});

private/checkSanityOfStructs.m

@@ -0,0 +1,64 @@
+function pStruct = checkSanityOfStructs(pStruct, type)
+% checkSanityOfStructs.m checks if the necessary fields of the parameters
+% or the properties struct are set. If necessary fields are missing but can
+% unambiguously, this will be done. Otherwise, an error will be displayed.
+%
+% USAGE:
+% pStruct = checkSanityOfStructs(pStruct, type)
+%
+% Parameters:
+%   pStruct: parameters or properties struct.
+%   type: string, either 'parameters' or 'properties'
+%
+% Return values:
+%   pSturct: struct containing informations about the parameters or the
+%       properties
+%
+% History:
+% * 2017/05/21 Paul Stapor
+
+
+
+    % See which struct should be checked
+    if ~(strcmp(type, 'parameters') || strcmp(type, 'properties'))
+        error('The given type of struct is invalid. Only parameters and properties and be checked by this function.');
+    else
+        if strcmp(type, 'parameters')
+            short_type = 'par';
+        else
+            short_type = 'prop';
+        end
+    end
+
+    % The least necessary information are lower and upper bounds for parameters
+    if ~isfield(pStruct, 'min')
+        error(['The struct ' type ' has no lower bounds provided.']);
+    end
+    if ~isfield(pStruct, 'max')
+        error(['The struct ' type ' has no upper bounds provided.']);
+    end
+
+    % Upper and lower bounds need to have the same length
+    if ~all(size(pStruct.min) == size(pStruct.max))
+        error(['The vectors for the lower and upper bounds of' type ' do not have the same size.']); 
+    end
+
+    % The number of pStruct needs to be set accordingly
+    if ~isfield(pStruct, 'number')
+        pStruct.number = length(pStruct.min);
+    else
+        if (length(pStruct.min) ~= pStruct.number)
+            warning(['The size of struct ' type ' was set incorrectly in ' type '.number. This was corrected.']);
+        end
+    end
+
+    % The names of the parameters have to be set correctly
+    if ~isfield(pStruct, 'name')
+        pStruct.name = arrayfun(@(x) [short_type num2str(x)], 1:pStruct.number, 'UniformOutput', false);
+    else
+        if (length(pStruct.name) ~= pStruct.number)
+            error(['The names for the struct ' type ' did not have the correct length. Either provide them with correct length or leave ' type '.name empty.']);
+        end
+    end
+
+end