The SUMO toolbox  2018a
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Pages
Functions
guiPlotModelErrors.m File Reference

Functions

function guiPlotModelErrors (var model, var outputIndex, var validation, var options, var parentHandle)
 Plot a model's error stats for a single output and print or return a summary. More...
 

Detailed Description

Authors
SUMO Lab Team
Version
2018a
Date
Copyright 2006-2018

This file is part of the Surrogate Modeling Toolbox ("SUMO Toolbox") and you can redistribute it and/or modify it under the terms of the GNU Affero General Public License version 3 as published by the Free Software Foundation. With the additional provision that a commercial license must be purchased if the SUMO Toolbox is used, modified, or extended in a commercial setting. For details see the included LICENSE.txt file. When referring to the SUMO Toolbox please make reference to the corresponding publication:

Contact : sumo@.nosp@m.sumo.nosp@m..inte.nosp@m.c.ug.nosp@m.ent.b.nosp@m.e - http://sumo.intec.ugent.be Signature [fighandle options trainingStats validationStats] = guiPlotModelErrors(model, outputIndex, validation, options, parentHandle)

Function Documentation

function guiPlotModelErrors ( var  model,
var  outputIndex,
var  validation,
var  options,
var  parentHandle 
)

Plot a model's error stats for a single output and print or return a summary.

If the summaries aren't requested as return values, they will be printed on standard output. All parameters except the model are optional. The options provided are not required to be complete, they will be merged with the defaults.

Parameters
modelthe model to get the stats for
outputIndexindex of the output dimension to show
validationvalidation function or matrix (may be empty)
optionsoptions for plotting and validation
parentHandlehandles of figure or panels to plot in
Return values
fighandlehandle of the figure were the errors were plotted
optionsplot and validation options, defaults if not specified
trainingStatscell array of strings with training stats summary
validationStatscell array of strings with validation stats summary

Examples:

  • guiPlotModelErrors(model, 1) * Show errors of a model's first output.
  • [dummy1 dummy2 trainingStats] = guiPlotModelErrors(model, 2, [], struct, panelHandle)
  • Show errors of a model's second output in a predefined panel and return the summary instead of printing it. Use the default options.
  • [dummy options] = guiPlotModelErrors * Get the default options.