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_model_t2_three_param.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: Ox::ModelT2ThreeParam&lt; MeasureType &gt; Class Template Reference</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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><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="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#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('class_ox_1_1_model_t2_three_param.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="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_ox_1_1_model_t2_three_param-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Ox::ModelT2ThreeParam&lt; MeasureType &gt; Class Template Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Container for a ThreeParam model function <img class="formulaInl" alt="$ A + B\exp(t/T_2) $" src="form_2.png"/>, cost function and Least-Squares function and derivatives.  
 <a href="class_ox_1_1_model_t2_three_param.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_ox_model_t2_three_param_8h_source.html">OxModelT2ThreeParam.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for Ox::ModelT2ThreeParam&lt; MeasureType &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="class_ox_1_1_model_t2_three_param__inherit__graph.png" border="0" usemap="#_ox_1_1_model_t2_three_param_3_01_measure_type_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="_ox_1_1_model_t2_three_param_3_01_measure_type_01_4_inherit__map" id="_ox_1_1_model_t2_three_param_3_01_measure_type_01_4_inherit__map">
<area shape="rect" id="node2" href="class_ox_1_1_model.html" title="Container for a model function, cost function and Least&#45;Squares function. And derivatives. " alt="" coords="5,5,189,32"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for Ox::ModelT2ThreeParam&lt; MeasureType &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="class_ox_1_1_model_t2_three_param__coll__graph.png" border="0" usemap="#_ox_1_1_model_t2_three_param_3_01_measure_type_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="_ox_1_1_model_t2_three_param_3_01_measure_type_01_4_coll__map" id="_ox_1_1_model_t2_three_param_3_01_measure_type_01_4_coll__map">
<area shape="rect" id="node2" href="class_ox_1_1_model.html" title="Container for a model function, cost function and Least&#45;Squares function. And derivatives. " alt="" coords="5,5,189,32"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a2ed5138a6db7e8b64c5c8d8275de70ac"><td class="memItemLeft" align="right" valign="top">virtual MeasureType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ox_1_1_model_t2_three_param.html#a2ed5138a6db7e8b64c5c8d8275de70ac">calcModelValue</a> (const MeasureType *parameters, MeasureType time)</td></tr>
<tr class="separator:a2ed5138a6db7e8b64c5c8d8275de70ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af959d697820c70df520f987ba5e75b78"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ox_1_1_model_t2_three_param.html#af959d697820c70df520f987ba5e75b78">calcLSResiduals</a> (const MeasureType *parameters, MeasureType *residuals)</td></tr>
<tr class="separator:af959d697820c70df520f987ba5e75b78"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a727daa3a07d63fc3efbf0559ce32de9b"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ox_1_1_model_t2_three_param.html#a727daa3a07d63fc3efbf0559ce32de9b">calcLSJacobian</a> (const MeasureType *parameters, MeasureType *jacobian)</td></tr>
<tr class="separator:a727daa3a07d63fc3efbf0559ce32de9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afa54ff1c8de4f2c2cf2fd50e3e357e2b"><td class="memItemLeft" align="right" valign="top">virtual MeasureType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ox_1_1_model_t2_three_param.html#afa54ff1c8de4f2c2cf2fd50e3e357e2b">calcCostValue</a> (const MeasureType *parameters)</td></tr>
<tr class="separator:afa54ff1c8de4f2c2cf2fd50e3e357e2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a296bdf8378923d3e501c6e929608baca"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ox_1_1_model_t2_three_param.html#a296bdf8378923d3e501c6e929608baca">calcCostDerivative</a> (const MeasureType *parameters, MeasureType *derivative)</td></tr>
<tr class="separator:a296bdf8378923d3e501c6e929608baca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7a6d2bae4e394a99e9e8943af9f344d0"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_ox_1_1_model.html">Model</a>&lt; MeasureType &gt; *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ox_1_1_model_t2_three_param.html#a7a6d2bae4e394a99e9e8943af9f344d0">newByCloning</a> ()</td></tr>
<tr class="separator:a7a6d2bae4e394a99e9e8943af9f344d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a504f1b6e964c67bbf251469f2ae880ff"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a504f1b6e964c67bbf251469f2ae880ff"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ox_1_1_model_t2_three_param.html#a504f1b6e964c67bbf251469f2ae880ff">~ModelT2ThreeParam</a> ()</td></tr>
<tr class="memdesc:a504f1b6e964c67bbf251469f2ae880ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">do not forget about the virtual destructor, see <a href="https://stackoverflow.com/questions/461203/when-to-use-virtual-destructors">https://stackoverflow.com/questions/461203/when-to-use-virtual-destructors</a> <br/></td></tr>
<tr class="separator:a504f1b6e964c67bbf251469f2ae880ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_ox_1_1_model"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_ox_1_1_model')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_ox_1_1_model.html">Ox::Model&lt; MeasureType &gt;</a></td></tr>
<tr class="memitem:a29715e78ec12b91c56df85fc0f782ea7 inherit pub_methods_class_ox_1_1_model"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a29715e78ec12b91c56df85fc0f782ea7"></a>
virtual int&#160;</td><td class="memItemRight" valign="bottom"><b>getNSamples</b> ()</td></tr>
<tr class="separator:a29715e78ec12b91c56df85fc0f782ea7 inherit pub_methods_class_ox_1_1_model"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c7497927d9aa7f0c3aa5933e4a7ff7d inherit pub_methods_class_ox_1_1_model"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7c7497927d9aa7f0c3aa5933e4a7ff7d"></a>
virtual const MeasureType *&#160;</td><td class="memItemRight" valign="bottom"><b>getInvTimes</b> () const </td></tr>
<tr class="separator:a7c7497927d9aa7f0c3aa5933e4a7ff7d inherit pub_methods_class_ox_1_1_model"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1606369f7a57a69c9944a54a135bc1f4 inherit pub_methods_class_ox_1_1_model"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1606369f7a57a69c9944a54a135bc1f4"></a>
virtual const MeasureType *&#160;</td><td class="memItemRight" valign="bottom"><b>getEchoTimes</b> () const </td></tr>
<tr class="separator:a1606369f7a57a69c9944a54a135bc1f4 inherit pub_methods_class_ox_1_1_model"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad1ecd4e858e0a5386a27505ec78135c5 inherit pub_methods_class_ox_1_1_model"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad1ecd4e858e0a5386a27505ec78135c5"></a>
virtual const MeasureType *&#160;</td><td class="memItemRight" valign="bottom"><b>getRepTimes</b> () const </td></tr>
<tr class="separator:ad1ecd4e858e0a5386a27505ec78135c5 inherit pub_methods_class_ox_1_1_model"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ada677d0048ec4544f8975c44ae3bc3d9 inherit pub_methods_class_ox_1_1_model"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ada677d0048ec4544f8975c44ae3bc3d9"></a>
virtual const MeasureType *&#160;</td><td class="memItemRight" valign="bottom"><b>getRelAcqTimes</b> () const </td></tr>
<tr class="separator:ada677d0048ec4544f8975c44ae3bc3d9 inherit pub_methods_class_ox_1_1_model"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae51878e45fa528e47a457610d857a9bb inherit pub_methods_class_ox_1_1_model"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae51878e45fa528e47a457610d857a9bb"></a>
virtual const MeasureType *&#160;</td><td class="memItemRight" valign="bottom"><b>getSignal</b> () const </td></tr>
<tr class="separator:ae51878e45fa528e47a457610d857a9bb inherit pub_methods_class_ox_1_1_model"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af457ac73701b13fa1b3af8d800e198dc inherit pub_methods_class_ox_1_1_model"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af457ac73701b13fa1b3af8d800e198dc"></a>
virtual int&#160;</td><td class="memItemRight" valign="bottom"><b>getNDims</b> ()</td></tr>
<tr class="separator:af457ac73701b13fa1b3af8d800e198dc inherit pub_methods_class_ox_1_1_model"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e37f6db1210b7b4a58d7ad38ba6b422 inherit pub_methods_class_ox_1_1_model"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9e37f6db1210b7b4a58d7ad38ba6b422"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setNSamples</b> (int _nSamples)</td></tr>
<tr class="separator:a9e37f6db1210b7b4a58d7ad38ba6b422 inherit pub_methods_class_ox_1_1_model"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2db9a20a6915dc41bce2deecec7c390a inherit pub_methods_class_ox_1_1_model"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2db9a20a6915dc41bce2deecec7c390a"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>setInvTimes</b> (const MeasureType *_InvTimes)</td></tr>
<tr class="separator:a2db9a20a6915dc41bce2deecec7c390a inherit pub_methods_class_ox_1_1_model"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac63fba341cfe586ec210f59fcdc0d715 inherit pub_methods_class_ox_1_1_model"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac63fba341cfe586ec210f59fcdc0d715"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>setEchoTimes</b> (const MeasureType *_EchoTimes)</td></tr>
<tr class="separator:ac63fba341cfe586ec210f59fcdc0d715 inherit pub_methods_class_ox_1_1_model"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af272a398debaf156f345d85940bec556 inherit pub_methods_class_ox_1_1_model"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af272a398debaf156f345d85940bec556"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>setRepTimes</b> (const MeasureType *_RepTimes)</td></tr>
<tr class="separator:af272a398debaf156f345d85940bec556 inherit pub_methods_class_ox_1_1_model"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a534bfcec58d93c7002a6c0eb4d58ed88 inherit pub_methods_class_ox_1_1_model"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a534bfcec58d93c7002a6c0eb4d58ed88"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>setRelAcqTimes</b> (const MeasureType *_RelAcqTimes)</td></tr>
<tr class="separator:a534bfcec58d93c7002a6c0eb4d58ed88 inherit pub_methods_class_ox_1_1_model"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb7eddc8c8c4ac94ab921158ce3a38a3 inherit pub_methods_class_ox_1_1_model"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abb7eddc8c8c4ac94ab921158ce3a38a3"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>setSignal</b> (const MeasureType *_Signal)</td></tr>
<tr class="separator:abb7eddc8c8c4ac94ab921158ce3a38a3 inherit pub_methods_class_ox_1_1_model"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae2c46e9820947efd450a93aaf53a0db5 inherit pub_methods_class_ox_1_1_model"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae2c46e9820947efd450a93aaf53a0db5"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ox_1_1_model.html#ae2c46e9820947efd450a93aaf53a0db5">disp</a> ()</td></tr>
<tr class="memdesc:ae2c46e9820947efd450a93aaf53a0db5 inherit pub_methods_class_ox_1_1_model"><td class="mdescLeft">&#160;</td><td class="mdescRight">show me your ModelT1 <br/></td></tr>
<tr class="separator:ae2c46e9820947efd450a93aaf53a0db5 inherit pub_methods_class_ox_1_1_model"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8186fd758a6f94d9e3af204b6c1aac3c inherit pub_methods_class_ox_1_1_model"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8186fd758a6f94d9e3af204b6c1aac3c"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ox_1_1_model.html#a8186fd758a6f94d9e3af204b6c1aac3c">setAllPointersToNull</a> ()</td></tr>
<tr class="memdesc:a8186fd758a6f94d9e3af204b6c1aac3c inherit pub_methods_class_ox_1_1_model"><td class="mdescLeft">&#160;</td><td class="mdescRight">set all the pointers to zero <br/></td></tr>
<tr class="separator:a8186fd758a6f94d9e3af204b6c1aac3c inherit pub_methods_class_ox_1_1_model"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a73f93cd40d0eddc1d3ff474fc2505fc2 inherit pub_methods_class_ox_1_1_model"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a73f93cd40d0eddc1d3ff474fc2505fc2"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ox_1_1_model.html#a73f93cd40d0eddc1d3ff474fc2505fc2">Model</a> ()</td></tr>
<tr class="memdesc:a73f93cd40d0eddc1d3ff474fc2505fc2 inherit pub_methods_class_ox_1_1_model"><td class="mdescLeft">&#160;</td><td class="mdescRight">constructor <br/></td></tr>
<tr class="separator:a73f93cd40d0eddc1d3ff474fc2505fc2 inherit pub_methods_class_ox_1_1_model"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a01911912db830e4814645a675990a906 inherit pub_methods_class_ox_1_1_model"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ox_1_1_model.html#a01911912db830e4814645a675990a906">Model</a> (const <a class="el" href="class_ox_1_1_model.html">Model</a> &amp;old)</td></tr>
<tr class="memdesc:a01911912db830e4814645a675990a906 inherit pub_methods_class_ox_1_1_model"><td class="mdescLeft">&#160;</td><td class="mdescRight">copy constructor keeps only _nSamples and _nDims  <a href="#a01911912db830e4814645a675990a906">More...</a><br/></td></tr>
<tr class="separator:a01911912db830e4814645a675990a906 inherit pub_methods_class_ox_1_1_model"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6353ac7352cdbbed2d00d9ed9e697c88 inherit pub_methods_class_ox_1_1_model"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6353ac7352cdbbed2d00d9ed9e697c88"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ox_1_1_model.html#a6353ac7352cdbbed2d00d9ed9e697c88">~Model</a> ()</td></tr>
<tr class="memdesc:a6353ac7352cdbbed2d00d9ed9e697c88 inherit pub_methods_class_ox_1_1_model"><td class="mdescLeft">&#160;</td><td class="mdescRight">do not forget about the virtual destructor, see <a href="https://stackoverflow.com/questions/461203/when-to-use-virtual-destructors">https://stackoverflow.com/questions/461203/when-to-use-virtual-destructors</a> <br/></td></tr>
<tr class="separator:a6353ac7352cdbbed2d00d9ed9e697c88 inherit pub_methods_class_ox_1_1_model"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_attribs_class_ox_1_1_model"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_ox_1_1_model')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="class_ox_1_1_model.html">Ox::Model&lt; MeasureType &gt;</a></td></tr>
<tr class="memitem:a20eb4db9cd1fa1cd0fa4b46e06e08d9c inherit pro_attribs_class_ox_1_1_model"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a20eb4db9cd1fa1cd0fa4b46e06e08d9c"></a>
const MeasureType *&#160;</td><td class="memItemRight" valign="bottom"><b>_InvTimes</b></td></tr>
<tr class="separator:a20eb4db9cd1fa1cd0fa4b46e06e08d9c inherit pro_attribs_class_ox_1_1_model"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7b00c7d8554d101dfdf86b2013200983 inherit pro_attribs_class_ox_1_1_model"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7b00c7d8554d101dfdf86b2013200983"></a>
const MeasureType *&#160;</td><td class="memItemRight" valign="bottom"><b>_EchoTimes</b></td></tr>
<tr class="separator:a7b00c7d8554d101dfdf86b2013200983 inherit pro_attribs_class_ox_1_1_model"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af2c4ac111d41ce5b6d5ca9f66ad36918 inherit pro_attribs_class_ox_1_1_model"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af2c4ac111d41ce5b6d5ca9f66ad36918"></a>
const MeasureType *&#160;</td><td class="memItemRight" valign="bottom"><b>_RepTimes</b></td></tr>
<tr class="separator:af2c4ac111d41ce5b6d5ca9f66ad36918 inherit pro_attribs_class_ox_1_1_model"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a093e159893a4ebf36452e470cda9a4d1 inherit pro_attribs_class_ox_1_1_model"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a093e159893a4ebf36452e470cda9a4d1"></a>
const MeasureType *&#160;</td><td class="memItemRight" valign="bottom"><b>_RelAcqTimes</b></td></tr>
<tr class="separator:a093e159893a4ebf36452e470cda9a4d1 inherit pro_attribs_class_ox_1_1_model"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a810156ed7ea865fa0980e6b05128a80c inherit pro_attribs_class_ox_1_1_model"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a810156ed7ea865fa0980e6b05128a80c"></a>
const MeasureType *&#160;</td><td class="memItemRight" valign="bottom"><b>_Signal</b></td></tr>
<tr class="separator:a810156ed7ea865fa0980e6b05128a80c inherit pro_attribs_class_ox_1_1_model"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1eb1604ca7c4587d4cb66ccc1d068adc inherit pro_attribs_class_ox_1_1_model"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1eb1604ca7c4587d4cb66ccc1d068adc"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>_nSamples</b></td></tr>
<tr class="separator:a1eb1604ca7c4587d4cb66ccc1d068adc inherit pro_attribs_class_ox_1_1_model"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae7c67e12cb601aafcce580b008d918cd inherit pro_attribs_class_ox_1_1_model"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae7c67e12cb601aafcce580b008d918cd"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>_nDims</b></td></tr>
<tr class="separator:ae7c67e12cb601aafcce580b008d918cd inherit pro_attribs_class_ox_1_1_model"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4f95dba7c1751745f8087e6cb98ba486 inherit pro_attribs_class_ox_1_1_model"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4f95dba7c1751745f8087e6cb98ba486"></a>
MeasureType *&#160;</td><td class="memItemRight" valign="bottom"><b>_Residuals</b></td></tr>
<tr class="separator:a4f95dba7c1751745f8087e6cb98ba486 inherit pro_attribs_class_ox_1_1_model"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename MeasureType&gt;<br/>
class Ox::ModelT2ThreeParam&lt; MeasureType &gt;</h3>

