root/doc/latex/classPF.tex @ 22

\section{PF Class Reference}
\label{classPF}\index{PF@{PF}}
A Particle Filter prototype.  


{\tt \#include $<$libPF.h$>$}

Inheritance diagram for PF:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=49pt]{classPF__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for PF:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=38pt]{classPF__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
ivec {\bf resample} (RESAMPLING\_\-METHOD method=SYSTEMATIC)\label{classPF_a0e26b2f6a5884aca49122f3e4f0cf19}

\begin{CompactList}\small\item\em Returns indexes of particles that should be resampled. The ordering MUST guarantee inplace replacement. (Important for MPF.). \item\end{CompactList}\item 
\textbf{PF} (vec w)\label{classPF_c37f95f0c1661c7f1e3fccb31d39de73}

\item 
void {\bf bayes} (const vec \&dt, bool evell)
\begin{CompactList}\small\item\em Incremental Bayes rule. \item\end{CompactList}\end{CompactItemize}
\subsection*{Protected Attributes}
\begin{CompactItemize}
\item 
int \textbf{n}\label{classPF_2c2f44ed7a4eaa42e07bdb58d503f280}

\item 
vec \textbf{w}\label{classPF_f6bc92f7979af4513b06b161497ba868}

\item 
Uniform\_\-RNG \textbf{URNG}\label{classPF_3568ca7c3b3175d98b548f496b4c34dd}

\end{CompactItemize}


\subsection{Detailed Description}
A Particle Filter prototype. 

Bayesian Filtering equations hold. 

\subsection{Member Function Documentation}
\index{PF@{PF}!bayes@{bayes}}
\index{bayes@{bayes}!PF@{PF}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void PF::bayes (const vec \& {\em dt}, bool {\em evall})\hspace{0.3cm}{\tt  [inline, virtual]}}\label{classPF_eb06bd7d4325f22f54233967295793b9}


Incremental Bayes rule. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em dt}]vector of input data \item[{\em evall}]If true, the filter will compute likelihood of the data record and store it in {\tt ll} \end{description}
\end{Desc}


Implements {\bf BM} \doxyref{}{p.}{classBM_c52edf4ad6e1dff9bf64b9e1e0cfb1f0}.

Reimplemented in {\bf TrivialPF} \doxyref{}{p.}{classTrivialPF_77a92bf054d763f806d27fc37a058389}.

The documentation for this class was generated from the following files:\begin{CompactItemize}
\item 
work/mixpp/bdm/estim/{\bf libPF.h}\item 
work/mixpp/bdm/estim/libPF.cpp\end{CompactItemize}