swh:1:snp:e6d42e6731ce66e3c09de07ac49964c03139e990
Raw File
Tip revision: 26b818c8be2be41dd673d938b403c5c7562635de authored by Travis CI on 28 November 2019, 13:55:12 UTC
Deploy code docs to GitHub Pages Travis build: 305
Tip revision: 26b818c
class_ox_1_1_calculator_t2.tex
\hypertarget{class_ox_1_1_calculator_t2}{\section{Ox\-:\-:Calculator\-T2$<$ Measure\-Type $>$ Class Template Reference}
\label{class_ox_1_1_calculator_t2}\index{Ox\-::\-Calculator\-T2$<$ Measure\-Type $>$@{Ox\-::\-Calculator\-T2$<$ Measure\-Type $>$}}
}


{\ttfamily \#include $<$Ox\-Calculator\-T2.\-h$>$}



Inheritance diagram for Ox\-:\-:Calculator\-T2$<$ Measure\-Type $>$\-:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=236pt]{class_ox_1_1_calculator_t2__inherit__graph}
\end{center}
\end{figure}


Collaboration diagram for Ox\-:\-:Calculator\-T2$<$ Measure\-Type $>$\-:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=236pt]{class_ox_1_1_calculator_t2__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
virtual int \hyperlink{class_ox_1_1_calculator_t2_a56e2bcb27465a83dd1a1150b7fe419c8}{prepare\-To\-Calculate} ()
\item 
virtual int \hyperlink{class_ox_1_1_calculator_t2_a8afe4974f3253edea4386a87695607ae}{calculate} ()
\item 
Measure\-Type \hyperlink{class_ox_1_1_calculator_t2_ace5f0515839bdffffb3d60e4536167b6}{calculate\-R2\-Abs\-From\-Model} (int n\-Samples, const Measure\-Type $\ast$time, const Measure\-Type $\ast$signal, const Measure\-Type $\ast$parameters)
\item 
const Measure\-Type $\ast$ \hyperlink{class_ox_1_1_calculator_t2_a1f43cfb6a385e6eeb2ff8fe167ab347d}{get\-Echo\-Times} () const 
\item 
\hyperlink{class_ox_1_1_calculator_t2_a9d0d9d252c322a6db51693ef42c0bed7}{Calculator\-T2} ()
\item 
virtual \hyperlink{class_ox_1_1_calculator_t2_a0a8e02ccb647bb1faf00dbcd4f61124c}{$\sim$\-Calculator\-T2} ()
\item 
virtual \hyperlink{class_ox_1_1_calculator}{Calculator}$<$ Measure\-Type $>$ $\ast$ \hyperlink{class_ox_1_1_calculator_t2_aaec3b1e6254b67b309c9beedb54ad9e7}{new\-By\-Cloning} ()
\end{DoxyCompactItemize}
\subsection*{Additional Inherited Members}


\subsection{Detailed Description}
\subsubsection*{template$<$typename Measure\-Type$>$class Ox\-::\-Calculator\-T2$<$ Measure\-Type $>$}


\begin{DoxyTemplParams}{Template Parameters}
{\em Measure\-Type} & \\
\hline
\end{DoxyTemplParams}


\subsection{Constructor \& Destructor Documentation}
\hypertarget{class_ox_1_1_calculator_t2_a9d0d9d252c322a6db51693ef42c0bed7}{\index{Ox\-::\-Calculator\-T2@{Ox\-::\-Calculator\-T2}!Calculator\-T2@{Calculator\-T2}}
\index{Calculator\-T2@{Calculator\-T2}!Ox::CalculatorT2@{Ox\-::\-Calculator\-T2}}
\subsubsection[{Calculator\-T2}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Measure\-Type$>$ {\bf Ox\-::\-Calculator\-T2}$<$ Measure\-Type $>$\-::{\bf Calculator\-T2} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [inline]}}}\label{class_ox_1_1_calculator_t2_a9d0d9d252c322a6db51693ef42c0bed7}
constructor \hypertarget{class_ox_1_1_calculator_t2_a0a8e02ccb647bb1faf00dbcd4f61124c}{\index{Ox\-::\-Calculator\-T2@{Ox\-::\-Calculator\-T2}!$\sim$\-Calculator\-T2@{$\sim$\-Calculator\-T2}}
\index{$\sim$\-Calculator\-T2@{$\sim$\-Calculator\-T2}!Ox::CalculatorT2@{Ox\-::\-Calculator\-T2}}
\subsubsection[{$\sim$\-Calculator\-T2}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Measure\-Type$>$ virtual {\bf Ox\-::\-Calculator\-T2}$<$ Measure\-Type $>$\-::$\sim${\bf Calculator\-T2} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}}\label{class_ox_1_1_calculator_t2_a0a8e02ccb647bb1faf00dbcd4f61124c}
destructor 

\subsection{Member Function Documentation}
\hypertarget{class_ox_1_1_calculator_t2_a8afe4974f3253edea4386a87695607ae}{\index{Ox\-::\-Calculator\-T2@{Ox\-::\-Calculator\-T2}!calculate@{calculate}}
\index{calculate@{calculate}!Ox::CalculatorT2@{Ox\-::\-Calculator\-T2}}
\subsubsection[{calculate}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Measure\-Type $>$ int {\bf Ox\-::\-Calculator\-T2}$<$ Measure\-Type $>$\-::calculate (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [virtual]}}}\label{class_ox_1_1_calculator_t2_a8afe4974f3253edea4386a87695607ae}
calling calculate\-Molli(int n\-Samples, const Measure\-Type$\ast$ inv\-Times, Measure\-Type$\ast$ signal, Measure\-Type$\ast$ signs) \begin{DoxyReturn}{Returns}
success/failure 
\end{DoxyReturn}


