Changeset 353 for doc/html/classbdm_1_1KalmanCh.html

Timestamp:

06/02/09 10:08:06 (16 years ago)

Author:

smidl

Message:

doc

Files:

• doc/html/classbdm_1_1KalmanCh.html (modified) (8 diffs)

doc/html/classbdm_1_1KalmanCh.html

@@ -112 +112 @@
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3d95e9de79ca1d52b06f1b8f80660f09"></a><!-- doxytag: member="bdm::KalmanCh::ToString" ref="3d95e9de79ca1d52b06f1b8f80660f09" args="()" -->
+virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#3d95e9de79ca1d52b06f1b8f80660f09">ToString</a> ()</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d4602efd3ad9fb9e4532426e4f488df8"></a><!-- doxytag: member="bdm::KalmanCh::from_setting" ref="d4602efd3ad9fb9e4532426e4f488df8" args="(const Setting &amp;root)" -->
+virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#d4602efd3ad9fb9e4532426e4f488df8">from_setting</a> (const Setting &amp;root)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method arrange instance properties according the data stored in the Setting structure. <br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a80210bbe266bf26f100f342460a313f"></a><!-- doxytag: member="bdm::KalmanCh::to_setting" ref="a80210bbe266bf26f100f342460a313f" args="(Setting &amp;root)" -->
+virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#a80210bbe266bf26f100f342460a313f">to_setting</a> (Setting &amp;root)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br></td></tr>
 <tr><td colspan="2"><div class="groupHeader">Mathematical operations</div></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1dee3fddaf021e62d925289660a707dc"></a><!-- doxytag: member="bdm::KalmanCh::bayesB" ref="1dee3fddaf021e62d925289660a707dc" args="(const mat &amp;Dt)" -->
@@ -255 +267 @@
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Name of extension variable. <br></td></tr>
 <tr><td colspan="2"><br><h2>Logging of results</h2></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="224dd68a83c1472b43163763fa93c477"></a><!-- doxytag: member="bdm::KalmanCh::set_options" ref="224dd68a83c1472b43163763fa93c477" args="(const string &amp;opt)" -->
-void&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>
-
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set boolean options from a string. <br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="adb539fa2585c8a2a91c54e5aebf330e"></a><!-- doxytag: member="bdm::KalmanCh::set_options" ref="adb539fa2585c8a2a91c54e5aebf330e" args="(const string &amp;opt)" -->
+virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#adb539fa2585c8a2a91c54e5aebf330e">set_options</a> (const string &amp;opt)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set boolean options from a string recognized are: "logbounds,logll". <br></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2298ca6af9b13a78a4c9e18ab43f1827"></a><!-- doxytag: member="bdm::KalmanCh::log_add" ref="2298ca6af9b13a78a4c9e18ab43f1827" args="(logger &amp;L, const string &amp;name=&quot;&quot;)" -->
 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#2298ca6af9b13a78a4c9e18ab43f1827">log_add</a> (<a class="el" href="classbdm_1_1logger.html">logger</a> &amp;L, const string &amp;name=&quot;&quot;)</td></tr>
@@ -269 +281 @@
 ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#109c1a626a69031658e3a44e9e500cca">LIDs</a></td></tr>
 
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">IDs of storages in loggers. <br></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5e0000d2c9df99b029eceff222f7d77"></a><!-- doxytag: member="bdm::KalmanCh::opt_L_bounds" ref="a5e0000d2c9df99b029eceff222f7d77" args="" -->
-bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#a5e0000d2c9df99b029eceff222f7d77">opt_L_bounds</a></td></tr>
-
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Option for logging bounds. <br></td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">IDs of storages in loggers 4:[1=mean,2=lb,3=ub,4=ll]. <br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="398b7e7a162cf37d0022d6126495f207"></a><!-- doxytag: member="bdm::KalmanCh::LFlags" ref="398b7e7a162cf37d0022d6126495f207" args="" -->
+ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#398b7e7a162cf37d0022d6126495f207">LFlags</a></td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Flags for logging - same size as LIDs, each entry correspond to the same in LIDs. <br></td></tr>
 </table>
 <hr><a name="_details"></a><h2>Detailed Description</h2>
