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


Inheritance diagram for Ox\-:\-:Calculator$<$ Measure\-Type $>$\-:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{class_ox_1_1_calculator__inherit__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
virtual int \hyperlink{class_ox_1_1_calculator_a9638894f2ec526b68f46f02122bae0c3}{calculate} ()=0
\item 
virtual int \hyperlink{class_ox_1_1_calculator_a01267c4e842b35f7eacaa9aacdd7e766}{prepare\-To\-Calculate} ()=0
\item 
\hypertarget{class_ox_1_1_calculator_a4b04d48cb906764aa235c387b631dca4}{virtual std\-::map$<$ std\-::string, \\*
Measure\-Type $>$ {\bfseries get\-Results} () const }\label{class_ox_1_1_calculator_a4b04d48cb906764aa235c387b631dca4}

\item 
virtual \hyperlink{class_ox_1_1_model}{Model}$<$ Measure\-Type $>$ $\ast$ \hyperlink{class_ox_1_1_calculator_a5589bf7b93a2d1e106532c35745f4329}{get\-Model} () const 
\item 
virtual \hyperlink{class_ox_1_1_fitter}{Fitter}$<$ Measure\-Type $>$ $\ast$ \hyperlink{class_ox_1_1_calculator_af648a7c6c957c9f51532f15c93147d62}{get\-Fitter} () const 
\item 
\hypertarget{class_ox_1_1_calculator_ad43fbbb3e888e1fa73f95d872a963bac}{virtual \hyperlink{class_ox_1_1_start_point_calculator}{Start\-Point\-Calculator}\\*
$<$ Measure\-Type $>$ $\ast$ {\bfseries get\-Start\-Point\-Calculator} () const }\label{class_ox_1_1_calculator_ad43fbbb3e888e1fa73f95d872a963bac}

\item 
\hypertarget{class_ox_1_1_calculator_a4ee7fdeb4009d2e433ef6a566768eb25}{virtual \hyperlink{class_ox_1_1_sign_calculator}{Sign\-Calculator}\\*
$<$ Measure\-Type $>$ $\ast$ {\bfseries get\-Sign\-Calculator} () const }\label{class_ox_1_1_calculator_a4ee7fdeb4009d2e433ef6a566768eb25}

\item 
\hypertarget{class_ox_1_1_calculator_ab844b24dfedd27d52466203ec0c913fa}{virtual const Measure\-Type $\ast$ {\bfseries get\-Inv\-Times} () const }\label{class_ox_1_1_calculator_ab844b24dfedd27d52466203ec0c913fa}

\item 
\hypertarget{class_ox_1_1_calculator_a6a46eb89732759c2544398f9a694f5c7}{virtual const Measure\-Type $\ast$ {\bfseries get\-Echo\-Times} () const }\label{class_ox_1_1_calculator_a6a46eb89732759c2544398f9a694f5c7}

\item 
\hypertarget{class_ox_1_1_calculator_a2e708f33e09e1e08345bea3024e99ec1}{virtual const Measure\-Type $\ast$ {\bfseries get\-Rep\-Times} () const }\label{class_ox_1_1_calculator_a2e708f33e09e1e08345bea3024e99ec1}

\item 
\hypertarget{class_ox_1_1_calculator_a6698aa9563e9c7d251d4ff73810dd12c}{virtual const Measure\-Type $\ast$ {\bfseries get\-Rel\-Acq\-Times} () const }\label{class_ox_1_1_calculator_a6698aa9563e9c7d251d4ff73810dd12c}

\item 
virtual const Measure\-Type $\ast$ \hyperlink{class_ox_1_1_calculator_ad9a623ee2bfc77732fa891c47c087aa9}{get\-Sig\-Mag} () const 
\item 
virtual const Measure\-Type $\ast$ \hyperlink{class_ox_1_1_calculator_acf6021ef084c24636a344a12627caff5}{get\-Sig\-Pha} () const 
\item 
\hypertarget{class_ox_1_1_calculator_abff843bf55042e78ce613caceef8e6a3}{virtual const Measure\-Type $\ast$ {\bfseries get\-Noise} () const }\label{class_ox_1_1_calculator_abff843bf55042e78ce613caceef8e6a3}

\item 
\hypertarget{class_ox_1_1_calculator_a10c8a3e18079c680cbdf54366d5dfed0}{virtual Measure\-Type $\ast$ {\bfseries get\-Signal} () const }\label{class_ox_1_1_calculator_a10c8a3e18079c680cbdf54366d5dfed0}

\item 
\hypertarget{class_ox_1_1_calculator_ac05783e37c8e6f3f457778ebbfa2e6a5}{virtual Measure\-Type $\ast$ {\bfseries get\-Signs} () const }\label{class_ox_1_1_calculator_ac05783e37c8e6f3f457778ebbfa2e6a5}

\item 
\hypertarget{class_ox_1_1_calculator_aebf55897e1f11cdd3afec75d24c8ea13}{virtual Measure\-Type $\ast$ {\bfseries get\-Start\-Point} ()}\label{class_ox_1_1_calculator_aebf55897e1f11cdd3afec75d24c8ea13}

\item 
\hypertarget{class_ox_1_1_calculator_a8232921e636ebc91a102bc2e95596a7b}{virtual Measure\-Type {\bfseries get\-Mean\-Cut\-Off} () const }\label{class_ox_1_1_calculator_a8232921e636ebc91a102bc2e95596a7b}

\item 
virtual int \hyperlink{class_ox_1_1_calculator_a5e5b6e1af84b8713c833a25d7c0dd90d}{get\-N\-Samples} () const 
\item 
virtual int \hyperlink{class_ox_1_1_calculator_a3a4266dedca7e02707e732a312b85048}{get\-N\-Dims} () const 
\item 
\hypertarget{class_ox_1_1_calculator_ab814b8876ab6ddd7585f73dd23024624}{virtual void {\bfseries set\-Model} (\hyperlink{class_ox_1_1_model}{Model}$<$ Measure\-Type $>$ $\ast$\-\_\-\-Model)}\label{class_ox_1_1_calculator_ab814b8876ab6ddd7585f73dd23024624}

\item 
\hypertarget{class_ox_1_1_calculator_a65d901e63b2f59b77a7dea82eaaa8215}{virtual void {\bfseries set\-Fitter} (\hyperlink{class_ox_1_1_fitter}{Fitter}$<$ Measure\-Type $>$ $\ast$\-\_\-\-Fitter)}\label{class_ox_1_1_calculator_a65d901e63b2f59b77a7dea82eaaa8215}

\item 
\hypertarget{class_ox_1_1_calculator_a9b29545ec9a0e911217f496f7d539471}{virtual void {\bfseries set\-Sign\-Calculator} (\hyperlink{class_ox_1_1_sign_calculator}{Sign\-Calculator}$<$ Measure\-Type $>$ $\ast$\-\_\-\-Sign\-Calculator)}\label{class_ox_1_1_calculator_a9b29545ec9a0e911217f496f7d539471}

\item 
\hypertarget{class_ox_1_1_calculator_a1ea380bc76e9cd19f0a04254ae167230}{virtual void {\bfseries set\-Start\-Point\-Calculator} (\hyperlink{class_ox_1_1_start_point_calculator}{Start\-Point\-Calculator}$<$ Measure\-Type $>$ $\ast$\-\_\-\-Start\-Point\-Calculator)}\label{class_ox_1_1_calculator_a1ea380bc76e9cd19f0a04254ae167230}

\item 
\hypertarget{class_ox_1_1_calculator_a1dcb241d551a06436108a9f4bf916ece}{virtual void {\bfseries set\-Inv\-Times} (const Measure\-Type $\ast$\-\_\-\-Inv\-Times)}\label{class_ox_1_1_calculator_a1dcb241d551a06436108a9f4bf916ece}

\item 
\hypertarget{class_ox_1_1_calculator_aaf50e9d3fae8e95ff981bf15e17bba28}{virtual void {\bfseries set\-Echo\-Times} (const Measure\-Type $\ast$\-\_\-\-Echo\-Times)}\label{class_ox_1_1_calculator_aaf50e9d3fae8e95ff981bf15e17bba28}

\item 
\hypertarget{class_ox_1_1_calculator_a51fb95a1a68b1e14b659761c1f64aaab}{virtual void {\bfseries set\-Sig\-Mag} (const Measure\-Type $\ast$\-\_\-\-Sig\-Mag)}\label{class_ox_1_1_calculator_a51fb95a1a68b1e14b659761c1f64aaab}

\item 
\hypertarget{class_ox_1_1_calculator_a7b753dac0897ee4a5cb9c4d7a21d0926}{virtual void {\bfseries set\-Sig\-Pha} (const Measure\-Type $\ast$\-\_\-\-Sig\-Pha)}\label{class_ox_1_1_calculator_a7b753dac0897ee4a5cb9c4d7a21d0926}

\item 
\hypertarget{class_ox_1_1_calculator_ac78f71339011991131c3b142ae1a9f45}{virtual void {\bfseries set\-Noise} (const Measure\-Type $\ast$\-\_\-\-Noise)}\label{class_ox_1_1_calculator_ac78f71339011991131c3b142ae1a9f45}

\item 
\hypertarget{class_ox_1_1_calculator_ad945e3f4dd3405c940bc8a22ea3f3ee9}{virtual void {\bfseries set\-Mean\-Cut\-Off} (Measure\-Type \-\_\-\-Mean\-Cut\-Off)}\label{class_ox_1_1_calculator_ad945e3f4dd3405c940bc8a22ea3f3ee9}

\item 
virtual void \hyperlink{class_ox_1_1_calculator_a1d0d07b7840883449168448983d43289}{set\-N\-Samples} (int \-\_\-n\-Samples)
\item 
virtual void \hyperlink{class_ox_1_1_calculator_a40c854c0d75685ecc1da531f7400e3b1}{set\-N\-Dims} (int \-\_\-n\-Dims)
\item 
\hypertarget{class_ox_1_1_calculator_a938a4bb0d2bc586bfb6982df28befbbf}{void \hyperlink{class_ox_1_1_calculator_a938a4bb0d2bc586bfb6982df28befbbf}{disp} ()}\label{class_ox_1_1_calculator_a938a4bb0d2bc586bfb6982df28befbbf}

\begin{DoxyCompactList}\small\item\em show me your \hyperlink{class_ox_1_1_model}{Model} \end{DoxyCompactList}\item 
\hypertarget{class_ox_1_1_calculator_acaaddad6379df03cccd825d565c9dd0e}{void \hyperlink{class_ox_1_1_calculator_acaaddad6379df03cccd825d565c9dd0e}{set\-All\-Pointers\-To\-Null} ()}\label{class_ox_1_1_calculator_acaaddad6379df03cccd825d565c9dd0e}

\begin{DoxyCompactList}\small\item\em set all the pointers to zero \end{DoxyCompactList}\item 
\hypertarget{class_ox_1_1_calculator_a4a3762f0c260cb0e34f72e40a7329d27}{\hyperlink{class_ox_1_1_calculator_a4a3762f0c260cb0e34f72e40a7329d27}{Calculator} ()}\label{class_ox_1_1_calculator_a4a3762f0c260cb0e34f72e40a7329d27}

\begin{DoxyCompactList}\small\item\em constructor \end{DoxyCompactList}\item 
\hypertarget{class_ox_1_1_calculator_a600434abcaff13ac70d0d4b06b9df583}{\hyperlink{class_ox_1_1_calculator_a600434abcaff13ac70d0d4b06b9df583}{Calculator} (const \hyperlink{class_ox_1_1_calculator}{Calculator} \&old)}\label{class_ox_1_1_calculator_a600434abcaff13ac70d0d4b06b9df583}

\begin{DoxyCompactList}\small\item\em copy constructor \end{DoxyCompactList}\item 
virtual \hyperlink{class_ox_1_1_calculator}{Calculator}$<$ Measure\-Type $>$ $\ast$ \hyperlink{class_ox_1_1_calculator_aaec48f39f9b0ea1b622485cf25fba484}{new\-By\-Cloning} ()=0
\item 
\hypertarget{class_ox_1_1_calculator_a0e0d0f525a80e54f17ab14e4073d780d}{virtual \hyperlink{class_ox_1_1_calculator_a0e0d0f525a80e54f17ab14e4073d780d}{$\sim$\-Calculator} ()}\label{class_ox_1_1_calculator_a0e0d0f525a80e54f17ab14e4073d780d}

\begin{DoxyCompactList}\small\item\em do not forget about the virtual destructor, see \href{https://stackoverflow.com/questions/461203/when-to-use-virtual-destructors}{\tt https\-://stackoverflow.\-com/questions/461203/when-\/to-\/use-\/virtual-\/destructors} \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Protected Attributes}
\begin{DoxyCompactItemize}
\item 
\hypertarget{class_ox_1_1_calculator_a37dee4f1bb2fcae66c6710a642fe6d7b}{\hyperlink{class_ox_1_1_model}{Model}$<$ Measure\-Type $>$ $\ast$ {\bfseries \-\_\-\-Model}}\label{class_ox_1_1_calculator_a37dee4f1bb2fcae66c6710a642fe6d7b}

\item 
\hypertarget{class_ox_1_1_calculator_ae00ef8e7db2e9eaa86b8649815246bf9}{\hyperlink{class_ox_1_1_fitter}{Fitter}$<$ Measure\-Type $>$ $\ast$ {\bfseries \-\_\-\-Fitter}}\label{class_ox_1_1_calculator_ae00ef8e7db2e9eaa86b8649815246bf9}

\item 
\hypertarget{class_ox_1_1_calculator_a0655f664d37e70e589bb8526175f19bb}{\hyperlink{class_ox_1_1_sign_calculator}{Sign\-Calculator}$<$ Measure\-Type $>$ $\ast$ {\bfseries \-\_\-\-Sign\-Calculator}}\label{class_ox_1_1_calculator_a0655f664d37e70e589bb8526175f19bb}

\item 
\hypertarget{class_ox_1_1_calculator_a8873b376837e41f40e2a9286a9ea5896}{\hyperlink{class_ox_1_1_start_point_calculator}{Start\-Point\-Calculator}\\*
$<$ Measure\-Type $>$ $\ast$ {\bfseries \-\_\-\-Start\-Point\-Calculator}}\label{class_ox_1_1_calculator_a8873b376837e41f40e2a9286a9ea5896}

\item 
\hypertarget{class_ox_1_1_calculator_ab5f694e40a431677359b6933154eebc0}{const Measure\-Type $\ast$ {\bfseries \-\_\-\-Inv\-Times}}\label{class_ox_1_1_calculator_ab5f694e40a431677359b6933154eebc0}

\item 
\hypertarget{class_ox_1_1_calculator_acc5f2033f9e72e394abae75abdb70076}{const Measure\-Type $\ast$ {\bfseries \-\_\-\-Echo\-Times}}\label{class_ox_1_1_calculator_acc5f2033f9e72e394abae75abdb70076}

\item 
\hypertarget{class_ox_1_1_calculator_acaa46125d5a97260020dcb8e880d8ca4}{const Measure\-Type $\ast$ {\bfseries \-\_\-\-Rep\-Times}}\label{class_ox_1_1_calculator_acaa46125d5a97260020dcb8e880d8ca4}

\item 
\hypertarget{class_ox_1_1_calculator_adc51d44af4e1e42ccda6e49efd618d07}{const Measure\-Type $\ast$ {\bfseries \-\_\-\-Rel\-Acq\-Times}}\label{class_ox_1_1_calculator_adc51d44af4e1e42ccda6e49efd618d07}

\item 
\hypertarget{class_ox_1_1_calculator_a88a92cc098cedb71d7ab4472375e1a71}{const Measure\-Type $\ast$ {\bfseries \-\_\-\-Sig\-Mag}}\label{class_ox_1_1_calculator_a88a92cc098cedb71d7ab4472375e1a71}

\item 
\hypertarget{class_ox_1_1_calculator_a369ce1a35879f24950dd23af0e14761c}{const Measure\-Type $\ast$ {\bfseries \-\_\-\-Sig\-Pha}}\label{class_ox_1_1_calculator_a369ce1a35879f24950dd23af0e14761c}

\item 
\hypertarget{class_ox_1_1_calculator_acb769c5cbf95ad5a59ccc1f587c8c421}{const Measure\-Type $\ast$ {\bfseries \-\_\-\-Noise}}\label{class_ox_1_1_calculator_acb769c5cbf95ad5a59ccc1f587c8c421}

\item 
\hypertarget{class_ox_1_1_calculator_a5bccc8796af4025d3f072406d839d3a6}{Measure\-Type $\ast$ {\bfseries \-\_\-\-Signal}}\label{class_ox_1_1_calculator_a5bccc8796af4025d3f072406d839d3a6}

\item 
\hypertarget{class_ox_1_1_calculator_a00fec572df90a97f103992d5857c46c3}{Measure\-Type $\ast$ {\bfseries \-\_\-\-Signs}}\label{class_ox_1_1_calculator_a00fec572df90a97f103992d5857c46c3}

\item 
\hypertarget{class_ox_1_1_calculator_a133c4c58f97fd13ffccbc7bb20bbd5e5}{Measure\-Type $\ast$ {\bfseries \-\_\-\-Start\-Point}}\label{class_ox_1_1_calculator_a133c4c58f97fd13ffccbc7bb20bbd5e5}

\item 
\hypertarget{class_ox_1_1_calculator_a89303af2e5a0bf1f4f8dae5947bfbab0}{int {\bfseries \-\_\-n\-Samples}}\label{class_ox_1_1_calculator_a89303af2e5a0bf1f4f8dae5947bfbab0}

\item 
\hypertarget{class_ox_1_1_calculator_abf7ad737349c2c4f92c25b3a7a02a063}{int {\bfseries \-\_\-n\-Dims}}\label{class_ox_1_1_calculator_abf7ad737349c2c4f92c25b3a7a02a063}

\item 
\hypertarget{class_ox_1_1_calculator_a27f0852e7c77218109b9fc3df8b92b07}{Measure\-Type {\bfseries \-\_\-\-Mean\-Cut\-Off}}\label{class_ox_1_1_calculator_a27f0852e7c77218109b9fc3df8b92b07}

\item 
\hypertarget{class_ox_1_1_calculator_adae260195d2f056224dbae5e9e34288d}{std\-::map$<$ std\-::string, \\*
Measure\-Type $>$ {\bfseries \-\_\-\-Results}}\label{class_ox_1_1_calculator_adae260195d2f056224dbae5e9e34288d}

\end{DoxyCompactItemize}


\subsection{Member Function Documentation}
\hypertarget{class_ox_1_1_calculator_a9638894f2ec526b68f46f02122bae0c3}{\index{Ox\-::\-Calculator@{Ox\-::\-Calculator}!calculate@{calculate}}
\index{calculate@{calculate}!Ox::Calculator@{Ox\-::\-Calculator}}
\subsubsection[{calculate}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Measure\-Type$>$ virtual int {\bf Ox\-::\-Calculator}$<$ Measure\-Type $>$\-::calculate (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [pure virtual]}}}\label{class_ox_1_1_calculator_a9638894f2ec526b68f46f02122bae0c3}
the most important function of this class \begin{DoxyReturn}{Returns}
success/failure 
\end{DoxyReturn}


Implemented in \hyperlink{class_ox_1_1_calculator_t1_shmolli_ac689ebbf27f95f6fa2559cc13a824db0}{Ox\-::\-Calculator\-T1\-Shmolli$<$ Measure\-Type $>$}, \hyperlink{class_ox_1_1_calculator_t2_a8afe4974f3253edea4386a87695607ae}{Ox\-::\-Calculator\-T2$<$ Measure\-Type $>$}, \hyperlink{class_ox_1_1_calculator_t2_truncation_a90077df2125150b62324c83da464b02b}{Ox\-::\-Calculator\-T2\-Truncation$<$ Measure\-Type $>$}, and \hyperlink{class_ox_1_1_calculator_t1_molli_a6f15bc9c026305248c927d62748903bf}{Ox\-::\-Calculator\-T1\-Molli$<$ Measure\-Type $>$}.

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

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

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

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

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

\end{DoxyReturn}
\hypertarget{class_ox_1_1_calculator_acf6021ef084c24636a344a12627caff5}{\index{Ox\-::\-Calculator@{Ox\-::\-Calculator}!get\-Sig\-Pha@{get\-Sig\-Pha}}
\index{get\-Sig\-Pha@{get\-Sig\-Pha}!Ox::Calculator@{Ox\-::\-Calculator}}
\subsubsection[{get\-Sig\-Pha}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Measure\-Type $>$ const Measure\-Type $\ast$ {\bf Ox\-::\-Calculator}$<$ Measure\-Type $>$\-::get\-Sig\-Pha (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [virtual]}}}\label{class_ox_1_1_calculator_acf6021ef084c24636a344a12627caff5}
does not have to be set \begin{DoxyReturn}{Returns}
Sig\-Pha pointer, can be 0 (N\-U\-L\-L) 
\end{DoxyReturn}
\hypertarget{class_ox_1_1_calculator_aaec48f39f9b0ea1b622485cf25fba484}{\index{Ox\-::\-Calculator@{Ox\-::\-Calculator}!new\-By\-Cloning@{new\-By\-Cloning}}
\index{new\-By\-Cloning@{new\-By\-Cloning}!Ox::Calculator@{Ox\-::\-Calculator}}
\subsubsection[{new\-By\-Cloning}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Measure\-Type$>$ virtual {\bf Calculator}$<$Measure\-Type$>$$\ast$ {\bf Ox\-::\-Calculator}$<$ Measure\-Type $>$\-::new\-By\-Cloning (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [pure virtual]}}}\label{class_ox_1_1_calculator_aaec48f39f9b0ea1b622485cf25fba484}
cloning \begin{DoxyReturn}{Returns}

\end{DoxyReturn}


Implemented in \hyperlink{class_ox_1_1_calculator_t1_molli_a2a924ff09d446b51542dc246a6a04bd3}{Ox\-::\-Calculator\-T1\-Molli$<$ Measure\-Type $>$}, \hyperlink{class_ox_1_1_calculator_t2_truncation_a6accdab54ee98182f12707786a461c20}{Ox\-::\-Calculator\-T2\-Truncation$<$ Measure\-Type $>$}, \hyperlink{class_ox_1_1_calculator_t2_aaec3b1e6254b67b309c9beedb54ad9e7}{Ox\-::\-Calculator\-T2$<$ Measure\-Type $>$}, and \hyperlink{class_ox_1_1_calculator_t1_shmolli_a1e4e7b6f59b6a0ca4cbe3ed60452b8e9}{Ox\-::\-Calculator\-T1\-Shmolli$<$ Measure\-Type $>$}.

\hypertarget{class_ox_1_1_calculator_a01267c4e842b35f7eacaa9aacdd7e766}{\index{Ox\-::\-Calculator@{Ox\-::\-Calculator}!prepare\-To\-Calculate@{prepare\-To\-Calculate}}
\index{prepare\-To\-Calculate@{prepare\-To\-Calculate}!Ox::Calculator@{Ox\-::\-Calculator}}
\subsubsection[{prepare\-To\-Calculate}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Measure\-Type$>$ virtual int {\bf Ox\-::\-Calculator}$<$ Measure\-Type $>$\-::prepare\-To\-Calculate (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [pure virtual]}}}\label{class_ox_1_1_calculator_a01267c4e842b35f7eacaa9aacdd7e766}
processing before calculate is called \begin{DoxyReturn}{Returns}
success/failure 
\end{DoxyReturn}


Implemented in \hyperlink{class_ox_1_1_calculator_t1_shmolli_a6464c63f20ecd9de842d722e5d9d2866}{Ox\-::\-Calculator\-T1\-Shmolli$<$ Measure\-Type $>$}, \hyperlink{class_ox_1_1_calculator_t1_molli_a591ec9658fb5a3e4f48715057cf62b38}{Ox\-::\-Calculator\-T1\-Molli$<$ Measure\-Type $>$}, \hyperlink{class_ox_1_1_calculator_t2_a56e2bcb27465a83dd1a1150b7fe419c8}{Ox\-::\-Calculator\-T2$<$ Measure\-Type $>$}, and \hyperlink{class_ox_1_1_calculator_t2_truncation_a87a5d80163f3909658498c341c7c1a7a}{Ox\-::\-Calculator\-T2\-Truncation$<$ Measure\-Type $>$}.

\hypertarget{class_ox_1_1_calculator_a40c854c0d75685ecc1da531f7400e3b1}{\index{Ox\-::\-Calculator@{Ox\-::\-Calculator}!set\-N\-Dims@{set\-N\-Dims}}
\index{set\-N\-Dims@{set\-N\-Dims}!Ox::Calculator@{Ox\-::\-Calculator}}
\subsubsection[{set\-N\-Dims}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Measure\-Type $>$ void {\bf Ox\-::\-Calculator}$<$ Measure\-Type $>$\-::set\-N\-Dims (
\begin{DoxyParamCaption}
\item[{int}]{n\-Dims}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [virtual]}}}\label{class_ox_1_1_calculator_a40c854c0d75685ecc1da531f7400e3b1}
\-\_\-\-Start\-Point is allocated here!!! 
\begin{DoxyParams}{Parameters}
{\em \-\_\-n\-Dims} & \\
\hline
\end{DoxyParams}
\hypertarget{class_ox_1_1_calculator_a1d0d07b7840883449168448983d43289}{\index{Ox\-::\-Calculator@{Ox\-::\-Calculator}!set\-N\-Samples@{set\-N\-Samples}}
\index{set\-N\-Samples@{set\-N\-Samples}!Ox::Calculator@{Ox\-::\-Calculator}}
\subsubsection[{set\-N\-Samples}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Measure\-Type $>$ void {\bf Ox\-::\-Calculator}$<$ Measure\-Type $>$\-::set\-N\-Samples (
\begin{DoxyParamCaption}
\item[{int}]{\-\_\-n\-Samples}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [virtual]}}}\label{class_ox_1_1_calculator_a1d0d07b7840883449168448983d43289}
\-\_\-\-Signal and \-\_\-\-Signs are allocated here!!! 
\begin{DoxyParams}{Parameters}
{\em \-\_\-n\-Samples} & \\
\hline
\end{DoxyParams}


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