root/doc/latex/classKalmanFull.tex @ 28

Revision 28, 3.5 kB (checked in by smidl, 16 years ago)

prelozitelna verze

  • Property svn:eol-style set to native
Line 
1\section{KalmanFull Class Reference}
2\label{classKalmanFull}\index{KalmanFull@{KalmanFull}}
3Basic \doxyref{Kalman}{p.}{classKalman} filter with full matrices (education purpose only)! Will be deleted soon! 
4
5
6{\tt \#include $<$libKF.h$>$}
7
8Inheritance diagram for KalmanFull:\nopagebreak
9\begin{figure}[H]
10\begin{center}
11\leavevmode
12\includegraphics[width=56pt]{classKalmanFull__inherit__graph}
13\end{center}
14\end{figure}
15Collaboration diagram for KalmanFull:\nopagebreak
16\begin{figure}[H]
17\begin{center}
18\leavevmode
19\includegraphics[width=56pt]{classKalmanFull__coll__graph}
20\end{center}
21\end{figure}
22\subsection*{Public Member Functions}
23\begin{CompactItemize}
24\item 
25{\bf KalmanFull} (mat A, mat B, mat C, mat D, mat R, mat Q, mat P0, vec mu0)\label{classKalmanFull_7197ab6e7380790006394eabd3b97043}
26
27\begin{CompactList}\small\item\em Full constructor. \item\end{CompactList}\item 
28void {\bf bayes} (const vec \&dt, bool {\bf evalll}=true)\label{classKalmanFull_048b13739b94c331cda08249b278552b}
29
30\begin{CompactList}\small\item\em Here dt = [yt;ut] of appropriate dimensions. \item\end{CompactList}\item 
31virtual void {\bf bayes} (const vec \&dt)=0
32\begin{CompactList}\small\item\em Incremental Bayes rule. \item\end{CompactList}\item 
33void {\bf bayes} (mat Dt)\label{classBM_87b07867fd4c133aa89a18543f68d9f9}
34
35\begin{CompactList}\small\item\em Batch Bayes rule (columns of Dt are observations). \item\end{CompactList}\item 
36{\bf epdf} $\ast$ {\bf \_\-epdf} ()\label{classBM_a5b8f6c8a872738cfaa30ab010e8c077}
37
38\begin{CompactList}\small\item\em Returns a pointer to the \doxyref{epdf}{p.}{classepdf} representing posterior density on parameters. Use with care! \item\end{CompactList}\end{CompactItemize}
39\subsection*{Public Attributes}
40\begin{CompactItemize}
41\item 
42vec {\bf mu}\label{classKalmanFull_fb5aec635e2720cc5ac31bc01c18a68a}
43
44\begin{CompactList}\small\item\em Mean value of the posterior density. \item\end{CompactList}\item 
45mat {\bf P}\label{classKalmanFull_b75dc059e84fa8ffc076203b30f926cc}
46
47\begin{CompactList}\small\item\em Variance of the posterior density. \item\end{CompactList}\item 
48double {\bf ll}\label{classBM_5623fef6572a08c2b53b8c87b82dc979}
49
50\begin{CompactList}\small\item\em Logarithm of marginalized data likelihood. \item\end{CompactList}\item 
51bool {\bf evalll}\label{classBM_bf6fb59b30141074f8ee1e2f43d03129}
52
53\begin{CompactList}\small\item\em If true, the filter will compute likelihood of the data record and store it in {\tt ll} . Set to false if you want to save time. \item\end{CompactList}\end{CompactItemize}
54\subsection*{Friends}
55\begin{CompactItemize}
56\item 
57std::ostream \& \textbf{operator$<$$<$} (std::ostream \&os, const {\bf KalmanFull} \&kf)\label{classKalmanFull_86ba216243ed95bb46d80d88775d16af}
58
59\end{CompactItemize}
60
61
62\subsection{Detailed Description}
63Basic \doxyref{Kalman}{p.}{classKalman} filter with full matrices (education purpose only)! Will be deleted soon!
64
65\subsection{Member Function Documentation}
66\index{KalmanFull@{KalmanFull}!bayes@{bayes}}
67\index{bayes@{bayes}!KalmanFull@{KalmanFull}}
68\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void BM::bayes (const vec \& {\em dt})\hspace{0.3cm}{\tt  [pure virtual, inherited]}}\label{classBM_a892eff438aab2dd1a9e2efcb7fb5bdf}
69
70
71Incremental Bayes rule.
72
73\begin{Desc}
74\item[Parameters:]
75\begin{description}
76\item[{\em dt}]vector of input data \end{description}
77\end{Desc}
78
79
80The documentation for this class was generated from the following files:\begin{CompactItemize}
81\item 
82work/mixpp/bdm/estim/{\bf libKF.h}\item 
83work/mixpp/bdm/estim/libKF.cpp\end{CompactItemize}
Note: See TracBrowser for help on using the browser.