Changeset 630 for library/doc/tutorial/01userguide.dox

Timestamp:

09/18/09 00:17:14 (15 years ago)

Author:

smidl

Message:

Tutorial update + new .m files

Files:

• library/doc/tutorial/01userguide.dox (modified) (9 diffs)

library/doc/tutorial/01userguide.dox

@@ -2 +2 @@
 \page user_guide Howto Use BDM - System, Data, Simulation
 
-This section serves as introdustion to the scenario of data simulation. Since it is the simpliest of all scenarios defined in \ref user_guide0 it also serves as introduction to configuration of an experiment (see \ref ui) and basic decision making objects (bdm::RV and bdm::DS).
+This section serves as introdustion to the scenario of data simulation. Since it is the simpliest of all scenarios defined in \ref user_guide0 it also serves as introduction to configuration of an experiment (see \ref ui_page) and basic decision making objects (bdm::RV and bdm::DS).
 
 All experiments are demonstarted on scenario simulator which can be either standalone application of mex file (simulator.mex**).
 
 
-\section config Configuration of an experiment
+\section ug_config Configuration of an experiment
 
 Configuration file (or config structure) is organized as a tree of information. High levels represent complex structures, leafs of the tree are basic data elements such as strings, numbers or vectors.
@@ -14 +14 @@
 
 The configuration has two possible options:
- - configuration file using syntax of libconfig (see \ref ui),
+ - configuration file using syntax of libconfig (see \ref ui_page),
  - matlab structure.
 For the purpose of tutorial, we will use the matlab notation. 
-These two options can be mutually converted from one to another using prepared mex files: config2mxstruct.mex and mxstruct2config.mex. Naturally, these scripts require matlab to run. If it is not available, manual conversion is relatively trivial, the major difference is in using different types of brackets (\ref ui)
-
-\subsection first First experiment
+These two options can be mutually converted from one to another using prepared mex files: config2mxstruct.mex and mxstruct2config.mex. Naturally, these scripts require matlab to run. If it is not available, manual conversion is relatively trivial, the major difference is in using different types of brackets (\ref ui_page)
+
+\subsection ug_first First experiment
 
 The first experiment that can be performed is:
@@ -43 +43 @@
 \endcode
 
-If you see this result, you have configured BDM correctly and you have sucessfully run you first experiment. In other cases, please check your installation, \ref installation. 
+If you see this result, you have configured BDM correctly and you have sucessfully run you first experiment. In other cases, please check your installation, \ref install. 
 All that the simulator did was actually copying \c DS.Data to \c M.ch0. Explanation of the experiment and the logic used there follows.
 
-\section sim Systems and DataSources
+\section ug_sim Systems and DataSources
 
 In standard system theory, the system is typically illustrated graphically as:
@@ -73 +73 @@
 
 
-\section memds DataSource of pre-recorded data -- MemDS
+\section ug_memds DataSource of pre-recorded data -- MemDS
 
 The first experiment run in \ref first was actually an instance of DataSource of pre-recorded data that were stored in memory, i.e. the bdm::MemDS class.
@@ -104 +104 @@
 Where the first line specifies a universal identification structure: random variable (bdm::RV).
 
-\section rvs What is RV and how to use it
+\section ug_rvs What is RV and how to use it
 
 RV stands for \c random \c variable which is a description of random variable or its realization. This object playes role of identifier of elements of vectors of data (in datasources), expected inputs to functions (in pdfs), or required results (operations conditioning). 
@@ -125 +125 @@
 Since all experiments are performed in matlab, the default mexlog class will be used. However, the way how the results are to be stored can be configured using configuration structure filled by fields from \c from_setting of the chosen logger, and passing it as third argument to \c simulator.
 
-\section datasource Class inheritance and DataSources
+\section ug_datasource Class inheritance and DataSources
 
 As mentioned above, the scenario \c simulator is written to accept any datasource (i.e. any offspring of bdm::DS). For full list of offsprings, click see Classes > Class Hierarchy.
@@ -175 +175 @@
 If the task was only to generate random realizations, this would indeed be a very clumsy way of doing it. However, the power of the proposed approach will be revelead in more demanding examples, one of which follows next.
 
-\section arx Simulating autoregressive model
+\section ug_arx_sim Simulating autoregressive model
 
 Consider the following autoregressive model: 
@@ -232 +232 @@
 The code above can be immediatelly run, usin the same execution sequence of \c estimator as above. 
 
-\subsection ini Initializing simulation
+\subsection ug_ini Initializing simulation
 
 When zeros are not appropriate initial conditions, the correct conditions can be set using additional commands (see bdm::MpdfDS.from_setting() ):
@@ -244 +244 @@
 
 
+\section ug_store Storing results of simulation
+
+If the simulated data are to be analyzed off-line it may be advantageous to store them and use for later use. 
+This operation is straightforward if the class of logger used in the \c simulator is compatible with some datasource class.
+
+For example, the output of \c MemDS can be stored as an .it file (filename is specified in configuration structure) which can be later read by bdm::ITppFileDS.
+
+In matlab, the output of mexlog is a structure of vectors or matrices. The results can be saved in a matlab file using:
+\code
+Data=[M.y; M.u];
+drv = RVjoin({y,u});
+save mpdfds_results Data drv
+\endcode
+Such data can be later provided e.g. by MemDS
+\code
+mxDS.class   = 'MemDS';
+mxDS.Data    = 'Data';
+mxDS.drv     = drv;
+\endcode
+
 */