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_t1_molli.tex
\hypertarget{class_ox_1_1_calculator_t1_molli}{\section{Ox\-:\-:Calculator\-T1\-Molli$<$ Measure\-Type $>$ Class Template Reference}
\label{class_ox_1_1_calculator_t1_molli}\index{Ox\-::\-Calculator\-T1\-Molli$<$ Measure\-Type $>$@{Ox\-::\-Calculator\-T1\-Molli$<$ Measure\-Type $>$}}
}


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



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


Collaboration diagram for Ox\-:\-:Calculator\-T1\-Molli$<$ Measure\-Type $>$\-:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=236pt]{class_ox_1_1_calculator_t1_molli__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
virtual int \hyperlink{class_ox_1_1_calculator_t1_molli_a6f15bc9c026305248c927d62748903bf}{calculate} ()
\item 
virtual int \hyperlink{class_ox_1_1_calculator_t1_molli_a591ec9658fb5a3e4f48715057cf62b38}{prepare\-To\-Calculate} ()
\item 
virtual std\-::map$<$ std\-::string, \\*
Measure\-Type $>$ \hyperlink{class_ox_1_1_calculator_t1_molli_ac275f14715caf983839e13f89a87e8d1}{calculate\-Molli} (int n\-Samples, const Measure\-Type $\ast$inv\-Times, Measure\-Type $\ast$signal, Measure\-Type $\ast$signs)
\item 
Measure\-Type \hyperlink{class_ox_1_1_calculator_t1_molli_a9c9238dd8a96e06d3e0a96810377b90b}{calculate\-R2\-Abs\-From\-Model} (int n\-Samples, const Measure\-Type $\ast$inv\-Times, const Measure\-Type $\ast$signal, const Measure\-Type $\ast$parameters)
\item 
int \hyperlink{class_ox_1_1_calculator_t1_molli_a030582bca754a7b81febfae53fe0c10c}{calculate\-Covariance\-Matrix} (const Measure\-Type $\ast$parameters, Measure\-Type $\ast$covariance\-Matrix)
\item 
int \hyperlink{class_ox_1_1_calculator_t1_molli_aec374fc512aa3b109138f0c16c53a171}{calculate\-Inv\-Covariance\-Matrix} (const Measure\-Type $\ast$inv\-Times, const Measure\-Type $\ast$residuals, const Measure\-Type $\ast$parameters, Measure\-Type $\ast$inv\-Covariance\-Matrix)
\item 
bool \hyperlink{class_ox_1_1_calculator_t1_molli_a06d8579492ee063b129b489e638333be}{get\-Do\-Calculate\-S\-D\-Map} () const 
\item 
const Measure\-Type $\ast$ \hyperlink{class_ox_1_1_calculator_t1_molli_af0ec071b9742038460f2987d24182030}{get\-Inv\-Times} () const 
\item 
void \hyperlink{class_ox_1_1_calculator_t1_molli_a65a51dcadaafdefc576201de535f8810}{set\-Do\-Calculate\-S\-D\-Map} (bool \-\_\-\-Do\-Calculate\-S\-D\-Map)
\item 
\hyperlink{class_ox_1_1_calculator_t1_molli_ab1892de078822ea106fcaebcf81047be}{Calculator\-T1\-Molli} ()
\item 
virtual \hyperlink{class_ox_1_1_calculator}{Calculator}$<$ Measure\-Type $>$ $\ast$ \hyperlink{class_ox_1_1_calculator_t1_molli_a2a924ff09d446b51542dc246a6a04bd3}{new\-By\-Cloning} ()
\end{DoxyCompactItemize}
\subsection*{Protected Attributes}
\begin{DoxyCompactItemize}
\item 
\hypertarget{class_ox_1_1_calculator_t1_molli_adb4f50cdf9dabf4890b4d28194d0522b}{double {\bfseries Max\-T\-I\-For\-Sign\-Invert}}\label{class_ox_1_1_calculator_t1_molli_adb4f50cdf9dabf4890b4d28194d0522b}

\item 
\hypertarget{class_ox_1_1_calculator_t1_molli_adbe23b503f5695ff35734d2c20972277}{bool {\bfseries \-\_\-\-Do\-Calculate\-S\-D\-Map}}\label{class_ox_1_1_calculator_t1_molli_adbe23b503f5695ff35734d2c20972277}

\end{DoxyCompactItemize}
\subsection*{Static Protected Attributes}
\begin{DoxyCompactItemize}
\item 
\hypertarget{class_ox_1_1_calculator_t1_molli_a92c26e9c23fca6757de6e21b6a9ea7cb}{static const int {\bfseries M\-A\-X\-\_\-\-T1\-\_\-\-T\-R\-E\-S\-H\-O\-L\-D} = 4000}\label{class_ox_1_1_calculator_t1_molli_a92c26e9c23fca6757de6e21b6a9ea7cb}

\end{DoxyCompactItemize}


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


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


\subsection{Constructor \& Destructor Documentation}
\hypertarget{class_ox_1_1_calculator_t1_molli_ab1892de078822ea106fcaebcf81047be}{\index{Ox\-::\-Calculator\-T1\-Molli@{Ox\-::\-Calculator\-T1\-Molli}!Calculator\-T1\-Molli@{Calculator\-T1\-Molli}}
\index{Calculator\-T1\-Molli@{Calculator\-T1\-Molli}!Ox::CalculatorT1Molli@{Ox\-::\-Calculator\-T1\-Molli}}
\subsubsection[{Calculator\-T1\-Molli}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Measure\-Type$>$ {\bf Ox\-::\-Calculator\-T1\-Molli}$<$ Measure\-Type $>$\-::{\bf Calculator\-T1\-Molli} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [inline]}}}\label{class_ox_1_1_calculator_t1_molli_ab1892de078822ea106fcaebcf81047be}
constructor 

\subsection{Member Function Documentation}
\hypertarget{class_ox_1_1_calculator_t1_molli_a6f15bc9c026305248c927d62748903bf}{\index{Ox\-::\-Calculator\-T1\-Molli@{Ox\-::\-Calculator\-T1\-Molli}!calculate@{calculate}}
\index{calculate@{calculate}!Ox::CalculatorT1Molli@{Ox\-::\-Calculator\-T1\-Molli}}
\subsubsection[{calculate}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Measure\-Type $>$ int {\bf Ox\-::\-Calculator\-T1\-Molli}$<$ Measure\-Type $>$\-::calculate (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [virtual]}}}\label{class_ox_1_1_calculator_t1_molli_a6f15bc9c026305248c927d62748903bf}
calling \hyperlink{class_ox_1_1_calculator_t1_molli_ac275f14715caf983839e13f89a87e8d1}{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 $>$}.



Reimplemented in \hyperlink{class_ox_1_1_calculator_t1_shmolli_ac689ebbf27f95f6fa2559cc13a824db0}{Ox\-::\-Calculator\-T1\-Shmolli$<$ Measure\-Type $>$}.

\hypertarget{class_ox_1_1_calculator_t1_molli_a030582bca754a7b81febfae53fe0c10c}{\index{Ox\-::\-Calculator\-T1\-Molli@{Ox\-::\-Calculator\-T1\-Molli}!calculate\-Covariance\-Matrix@{calculate\-Covariance\-Matrix}}
\index{calculate\-Covariance\-Matrix@{calculate\-Covariance\-Matrix}!Ox::CalculatorT1Molli@{Ox\-::\-Calculator\-T1\-Molli}}
\subsubsection[{calculate\-Covariance\-Matrix}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Measure\-Type $>$ int {\bf Ox\-::\-Calculator\-T1\-Molli}$<$ Measure\-Type $>$\-::calculate\-Covariance\-Matrix (
\begin{DoxyParamCaption}
\item[{const Measure\-Type $\ast$}]{parameters, }
\item[{Measure\-Type $\ast$}]{covariance\-Matrix}
\end{DoxyParamCaption}
)}}\label{class_ox_1_1_calculator_t1_molli_a030582bca754a7b81febfae53fe0c10c}
calculate covariance matrix needed for S\-D estimation 
\begin{DoxyParams}{Parameters}
{\em parameters} & \\
\hline
{\em covariance\-Matrix} & \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}

