Show
Ignore:
Timestamp:
03/05/09 14:03:56 (15 years ago)
Author:
smidl
Message:

doc

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • doc/html/classEKFfixed.html

    r280 r287  
    6767</div> 
    6868<div class="contents"> 
    69 <h1>EKFfixed Class Reference</h1><!-- doxytag: class="EKFfixed" --><!-- doxytag: inherits="bdm::BM,bdm::BMcond" --><code>#include &lt;<a class="el" href="ekf__obj_8h-source.html">ekf_obj.h</a>&gt;</code> 
     69<h1>EKFfixed Class Reference</h1><!-- doxytag: class="EKFfixed" --><!-- doxytag: inherits="bdm::BM" --><code>#include &lt;<a class="el" href="ekf__obj_8h-source.html">ekf_obj.h</a>&gt;</code> 
    7070<p> 
    7171<div class="dynheader"> 
     
    7575<p><center><img src="classEKFfixed.png" usemap="#EKFfixed_map" border="0" alt=""></center> 
    7676<map name="EKFfixed_map"> 
    77 <area href="classbdm_1_1BM.html" alt="bdm::BM" shape="rect" coords="0,56,88,80"> 
    78 <area href="classbdm_1_1BMcond.html" alt="bdm::BMcond" shape="rect" coords="98,56,186,80"> 
    79 <area href="classbdm_1_1bdmroot.html" alt="bdm::bdmroot" shape="rect" coords="0,0,88,24"> 
    80 <area href="classbdm_1_1bdmroot.html" alt="bdm::bdmroot" shape="rect" coords="98,0,186,24"> 
     77<area href="classbdm_1_1BM.html" alt="bdm::BM" shape="rect" coords="0,56,86,80"> 
     78<area href="classbdm_1_1bdmroot.html" alt="bdm::bdmroot" shape="rect" coords="0,0,86,24"> 
    8179</map> 
    8280</div> 
     
    8886An approximation of the exact Bayesian filter with Gaussian noices and non-linear evolutions of their mean. <table border="0" cellpadding="0" cellspacing="0"> 
    8987<tr><td></td></tr> 
     88<tr><td colspan="2"><br><h2>Extension to conditional BM</h2></td></tr> 
     89<tr><td colspan="2">This extension is useful e.g. in Marginalized Particle Filter (<a class="el" href="classbdm_1_1MPF.html">bdm::MPF</a>). Alternatively, it can be used for automated connection to DS when the condition is observed <br><br></td></tr> 
     90<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="de95c590d650b2db423d53992f0906cb"></a><!-- doxytag: member="EKFfixed::rvc" ref="de95c590d650b2db423d53992f0906cb" args="" --> 
     91RV&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#de95c590d650b2db423d53992f0906cb">rvc</a></td></tr> 
     92 
     93<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Name of extension variable. <br></td></tr> 
     94<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b5e8e016be16e4029c789063cb3f3b33"></a><!-- doxytag: member="EKFfixed::_rvc" ref="b5e8e016be16e4029c789063cb3f3b33" args="() const " --> 
     95const RV &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#b5e8e016be16e4029c789063cb3f3b33">_rvc</a> () const </td></tr> 
     96 
     97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr> 
     98<tr><td colspan="2"><br><h2>Logging of results</h2></td></tr> 
     99<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="109c1a626a69031658e3a44e9e500cca"></a><!-- doxytag: member="EKFfixed::LIDs" ref="109c1a626a69031658e3a44e9e500cca" args="" --> 
     100ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#109c1a626a69031658e3a44e9e500cca">LIDs</a></td></tr> 
     101 
     102<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">IDs of storages in loggers. <br></td></tr> 
     103<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5e0000d2c9df99b029eceff222f7d77"></a><!-- doxytag: member="EKFfixed::opt_L_bounds" ref="a5e0000d2c9df99b029eceff222f7d77" args="" --> 
     104bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#a5e0000d2c9df99b029eceff222f7d77">opt_L_bounds</a></td></tr> 
     105 
     106<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Option for logging bounds. <br></td></tr> 
     107<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="224dd68a83c1472b43163763fa93c477"></a><!-- doxytag: member="EKFfixed::set_options" ref="224dd68a83c1472b43163763fa93c477" args="(const string &amp;opt)" --> 
     108void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#224dd68a83c1472b43163763fa93c477">set_options</a> (const string &amp;opt)</td></tr> 
     109 
     110<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set boolean options from a string. <br></td></tr> 
     111<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="aa5d1f7e638db229403e3917bf155ee3"></a><!-- doxytag: member="EKFfixed::log_add" ref="aa5d1f7e638db229403e3917bf155ee3" args="(logger *L, const string &amp;name=&quot;&quot;)" --> 
     112void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#aa5d1f7e638db229403e3917bf155ee3">log_add</a> (logger *L, const string &amp;name=&quot;&quot;)</td></tr> 
     113 
     114<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add all logged variables to a <a class="el" href="classbdm_1_1logger.html" title="Class for storing results (and semi-results) of an experiment.">logger</a>. <br></td></tr> 
     115<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0647606eefbf294623bf664971c7d461"></a><!-- doxytag: member="EKFfixed::logit" ref="0647606eefbf294623bf664971c7d461" args="(logger *L)" --> 
     116void&nbsp;</td><td class="memItemRight" valign="bottom"><b>logit</b> (logger *L)</td></tr> 
     117 
    90118<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> 
    91119<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cece920bbf58fc72b25a6417b3ef0259"></a><!-- doxytag: member="EKFfixed::init_ekf" ref="cece920bbf58fc72b25a6417b3ef0259" args="(double Tv)" --> 
     
    120148 
    121149<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Substitute <code>val</code> for <code>rvc</code>. <br></td></tr> 
    122 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7506910f93250b44fea505ec4ffb19dc"></a><!-- doxytag: member="EKFfixed::_rvc" ref="7506910f93250b44fea505ec4ffb19dc" args="() const " --> 
    123 const RV &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BMcond.html#7506910f93250b44fea505ec4ffb19dc">_rvc</a> () const </td></tr> 
    124  
    125 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr> 
    126150<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr> 
    127 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual BM *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#c0f027ff91d8459937c6f60ff8e553ff">_copy_</a> ()</td></tr> 
     151<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual BM *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#40f01563651c1e4fe926189e41a6b8ab">_copy_</a> () const </td></tr> 
    128152 
    129153<tr><td colspan="2"><div class="groupHeader">Mathematical operations</div></td></tr> 
     
    239263 
    240264<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">If true, the filter will compute likelihood of the data record and store it in <code>ll</code> . Set to false if you want to save computational time. <br></td></tr> 
    241 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1164a90f782a2a323b1ee17242100b39"></a><!-- doxytag: member="EKFfixed::dimc" ref="1164a90f782a2a323b1ee17242100b39" args="" --> 
    242 int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BMcond.html#1164a90f782a2a323b1ee17242100b39">dimc</a></td></tr> 
    243  
    244 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">dimension of the conditioning variable <br></td></tr> 
    245 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9a12750776d977408aada06a70093297"></a><!-- doxytag: member="EKFfixed::rvc" ref="9a12750776d977408aada06a70093297" args="" --> 
    246 RV&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BMcond.html#9a12750776d977408aada06a70093297">rvc</a></td></tr> 
    247  
    248 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Identificator of the conditioning variable. <br></td></tr> 
    249265</table> 
    250266<hr><h2>Member Function Documentation</h2> 
    251 <a class="anchor" name="c0f027ff91d8459937c6f60ff8e553ff"></a><!-- doxytag: member="EKFfixed::_copy_" ref="c0f027ff91d8459937c6f60ff8e553ff" args="()" --> 
     267<a class="anchor" name="40f01563651c1e4fe926189e41a6b8ab"></a><!-- doxytag: member="EKFfixed::_copy_" ref="40f01563651c1e4fe926189e41a6b8ab" args="() const " --> 
    252268<div class="memitem"> 
    253269<div class="memproto"> 
     
    258274          <td class="paramname">          </td> 
    259275          <td>&nbsp;)&nbsp;</td> 
    260           <td><code> [inline, virtual, inherited]</code></td> 
     276          <td> const<code> [inline, virtual, inherited]</code></td> 
    261277        </tr> 
    262278      </table> 
     
    265281 
    266282<p> 
    267 Copy function required in vectors, Arrays of <a class="el" href="classbdm_1_1BM.html" title="Bayesian Model of a system, i.e. all uncertainty is modeled by probabilities.">BM</a> etc. Have to be DELETED manually! Prototype: <div class="fragment"><pre class="fragment"> BM* <a class="code" href="classbdm_1_1BM.html#c0f027ff91d8459937c6f60ff8e553ff">_copy_</a>(){<span class="keywordflow">return</span> <span class="keyword">new</span> BM(*<span class="keyword">this</span>);}  
     283Copy function required in vectors, Arrays of <a class="el" href="classbdm_1_1BM.html" title="Bayesian Model of a system, i.e. all uncertainty is modeled by probabilities.">BM</a> etc. Have to be DELETED manually! Prototype: <div class="fragment"><pre class="fragment"> BM* <a class="code" href="classbdm_1_1BM.html#40f01563651c1e4fe926189e41a6b8ab">_copy_</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> <span class="keyword">new</span> BM(*<span class="keyword">this</span>);}  
    268284</pre></div>  
    269 <p>Reimplemented in <a class="el" href="classbdm_1_1ARX.html#60c40b5c6abc4c7e464b4ccae64a5a61">bdm::ARX</a>.</p> 
     285<p>Reimplemented in <a class="el" href="classbdm_1_1ARX.html#ca0b54c0997cfd567f49377af5def106">bdm::ARX</a>, <a class="el" href="classbdm_1_1KalmanCh.html#24ce65bdaa538d4d5153d709a929b996">bdm::KalmanCh</a>, <a class="el" href="classbdm_1_1EKF.html#fe9b2e227255ad32dc73df316b7318f4">bdm::EKF&lt; sq_T &gt;</a>, and <a class="el" href="classbdm_1_1EKFCh.html#1d1d91400e3f177de9fe7962ea17adc4">bdm::EKFCh</a>.</p> 
    270286 
    271287</div> 
     
    291307<p>Reimplemented in <a class="el" href="classbdm_1_1ARX.html#080a7e531e3aa06694112863b15bc6a4">bdm::ARX</a>, <a class="el" href="classbdm_1_1MixEF.html#da724da464a75e07521941e430929efa">bdm::MixEF</a>, and <a class="el" href="classbdm_1_1multiBM.html#e157b607c1e3fa91d42aeea44458e2bf">bdm::multiBM</a>.</p> 
    292308 
    293 <p>Referenced by <a class="el" href="libBM_8h-source.html#l00628">bdm::BM::logpred_m()</a>.</p> 
     309<p>Referenced by <a class="el" href="libBM_8h-source.html#l00650">bdm::BM::logpred_m()</a>.</p> 
    294310 
    295311</div> 
     
    298314<li><a class="el" href="ekf__obj_8h-source.html">ekf_obj.h</a><li>ekf_obj.cpp</ul> 
    299315</div> 
    300 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 18 17:38:51 2009 for mixpp by&nbsp; 
     316<hr size="1"><address style="text-align: right;"><small>Generated on Wed Mar 4 18:50:17 2009 for mixpp by&nbsp; 
    301317<a href="http://www.doxygen.org/index.html"> 
    302318<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>