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

Functions

function genMovie (var model, var outputIndex, var inputs, var plotOptions, var fighandle, var movieOptions)
 Create a movie by varying over a chosen dimension. 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 [movieOptions plotOptions] = genMovie(model, outputIndex, inputs, plotOptions, fighandle, movieOptions)

Function Documentation

function genMovie ( var  model,
var  outputIndex,
var  inputs,
var  plotOptions,
var  fighandle,
var  movieOptions 
)

Create a movie by varying over a chosen dimension.

Get the default movie options and plot options as a return value by specifying zero parameters. The slices will be saved in a subdirectory 'slices' at the location of the movie. All previously existing png and fig files will be deleted from that directory. The plot and movie options will be merged with the defaults, so you need not specify all fields.

Parameters
modelthe model whereof a movie must be created
outputIndexthe index of the output dimension to plot
inputsinput settings: xIndex, yIndex, zIndex (varies over time), bounds and values
plotOptionsplot options
fighandlehandle of the figure to plot in
movieOptionsmovie options Examples:
  • genMovie(model,2) * Create a movie of the second output.
  • [movieOptions plotOptions] = genMovie * Get the default movie and plot options.