Accelerating the pace of engineering and science

# simOptions

Option set for sim

## Syntax

opt = simOptions
opt = simOptions(Name,Value)

## Description

opt = simOptions creates the default options set for sim.

opt = simOptions(Name,Value) creates an option set with the options specified by one or more Name,Value pair arguments.

## Input Arguments

### Name-Value Pair Arguments

Specify optional comma-separated pairs of Name,Value arguments. Name is the argument name and Value is the corresponding value. Name must appear inside single quotes (' '). You can specify several name and value pair arguments in any order as Name1,Value1,...,NameN,ValueN.

 'InitialCondition' Specify initial conditions. InitialCondition must be one of the following: 'z' — Zero initial conditions.x0 — Numerical column vector denoting initial states. For multi-experiment data, use a matrix with Ne columns, where Ne is the number of experiments. Use this option for state-space models (idss and idgrey) only.io — Structure with the following fields:InputOutputUse the Input and Output fields to specify the history for a time interval that starts before the start time of the data used by compare. In case the data used by compare is a time-series model, specify Input as []. Use a row vector to denote a constant signal value. The number of columns in Input and Output must always equal the number of input and output channels, respectively. For multi-experiment data, specify io as a structure array of Ne elements, where Ne is the number of experiments. Default: 'z', except for idnlgrey models where the initial conditions stored internally in the model are used. 'InputOffset' Input signal offset. Specify as a column vector of length Nu, where Nu is the number of inputs. Use [] to indicate no offset. For multiexperiment data, specify InputOffset as a Nu-by-Ne matrix. Nu is the number of inputs, and Ne is the number of experiments. Each entry specified by InputOffset is subtracted from the corresponding input data before the input is used to simulate the model. Default: [] 'OutputOffset' Output signal offset. Specify as a column vector of length Ny, where Ny is the number of outputs. Use [] to indicate no offset. For multi-experiment data, specify OutputOffset as a Ny-by-Ne matrix. Ny is the number of outputs, and Ne is the number of experiments. Each entry specified by OutputOffset is added to the corresponding simulated response of the model. Default: [] 'AddNoise' Specify whether noise should be added to the response model or not. Default: false 'NoiseData' Noise signal data. Specify the noise signal, e, for the model $y\left(t\right)=Gu\left(t\right)+He\left(t\right)$ Where G is the transfer function from the input, u(t), to the output, y(t). NoiseData is used for simulation only when AddNoise is true. NoiseData takes one of the following: Matrix — Ns-by-Ny matrix, where Ns is the number of input data samples, and Ny is the number of outputs. Each entry of this matrix is added to the corresponding output data point. Before addition, the noise is scaled according to the NoiseVariance property of the identified model used in simsd.To obtain the right noise level, specify NoiseData as white noise with zero mean and unit covariance.Cell array — For multiexperiment data, specify NoiseData as a cell array of Ne matrices. Ne is the number of experiments.[] — Gaussian noise is automatically specified as NoiseData. Default: []

## Output Arguments

 opt Option set containing the specified options for sim.

## Examples

expand all

### Create Default Options Set for Model Simulation

`opt = simOptions;`

### Specify Options for Model Simulation

Create an options set for sim using zero initial conditions, and set the input offset to 5.

`opt = simOptions('InitialCondition','z','InputOffset',5);`

Alternatively, use dot notation to set the values of opt.

```opt = simOptions;
opt.InitialCondition = 'z';
opt.InputOffset = 5;```