swh:1:snp:e6d42e6731ce66e3c09de07ac49964c03139e990
Tip revision: 26b818c8be2be41dd673d938b403c5c7562635de authored by Travis CI on 28 November 2019, 13:55:12 UTC
Deploy code docs to GitHub Pages Travis build: 305
Deploy code docs to GitHub Pages Travis build: 305
Tip revision: 26b818c
_ox_fitter_levenberg_marquardt_vnl_8h_source.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>Tomato: lib/OxFitterLevenbergMarquardtVnl.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Tomato
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('_ox_fitter_levenberg_marquardt_vnl_8h_source.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">OxFitterLevenbergMarquardtVnl.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="_ox_fitter_levenberg_marquardt_vnl_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#ifndef Tomato_OXFITTERLevenbergMarquardtVNL_H</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor"></span><span class="preprocessor">#define Tomato_OXFITTERLevenbergMarquardtVNL_H</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include "CmakeConfigForTomato.h"</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#ifdef USE_VNL</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include "<a class="code" href="_ox_fitter_8h.html">OxFitter.h</a>"</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include "<a class="code" href="_ox_model_t1_adapter_vnl_least_squares_8h.html">OxModelT1AdapterVnlLeastSquares.h</a>"</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <vnl/algo/vnl_levenberg_marquardt.h></span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">namespace </span>Ox {</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  <span class="keyword">template</span><<span class="keyword">typename</span> MeasureType></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  <span class="keyword">class </span>FitterLevenbergMarquardtVnl : <span class="keyword">public</span> Fitter<MeasureType> {</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <span class="keyword">typedef</span> vnl_levenberg_marquardt VnlFitterType; <span class="comment">// !!! this is the most important configuration part !!!</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <span class="keyword">typedef</span> ModelT1AdapterVnlLeastSquares FunctionsAdaptedToVnlType;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keyword">virtual</span> <span class="keywordtype">int</span> performFitting(){</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  configureMinimizer();</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  vnl_vector<MeasureType> temp(this->getParameters(), this->_ModelT1->getNDims());</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  _VnlFitter->minimize(temp);</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keywordflow">if</span> (temp.size() != 0) {</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  temp.copy_out(this->getParameters());</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  }</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordflow">if</span> (this->getVerbose()) {</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  std::cout << <span class="stringliteral">"Results: "</span> << temp << <span class="stringliteral">" Cost: "</span> << this->_ModelT1->calcCostValue(this->getParameters()) << std::endl;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  }</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keywordflow">return</span> 0; <span class="comment">//EXIT_SUCCESS;</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  };</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="comment">// getters</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  FunctionsAdaptedToVnlType *getFunctionsAdaptedToVnl()<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordflow">return</span> _FunctionsAdaptedToVnl;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  }</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> disp(){</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  std::cout << <span class="stringliteral">"\nYou called disp() on a FitterLevenbergMarquardtVnl object"</span> << <span class="keyword">this</span> << <span class="stringliteral">"\n"</span>;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  std::cout << <span class="stringliteral">"It has VnlFitter "</span> << _VnlFitter << std::endl;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  std::cout << <span class="stringliteral">"It has FunctionsAdaptedToVnl "</span> << _FunctionsAdaptedToVnl << std::endl;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  std::cout << <span class="stringliteral">"It's base class is as follows: "</span>;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <a class="code" href="class_ox_1_1_fitter.html#a0a9b45eb21ba174327f95a894e6331b6">Fitter<MeasureType>::disp</a>();</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  }</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  FitterLevenbergMarquardtVnl() {</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="comment">// I cannot initialise _FunctionsAdaptedToVnl here, as I do not know nSamples yet</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  _FunctionsAdaptedToVnl = 0; <span class="comment">// nullptr</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  _VnlFitter = 0; <span class="comment">// nullptr</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  };</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  FitterLevenbergMarquardtVnl(<span class="keyword">const</span> FitterLevenbergMarquardtVnl &old) : Fitter<MeasureType>(old){</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="comment">// I cannot initialise _FunctionsAdaptedToVnl here, as I do not know nSamples and nDims yet</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  _FunctionsAdaptedToVnl = 0; <span class="comment">// nullptr</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  _VnlFitter = 0; <span class="comment">// nullptr</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  }</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keyword">virtual</span> Fitter<MeasureType> *newByCloning() { <span class="keywordflow">return</span> <span class="keyword">new</span> FitterLevenbergMarquardtVnl<MeasureType>(*this); }</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keyword">virtual</span> ~FitterLevenbergMarquardtVnl() {</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keyword">delete</span> _FunctionsAdaptedToVnl; _FunctionsAdaptedToVnl = 0;</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keyword">delete</span> _VnlFitter; _VnlFitter = 0;</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  };</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> configureMinimizer() {</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keywordtype">int</span> nSamples = this->_ModelT1->getNSamples();</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keywordtype">int</span> nDims = this->_ModelT1->getNDims();</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keywordtype">bool</span> doReconfigure = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keywordflow">if</span> (!_VnlFitter) {</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  doReconfigure = <span class="keyword">true</span>;</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  }</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> </div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keywordflow">if</span> (_FunctionsAdaptedToVnl != 0) {</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keywordflow">if</span> (nSamples != _FunctionsAdaptedToVnl->get_number_of_residuals()) {</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  doReconfigure = <span class="keyword">true</span>;</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  }</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  }</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> </div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keywordflow">if</span> (doReconfigure) {</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keywordflow">if</span> (!this->_ModelT1) {</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keywordflow">throw</span> std::runtime_error(<span class="stringliteral">"Set the Model object"</span>);</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  } <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> </div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keyword">delete</span> _FunctionsAdaptedToVnl; _FunctionsAdaptedToVnl = 0;</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="keywordflow">if</span> (this->_UseGradient) {</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  _FunctionsAdaptedToVnl = <span class="keyword">new</span> FunctionsAdaptedToVnlType(nDims, nSamples, vnl_least_squares_function::use_gradient);</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  } <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  _FunctionsAdaptedToVnl = <span class="keyword">new</span> FunctionsAdaptedToVnlType(nDims, nSamples, vnl_least_squares_function::no_gradient);</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  }</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> </div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  _FunctionsAdaptedToVnl->setModel(this->_ModelT1);</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> </div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <span class="keyword">delete</span> _VnlFitter; _VnlFitter = 0;</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  _VnlFitter = <span class="keyword">new</span> VnlFitterType(*_FunctionsAdaptedToVnl);</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  }</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  _VnlFitter->set_x_tolerance(this->getXTolerance());</div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  _VnlFitter->set_f_tolerance(this->getFTolerance());</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <span class="comment">//m_LocalFitter->set_g_tolerance(this->GetGTolerance());</span></div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  _VnlFitter->set_max_function_evals(this->getMaxFunctionEvals());</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  }</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> </div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  };</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> </div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <span class="keyword">private</span>:</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> </div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  VnlFitterType *_VnlFitter; <span class="comment">// not meant to be see outside</span></div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  FunctionsAdaptedToVnlType *_FunctionsAdaptedToVnl; <span class="comment">// not meant to be see outside</span></div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> </div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  };</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> </div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> } <span class="comment">// namespace Ox</span></div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> </div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="preprocessor">#endif //USE_VNL</span></div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="preprocessor">#endif //Tomato_OXFITTERLevenbergMarquardtVNL_H</span></div>
<div class="ttc" id="class_ox_1_1_fitter_html_a0a9b45eb21ba174327f95a894e6331b6"><div class="ttname"><a href="class_ox_1_1_fitter.html#a0a9b45eb21ba174327f95a894e6331b6">Ox::Fitter::disp</a></div><div class="ttdeci">virtual void disp()</div><div class="ttdoc">show me your Fitter </div><div class="ttdef"><b>Definition:</b> OxFitter.h:73</div></div>
<div class="ttc" id="_ox_model_t1_adapter_vnl_least_squares_8h_html"><div class="ttname"><a href="_ox_model_t1_adapter_vnl_least_squares_8h.html">OxModelT1AdapterVnlLeastSquares.h</a></div></div>
<div class="ttc" id="_ox_fitter_8h_html"><div class="ttname"><a href="_ox_fitter_8h.html">OxFitter.h</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_97aefd0d527b934f1d99a682da8fe6a9.html">lib</a></li><li class="navelem"><a class="el" href="_ox_fitter_levenberg_marquardt_vnl_8h.html">OxFitterLevenbergMarquardtVnl.h</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
</ul>
</div>
</body>
</html>
