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
struct_ox_1_1_tomato_options.tex
\hypertarget{struct_ox_1_1_tomato_options}{\section{Ox\-:\-:Tomato\-Options$<$ T\-Y\-P\-E $>$ Struct Template Reference}
\label{struct_ox_1_1_tomato_options}\index{Ox\-::\-Tomato\-Options$<$ T\-Y\-P\-E $>$@{Ox\-::\-Tomato\-Options$<$ T\-Y\-P\-E $>$}}
}


{\ttfamily \#include $<$Ox\-Factory\-Of\-Fitters.\-h$>$}

\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
void \hyperlink{struct_ox_1_1_tomato_options_a76497b53cadad720af7ff0f83b99096b}{init} ()
\item 
\hyperlink{struct_ox_1_1_tomato_options_a71193c5376cb6a732895c160d312d85c}{Tomato\-Options} ()
\item 
\hyperlink{struct_ox_1_1_tomato_options_a5c33d9488b728af994565639f75d9bba}{Tomato\-Options} (const std\-::string \&file\-Path)
\item 
\hyperlink{struct_ox_1_1_tomato_options_a6f291fb0d37adaf6d4b2167e9c75af3e}{$\sim$\-Tomato\-Options} ()
\item 
int \hyperlink{struct_ox_1_1_tomato_options_a41d923f3ffea2007a75217f4f651219b}{export\-To\-Yaml} ()
\item 
int \hyperlink{struct_ox_1_1_tomato_options_aaa834ee2985662cdefbdbe4279481b33}{export\-To\-Yaml} (std\-::string file\-Path)
\item 
void \hyperlink{struct_ox_1_1_tomato_options_a3a17d988d7ac73abef1ad2d79575ab30}{print\-Current} ()
\item 
int \hyperlink{struct_ox_1_1_tomato_options_ac5b8f4b3fd18b6824188ddf0f39ab781}{find\-In\-Array} (int size, const char $\ast$name\-Array\mbox{[}$\,$\mbox{]}, std\-::string name)
\end{DoxyCompactItemize}
\subsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item 
\hypertarget{struct_ox_1_1_tomato_options_ad123055506ec1c4c73b397a5f771d2e7}{std\-::vector$<$ std\-::string $>$ {\bfseries files\-\_\-magnitude}}\label{struct_ox_1_1_tomato_options_ad123055506ec1c4c73b397a5f771d2e7}

\item 
\hypertarget{struct_ox_1_1_tomato_options_acd13f26343647d05164a33cb5b4163f3}{std\-::vector$<$ std\-::string $>$ {\bfseries files\-\_\-phase}}\label{struct_ox_1_1_tomato_options_acd13f26343647d05164a33cb5b4163f3}

\item 
\hypertarget{struct_ox_1_1_tomato_options_aeffcb3fc69397596ce852699a2f3b05d}{std\-::string {\bfseries dir\-\_\-magnitude}}\label{struct_ox_1_1_tomato_options_aeffcb3fc69397596ce852699a2f3b05d}

\item 
\hypertarget{struct_ox_1_1_tomato_options_a92cabcc150b94b5b4c3dbea6e8ecb846}{std\-::string {\bfseries dir\-\_\-phase}}\label{struct_ox_1_1_tomato_options_a92cabcc150b94b5b4c3dbea6e8ecb846}

\item 
\hypertarget{struct_ox_1_1_tomato_options_af31a50b6e23004912a1512812c823a29}{std\-::string {\bfseries dir\-\_\-output\-\_\-map}}\label{struct_ox_1_1_tomato_options_af31a50b6e23004912a1512812c823a29}

\item 
\hypertarget{struct_ox_1_1_tomato_options_ab8e2816968affd97a0ba0b13c44c4c02}{std\-::string {\bfseries dir\-\_\-output\-\_\-fitparams}}\label{struct_ox_1_1_tomato_options_ab8e2816968affd97a0ba0b13c44c4c02}

\item 
\hypertarget{struct_ox_1_1_tomato_options_a657de7a6c7607a1727ed38d79306ecd1}{std\-::vector$<$ Measure\-Type $>$ {\bfseries signal\-\_\-magnitude}}\label{struct_ox_1_1_tomato_options_a657de7a6c7607a1727ed38d79306ecd1}

\item 
\hypertarget{struct_ox_1_1_tomato_options_a76d334a72a2e2df16e140441cc79ab3e}{std\-::vector$<$ Measure\-Type $>$ {\bfseries signal\-\_\-phase}}\label{struct_ox_1_1_tomato_options_a76d334a72a2e2df16e140441cc79ab3e}

\item 
\hypertarget{struct_ox_1_1_tomato_options_a0d4ad4476a8817e68ead08d1b0645033}{calculators\-Type\-\_\-t {\bfseries parameter\-\_\-to\-\_\-map}}\label{struct_ox_1_1_tomato_options_a0d4ad4476a8817e68ead08d1b0645033}

\item 
\hypertarget{struct_ox_1_1_tomato_options_a943b1f0402f72d794bf21c62c3333f8b}{param\-Type\-\_\-t {\bfseries parameter\-\_\-type}}\label{struct_ox_1_1_tomato_options_a943b1f0402f72d794bf21c62c3333f8b}

\item 
\hypertarget{struct_ox_1_1_tomato_options_a2d1d2149185ef71968980cf8c6afcf14}{fitters\-Type\-\_\-t {\bfseries fitting\-\_\-method}}\label{struct_ox_1_1_tomato_options_a2d1d2149185ef71968980cf8c6afcf14}

\item 
\hypertarget{struct_ox_1_1_tomato_options_a4a5e32c79e597006aaaa79600ddaa564}{model\-Type\-\_\-t {\bfseries model\-\_\-type}}\label{struct_ox_1_1_tomato_options_a4a5e32c79e597006aaaa79600ddaa564}

\item 
\hypertarget{struct_ox_1_1_tomato_options_a2cf923d6d04fb8cb510db2623e93119d}{sign\-Calculators\-Type\-\_\-t {\bfseries sign\-\_\-calc\-\_\-method}}\label{struct_ox_1_1_tomato_options_a2cf923d6d04fb8cb510db2623e93119d}

\item 
\hypertarget{struct_ox_1_1_tomato_options_a9da2993961d10c848b0860284900c869}{start\-Point\-Calculators\-Type\-\_\-t {\bfseries start\-\_\-point\-\_\-calc\-\_\-method}}\label{struct_ox_1_1_tomato_options_a9da2993961d10c848b0860284900c869}

\item 
\hypertarget{struct_ox_1_1_tomato_options_ae2ac4c46e46b4d183c6944771701040b}{Measure\-Type {\bfseries f\-Tolerance}}\label{struct_ox_1_1_tomato_options_ae2ac4c46e46b4d183c6944771701040b}

\item 
\hypertarget{struct_ox_1_1_tomato_options_a9b864c01b6b0b4e4d5a56470f6c5f004}{int {\bfseries max\-\_\-function\-\_\-evals}}\label{struct_ox_1_1_tomato_options_a9b864c01b6b0b4e4d5a56470f6c5f004}

\item 
\hypertarget{struct_ox_1_1_tomato_options_a367c540e5413f8ffa3a6bc6ef5781b45}{bool {\bfseries use\-\_\-gradient}}\label{struct_ox_1_1_tomato_options_a367c540e5413f8ffa3a6bc6ef5781b45}

\item 
\hypertarget{struct_ox_1_1_tomato_options_ab7ac986b6ad257e73eda3d524f85fe85}{std\-::vector$<$ Measure\-Type $>$ {\bfseries inversion\-\_\-times}}\label{struct_ox_1_1_tomato_options_ab7ac986b6ad257e73eda3d524f85fe85}

\item 
\hypertarget{struct_ox_1_1_tomato_options_ae70219d5c42877178575baa5d6ae51c3}{std\-::vector$<$ Measure\-Type $>$ {\bfseries echo\-\_\-times}}\label{struct_ox_1_1_tomato_options_ae70219d5c42877178575baa5d6ae51c3}

\item 
\hypertarget{struct_ox_1_1_tomato_options_a0eced6fbbc1270e5d437a18ba950c06c}{std\-::vector$<$ Measure\-Type $>$ {\bfseries start\-\_\-point}}\label{struct_ox_1_1_tomato_options_a0eced6fbbc1270e5d437a18ba950c06c}

\item 
\hypertarget{struct_ox_1_1_tomato_options_ae9352986deb21ca97d4fd34daf564241}{std\-::vector$<$ Measure\-Type $>$ {\bfseries noise}}\label{struct_ox_1_1_tomato_options_ae9352986deb21ca97d4fd34daf564241}

\item 
\hypertarget{struct_ox_1_1_tomato_options_af81d1a55409036109d253b313d59e972}{Measure\-Type {\bfseries mean\-\_\-cut\-\_\-off}}\label{struct_ox_1_1_tomato_options_af81d1a55409036109d253b313d59e972}

\item 
\hypertarget{struct_ox_1_1_tomato_options_ab245e10cf32b36c48d66208a5f505099}{Measure\-Type {\bfseries map\-\_\-scale\-\_\-factor}}\label{struct_ox_1_1_tomato_options_ab245e10cf32b36c48d66208a5f505099}

\item 
\hypertarget{struct_ox_1_1_tomato_options_aa762826a11ff767aa969bd66c29b577f}{bool {\bfseries use\-\_\-colorbar}}\label{struct_ox_1_1_tomato_options_aa762826a11ff767aa969bd66c29b577f}

\item 
\hypertarget{struct_ox_1_1_tomato_options_a54efb4945f2857ee4ed9e1d5552fc3dd}{int {\bfseries number\-\_\-of\-\_\-threads}}\label{struct_ox_1_1_tomato_options_a54efb4945f2857ee4ed9e1d5552fc3dd}

\item 
\hypertarget{struct_ox_1_1_tomato_options_ab20a779c5a8dd371ec9356e3f9ce79c9}{int {\bfseries output\-\_\-map\-\_\-series\-\_\-number}}\label{struct_ox_1_1_tomato_options_ab20a779c5a8dd371ec9356e3f9ce79c9}

\item 
\hypertarget{struct_ox_1_1_tomato_options_a58664e816cde6eff746bd5abe4fe2d1c}{int {\bfseries output\-\_\-fitparams\-\_\-series\-\_\-number}}\label{struct_ox_1_1_tomato_options_a58664e816cde6eff746bd5abe4fe2d1c}

\item 
\hypertarget{struct_ox_1_1_tomato_options_a008c932c7d65248d2d82e0e654993384}{double {\bfseries calculation\-\_\-time}}\label{struct_ox_1_1_tomato_options_a008c932c7d65248d2d82e0e654993384}

\end{DoxyCompactItemize}


\subsection{Detailed Description}
\subsubsection*{template$<$typename T\-Y\-P\-E$>$struct Ox\-::\-Tomato\-Options$<$ T\-Y\-P\-E $>$}

Here you can configure different fitting methods 
\begin{DoxyTemplParams}{Template Parameters}
{\em T\-Y\-P\-E} & \\
\hline
\end{DoxyTemplParams}


\subsection{Constructor \& Destructor Documentation}
\hypertarget{struct_ox_1_1_tomato_options_a71193c5376cb6a732895c160d312d85c}{\index{Ox\-::\-Tomato\-Options@{Ox\-::\-Tomato\-Options}!Tomato\-Options@{Tomato\-Options}}
\index{Tomato\-Options@{Tomato\-Options}!Ox::TomatoOptions@{Ox\-::\-Tomato\-Options}}
\subsubsection[{Tomato\-Options}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Measure\-Type $>$ {\bf Ox\-::\-Tomato\-Options}$<$ Measure\-Type $>$\-::{\bf Tomato\-Options} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}\label{struct_ox_1_1_tomato_options_a71193c5376cb6a732895c160d312d85c}
constructor with defaults \hypertarget{struct_ox_1_1_tomato_options_a5c33d9488b728af994565639f75d9bba}{\index{Ox\-::\-Tomato\-Options@{Ox\-::\-Tomato\-Options}!Tomato\-Options@{Tomato\-Options}}
\index{Tomato\-Options@{Tomato\-Options}!Ox::TomatoOptions@{Ox\-::\-Tomato\-Options}}
\subsubsection[{Tomato\-Options}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Measure\-Type $>$ {\bf Ox\-::\-Tomato\-Options}$<$ Measure\-Type $>$\-::{\bf Tomato\-Options} (
\begin{DoxyParamCaption}
\item[{const std\-::string \&}]{file\-Path}
\end{DoxyParamCaption}
)}}\label{struct_ox_1_1_tomato_options_a5c33d9488b728af994565639f75d9bba}
constructor with parser 
\begin{DoxyParams}{Parameters}
{\em file\-Path} & \\
\hline
\end{DoxyParams}
\hypertarget{struct_ox_1_1_tomato_options_a6f291fb0d37adaf6d4b2167e9c75af3e}{\index{Ox\-::\-Tomato\-Options@{Ox\-::\-Tomato\-Options}!$\sim$\-Tomato\-Options@{$\sim$\-Tomato\-Options}}
\index{$\sim$\-Tomato\-Options@{$\sim$\-Tomato\-Options}!Ox::TomatoOptions@{Ox\-::\-Tomato\-Options}}
\subsubsection[{$\sim$\-Tomato\-Options}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Measure\-Type $>$ {\bf Ox\-::\-Tomato\-Options}$<$ Measure\-Type $>$\-::$\sim${\bf Tomato\-Options} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}\label{struct_ox_1_1_tomato_options_a6f291fb0d37adaf6d4b2167e9c75af3e}
destructor 

\subsection{Member Function Documentation}
\hypertarget{struct_ox_1_1_tomato_options_a41d923f3ffea2007a75217f4f651219b}{\index{Ox\-::\-Tomato\-Options@{Ox\-::\-Tomato\-Options}!export\-To\-Yaml@{export\-To\-Yaml}}
\index{export\-To\-Yaml@{export\-To\-Yaml}!Ox::TomatoOptions@{Ox\-::\-Tomato\-Options}}
\subsubsection[{export\-To\-Yaml}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Measure\-Type $>$ int {\bf Ox\-::\-Tomato\-Options}$<$ Measure\-Type $>$\-::export\-To\-Yaml (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}\label{struct_ox_1_1_tomato_options_a41d923f3ffea2007a75217f4f651219b}
\begin{DoxyReturn}{Returns}

\end{DoxyReturn}
\hypertarget{struct_ox_1_1_tomato_options_aaa834ee2985662cdefbdbe4279481b33}{\index{Ox\-::\-Tomato\-Options@{Ox\-::\-Tomato\-Options}!export\-To\-Yaml@{export\-To\-Yaml}}
\index{export\-To\-Yaml@{export\-To\-Yaml}!Ox::TomatoOptions@{Ox\-::\-Tomato\-Options}}
\subsubsection[{export\-To\-Yaml}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Measure\-Type $>$ int {\bf Ox\-::\-Tomato\-Options}$<$ Measure\-Type $>$\-::export\-To\-Yaml (
\begin{DoxyParamCaption}
\item[{std\-::string}]{file\-Path}
\end{DoxyParamCaption}
)}}\label{struct_ox_1_1_tomato_options_aaa834ee2985662cdefbdbe4279481b33}

\begin{DoxyParams}{Parameters}
{\em file\-Path} & \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}

\end{DoxyReturn}
\hypertarget{struct_ox_1_1_tomato_options_ac5b8f4b3fd18b6824188ddf0f39ab781}{\index{Ox\-::\-Tomato\-Options@{Ox\-::\-Tomato\-Options}!find\-In\-Array@{find\-In\-Array}}
\index{find\-In\-Array@{find\-In\-Array}!Ox::TomatoOptions@{Ox\-::\-Tomato\-Options}}
\subsubsection[{find\-In\-Array}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Measure\-Type $>$ int {\bf Ox\-::\-Tomato\-Options}$<$ Measure\-Type $>$\-::find\-In\-Array (
\begin{DoxyParamCaption}
\item[{int}]{size, }
\item[{const char $\ast$}]{name\-Array\mbox{[}$\,$\mbox{]}, }
\item[{std\-::string}]{name}
\end{DoxyParamCaption}
)}}\label{struct_ox_1_1_tomato_options_ac5b8f4b3fd18b6824188ddf0f39ab781}
useful in looking for params defined in factories 
\begin{DoxyParams}{Parameters}
{\em size} & \\
\hline
{\em name\-Array} & \\
\hline
{\em name} & \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}

\end{DoxyReturn}
\hypertarget{struct_ox_1_1_tomato_options_a76497b53cadad720af7ff0f83b99096b}{\index{Ox\-::\-Tomato\-Options@{Ox\-::\-Tomato\-Options}!init@{init}}
\index{init@{init}!Ox::TomatoOptions@{Ox\-::\-Tomato\-Options}}
\subsubsection[{init}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename T\-Y\-P\-E$>$ void {\bf Ox\-::\-Tomato\-Options}$<$ T\-Y\-P\-E $>$\-::init (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [inline]}}}\label{struct_ox_1_1_tomato_options_a76497b53cadad720af7ff0f83b99096b}
initialise the defaults done this way to work around delegating constructors in cpp98 \hypertarget{struct_ox_1_1_tomato_options_a3a17d988d7ac73abef1ad2d79575ab30}{\index{Ox\-::\-Tomato\-Options@{Ox\-::\-Tomato\-Options}!print\-Current@{print\-Current}}
\index{print\-Current@{print\-Current}!Ox::TomatoOptions@{Ox\-::\-Tomato\-Options}}
\subsubsection[{print\-Current}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Measure\-Type $>$ void {\bf Ox\-::\-Tomato\-Options}$<$ Measure\-Type $>$\-::print\-Current (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}\label{struct_ox_1_1_tomato_options_a3a17d988d7ac73abef1ad2d79575ab30}
print current state of the struct 

The documentation for this struct was generated from the following files\-:\begin{DoxyCompactItemize}
\item 
lib/\hyperlink{_ox_factory_of_calculators_8h}{Ox\-Factory\-Of\-Calculators.\-h}\item 
lib/\hyperlink{_tomato_options_8h}{Tomato\-Options.\-h}\item 
lib/\hyperlink{_tomato_options_8hxx}{Tomato\-Options.\-hxx}\end{DoxyCompactItemize}
back to top