Option set for
the default option set for
opt = residOptions
resid. Use dot notation
to customize the option set, if needed.
Create a default option set for
opt = residOptions;
Specify the maximum lag for residual correlation calculations.
opt.MaxLag = 35;
Create an option set for
resid that specifies initial condition as zero.
opt = residOptions('InitialCondition','z');
comma-separated pairs of
the argument name and
Value is the corresponding value.
Name must appear inside quotes. You can specify several name and value
pair arguments in any order as
'MaxLag'— Maximum positive lag
25(default) | positive integer
Maximum positive lag for residual correlation and impulse response
calculations, specified as the comma-separated pair consisting of
a positive integer.
'InitialCondition'— Handling of initial conditions
'd'| column vector | matrix | structure |
Handling of initial conditions, specified as the comma-separated
pair consisting of
'InitialCondition' and one of
the following values:
'z' — Zero initial conditions.
'e' — Estimate initial conditions
such that the prediction error for observed output is minimized.
For nonlinear grey-box models, only those initial states
are designated as free in the model (
= false) are estimated. To estimate all the states of the
model, first specify all the
Nx states of the
for i = 1:Nx sys.InitialStates(i).Fixed = false; end
Similarly, to fix all the initial states to values specified
sys.InitialStates, first specify all the states
as fixed in the
sys.InitialStates property of the
nonlinear grey-box model.
'd' — Similar to
but absorbs nonzero delays into the model coefficients. The delays
are first converted to explicit model states, and the initial values
of those states are also estimated and returned.
Use this option for linear models only.
Vector or Matrix — Initial guess for state
values, specified as a numerical column vector of length equal to
the number of states. For multi-experiment data, specify a matrix
with Ne columns, where Ne is
the number of experiments. Otherwise, use a column vector to specify
the same initial conditions for all experiments. Use this option for
idgrey) and nonlinear models (
Structure with the following fields, which contain
the historical input and output values for a time interval immediately
before the start time of the data used by
|Input history, specified as a matrix with Nu columns,
where Nu is the number of input channels. For time
series models, use |
|Output history, specified as a matrix with Ny columns, where Ny is the number of output channels. The number of rows must be greater than or equal to the model order.|
For multi-experiment data, configure the initial conditions
separately for each experiment by specifying
a structure array with Ne elements. To specify
the same initial conditions for all experiments, use a single structure.
The software uses
map the historical data to states. If your model is not
idnlarx, the software first converts the model
to its state-space representation and then maps the data to states.
If conversion of your model to
idss is not possible,
the estimated states are returned empty.
x0obj — Specification object
idpar. Use this
object for discrete-time state-space (
and nonlinear grey-box (
idnlgrey) models only.
x0obj to impose constraints on the initial
states by fixing their value or specifying minimum or maximum bounds.
'OutputWeight'— Weight of output for initial condition estimation
Weight of output for initial condition estimation, specified
as the comma-separated pair consisting of
one of the following:
 — No weighting is used.
This option is the same as using
eye(Ny) for the
output weight. Ny is the number of outputs.
'noise' — Inverse of the
noise variance stored with the model.
Matrix of doubles — A positive semidefinite matrix of dimension Ny-by-Ny. Ny is the number of outputs.
opt— Option set for
Option set for
resid, returned as an