Changeset 661 for library/doc/tutorial/arx_ui.dox

Timestamp:

10/15/09 00:10:19 (15 years ago)

Author:

smidl

Message:

doc

Files:

• library/doc/tutorial/arx_ui.dox (modified) (3 diffs)

library/doc/tutorial/arx_ui.dox

@@ -2 +2 @@
 \page arx_ui Running experiment \c estimator with ARX data fields 
 
-The experiment \ref estimator.cpp can be run either on command line, or as a mex file in Matlab.
+The experiment \c estimator.cpp can be run either on command line, or as a mex file in Matlab.
 
 \section cmd Command Line
@@ -11 +11 @@
 The structure is interpreted by application \c estimator, which looks for fields:
 <dl>
-<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>
-<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>
-<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>
+<dt>system</dt><dd> description of a Data Source generating Data. The structure must by UI with \c class="DS_offspring". In our example, it is of class "ArxDS" which is parsed by bdm::UIArxDS UIbuilder generating a Data Source simulating ARX process.</dd>
+<dt>estimator</dt> <dd> description of a Baysian model used to estimate parameters of the data model. In this case, it is of class "ARXest" which is parsed by bdm::UIARX UIbuilder generating Bayesian estimator of autoregressive processess.</dd>
+<dt>logger</dt><dd> description of a way how to store results. UI is of \c class="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>
 </dl>
 When 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:
@@ -20 +20 @@
 
 \section mex Matlab mex file
-The 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.
+The 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 class="mexlog" which will store the results in a matlab structure.
 
 The exact configuration file may look as follows: