%
% API Documentation for nMOLDYN
% Module nMOLDYN.Tests.AnalysisTests
%
% Generated by epydoc 3.0.1
% [Thu Oct  8 17:00:03 2009]
%

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%                          Module Description                           %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

    \index{nMOLDYN \textit{(package)}!nMOLDYN.Tests \textit{(package)}!nMOLDYN.Tests.AnalysisTests \textit{(module)}|(}
\section{Module nMOLDYN.Tests.AnalysisTests}

    \label{nMOLDYN:Tests:AnalysisTests}
Test cases for analysis modules.

\begin{itemize}
\setlength{\parskip}{0.6ex}
  \item testCorrelation1: test for the autocorrelation of a single time serie.

  \item testCorrelation2: test for the autocorrelation of a two dimensional 
    time serie.

  \item testCorrelation3: another test for the autocorrelation of a two 
    dimensional time serie.

\end{itemize}


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%                           Class Description                           %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

    \index{nMOLDYN \textit{(package)}!nMOLDYN.Tests \textit{(package)}!nMOLDYN.Tests.AnalysisTests \textit{(module)}!nMOLDYN.Tests.AnalysisTests.AnalysisTest \textit{(class)}|(}
\subsection{Class AnalysisTest}

    \label{nMOLDYN:Tests:AnalysisTests:AnalysisTest}
\begin{tabular}{cccccc}
% Line for unittest.TestCase, linespec=[False]
\multicolumn{2}{r}{\settowidth{\BCL}{unittest.TestCase}\multirow{2}{\BCL}{unittest.TestCase}}
&&
  \\\cline{3-3}
  &&\multicolumn{1}{c|}{}
&&
  \\
&&\multicolumn{2}{l}{\textbf{nMOLDYN.Tests.AnalysisTests.AnalysisTest}}
\end{tabular}

Tests Analysis module functionnalities.


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%                                Methods                                %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

  \subsubsection{Methods}

    \vspace{0.5ex}

\hspace{.8\funcindent}\begin{boxedminipage}{\funcwidth}

    \raggedright \textbf{setUp}(\textit{self})

\setlength{\parskip}{2ex}
    Hook method for setting up the test fixture before exercising it.

\setlength{\parskip}{1ex}
      Overrides: unittest.TestCase.setUp 	extit{(inherited documentation)}

    \end{boxedminipage}

    \label{nMOLDYN:Tests:AnalysisTests:AnalysisTest:testCorrelation1}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.Tests \textit{(package)}!nMOLDYN.Tests.AnalysisTests \textit{(module)}!nMOLDYN.Tests.AnalysisTests.AnalysisTest \textit{(class)}!nMOLDYN.Tests.AnalysisTests.AnalysisTest.testCorrelation1 \textit{(method)}}

    \vspace{0.5ex}

\hspace{.8\funcindent}\begin{boxedminipage}{\funcwidth}

    \raggedright \textbf{testCorrelation1}(\textit{self})

\setlength{\parskip}{2ex}
\setlength{\parskip}{1ex}
    \end{boxedminipage}

    \label{nMOLDYN:Tests:AnalysisTests:AnalysisTest:testCorrelation2}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.Tests \textit{(package)}!nMOLDYN.Tests.AnalysisTests \textit{(module)}!nMOLDYN.Tests.AnalysisTests.AnalysisTest \textit{(class)}!nMOLDYN.Tests.AnalysisTests.AnalysisTest.testCorrelation2 \textit{(method)}}

    \vspace{0.5ex}

\hspace{.8\funcindent}\begin{boxedminipage}{\funcwidth}

    \raggedright \textbf{testCorrelation2}(\textit{self})

\setlength{\parskip}{2ex}
\setlength{\parskip}{1ex}
    \end{boxedminipage}

    \label{nMOLDYN:Tests:AnalysisTests:AnalysisTest:testCorrelation3}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.Tests \textit{(package)}!nMOLDYN.Tests.AnalysisTests \textit{(module)}!nMOLDYN.Tests.AnalysisTests.AnalysisTest \textit{(class)}!nMOLDYN.Tests.AnalysisTests.AnalysisTest.testCorrelation3 \textit{(method)}}

    \vspace{0.5ex}

\hspace{.8\funcindent}\begin{boxedminipage}{\funcwidth}

    \raggedright \textbf{testCorrelation3}(\textit{self})

\setlength{\parskip}{2ex}
\setlength{\parskip}{1ex}
    \end{boxedminipage}


\large{\textbf{\textit{Inherited from unittest.TestCase}}}

\begin{quote}
\_\_call\_\_(), \_\_init\_\_(), \_\_repr\_\_(), \_\_str\_\_(), assertAlmostEqual(), assertAlmostEquals(), assertEqual(), assertEquals(), assertFalse(), assertNotAlmostEqual(), assertNotAlmostEquals(), assertNotEqual(), assertNotEquals(), assertRaises(), assertTrue(), assert\_(), countTestCases(), debug(), defaultTestResult(), fail(), failIf(), failIfAlmostEqual(), failIfEqual(), failUnless(), failUnlessAlmostEqual(), failUnlessEqual(), failUnlessRaises(), id(), run(), shortDescription(), tearDown()
\end{quote}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.Tests \textit{(package)}!nMOLDYN.Tests.AnalysisTests \textit{(module)}!nMOLDYN.Tests.AnalysisTests.AnalysisTest \textit{(class)}|)}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.Tests \textit{(package)}!nMOLDYN.Tests.AnalysisTests \textit{(module)}|)}