\end{DoxyReturn}
\hypertarget{class_ox_1_1_calculator_t1_molli_aec374fc512aa3b109138f0c16c53a171}{\index{Ox\-::\-Calculator\-T1\-Molli@{Ox\-::\-Calculator\-T1\-Molli}!calculate\-Inv\-Covariance\-Matrix@{calculate\-Inv\-Covariance\-Matrix}}
\index{calculate\-Inv\-Covariance\-Matrix@{calculate\-Inv\-Covariance\-Matrix}!Ox::CalculatorT1Molli@{Ox\-::\-Calculator\-T1\-Molli}}
\subsubsection[{calculate\-Inv\-Covariance\-Matrix}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Measure\-Type $>$ int {\bf Ox\-::\-Calculator\-T1\-Molli}$<$ Measure\-Type $>$\-::calculate\-Inv\-Covariance\-Matrix (
\begin{DoxyParamCaption}
\item[{const Measure\-Type $\ast$}]{inv\-Times, }
\item[{const Measure\-Type $\ast$}]{residuals, }
\item[{const Measure\-Type $\ast$}]{parameters, }
\item[{Measure\-Type $\ast$}]{inv\-Covariance\-Matrix}
\end{DoxyParamCaption}
)}}\label{class_ox_1_1_calculator_t1_molli_aec374fc512aa3b109138f0c16c53a171}
calculate inverse covariance matrix needed for S\-D estimation 
\begin{DoxyParams}{Parameters}
{\em inv\-Times} & \\
\hline
{\em residuals} & \\
\hline
{\em parameters} & \\
\hline
{\em inv\-Covariance\-Matrix} & \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}