<p>Container for a ThreeParam model function <img class="formulaInl" alt="$ A + B\exp(t/T_2) $" src="form_2.png"/>, cost function and Least-Squares function and derivatives. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
  <table class="tparams">
    <tr><td class="paramname">MeasureType</td><td></td></tr>
  </table>
  </dd>
</dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a296bdf8378923d3e501c6e929608baca"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename MeasureType &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_ox_1_1_model_t2_three_param.html">Ox::ModelT2ThreeParam</a>&lt; MeasureType &gt;::calcCostDerivative </td>
          <td>(</td>
          <td class="paramtype">const MeasureType *&#160;</td>
          <td class="paramname"><em>parameters</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">MeasureType *&#160;</td>
          <td class="paramname"><em>derivative</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>calcCostDerivative the most important function of this class </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">derivative</td><td></td></tr>
  </table>
  </dd>
</dl>

<p>Implements <a class="el" href="class_ox_1_1_model.html#a274f0efdbbc364e82bba7470f933eecd">Ox::Model&lt; MeasureType &gt;</a>.</p>

</div>
</div>
<a class="anchor" id="afa54ff1c8de4f2c2cf2fd50e3e357e2b"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename MeasureType &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">MeasureType <a class="el" href="class_ox_1_1_model_t2_three_param.html">Ox::ModelT2ThreeParam</a>&lt; MeasureType &gt;::calcCostValue </td>
          <td>(</td>
          <td class="paramtype">const MeasureType *&#160;</td>
          <td class="paramname"><em>parameters</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>calcCostValue the most important function of this class </p>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>

<p>Implements <a class="el" href="class_ox_1_1_model.html#aa5997cea7114d0e323e79956adb13ba4">Ox::Model&lt; MeasureType &gt;</a>.</p>

</div>
</div>
<a class="anchor" id="a727daa3a07d63fc3efbf0559ce32de9b"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename MeasureType &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_ox_1_1_model_t2_three_param.html">Ox::ModelT2ThreeParam</a>&lt; MeasureType &gt;::calcLSJacobian </td>
          <td>(</td>
          <td class="paramtype">const MeasureType *&#160;</td>
          <td class="paramname"><em>parameters</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">MeasureType *&#160;</td>
          <td class="paramname"><em>jacobian</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>calcLSJacobian the most important function of this class </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">jacobian</td><td>- 2d matrix stored as 1d array </td></tr>
  </table>
  </dd>
</dl>

<p>Implements <a class="el" href="class_ox_1_1_model.html#a4cadb65b8416b4b30e91bf6db00737f3">Ox::Model&lt; MeasureType &gt;</a>.</p>

</div>
</div>
<a class="anchor" id="af959d697820c70df520f987ba5e75b78"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename MeasureType &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_ox_1_1_model_t2_three_param.html">Ox::ModelT2ThreeParam</a>&lt; MeasureType &gt;::calcLSResiduals </td>
          <td>(</td>
          <td class="paramtype">const MeasureType *&#160;</td>
          <td class="paramname"><em>parameters</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">MeasureType *&#160;</td>
          <td class="paramname"><em>residuals</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>calcLSResiduals the most important function of this class </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">residuals</td><td></td></tr>
  </table>
  </dd>
</dl>

<p>Implements <a class="el" href="class_ox_1_1_model.html#a17e0ef71135350d4f61bef2a097fb586">Ox::Model&lt; MeasureType &gt;</a>.</p>

</div>
</div>
<a class="anchor" id="a2ed5138a6db7e8b64c5c8d8275de70ac"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename MeasureType &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">MeasureType <a class="el" href="class_ox_1_1_model_t2_three_param.html">Ox::ModelT2ThreeParam</a>&lt; MeasureType &gt;::calcModelValue </td>
          <td>(</td>
          <td class="paramtype">const MeasureType *&#160;</td>
          <td class="paramname"><em>parameters</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">MeasureType&#160;</td>
          <td class="paramname"><em>time</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>calcModelValue the most important function of this class </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">time</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>model(time) </dd></dl>

<p>Implements <a class="el" href="class_ox_1_1_model.html#ae3a3f5bfeefd8a8c0c012e1761eac1f5">Ox::Model&lt; MeasureType &gt;</a>.</p>

</div>
</div>
<a class="anchor" id="a7a6d2bae4e394a99e9e8943af9f344d0"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename MeasureType&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="class_ox_1_1_model.html">Model</a>&lt;MeasureType&gt;* <a class="el" href="class_ox_1_1_model_t2_three_param.html">Ox::ModelT2ThreeParam</a>&lt; MeasureType &gt;::newByCloning </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>cloning </p>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>

<p>Implements <a class="el" href="class_ox_1_1_model.html#a694868476dd17a4d203f4ebc57047d2f">Ox::Model&lt; MeasureType &gt;</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>lib/<a class="el" href="_ox_model_t2_three_param_8h_source.html">OxModelT2ThreeParam.h</a></li>
<li>lib/<a class="el" href="_ox_model_t2_three_param_8hxx_source.html">OxModelT2ThreeParam.hxx</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><b>Ox</b></li><li class="navelem"><a class="el" href="class_ox_1_1_model_t2_three_param.html">ModelT2ThreeParam</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