root/library/doc/tutorial/arx_ui.dox @ 651

Revision 651, 2.0 kB (checked in by mido, 15 years ago)

\doc directory cleaned a bit

Line 
1/*!
2\page arx_ui Running experiment \c estimator with ARX data fields
3
4The experiment \ref estimator.cpp can be run either on command line, or as a mex file in Matlab.
5
6\section cmd Command Line
7
8In order to use it for estimation of an ARX model, we can define the following \ref ui_page "user info" structure:
9\include arx_test.cfg
10
11The structure is interpreted by application \c estimator, which looks for fields:
12<dl>
13<dt>system</dt><dd> description of a Data Source generating Data. The structure must by UI with \c type="DS_offspring". In our example, it is of type "ArxDS" which is parsed by bdm::UIArxDS UIbuilder generating a Data Source simulating ARX process.</dd>
14<dt>estimator</dt> <dd> description of a Baysian model used to estimate parameters of the data model. In this case, it is of type "ARXest" which is parsed by bdm::UIARX UIbuilder generating Bayesian estimator of autoregressive processess.</dd>
15<dt>logger</dt><dd> description of a way how to store results. UI is of \c type="logger_offspring". In this case, it is of class "dirfilelog" which is parsed by bdm::UIdirfilelog which generates object storing data in directory specified by dirname="" field in fileformat understood by program kst.</dd>
16</dl>
17When the application estimator is run with the above code, it produces a directory of data files, which can be displayed by program kst. Expected results are:
18\image html arx_ui_kst.png
19\image latex arx_ui_kst.png "Typical run of estimator arx_test.cfg" width=\linewidth
20
21\section mex Matlab mex file
22The matlab mex file can be run with exactly the same configuration as above. However, when we wish to see the results in Matlab, we may wish to change the logger object to \c type="mexlog" which will store the results in a matlab structure.
23
24The exact configuration file may look as follows:
25\include arx_mex_test.cfg
26
27The resulting structure can be displayed using matlab script arx_test_disp.m, typically producing the following results:
28\image html arx_ui_mex.png
29\image latex arx_ui_mex.png "Typical run of matlab file arx_test_disp" width=\linewidth
30
31
32*/
Note: See TracBrowser for help on using the browser.