function obj = forecastOptions(varargin)
%FORECASTOPTIONS  Creates option set for the FORECAST command.
%
%   InitialCondition    Handling of initial conditions for forecasting.
%                 Initial conditions refer to the conditions at the first
%                 time instant of the observed data. One of the following:
%                 'z': Zero initial conditions.
%                 'e': Estimate initial conditions such that the prediction
%                      error for the observed output over its time span is
%                      as small as possible. Default.
%               X0Obj: A specification object created using the "idpar"
%                      command. For discrete-time state-space models only
%                      (idss, idgrey, idnlgrey). Use X0Obj to impose
%                      constraints on the value of initial states X0, such
%                      as fixing certain entries or imposing min/max
%                      bounds.
%
%   InputOffset   Input signal offset level present in both PASTDATA and
%                 FUTUREINPUTS arguments of the FORECAST command. Specify
%                 as an Nu-element column vector, where Nu is the number of
%                 inputs. When using multi-experiment PASTDATA, specify as
%                 Nu-by-Ne matrix, where Ne is the number of experiments.
%                 The offset value InputOffset(i,j) is subtracted from the
%                 i:th input signal of the j:th experiment in PASTDATA and
%                 FUTUREINPUTS. Default is [] which implies no offsets. 
%
%   OutputOffset  Output signal offset level present in both PASTDATA and
%                 the YF arguments of the FORECAST command. Specify as an
%                 Ny-element column vector, where Ny is the number of
%                 outputs. When using multi-experiment PASTDATA, specify as
%                 Ny-by-Ne matrix, where Ne is the number of experiments.
%                 The offset value OutputOffset(i,j) is subtracted from the
%                 i:th output signal of the j:th experiment in PASTDATA.
%                 The offset is then added to the forecasted response of
%                 the model with detrended data.
%                 Default is [] which implies no offsets. 
%
%   InputInterSample  Intersample behavior of the input signals, which
%                     influences the estimation, simulation and prediction
%                     of continuous-time models. Specify as 'auto' (default),
%                     'zoh','foh','bl'.
%
% See also FORECAST, IDPAR.

%   Author(s): Rajiv Singh
%   Copyright 2011-2020 The MathWorks, Inc.

try
   obj = initOptions(idoptions.predict('forecast'),varargin);
catch E
   throw(E);
end
