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
_ox_model_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/OxModel.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&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;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&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;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_model_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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</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">OxModel.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="_ox_model_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>&#160;</div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="preprocessor">#ifndef Tomato_OxModel_H</span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define Tomato_OxModel_H</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="preprocessor">#include &quot;tomatolib_export.h&quot;</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;</div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="keyword">namespace </span>Ox {</div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;</div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;    <span class="keyword">template</span>&lt; <span class="keyword">typename</span> MeasureType &gt;</div>
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="class_ox_1_1_model.html">   25</a></span>&#160;    <span class="keyword">class </span><a class="code" href="class_ox_1_1_model.html">Model</a>{</div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;</div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;    <span class="keyword">public</span>:</div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;</div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;        <span class="keyword">virtual</span> MeasureType <a class="code" href="class_ox_1_1_model.html#ae3a3f5bfeefd8a8c0c012e1761eac1f5">calcModelValue</a>(<span class="keyword">const</span> MeasureType* parameters, MeasureType time) = 0;</div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;</div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;        <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_ox_1_1_model.html#a17e0ef71135350d4f61bef2a097fb586">calcLSResiduals</a>(<span class="keyword">const</span> MeasureType* parameters, MeasureType* residuals) = 0;</div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;</div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;        <span class="keyword">virtual</span> MeasureType <a class="code" href="class_ox_1_1_model.html#aa5997cea7114d0e323e79956adb13ba4">calcCostValue</a>(<span class="keyword">const</span> MeasureType* parameters) = 0;</div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;</div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;        <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_ox_1_1_model.html#a274f0efdbbc364e82bba7470f933eecd">calcCostDerivative</a>(<span class="keyword">const</span> MeasureType* parameters, MeasureType* derivative) = 0;</div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;</div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;        <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_ox_1_1_model.html#a4cadb65b8416b4b30e91bf6db00737f3">calcLSJacobian</a>(<span class="keyword">const</span> MeasureType* parameters, MeasureType* jacobian) = 0;</div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;</div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;        <span class="comment">// getters</span></div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;        <span class="keyword">virtual</span> <span class="keywordtype">int</span> getNSamples() { <span class="keywordflow">return</span> _nSamples; }</div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;        <span class="keyword">virtual</span> <span class="keyword">const</span> MeasureType *getInvTimes()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _InvTimes; }</div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;        <span class="keyword">virtual</span> <span class="keyword">const</span> MeasureType *getEchoTimes()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _EchoTimes; }</div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;        <span class="keyword">virtual</span> <span class="keyword">const</span> MeasureType *getRepTimes()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _RepTimes; }</div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;        <span class="keyword">virtual</span> <span class="keyword">const</span> MeasureType *getRelAcqTimes()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _RelAcqTimes; }</div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;        <span class="keyword">virtual</span> <span class="keyword">const</span> MeasureType *getSignal()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _Signal; }</div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;        <span class="keyword">virtual</span> <span class="keywordtype">int</span> getNDims() { <span class="keywordflow">return</span> _nDims; }</div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;</div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;        <span class="comment">// setters</span></div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;        <span class="keywordtype">void</span> setNSamples(<span class="keywordtype">int</span> _nSamples);</div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;        <span class="keyword">virtual</span> <span class="keywordtype">void</span> setInvTimes(<span class="keyword">const</span> MeasureType *_InvTimes) { Model::_InvTimes = _InvTimes; }</div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;        <span class="keyword">virtual</span> <span class="keywordtype">void</span> setEchoTimes(<span class="keyword">const</span> MeasureType *_EchoTimes) { Model::_EchoTimes = _EchoTimes; }</div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;        <span class="keyword">virtual</span> <span class="keywordtype">void</span> setRepTimes(<span class="keyword">const</span> MeasureType *_RepTimes) { Model::_RepTimes = _RepTimes; }</div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;        <span class="keyword">virtual</span> <span class="keywordtype">void</span> setRelAcqTimes(<span class="keyword">const</span> MeasureType *_RelAcqTimes) { Model::_RelAcqTimes = _RelAcqTimes; }</div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;        <span class="keyword">virtual</span> <span class="keywordtype">void</span> setSignal(<span class="keyword">const</span> MeasureType *_Signal) { Model::_Signal = _Signal; }</div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;</div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;        <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_ox_1_1_model.html#ae2c46e9820947efd450a93aaf53a0db5">disp</a>();</div>
<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;</div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;        <span class="keywordtype">void</span> <a class="code" href="class_ox_1_1_model.html#a8186fd758a6f94d9e3af204b6c1aac3c">setAllPointersToNull</a>();</div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;</div>
<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;        <a class="code" href="class_ox_1_1_model.html#a73f93cd40d0eddc1d3ff474fc2505fc2">Model</a>();</div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;</div>
<div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;        <a class="code" href="class_ox_1_1_model.html#a73f93cd40d0eddc1d3ff474fc2505fc2">Model</a>(<span class="keyword">const</span> <a class="code" href="class_ox_1_1_model.html">Model</a> &amp;old);</div>
<div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;</div>
<div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;        <span class="keyword">virtual</span> <a class="code" href="class_ox_1_1_model.html">Model&lt;MeasureType&gt;</a> *<a class="code" href="class_ox_1_1_model.html#a694868476dd17a4d203f4ebc57047d2f">newByCloning</a>() = 0;</div>
<div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;</div>
<div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;        <span class="keyword">virtual</span> <a class="code" href="class_ox_1_1_model.html#a6353ac7352cdbbed2d00d9ed9e697c88">~Model</a>();</div>
<div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;</div>
<div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;    <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;</div>
<div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;        <span class="keyword">const</span> MeasureType* _InvTimes;</div>
<div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;        <span class="keyword">const</span> MeasureType* _EchoTimes;</div>
<div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;        <span class="keyword">const</span> MeasureType* _RepTimes;</div>
<div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;        <span class="keyword">const</span> MeasureType* _RelAcqTimes;</div>
<div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;        <span class="keyword">const</span> MeasureType* _Signal;</div>
<div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;        <span class="keywordtype">int</span> _nSamples;</div>
<div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;        <span class="keywordtype">int</span> _nDims;</div>
<div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;</div>
<div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;        <span class="comment">// helper variables</span></div>
<div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;        MeasureType* _Residuals;</div>
<div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;    };</div>
<div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;} <span class="comment">//namespace Ox</span></div>
<div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;</div>
<div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;<span class="preprocessor">#ifndef TOMATOLIB_COMPILED</span></div>
<div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#include &quot;OxModel.hxx&quot;</span></div>
<div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;<span class="preprocessor">#endif //TOMATOLIB_COMPILED</span></div>
<div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;<span class="preprocessor">#endif //Tomato_OxModel_H</span></div>
<div class="ttc" id="class_ox_1_1_model_html_ae2c46e9820947efd450a93aaf53a0db5"><div class="ttname"><a href="class_ox_1_1_model.html#ae2c46e9820947efd450a93aaf53a0db5">Ox::Model::disp</a></div><div class="ttdeci">virtual void disp()</div><div class="ttdoc">show me your ModelT1 </div><div class="ttdef"><b>Definition:</b> OxModel.hxx:26</div></div>
<div class="ttc" id="class_ox_1_1_model_html"><div class="ttname"><a href="class_ox_1_1_model.html">Ox::Model</a></div><div class="ttdoc">Container for a model function, cost function and Least-Squares function. And derivatives. </div><div class="ttdef"><b>Definition:</b> OxModel.h:25</div></div>
<div class="ttc" id="class_ox_1_1_model_html_a4cadb65b8416b4b30e91bf6db00737f3"><div class="ttname"><a href="class_ox_1_1_model.html#a4cadb65b8416b4b30e91bf6db00737f3">Ox::Model::calcLSJacobian</a></div><div class="ttdeci">virtual void calcLSJacobian(const MeasureType *parameters, MeasureType *jacobian)=0</div></div>
<div class="ttc" id="class_ox_1_1_model_html_ae3a3f5bfeefd8a8c0c012e1761eac1f5"><div class="ttname"><a href="class_ox_1_1_model.html#ae3a3f5bfeefd8a8c0c012e1761eac1f5">Ox::Model::calcModelValue</a></div><div class="ttdeci">virtual MeasureType calcModelValue(const MeasureType *parameters, MeasureType time)=0</div></div>
<div class="ttc" id="class_ox_1_1_model_html_a274f0efdbbc364e82bba7470f933eecd"><div class="ttname"><a href="class_ox_1_1_model.html#a274f0efdbbc364e82bba7470f933eecd">Ox::Model::calcCostDerivative</a></div><div class="ttdeci">virtual void calcCostDerivative(const MeasureType *parameters, MeasureType *derivative)=0</div></div>
<div class="ttc" id="class_ox_1_1_model_html_a73f93cd40d0eddc1d3ff474fc2505fc2"><div class="ttname"><a href="class_ox_1_1_model.html#a73f93cd40d0eddc1d3ff474fc2505fc2">Ox::Model::Model</a></div><div class="ttdeci">Model()</div><div class="ttdoc">constructor </div><div class="ttdef"><b>Definition:</b> OxModel.hxx:50</div></div>
<div class="ttc" id="class_ox_1_1_model_html_a694868476dd17a4d203f4ebc57047d2f"><div class="ttname"><a href="class_ox_1_1_model.html#a694868476dd17a4d203f4ebc57047d2f">Ox::Model::newByCloning</a></div><div class="ttdeci">virtual Model&lt; MeasureType &gt; * newByCloning()=0</div></div>
<div class="ttc" id="class_ox_1_1_model_html_a17e0ef71135350d4f61bef2a097fb586"><div class="ttname"><a href="class_ox_1_1_model.html#a17e0ef71135350d4f61bef2a097fb586">Ox::Model::calcLSResiduals</a></div><div class="ttdeci">virtual void calcLSResiduals(const MeasureType *parameters, MeasureType *residuals)=0</div></div>
<div class="ttc" id="class_ox_1_1_model_html_aa5997cea7114d0e323e79956adb13ba4"><div class="ttname"><a href="class_ox_1_1_model.html#aa5997cea7114d0e323e79956adb13ba4">Ox::Model::calcCostValue</a></div><div class="ttdeci">virtual MeasureType calcCostValue(const MeasureType *parameters)=0</div></div>
<div class="ttc" id="class_ox_1_1_model_html_a6353ac7352cdbbed2d00d9ed9e697c88"><div class="ttname"><a href="class_ox_1_1_model.html#a6353ac7352cdbbed2d00d9ed9e697c88">Ox::Model::~Model</a></div><div class="ttdeci">virtual ~Model()</div><div class="ttdoc">do not forget about the virtual destructor, see https://stackoverflow.com/questions/461203/when-to-us...</div><div class="ttdef"><b>Definition:</b> OxModel.hxx:74</div></div>
<div class="ttc" id="class_ox_1_1_model_html_a8186fd758a6f94d9e3af204b6c1aac3c"><div class="ttname"><a href="class_ox_1_1_model.html#a8186fd758a6f94d9e3af204b6c1aac3c">Ox::Model::setAllPointersToNull</a></div><div class="ttdeci">void setAllPointersToNull()</div><div class="ttdoc">set all the pointers to zero </div><div class="ttdef"><b>Definition:</b> OxModel.hxx:40</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_model_8h.html">OxModel.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>
back to top