\end{DoxyReturn}
\hypertarget{class_ox_1_1_calculator_t1_molli_ac275f14715caf983839e13f89a87e8d1}{\index{Ox\-::\-Calculator\-T1\-Molli@{Ox\-::\-Calculator\-T1\-Molli}!calculate\-Molli@{calculate\-Molli}}
\index{calculate\-Molli@{calculate\-Molli}!Ox::CalculatorT1Molli@{Ox\-::\-Calculator\-T1\-Molli}}
\subsubsection[{calculate\-Molli}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Measure\-Type $>$ std\-::map$<$ std\-::string, Measure\-Type $>$ {\bf Ox\-::\-Calculator\-T1\-Molli}$<$ Measure\-Type $>$\-::calculate\-Molli (
\begin{DoxyParamCaption}
\item[{int}]{n\-Samples, }
\item[{const Measure\-Type $\ast$}]{inv\-Times, }
\item[{Measure\-Type $\ast$}]{signal, }
\item[{Measure\-Type $\ast$}]{signs}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [virtual]}}}\label{class_ox_1_1_calculator_t1_molli_ac275f14715caf983839e13f89a87e8d1}
The most important function of this class It has all the input parameters so that I can call it from the shmolli class 
\begin{DoxyParams}{Parameters}
{\em n\-Samples} & \\
\hline
{\em inv\-Times} & \\
\hline
{\em signal} & \\
\hline
{\em signs} & \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
results 
\end{DoxyReturn}
\hypertarget{class_ox_1_1_calculator_t1_molli_a9c9238dd8a96e06d3e0a96810377b90b}{\index{Ox\-::\-Calculator\-T1\-Molli@{Ox\-::\-Calculator\-T1\-Molli}!calculate\-R2\-Abs\-From\-Model@{calculate\-R2\-Abs\-From\-Model}}
\index{calculate\-R2\-Abs\-From\-Model@{calculate\-R2\-Abs\-From\-Model}!Ox::CalculatorT1Molli@{Ox\-::\-Calculator\-T1\-Molli}}
\subsubsection[{calculate\-R2\-Abs\-From\-Model}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Measure\-Type $>$ Measure\-Type {\bf Ox\-::\-Calculator\-T1\-Molli}$<$ Measure\-Type $>$\-::calculate\-R2\-Abs\-From\-Model (
\begin{DoxyParamCaption}
\item[{int}]{n\-Samples, }
\item[{const Measure\-Type $\ast$}]{inv\-Times, }
\item[{const Measure\-Type $\ast$}]{signal, }
\item[{const Measure\-Type $\ast$}]{parameters}
\end{DoxyParamCaption}
)}}\label{class_ox_1_1_calculator_t1_molli_a9c9238dd8a96e06d3e0a96810377b90b}
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_t1_molli_a06d8579492ee063b129b489e638333be}{\index{Ox\-::\-Calculator\-T1\-Molli@{Ox\-::\-Calculator\-T1\-Molli}!get\-Do\-Calculate\-S\-D\-Map@{get\-Do\-Calculate\-S\-D\-Map}}
\index{get\-Do\-Calculate\-S\-D\-Map@{get\-Do\-Calculate\-S\-D\-Map}!Ox::CalculatorT1Molli@{Ox\-::\-Calculator\-T1\-Molli}}
\subsubsection[{get\-Do\-Calculate\-S\-D\-Map}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Measure\-Type $>$ bool {\bf Ox\-::\-Calculator\-T1\-Molli}$<$ Measure\-Type $>$\-::get\-Do\-Calculate\-S\-D\-Map (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const}}\label{class_ox_1_1_calculator_t1_molli_a06d8579492ee063b129b489e638333be}
\begin{DoxyReturn}{Returns}

\end{DoxyReturn}
\hypertarget{class_ox_1_1_calculator_t1_molli_af0ec071b9742038460f2987d24182030}{\index{Ox\-::\-Calculator\-T1\-Molli@{Ox\-::\-Calculator\-T1\-Molli}!get\-Inv\-Times@{get\-Inv\-Times}}
\index{get\-Inv\-Times@{get\-Inv\-Times}!Ox::CalculatorT1Molli@{Ox\-::\-Calculator\-T1\-Molli}}
\subsubsection[{get\-Inv\-Times}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Measure\-Type $>$ const Measure\-Type $\ast$ {\bf Ox\-::\-Calculator\-T1\-Molli}$<$ Measure\-Type $>$\-::get\-Inv\-Times (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [virtual]}}}\label{class_ox_1_1_calculator_t1_molli_af0ec071b9742038460f2987d24182030}
/throw exception if \-\_\-\-Inv\-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_t1_molli_a2a924ff09d446b51542dc246a6a04bd3}{\index{Ox\-::\-Calculator\-T1\-Molli@{Ox\-::\-Calculator\-T1\-Molli}!new\-By\-Cloning@{new\-By\-Cloning}}
\index{new\-By\-Cloning@{new\-By\-Cloning}!Ox::CalculatorT1Molli@{Ox\-::\-Calculator\-T1\-Molli}}
\subsubsection[{new\-By\-Cloning}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Measure\-Type$>$ virtual {\bf Calculator}$<$Measure\-Type$>$$\ast$ {\bf Ox\-::\-Calculator\-T1\-Molli}$<$ Measure\-Type $>$\-::new\-By\-Cloning (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}}\label{class_ox_1_1_calculator_t1_molli_a2a924ff09d446b51542dc246a6a04bd3}
cloning \begin{DoxyReturn}{Returns}

\end{DoxyReturn}


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



Reimplemented in \hyperlink{class_ox_1_1_calculator_t1_shmolli_a1e4e7b6f59b6a0ca4cbe3ed60452b8e9}{Ox\-::\-Calculator\-T1\-Shmolli$<$ Measure\-Type $>$}.

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

\end{DoxyReturn}


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



Reimplemented in \hyperlink{class_ox_1_1_calculator_t1_shmolli_a6464c63f20ecd9de842d722e5d9d2866}{Ox\-::\-Calculator\-T1\-Shmolli$<$ Measure\-Type $>$}.

\hypertarget{class_ox_1_1_calculator_t1_molli_a65a51dcadaafdefc576201de535f8810}{\index{Ox\-::\-Calculator\-T1\-Molli@{Ox\-::\-Calculator\-T1\-Molli}!set\-Do\-Calculate\-S\-D\-Map@{set\-Do\-Calculate\-S\-D\-Map}}
\index{set\-Do\-Calculate\-S\-D\-Map@{set\-Do\-Calculate\-S\-D\-Map}!Ox::CalculatorT1Molli@{Ox\-::\-Calculator\-T1\-Molli}}
\subsubsection[{set\-Do\-Calculate\-S\-D\-Map}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Measure\-Type $>$ void {\bf Ox\-::\-Calculator\-T1\-Molli}$<$ Measure\-Type $>$\-::set\-Do\-Calculate\-S\-D\-Map (
\begin{DoxyParamCaption}
\item[{bool}]{\-\_\-\-Do\-Calculate\-S\-D\-Map}
\end{DoxyParamCaption}
)}}\label{class_ox_1_1_calculator_t1_molli_a65a51dcadaafdefc576201de535f8810}

\begin{DoxyParams}{Parameters}
{\em \-\_\-\-Do\-Calculate\-S\-D\-Map} & \\
\hline
\end{DoxyParams}


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