root/doc/html/estimator_8cpp.html @ 302

Revision 302, 5.5 kB (checked in by smidl, 16 years ago)

Install manual ticket #17

Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3<title>mixpp: estimator.cpp File Reference</title>
4<link href="tabs.css" rel="stylesheet" type="text/css">
5<link href="doxygen.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.8 -->
8<script type="text/javascript">
9<!--
10function changeDisplayState (e){
11  var num=this.id.replace(/[^[0-9]/g,'');
12  var button=this.firstChild;
13  var sectionDiv=document.getElementById('dynsection'+num);
14  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
15    sectionDiv.style.display='block';
16    button.src='open.gif';
17  }else{
18    sectionDiv.style.display='none';
19    button.src='closed.gif';
20  }
21}
22function initDynSections(){
23  var divs=document.getElementsByTagName('div');
24  var sectionCounter=1;
25  for(var i=0;i<divs.length-1;i++){
26    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
27      var header=divs[i];
28      var section=divs[i+1];
29      var button=header.firstChild;
30      if (button!='IMG'){
31        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
32        button=document.createElement('img');
33        divs[i].insertBefore(button,divs[i].firstChild);
34      }
35      header.style.cursor='pointer';
36      header.onclick=changeDisplayState;
37      header.id='dynheader'+sectionCounter;
38      button.src='closed.gif';
39      section.id='dynsection'+sectionCounter;
40      section.style.display='none';
41      section.style.marginLeft='14px';
42      sectionCounter++;
43    }
44  }
45}
46window.onload = initDynSections;
47-->
48</script>
49<div class="navigation" id="top">
50  <div class="tabs">
51    <ul>
52      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
53      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
54      <li><a href="modules.html"><span>Modules</span></a></li>
55      <li><a href="annotated.html"><span>Classes</span></a></li>
56      <li class="current"><a href="files.html"><span>Files</span></a></li>
57    </ul>
58  </div>
59  <div class="tabs">
60    <ul>
61      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
62      <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
63    </ul>
64  </div>
65</div>
66<div class="contents">
67<h1>estimator.cpp File Reference</h1>Application Estimator. 
68<a href="#_details">More...</a>
69<p>
70<code>#include &lt;<a class="el" href="libDS__ui_8h-source.html">stat/libDS_ui.h</a>&gt;</code><br>
71<code>#include &lt;<a class="el" href="arx__ui_8h-source.html">estim/arx_ui.h</a>&gt;</code><br>
72<table border="0" cellpadding="0" cellspacing="0">
73<tr><td></td></tr>
74<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
75<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0ddf1224851353fc92bfbff6f499fa97"></a><!-- doxytag: member="estimator.cpp::main" ref="0ddf1224851353fc92bfbff6f499fa97" args="(int argc, char *argv[])" -->
76int&nbsp;</td><td class="memItemRight" valign="bottom"><b>main</b> (int argc, char *argv[])</td></tr>
77
78</table>
79<hr><a name="_details"></a><h2>Detailed Description</h2>
80Application Estimator.
81<p>
82The general task of estimation is defined on the following scheme: <div align="center">
83<img src="inline_dotgraph_1.dot.png" alt="inline_dotgraph_1.dot" border="0" usemap="#inline_dotgraph_1.dot.map">
84<map name="inline_dotgraph_1.dot.map"></map>
85</div>
86<p>
87Here, <ul>
88<li>Data Source is an object (class DS) providing sequential data, <img class="formulaInl" alt="$ [d_1, d_2, \ldots d_t] $" src="form_116.png">. </li>
89<li>Bayesian Model is an object (class BM) performing Bayesian filtering, </li>
90<li>Result Logger is an object (class logger) dedicated to storing important data from the experiment.</li>
91</ul>
92<h2><a class="anchor" name="cmd">
93Command-line usage</a></h2>
94Execute command: <div class="fragment"><pre class="fragment">$&gt; estimator config_file.cfg
95</pre></div><p>
96Full description of the experiment is in the file config_file.cfg which is expected to have the following structure: <div class="fragment"><pre class="fragment">system = {type = <span class="stringliteral">"DS_offspring"</span>, ...};      <span class="comment">// definition of a data source</span>
97estimator = {type = <span class="stringliteral">"BM_offspring"</span>, ...};   <span class="comment">// definition of an estimator</span>
98logger = {type = <span class="stringliteral">"logger_type"</span>,...};        <span class="comment">// definition of a logger</span>
99experiment = {ndat = 11000; };              <span class="comment">// definition of number of data records</span>
100</pre></div><p>
101The above description must be specialized to specific classes. See, <a class="el" href="arx_ui.html">Running experiment <code>estimator</code> with ARX data fields</a> how to do it for estimation of an ARX model.<h2><a class="anchor" name="ex">
102Matlab usage</a></h2>
103Execute command: <div class="fragment"><pre class="fragment">&gt;&gt; estimator(<span class="stringliteral">'config_file.cfg'</span>);
104</pre></div> when using loggers storing results on hard drives, and <div class="fragment"><pre class="fragment">&gt;&gt; Res=estimator(<span class="stringliteral">'config_file.cfg'</span>);
105</pre></div> when using logger of the type <code>"mexlog"</code>. The results will be stored in structure <code>M</code>. </div>
106<hr size="1"><address style="text-align: right;"><small>Generated on Thu Mar 19 16:25:43 2009 for mixpp by&nbsp;
107<a href="http://www.doxygen.org/index.html">
108<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
109</body>
110</html>
Note: See TracBrowser for help on using the browser.