@@ -287 +299 @@
         <span class="comment">// matrices</span>
         mat A = eye(dx);
-        mat B = zeros(dx,du);
-        mat C = eye(dx);
-        mat D = zeros(dy,du);
-        mat Q = eye(dx);
-        mat R = 0.1*eye(dy);
+        mat <a class="code" href="classbdm_1_1Kalman.html#5977b2c81857948a35105f0e7840203c" title="Matrix B.">B</a> = <a class="code" href="group__specmat.html#g4c206300055f51390d03770ea5600da3" title="A Double vector of zeros.">zeros</a>(dx,du);
+        mat <a class="code" href="classbdm_1_1Kalman.html#818eba63a23972786a4579ad30294177" title="Matrix C.">C</a> = eye(dx);
+        mat D = <a class="code" href="group__specmat.html#g4c206300055f51390d03770ea5600da3" title="A Double vector of zeros.">zeros</a>(dy,du);
+        mat <a class="code" href="classbdm_1_1Kalman.html#70f8bf19e81b532c60fd3a7a152425ee" title="Matrix Q in square-root form.">Q</a> = eye(dx);
+        mat <a class="code" href="classbdm_1_1Kalman.html#475b088287cdfbba4dc60a3d027728b7" title="Matrix R in square-root form.">R</a> = 0.1*eye(dy);
         <span class="comment">//prior</span>
         mat P0 = 100*eye(dx);
-        vec mu0 = zeros(dx);
+        vec mu0 = <a class="code" href="group__specmat.html#g4c206300055f51390d03770ea5600da3" title="A Double vector of zeros.">zeros</a>(dx);
         <span class="comment">// Estimator</span>
         KalmanCh KF;
@@ -301 +313 @@
         <span class="comment">// Estimation loop</span>
         <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i=0;i&lt;100;i++){
-                KF.bayes(randn(dx+du));
+                KF.bayes(<a class="code" href="group__randgen.html#g9ecf5af23567f51abc9af737fdbd872a" title="Generates a random Gaussian (0,1) variable.">randn</a>(dx+du));
         }
         <span class="comment">//print results</span>
@@ -335 +347 @@
 <p>Reimplemented from <a class="el" href="classbdm_1_1Kalman.html#4a39330c14eff8d13179e868a1d1aa8c">bdm::Kalman&lt; chmat &gt;</a>.</p>
 
