MATLAB Examples

Access Estimation Report

This example shows how to access the estimation report.

The estimation report keeps a log of information such as the data used, default and other settings used, and estimated results such as parameter values, initial conditions, and fit.

After you estimate a model, use dot notation to access the estimation report. For example:

load iddata1 z1;
np = 2;
sys = tfest(z1,np);
sys_report = sys.Report
sys_report = 

              Status: 'Estimated using TFEST'
              Method: 'TFEST'
          InitMethod: 'IV'
            N4Weight: 'Not applicable'
           N4Horizon: 'Not applicable'
    InitialCondition: 'estimate'
                 Fit: [1x1 struct]
          Parameters: [1x1 struct]
         OptionsUsed: [1x1 idoptions.tfest]
           RandState: []
            DataUsed: [1x1 struct]
         Termination: [1x1 struct]

Explore the options used during the estimation.

sys.Report.OptionsUsed
Option set for the tfest command:

          InitMethod: 'iv'
          InitOption: [1x1 struct]
    InitialCondition: 'auto'
             Display: 'off'
         InputOffset: []
        OutputOffset: []
            EstCovar: 1
      Regularization: [1x1 struct]
        SearchMethod: 'auto'
        SearchOption: [1x1 idoptions.search.identsolver]
     WeightingFilter: []
    EnforceStability: 0
        OutputWeight: []
            Advanced: [1x1 struct]

View the fit of the transfer function model with the estimation data.

sys.Report.Fit
ans = 

  struct with fields:

    FitPercent: 70.7720
       LossFcn: 1.6575
           MSE: 1.6575
           FPE: 1.7252
           AIC: 1.0150e+03
          AICc: 1.0153e+03
          nAIC: 0.5453
           BIC: 1.0372e+03