root/doc/latex/estimator_8cpp.tex @ 275

Revision 275, 2.3 kB (checked in by smidl, 15 years ago)

doc

Line 
1\hypertarget{estimator_8cpp}{
2\section{estimator.cpp File Reference}
3\label{estimator_8cpp}\index{estimator.cpp@{estimator.cpp}}
4}
5
6
7\subsection{Detailed Description}
8Application Estimator.
9
10The general task of estimation is defined on the following scheme: \begin{center}
11\begin{ImageNoCaption}\mbox{\includegraphics{inline_dotgraph_1}}
12\end{ImageNoCaption}
13\end{center}
14
15
16Here, \begin{itemize}
17\item Data Source is an object (class DS) providing sequential data, $ [d_1, d_2, \ldots d_t] $. \item Bayesian Model is an object (class BM) performing Bayesian filtering, \item Result Logger is an object (class logger) dedicated to storing important data from the experiment.\end{itemize}
18\hypertarget{arx_ui_cmd}{}\subsection{Command-line usage}\label{arx_ui_cmd}
19Execute command:
20
21\begin{Code}\begin{verbatim}$> estimator config_file.cfg
22\end{verbatim}
23\end{Code}
24
25
26
27Full description of the experiment is in the file config\_\-file.cfg which is expected to have the following structure:
28
29\begin{Code}\begin{verbatim}system = {type = "DS_offspring", ...};      // definition of a data source
30estimator = {type = "BM_offspring", ...};   // definition of an estimator
31logger = {type = "logger_type",...};        // definition of a logger
32experiment = {ndat = 11000; };              // definition of number of data records
33\end{verbatim}
34\end{Code}
35
36
37
38The above description must be specialized to specific classes. See, \hyperlink{arx_ui}{Running experiment {\tt estimator} with ARX data fields} how to do it for estimation of an ARX model.\hypertarget{estimator_8cpp_ex}{}\subsection{Matlab usage}\label{estimator_8cpp_ex}
39Execute command:
40
41\begin{Code}\begin{verbatim}>> estimator('config_file.cfg');
42\end{verbatim}
43\end{Code}
44
45 when using loggers storing results on hard drives, and
46
47\begin{Code}\begin{verbatim}>> Res=estimator('config_file.cfg');
48\end{verbatim}
49\end{Code}
50
51 when using logger of the type {\tt \char`\"{}mexlog\char`\"{}}. The results will be stored in structure {\tt M}.
52
53{\tt \#include $<$stat/libDS\_\-ui.h$>$}\par
54{\tt \#include $<$estim/arx\_\-ui.h$>$}\par
55\subsection*{Functions}
56\begin{CompactItemize}
57\item 
58\hypertarget{estimator_8cpp_0ddf1224851353fc92bfbff6f499fa97}{
59int \textbf{main} (int argc, char $\ast$argv\mbox{[}$\,$\mbox{]})}
60\label{estimator_8cpp_0ddf1224851353fc92bfbff6f499fa97}
61
62\end{CompactItemize}
Note: See TracBrowser for help on using the browser.