Initial commit
[pftoolbox.git] / filters / @sis / props.txt
blob8d567762404b4bee7a127357b2f3158cf53eb466
1 Help on properties of the SIS 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
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
17 'N'\r
18 Number of particles to use in the filter algorithm.\r
20 'Nth'\r
21 The resampling threshold. Must be a double in the interval 0<=Nth<=N.\r
23 'xhat'\r
24 Estimate of x, generated by the last filter operation.\r
25 xhat(i,k) contains the estimate of state i at step k.\r
27 'xpred'\r
28 One-step prediction of x, generated by the last filter operation.\r
29 xpred(i,k) contains the prediction of state i at step k.\r
31 'u'\r
32 Deterministic data used in the last filter operation, where u(:,k) is\r
33 the data used at step k.\r
35 'y'\r
36 Input data that was used in the last filter operation, where y(:,k) is\r
37 the data used at step k.\r
39 'q'\r
40 The importance weights.\r
42 'xhat_particles'\r
43 The particles used to generate xhat(:,end).\r
45 'xpred_particles'\r
46 The particles used to generate xpred(:,end).\r
48 'historysize'\r
49 Size of the history buffer.\r
50 The default, historysize=0 means that no history buffers will be created,\r
51 and historysize=-1 creates buffers of unlimited size.\r
52 History buffers are turned off by default to gain performance.\r
54 'xhat_history'\r
55 History of xhat.\r
57 'xpred_history'\r
58 History of xpred.\r
60 'y_history'\r
61 History of y.\r
63 'u_history'\r
64 History of u.\r
66 'Ts_history'\r
67 History of Ts.\r