filters/@sir/props.txt

   1 Help on properties of the SIR particle filter.\r
   2 \r
   3 'model'\r
   4 Model object. If no model is assigned, the object is considered empty\r
   5 and can't be used for filtering.\r
   6 \r
   7 't'\r
   8 Current time.\r
   9 Will be used as the time of the next filtering step, if nothing else is\r
  10 specified in the call to the filter method. See 'help ekf/filter' for more\r
  11 information.\r
  12 \r
  13 'Ts'\r
  14 Sample points of the last filter operation. This is a column vector.\r
  15 Ts(k) contains the time at step k.\r
  16 \r
  17 'xhat'\r
  18 Estimate of x, generated by the last filter operation.\r
  19 xhat(i,k) contains the estimate of state i at step k.\r
  20 \r
  21 'xpred'\r
  22 One-step prediction of x, generated by the last filter operation.\r
  23 xpred(i,k) contains the prediction of state i at step k.\r
  24 \r
  25 'u'\r
  26 Deterministic data used in the last filter operation, where u(:,k) is\r
  27 the data used at step k.\r
  28 \r
  29 'y'\r
  30 Input data that was used in the last filter operation, where y(:,k) is\r
  31 the data used at step k.\r
  32 \r
  33 'N'\r
  34 Number of particles to use in the filter algorithm.\r
  35 \r
  36 'xhat_particles'\r
  37 The particles used to generate xhat(:,end).\r
  38 \r
  39 'xpred_particles'\r
  40 The particles used to generate xpred(:,end).\r
  41 \r
  42 'historysize'\r
  43 Size of the history buffer.\r
  44 The default, historysize=0 means that no history buffers will be created,\r
  45 and historysize=-1 creates buffers of unlimited size.\r
  46 History buffers are turned off by default to gain performance.\r
  47 \r
  48 'xhat_history'\r
  49 History of xhat.\r
  50 \r
  51 'xpred_history'\r
  52 History of xpred.\r
  53 \r
  54 'y_history'\r
  55 History of y.\r
  56 \r
  57 'u_history'\r
  58 History of u.\r
  59 \r
  60 'Ts_history'\r
  61 History of Ts.\r