Implements \hyperlink{class_ox_1_1_calculator_a9638894f2ec526b68f46f02122bae0c3}{Ox\-::\-Calculator$<$ Measure\-Type $>$}.

\hypertarget{class_ox_1_1_calculator_t2_ace5f0515839bdffffb3d60e4536167b6}{\index{Ox\-::\-Calculator\-T2@{Ox\-::\-Calculator\-T2}!calculate\-R2\-Abs\-From\-Model@{calculate\-R2\-Abs\-From\-Model}}
\index{calculate\-R2\-Abs\-From\-Model@{calculate\-R2\-Abs\-From\-Model}!Ox::CalculatorT2@{Ox\-::\-Calculator\-T2}}
\subsubsection[{calculate\-R2\-Abs\-From\-Model}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Measure\-Type $>$ Measure\-Type {\bf Ox\-::\-Calculator\-T2}$<$ Measure\-Type $>$\-::calculate\-R2\-Abs\-From\-Model (
\begin{DoxyParamCaption}
\item[{int}]{n\-Samples, }
\item[{const Measure\-Type $\ast$}]{time, }
\item[{const Measure\-Type $\ast$}]{signal, }
\item[{const Measure\-Type $\ast$}]{parameters}
\end{DoxyParamCaption}
)}}\label{class_ox_1_1_calculator_t2_ace5f0515839bdffffb3d60e4536167b6}
Calculate goodness of fit map 
\begin{DoxyParams}{Parameters}
{\em n\-Samples} & \\
\hline
{\em inv\-Times} & \\
\hline
{\em signal} & \\
\hline
{\em parameters} & \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}

\end{DoxyReturn}
\hypertarget{class_ox_1_1_calculator_t2_a1f43cfb6a385e6eeb2ff8fe167ab347d}{\index{Ox\-::\-Calculator\-T2@{Ox\-::\-Calculator\-T2}!get\-Echo\-Times@{get\-Echo\-Times}}
\index{get\-Echo\-Times@{get\-Echo\-Times}!Ox::CalculatorT2@{Ox\-::\-Calculator\-T2}}
\subsubsection[{get\-Echo\-Times}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Measure\-Type $>$ const Measure\-Type $\ast$ {\bf Ox\-::\-Calculator\-T2}$<$ Measure\-Type $>$\-::get\-Echo\-Times (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [virtual]}}}\label{class_ox_1_1_calculator_t2_a1f43cfb6a385e6eeb2ff8fe167ab347d}
/throw exception if \-\_\-\-Echo\-Times == 0 \begin{DoxyReturn}{Returns}

\end{DoxyReturn}


Reimplemented from \hyperlink{class_ox_1_1_calculator}{Ox\-::\-Calculator$<$ Measure\-Type $>$}.

\hypertarget{class_ox_1_1_calculator_t2_aaec3b1e6254b67b309c9beedb54ad9e7}{\index{Ox\-::\-Calculator\-T2@{Ox\-::\-Calculator\-T2}!new\-By\-Cloning@{new\-By\-Cloning}}
\index{new\-By\-Cloning@{new\-By\-Cloning}!Ox::CalculatorT2@{Ox\-::\-Calculator\-T2}}
\subsubsection[{new\-By\-Cloning}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Measure\-Type$>$ virtual {\bf Calculator}$<$Measure\-Type$>$$\ast$ {\bf Ox\-::\-Calculator\-T2}$<$ Measure\-Type $>$\-::new\-By\-Cloning (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}}\label{class_ox_1_1_calculator_t2_aaec3b1e6254b67b309c9beedb54ad9e7}
cloning \begin{DoxyReturn}{Returns}

\end{DoxyReturn}


Implements \hyperlink{class_ox_1_1_calculator_aaec48f39f9b0ea1b622485cf25fba484}{Ox\-::\-Calculator$<$ Measure\-Type $>$}.

\hypertarget{class_ox_1_1_calculator_t2_a56e2bcb27465a83dd1a1150b7fe419c8}{\index{Ox\-::\-Calculator\-T2@{Ox\-::\-Calculator\-T2}!prepare\-To\-Calculate@{prepare\-To\-Calculate}}
\index{prepare\-To\-Calculate@{prepare\-To\-Calculate}!Ox::CalculatorT2@{Ox\-::\-Calculator\-T2}}
\subsubsection[{prepare\-To\-Calculate}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Measure\-Type $>$ int {\bf Ox\-::\-Calculator\-T2}$<$ Measure\-Type $>$\-::prepare\-To\-Calculate (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [virtual]}}}\label{class_ox_1_1_calculator_t2_a56e2bcb27465a83dd1a1150b7fe419c8}
do all the checks and prepare to do the calculation, for example calc signal/signs and \-\_\-\-T\-R\-Raverage\-H\-B \begin{DoxyReturn}{Returns}
success/failure 
\end{DoxyReturn}


Implements \hyperlink{class_ox_1_1_calculator_a01267c4e842b35f7eacaa9aacdd7e766}{Ox\-::\-Calculator$<$ Measure\-Type $>$}.



The documentation for this class was generated from the following files\-:\begin{DoxyCompactItemize}
\item 
lib/\hyperlink{_ox_calculator_t2_8h}{Ox\-Calculator\-T2.\-h}\item 
lib/\hyperlink{_ox_calculator_t2_8hxx}{Ox\-Calculator\-T2.\-hxx}\end{DoxyCompactItemize}
back to top