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


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



Inheritance diagram for Ox\-:\-:Start\-Point\-Calculator$<$ Measure\-Type $>$\-:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{class_ox_1_1_start_point_calculator__inherit__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
virtual int \hyperlink{class_ox_1_1_start_point_calculator_a9d1132410d68eb16f3f71ec4015c0b2f}{calculate\-Start\-Point} ()=0
\item 
\hypertarget{class_ox_1_1_start_point_calculator_a01bcfb382bec0c4c28ae2bb5783b458c}{const Measure\-Type $\ast$ {\bfseries get\-Input\-Start\-Point} () const }\label{class_ox_1_1_start_point_calculator_a01bcfb382bec0c4c28ae2bb5783b458c}

\item 
\hypertarget{class_ox_1_1_start_point_calculator_a48b39c1d6bb733821f7297593e424728}{Measure\-Type $\ast$ {\bfseries get\-Calculated\-Start\-Point} () const }\label{class_ox_1_1_start_point_calculator_a48b39c1d6bb733821f7297593e424728}

\item 
\hypertarget{class_ox_1_1_start_point_calculator_a75c73487e21a0f4920762c1efc96d573}{int {\bfseries get\-N\-Dims} () const }\label{class_ox_1_1_start_point_calculator_a75c73487e21a0f4920762c1efc96d573}

\item 
\hypertarget{class_ox_1_1_start_point_calculator_ac76047ce4b0d474203cae066471cce61}{virtual void {\bfseries set\-Input\-Start\-Point} (const Measure\-Type $\ast$\-\_\-\-Input\-Start\-Point)}\label{class_ox_1_1_start_point_calculator_ac76047ce4b0d474203cae066471cce61}

\item 
\hypertarget{class_ox_1_1_start_point_calculator_a02b51af6d6019cfc47d04b752ad96c86}{virtual void {\bfseries set\-N\-Dims} (int \-\_\-n\-Dims)}\label{class_ox_1_1_start_point_calculator_a02b51af6d6019cfc47d04b752ad96c86}

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

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

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

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

\item 
\hypertarget{class_ox_1_1_start_point_calculator_aebb0511e802eff920369dec99b6c00fb}{virtual void {\bfseries set\-Calculated\-Start\-Point} (Measure\-Type $\ast$\-\_\-\-Calculated\-Start\-Point)}\label{class_ox_1_1_start_point_calculator_aebb0511e802eff920369dec99b6c00fb}

\item 
\hypertarget{class_ox_1_1_start_point_calculator_a72195ac7840734cd9001d0303ab859f4}{virtual void {\bfseries set\-N\-Samples} (int \-\_\-n\-Samples)}\label{class_ox_1_1_start_point_calculator_a72195ac7840734cd9001d0303ab859f4}

\item 
\hypertarget{class_ox_1_1_start_point_calculator_a1e68d3a23cee006d4dbdd47583c5d316}{void {\bfseries disp} ()}\label{class_ox_1_1_start_point_calculator_a1e68d3a23cee006d4dbdd47583c5d316}

\item 
\hypertarget{class_ox_1_1_start_point_calculator_a00a48e8845623b57e414380924a3f82b}{void \hyperlink{class_ox_1_1_start_point_calculator_a00a48e8845623b57e414380924a3f82b}{set\-All\-Pointers\-To\-Null} ()}\label{class_ox_1_1_start_point_calculator_a00a48e8845623b57e414380924a3f82b}

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

\begin{DoxyCompactList}\small\item\em constructor \end{DoxyCompactList}\item 
\hypertarget{class_ox_1_1_start_point_calculator_ab6b12ed8fa6b47b3335b5c7a92b94623}{\hyperlink{class_ox_1_1_start_point_calculator_ab6b12ed8fa6b47b3335b5c7a92b94623}{Start\-Point\-Calculator} (const \hyperlink{class_ox_1_1_start_point_calculator}{Start\-Point\-Calculator} \&old)}\label{class_ox_1_1_start_point_calculator_ab6b12ed8fa6b47b3335b5c7a92b94623}

\begin{DoxyCompactList}\small\item\em copy constructor \end{DoxyCompactList}\item 
virtual \hyperlink{class_ox_1_1_start_point_calculator}{Start\-Point\-Calculator}\\*
$<$ Measure\-Type $>$ $\ast$ \hyperlink{class_ox_1_1_start_point_calculator_acd2a221872002157f232e1e7f73a1859}{new\-By\-Cloning} ()=0
\item 
\hypertarget{class_ox_1_1_start_point_calculator_a210c3312a8926b750dba8e498c6b620a}{virtual \hyperlink{class_ox_1_1_start_point_calculator_a210c3312a8926b750dba8e498c6b620a}{$\sim$\-Start\-Point\-Calculator} ()}\label{class_ox_1_1_start_point_calculator_a210c3312a8926b750dba8e498c6b620a}

\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_start_point_calculator_a92176ada269bb53017ed3cbedb3b629d}{Measure\-Type $\ast$ {\bfseries \-\_\-\-Input\-Start\-Point}}\label{class_ox_1_1_start_point_calculator_a92176ada269bb53017ed3cbedb3b629d}

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

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

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

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

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

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

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

\item 
\hypertarget{class_ox_1_1_start_point_calculator_a800e7f49b7956602b4ae9e4eb718eadd}{bool {\bfseries \-\_\-n\-Dims\-Changed}}\label{class_ox_1_1_start_point_calculator_a800e7f49b7956602b4ae9e4eb718eadd}

\end{DoxyCompactItemize}


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


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


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


Implemented in \hyperlink{class_ox_1_1_start_point_calculator_basic_a9d227adf887f091f180f3e2fd37ab2cc}{Ox\-::\-Start\-Point\-Calculator\-Basic$<$ Measure\-Type $>$}, and \hyperlink{class_ox_1_1_start_point_calculator_shmolli_acd0913906ed0d4301b78b5329cc3d62f}{Ox\-::\-Start\-Point\-Calculator\-Shmolli$<$ Measure\-Type $>$}.

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

\end{DoxyReturn}


Implemented in \hyperlink{class_ox_1_1_start_point_calculator_shmolli_ab3f7f6efa7fb6ac4ce1a93fb7ec42f85}{Ox\-::\-Start\-Point\-Calculator\-Shmolli$<$ Measure\-Type $>$}, and \hyperlink{class_ox_1_1_start_point_calculator_basic_a65bb3460d9358f3d9538648e221c8247}{Ox\-::\-Start\-Point\-Calculator\-Basic$<$ Measure\-Type $>$}.



The documentation for this class was generated from the following file\-:\begin{DoxyCompactItemize}
\item 
lib/\hyperlink{_ox_start_point_calculator_8h}{Ox\-Start\-Point\-Calculator.\-h}\end{DoxyCompactItemize}
back to top