ParamSweep2D.m

Go to the documentation of this file.

/* (Autoinserted by mtoc++)
 * This source code has been filtered by the mtoc++ executable,
 * which generates code that can be processed by the doxygen documentation tool.
 *
 * On the other hand, it can neither be interpreted by MATLAB, nor can it be compiled with a C++ compiler.
 * Except for the comments, the function bodies of your M-file functions are untouched.
 * Consequently, the FILTER_SOURCE_FILES doxygen switch (default in our Doxyfile.template) will produce
 * attached source files that are highly readable by humans.
 *
 * Additionally, links in the doxygen generated documentation to the source code of functions and class members refer to
 * the correct locations in the source code browser.
 * However, the line numbers most likely do not correspond to the line numbers in the original MATLAB source files.
 */

function [h , Y , E ] = ParamSweep2D(rmodel,mu,inputidx,matrix<integer> params,rowvec<double> range1,rowvec<double> range2,handle ax) {


/*  Validity checks  */
[pname[1:2]] = rmodel.System.Params(params).Name;
if size(range1,2) == 0 || size(range2,2) == 0
    error(" Parameter ranges to sweep must be given. ");
end
if nargin < 7
    h = figure;
    ax = gca(h);
end

p = 0;
[MU1, MU2] = meshgrid(range1,range2);

pi = ProcessIndicator(" Starting parameter sweep for '%s' and '%s' (%d runs)...  ",numel(MU1),false,...
    pname[1],pname[2],numel(MU1));

mu(params(1)) = range1(1);
mu(params(2)) = range2(1);
[~, y] = rmodel.simulate(mu, inputidx);
if size(y,1) > 1
    error(" PlotParamSweep only applicable for onedimensional system output. ");
end

Y = zeros(size(MU1));
Y(1,1) = y(end);
if rmodel.ErrorEstimator.Enabled
    E = zeros(size(MU1));
    E(1,1) = rmodel.ErrorEstimator.OutputError(end);
else
    E = [];
end

/*  Iterate over parameter values */
pi.step;
for idx = 2:numel(MU1)
    mu(params(1)) = MU1(idx);
    mu(params(2)) = MU2(idx);
    [~, y] = rmodel.simulate(mu, inputidx);
    Y(idx) = y(end);

    if rmodel.ErrorEstimator.Enabled
        E(idx) = rmodel.ErrorEstimator.OutputError(end);
    end
    pi.step;
end
pi.stop;

/* % Prepare plot */
tit = sprintf(" Outputs at T=%1.2f for 2D parameter sweep, base \\mu = [%s]\n'%s' (idx:%d) from %1.3f to %1.3f\n'%s' (idx:%d) from %1.3f to %1.3f ",...
    rmodel.T,num2str(mu^t),pname[1],params(1),range1(1),range1(end),pname[2],params(2),range2(1),range2(end));

/* % Upper bound */
if rmodel.ErrorEstimator.Enabled
    obj = surf(ax,MU1,MU2,Y+E," EdgeColor "," none "," FaceColor "," red ");
    alpha(obj,.3);
/*      mesh(T,MU,Y+E,'EdgeColor','none','FaceColor','red'); */
    hold on;
end

/* % y plot */
surf(ax,MU1,MU2,Y," EdgeColor "," none ");
colormap jet;
title(tit); 
xlabel(sprintf(" Parameter %d: %s ",params(1),pname[1]));
ylabel(sprintf(" Parameter %d: %s ",params(2),pname[2]));

/* % Lower bound */
if rmodel.ErrorEstimator.Enabled    
    obj = surf(ax,MU1,MU2,Y-E," EdgeColor "," none "," FaceColor "," red ");
    alpha(obj,.3);
/*      mesh(T,MU,Y-E,'EdgeColor','none','FaceColor','red'); */
    hold off;
end
}