-<p>Reimplemented in <a class="el" href="classpmsmCRB.html#13749c201329922511369cdbe2f0f50a">pmsmCRB</a>, and <a class="el" href="classbdm_1_1EKFCh.html#4c8609c37290b158f88a31dae4047225">bdm::EKFCh</a>.</p>
-
-<p>References <a class="el" href="chmat_8h-source.html#l00067">chmat::_Ch()</a>, <a class="el" href="libKF_8h-source.html#l00095">bdm::Kalman&lt; chmat &gt;::_K</a>, <a class="el" href="libKF_8h-source.html#l00101">bdm::Kalman&lt; chmat &gt;::_mu</a>, <a class="el" href="libKF_8h-source.html#l00103">bdm::Kalman&lt; chmat &gt;::_P</a>, <a class="el" href="libKF_8h-source.html#l00099">bdm::Kalman&lt; chmat &gt;::_Ry</a>, <a class="el" href="libKF_8h-source.html#l00097">bdm::Kalman&lt; chmat &gt;::_yp</a>, <a class="el" href="libKF_8h-source.html#l00077">bdm::Kalman&lt; chmat &gt;::A</a>, <a class="el" href="libKF_8h-source.html#l00079">bdm::Kalman&lt; chmat &gt;::B</a>, <a class="el" href="libKF_8h-source.html#l00081">bdm::Kalman&lt; chmat &gt;::C</a>, <a class="el" href="libKF_8h-source.html#l00083">bdm::Kalman&lt; chmat &gt;::D</a>, <a class="el" href="libKF_8h-source.html#l00075">bdm::Kalman&lt; chmat &gt;::dimu</a>, <a class="el" href="libKF_8h-source.html#l00071">bdm::Kalman&lt; chmat &gt;::dimx</a>, <a class="el" href="libKF_8h-source.html#l00073">bdm::Kalman&lt; chmat &gt;::dimy</a>, <a class="el" href="libBM_8h-source.html#l00637">bdm::BM::evalll</a>, <a class="el" href="libEF_8h-source.html#l00051">bdm::eEF::evallog()</a>, <a class="el" href="libKF_8h-source.html#l00092">bdm::Kalman&lt; chmat &gt;::fy</a>, <a class="el" href="libBM_8h-source.html#l00635">bdm::BM::ll</a>, <a class="el" href="libKF_8h-source.html#l00142">postA</a>, and <a class="el" href="libKF_8h-source.html#l00140">preA</a>.</p>
+<p>Reimplemented in <a class="el" href="classbdm_1_1EKFCh.html#4c8609c37290b158f88a31dae4047225">bdm::EKFCh</a>.</p>
+
+<p>References <a class="el" href="chmat_8h-source.html#l00067">chmat::_Ch()</a>, <a class="el" href="libKF_8h-source.html#l00098">bdm::Kalman&lt; chmat &gt;::_K</a>, <a class="el" href="libKF_8h-source.html#l00104">bdm::Kalman&lt; chmat &gt;::_mu</a>, <a class="el" href="libKF_8h-source.html#l00106">bdm::Kalman&lt; chmat &gt;::_P</a>, <a class="el" href="libKF_8h-source.html#l00102">bdm::Kalman&lt; chmat &gt;::_Ry</a>, <a class="el" href="libKF_8h-source.html#l00100">bdm::Kalman&lt; chmat &gt;::_yp</a>, <a class="el" href="libKF_8h-source.html#l00080">bdm::Kalman&lt; chmat &gt;::A</a>, <a class="el" href="libKF_8h-source.html#l00082">bdm::Kalman&lt; chmat &gt;::B</a>, <a class="el" href="ls__solve_8cpp-source.html#l00850">itpp::backward_substitution()</a>, <a class="el" href="libKF_8h-source.html#l00084">bdm::Kalman&lt; chmat &gt;::C</a>, <a class="el" href="libKF_8h-source.html#l00086">bdm::Kalman&lt; chmat &gt;::D</a>, <a class="el" href="libKF_8h-source.html#l00078">bdm::Kalman&lt; chmat &gt;::dimu</a>, <a class="el" href="libKF_8h-source.html#l00074">bdm::Kalman&lt; chmat &gt;::dimx</a>, <a class="el" href="libKF_8h-source.html#l00076">bdm::Kalman&lt; chmat &gt;::dimy</a>, <a class="el" href="libBM_8h-source.html#l00664">bdm::BM::evalll</a>, <a class="el" href="libEF_8h-source.html#l00051">bdm::eEF::evallog()</a>, <a class="el" href="libKF_8h-source.html#l00095">bdm::Kalman&lt; chmat &gt;::fy</a>, <a class="el" href="inv_8cpp-source.html#l00109">itpp::inv()</a>, <a class="el" href="itassert_8h-source.html#l00173">it_warning</a>, <a class="el" href="libBM_8h-source.html#l00662">bdm::BM::ll</a>, <a class="el" href="libKF_8h-source.html#l00147">postA</a>, <a class="el" href="libKF_8h-source.html#l00145">preA</a>, and <a class="el" href="qr_8cpp-source.html#l00333">itpp::qr()</a>.</p>
 
 </div>
@@ -361 +373 @@
 <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>
 
-<p>Referenced by <a class="el" href="libBM_8h-source.html#l00662">bdm::BM::logpred_m()</a>.</p>
+<p>References <a class="el" href="itassert_8h-source.html#l00126">it_error</a>.</p>
+
+<p>Referenced by <a class="el" href="libBM_8h-source.html#l00690">bdm::BM::logpred_m()</a>.</p>
 
 </div>
@@ -368 +382 @@
 <li><a class="el" href="libKF_8h-source.html">libKF.h</a><li>libKF.cpp</ul>
 </div>
-<hr size="1"><address style="text-align: right;"><small>Generated on Thu Apr 23 21:06:45 2009 for mixpp by&nbsp;
+<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:18 2009 for mixpp by&nbsp;
 <a href="http://www.doxygen.org/index.html">
 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>