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
class_ox_1_1_model.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::Model< MeasureType > 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 Page</span></a></li>
<li><a href="pages.html"><span>Related 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 List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class 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.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="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="class_ox_1_1_model-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Ox::Model< MeasureType > Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Container for a model function, cost function and Least-Squares function. And derivatives.
<a href="class_ox_1_1_model.html#details">More...</a></p>
<p><code>#include <<a class="el" href="_ox_model_8h_source.html">OxModel.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for Ox::Model< MeasureType >:</div>
<div class="dyncontent">
<div class="center"><img src="class_ox_1_1_model__inherit__graph.png" border="0" usemap="#_ox_1_1_model_3_01_measure_type_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="_ox_1_1_model_3_01_measure_type_01_4_inherit__map" id="_ox_1_1_model_3_01_measure_type_01_4_inherit__map">
<area shape="rect" id="node2" href="class_ox_1_1_model_t1_shmolli.html" title="Container for a CalculatorShmolli model function , cost function and Least-Squares function and deriv..." alt="" coords="254,5,394,46"/><area shape="rect" id="node3" href="class_ox_1_1_model_t1_three_param.html" title="Container for a ThreeParam model function , cost function and Least-Squares function and derivatives..." alt="" coords="240,70,408,111"/><area shape="rect" id="node4" href="class_ox_1_1_model_t1_two_param.html" title="Container for a TwoParam model function , cost function and Least-Squares function and derivatives..." alt="" coords="244,135,404,177"/><area shape="rect" id="node5" href="class_ox_1_1_model_t2_three_param.html" title="Container for a ThreeParam model function , cost function and Least-Squares function and derivatives..." alt="" coords="240,201,408,242"/><area shape="rect" id="node6" href="class_ox_1_1_model_t2_two_param.html" title="Container for a TwoParam model function , cost function and Least-Squares function and derivatives..." alt="" coords="244,266,404,307"/></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:ae3a3f5bfeefd8a8c0c012e1761eac1f5"><td class="memItemLeft" align="right" valign="top">virtual MeasureType </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ox_1_1_model.html#ae3a3f5bfeefd8a8c0c012e1761eac1f5">calcModelValue</a> (const MeasureType *parameters, MeasureType time)=0</td></tr>
<tr class="separator:ae3a3f5bfeefd8a8c0c012e1761eac1f5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a17e0ef71135350d4f61bef2a097fb586"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ox_1_1_model.html#a17e0ef71135350d4f61bef2a097fb586">calcLSResiduals</a> (const MeasureType *parameters, MeasureType *residuals)=0</td></tr>
<tr class="separator:a17e0ef71135350d4f61bef2a097fb586"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa5997cea7114d0e323e79956adb13ba4"><td class="memItemLeft" align="right" valign="top">virtual MeasureType </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ox_1_1_model.html#aa5997cea7114d0e323e79956adb13ba4">calcCostValue</a> (const MeasureType *parameters)=0</td></tr>
<tr class="separator:aa5997cea7114d0e323e79956adb13ba4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a274f0efdbbc364e82bba7470f933eecd"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ox_1_1_model.html#a274f0efdbbc364e82bba7470f933eecd">calcCostDerivative</a> (const MeasureType *parameters, MeasureType *derivative)=0</td></tr>
<tr class="separator:a274f0efdbbc364e82bba7470f933eecd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4cadb65b8416b4b30e91bf6db00737f3"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ox_1_1_model.html#a4cadb65b8416b4b30e91bf6db00737f3">calcLSJacobian</a> (const MeasureType *parameters, MeasureType *jacobian)=0</td></tr>
<tr class="separator:a4cadb65b8416b4b30e91bf6db00737f3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a29715e78ec12b91c56df85fc0f782ea7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a29715e78ec12b91c56df85fc0f782ea7"></a>
virtual int </td><td class="memItemRight" valign="bottom"><b>getNSamples</b> ()</td></tr>
<tr class="separator:a29715e78ec12b91c56df85fc0f782ea7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7c7497927d9aa7f0c3aa5933e4a7ff7d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7c7497927d9aa7f0c3aa5933e4a7ff7d"></a>
virtual const MeasureType * </td><td class="memItemRight" valign="bottom"><b>getInvTimes</b> () const </td></tr>
<tr class="separator:a7c7497927d9aa7f0c3aa5933e4a7ff7d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1606369f7a57a69c9944a54a135bc1f4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1606369f7a57a69c9944a54a135bc1f4"></a>
virtual const MeasureType * </td><td class="memItemRight" valign="bottom"><b>getEchoTimes</b> () const </td></tr>
<tr class="separator:a1606369f7a57a69c9944a54a135bc1f4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad1ecd4e858e0a5386a27505ec78135c5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad1ecd4e858e0a5386a27505ec78135c5"></a>
virtual const MeasureType * </td><td class="memItemRight" valign="bottom"><b>getRepTimes</b> () const </td></tr>
<tr class="separator:ad1ecd4e858e0a5386a27505ec78135c5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ada677d0048ec4544f8975c44ae3bc3d9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ada677d0048ec4544f8975c44ae3bc3d9"></a>
virtual const MeasureType * </td><td class="memItemRight" valign="bottom"><b>getRelAcqTimes</b> () const </td></tr>
<tr class="separator:ada677d0048ec4544f8975c44ae3bc3d9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae51878e45fa528e47a457610d857a9bb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae51878e45fa528e47a457610d857a9bb"></a>
virtual const MeasureType * </td><td class="memItemRight" valign="bottom"><b>getSignal</b> () const </td></tr>
<tr class="separator:ae51878e45fa528e47a457610d857a9bb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af457ac73701b13fa1b3af8d800e198dc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af457ac73701b13fa1b3af8d800e198dc"></a>
virtual int </td><td class="memItemRight" valign="bottom"><b>getNDims</b> ()</td></tr>
<tr class="separator:af457ac73701b13fa1b3af8d800e198dc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9e37f6db1210b7b4a58d7ad38ba6b422"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9e37f6db1210b7b4a58d7ad38ba6b422"></a>
void </td><td class="memItemRight" valign="bottom"><b>setNSamples</b> (int _nSamples)</td></tr>
<tr class="separator:a9e37f6db1210b7b4a58d7ad38ba6b422"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2db9a20a6915dc41bce2deecec7c390a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2db9a20a6915dc41bce2deecec7c390a"></a>
virtual void </td><td class="memItemRight" valign="bottom"><b>setInvTimes</b> (const MeasureType *_InvTimes)</td></tr>
<tr class="separator:a2db9a20a6915dc41bce2deecec7c390a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac63fba341cfe586ec210f59fcdc0d715"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac63fba341cfe586ec210f59fcdc0d715"></a>
virtual void </td><td class="memItemRight" valign="bottom"><b>setEchoTimes</b> (const MeasureType *_EchoTimes)</td></tr>
<tr class="separator:ac63fba341cfe586ec210f59fcdc0d715"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af272a398debaf156f345d85940bec556"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af272a398debaf156f345d85940bec556"></a>
virtual void </td><td class="memItemRight" valign="bottom"><b>setRepTimes</b> (const MeasureType *_RepTimes)</td></tr>
<tr class="separator:af272a398debaf156f345d85940bec556"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a534bfcec58d93c7002a6c0eb4d58ed88"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a534bfcec58d93c7002a6c0eb4d58ed88"></a>
virtual void </td><td class="memItemRight" valign="bottom"><b>setRelAcqTimes</b> (const MeasureType *_RelAcqTimes)</td></tr>
<tr class="separator:a534bfcec58d93c7002a6c0eb4d58ed88"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abb7eddc8c8c4ac94ab921158ce3a38a3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abb7eddc8c8c4ac94ab921158ce3a38a3"></a>
virtual void </td><td class="memItemRight" valign="bottom"><b>setSignal</b> (const MeasureType *_Signal)</td></tr>
<tr class="separator:abb7eddc8c8c4ac94ab921158ce3a38a3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae2c46e9820947efd450a93aaf53a0db5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae2c46e9820947efd450a93aaf53a0db5"></a>
virtual void </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"><td class="mdescLeft"> </td><td class="mdescRight">show me your ModelT1 <br/></td></tr>
<tr class="separator:ae2c46e9820947efd450a93aaf53a0db5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8186fd758a6f94d9e3af204b6c1aac3c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8186fd758a6f94d9e3af204b6c1aac3c"></a>
void </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"><td class="mdescLeft"> </td><td class="mdescRight">set all the pointers to zero <br/></td></tr>
<tr class="separator:a8186fd758a6f94d9e3af204b6c1aac3c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a73f93cd40d0eddc1d3ff474fc2505fc2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a73f93cd40d0eddc1d3ff474fc2505fc2"></a>
 </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"><td class="mdescLeft"> </td><td class="mdescRight">constructor <br/></td></tr>
<tr class="separator:a73f93cd40d0eddc1d3ff474fc2505fc2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a01911912db830e4814645a675990a906"><td class="memItemLeft" align="right" valign="top"> </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> &old)</td></tr>
<tr class="memdesc:a01911912db830e4814645a675990a906"><td class="mdescLeft"> </td><td class="mdescRight">copy constructor keeps only _nSamples and _nDims <a href="#a01911912db830e4814645a675990a906">More...</a><br/></td></tr>
<tr class="separator:a01911912db830e4814645a675990a906"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a694868476dd17a4d203f4ebc57047d2f"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_ox_1_1_model.html">Model</a>< MeasureType > * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ox_1_1_model.html#a694868476dd17a4d203f4ebc57047d2f">newByCloning</a> ()=0</td></tr>
<tr class="separator:a694868476dd17a4d203f4ebc57047d2f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6353ac7352cdbbed2d00d9ed9e697c88"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6353ac7352cdbbed2d00d9ed9e697c88"></a>
virtual </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"><td class="mdescLeft"> </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"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a20eb4db9cd1fa1cd0fa4b46e06e08d9c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a20eb4db9cd1fa1cd0fa4b46e06e08d9c"></a>
const MeasureType * </td><td class="memItemRight" valign="bottom"><b>_InvTimes</b></td></tr>
<tr class="separator:a20eb4db9cd1fa1cd0fa4b46e06e08d9c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7b00c7d8554d101dfdf86b2013200983"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7b00c7d8554d101dfdf86b2013200983"></a>
const MeasureType * </td><td class="memItemRight" valign="bottom"><b>_EchoTimes</b></td></tr>
<tr class="separator:a7b00c7d8554d101dfdf86b2013200983"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af2c4ac111d41ce5b6d5ca9f66ad36918"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af2c4ac111d41ce5b6d5ca9f66ad36918"></a>
const MeasureType * </td><td class="memItemRight" valign="bottom"><b>_RepTimes</b></td></tr>
<tr class="separator:af2c4ac111d41ce5b6d5ca9f66ad36918"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a093e159893a4ebf36452e470cda9a4d1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a093e159893a4ebf36452e470cda9a4d1"></a>
const MeasureType * </td><td class="memItemRight" valign="bottom"><b>_RelAcqTimes</b></td></tr>
<tr class="separator:a093e159893a4ebf36452e470cda9a4d1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a810156ed7ea865fa0980e6b05128a80c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a810156ed7ea865fa0980e6b05128a80c"></a>
const MeasureType * </td><td class="memItemRight" valign="bottom"><b>_Signal</b></td></tr>
<tr class="separator:a810156ed7ea865fa0980e6b05128a80c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1eb1604ca7c4587d4cb66ccc1d068adc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1eb1604ca7c4587d4cb66ccc1d068adc"></a>
int </td><td class="memItemRight" valign="bottom"><b>_nSamples</b></td></tr>
<tr class="separator:a1eb1604ca7c4587d4cb66ccc1d068adc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae7c67e12cb601aafcce580b008d918cd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae7c67e12cb601aafcce580b008d918cd"></a>
int </td><td class="memItemRight" valign="bottom"><b>_nDims</b></td></tr>
<tr class="separator:ae7c67e12cb601aafcce580b008d918cd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4f95dba7c1751745f8087e6cb98ba486"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4f95dba7c1751745f8087e6cb98ba486"></a>
MeasureType * </td><td class="memItemRight" valign="bottom"><b>_Residuals</b></td></tr>
<tr class="separator:a4f95dba7c1751745f8087e6cb98ba486"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template<typename MeasureType><br/>
class Ox::Model< MeasureType ></h3>
<p>Container for a model function, cost function and Least-Squares function. And derivatives. </p>
<p>Here model function is defined - <a class="el" href="class_ox_1_1_model.html#ae3a3f5bfeefd8a8c0c012e1761eac1f5">calcModelValue()</a>. Fitting algorithms based on optimisation need a cost function - <a class="el" href="class_ox_1_1_model.html#aa5997cea7114d0e323e79956adb13ba4">calcCostValue()</a>. Fitting algorithms based on least squares need a residuals calculation - <a class="el" href="class_ox_1_1_model.html#a17e0ef71135350d4f61bef2a097fb586">calcLSResiduals()</a>. Some fitting algorithms use derivatives, hence <a class="el" href="class_ox_1_1_model.html#a4cadb65b8416b4b30e91bf6db00737f3">calcLSJacobian()</a> and <a class="el" href="class_ox_1_1_model.html#a274f0efdbbc364e82bba7470f933eecd">calcCostDerivative()</a>. The member variables are pointers to c-arrays, we need to know how many samples we want to process. That's the nSamples defined in the constructor. </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">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a01911912db830e4814645a675990a906"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename MeasureType > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_ox_1_1_model.html">Ox::Model</a>< MeasureType >::<a class="el" href="class_ox_1_1_model.html">Model</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_ox_1_1_model.html">Model</a>< MeasureType > & </td>
<td class="paramname"><em>old</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>copy constructor keeps only _nSamples and _nDims </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">old</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a274f0efdbbc364e82bba7470f933eecd"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename MeasureType> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="class_ox_1_1_model.html">Ox::Model</a>< MeasureType >::calcCostDerivative </td>
<td>(</td>
<td class="paramtype">const MeasureType * </td>
<td class="paramname"><em>parameters</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">MeasureType * </td>
<td class="paramname"><em>derivative</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure 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>Implemented in <a class="el" href="class_ox_1_1_model_t1_shmolli.html#afaadbc879361f3ea674fe79a9fc1cf49">Ox::ModelT1Shmolli< MeasureType ></a>, <a class="el" href="class_ox_1_1_model_t1_three_param.html#a7bd09162c315aa491af661cf8d88bcdd">Ox::ModelT1ThreeParam< MeasureType ></a>, <a class="el" href="class_ox_1_1_model_t1_two_param.html#a328e0fdc6b5769ecc3327596c9b12be3">Ox::ModelT1TwoParam< MeasureType ></a>, <a class="el" href="class_ox_1_1_model_t2_three_param.html#a296bdf8378923d3e501c6e929608baca">Ox::ModelT2ThreeParam< MeasureType ></a>, and <a class="el" href="class_ox_1_1_model_t2_two_param.html#a4957d8cf05666364c6c21483fd0f9fa9">Ox::ModelT2TwoParam< MeasureType ></a>.</p>
</div>
</div>
<a class="anchor" id="aa5997cea7114d0e323e79956adb13ba4"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename MeasureType> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual MeasureType <a class="el" href="class_ox_1_1_model.html">Ox::Model</a>< MeasureType >::calcCostValue </td>
<td>(</td>
<td class="paramtype">const MeasureType * </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">pure 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>Implemented in <a class="el" href="class_ox_1_1_model_t1_shmolli.html#a0f9b89832a6321b5b54abb9e219e803d">Ox::ModelT1Shmolli< MeasureType ></a>, <a class="el" href="class_ox_1_1_model_t1_three_param.html#ad417e4455caae28f1364f82b5f8f37d5">Ox::ModelT1ThreeParam< MeasureType ></a>, <a class="el" href="class_ox_1_1_model_t1_two_param.html#ab4ec672167094e84f2fddc5d052d528c">Ox::ModelT1TwoParam< MeasureType ></a>, <a class="el" href="class_ox_1_1_model_t2_three_param.html#afa54ff1c8de4f2c2cf2fd50e3e357e2b">Ox::ModelT2ThreeParam< MeasureType ></a>, and <a class="el" href="class_ox_1_1_model_t2_two_param.html#abd88af16b5860a18632453ca1ce858b4">Ox::ModelT2TwoParam< MeasureType ></a>.</p>
</div>
</div>
<a class="anchor" id="a4cadb65b8416b4b30e91bf6db00737f3"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename MeasureType> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="class_ox_1_1_model.html">Ox::Model</a>< MeasureType >::calcLSJacobian </td>
<td>(</td>
<td class="paramtype">const MeasureType * </td>
<td class="paramname"><em>parameters</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">MeasureType * </td>
<td class="paramname"><em>jacobian</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure 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>Implemented in <a class="el" href="class_ox_1_1_model_t1_shmolli.html#a667e5c9088ba65e0cba506246671e3da">Ox::ModelT1Shmolli< MeasureType ></a>, <a class="el" href="class_ox_1_1_model_t1_three_param.html#a2b6268cb77c6a9d95c7861641cd3a2d5">Ox::ModelT1ThreeParam< MeasureType ></a>, <a class="el" href="class_ox_1_1_model_t1_two_param.html#af5952a47062e6edffe78f8594cc220e4">Ox::ModelT1TwoParam< MeasureType ></a>, <a class="el" href="class_ox_1_1_model_t2_three_param.html#a727daa3a07d63fc3efbf0559ce32de9b">Ox::ModelT2ThreeParam< MeasureType ></a>, and <a class="el" href="class_ox_1_1_model_t2_two_param.html#af056e278a340918eb57f23f63ba2f23c">Ox::ModelT2TwoParam< MeasureType ></a>.</p>
</div>
</div>
<a class="anchor" id="a17e0ef71135350d4f61bef2a097fb586"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename MeasureType> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="class_ox_1_1_model.html">Ox::Model</a>< MeasureType >::calcLSResiduals </td>
<td>(</td>
<td class="paramtype">const MeasureType * </td>
<td class="paramname"><em>parameters</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">MeasureType * </td>
<td class="paramname"><em>residuals</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure 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>Implemented in <a class="el" href="class_ox_1_1_model_t1_shmolli.html#ae393758f44f51e2fddae4c3c919fe4db">Ox::ModelT1Shmolli< MeasureType ></a>, <a class="el" href="class_ox_1_1_model_t1_three_param.html#abef151c12e9b7d49e23955dd1ae9c992">Ox::ModelT1ThreeParam< MeasureType ></a>, <a class="el" href="class_ox_1_1_model_t1_two_param.html#a8c02d34fac5a35310f6ee60209f70d45">Ox::ModelT1TwoParam< MeasureType ></a>, <a class="el" href="class_ox_1_1_model_t2_three_param.html#af959d697820c70df520f987ba5e75b78">Ox::ModelT2ThreeParam< MeasureType ></a>, and <a class="el" href="class_ox_1_1_model_t2_two_param.html#a7f4e4edc966189fb95f6fcbbd6417c5f">Ox::ModelT2TwoParam< MeasureType ></a>.</p>
</div>
</div>
<a class="anchor" id="ae3a3f5bfeefd8a8c0c012e1761eac1f5"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename MeasureType> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual MeasureType <a class="el" href="class_ox_1_1_model.html">Ox::Model</a>< MeasureType >::calcModelValue </td>
<td>(</td>
<td class="paramtype">const MeasureType * </td>
<td class="paramname"><em>parameters</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">MeasureType </td>
<td class="paramname"><em>time</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure 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>Implemented in <a class="el" href="class_ox_1_1_model_t1_shmolli.html#a72576d4db2ff938037c3d9d4fe25b9d7">Ox::ModelT1Shmolli< MeasureType ></a>, <a class="el" href="class_ox_1_1_model_t1_three_param.html#a4b2e40499a77399cc3dd74fbe9a02aee">Ox::ModelT1ThreeParam< MeasureType ></a>, <a class="el" href="class_ox_1_1_model_t1_two_param.html#aaa8218e3d53e1913589d272bcbb62b47">Ox::ModelT1TwoParam< MeasureType ></a>, <a class="el" href="class_ox_1_1_model_t2_three_param.html#a2ed5138a6db7e8b64c5c8d8275de70ac">Ox::ModelT2ThreeParam< MeasureType ></a>, and <a class="el" href="class_ox_1_1_model_t2_two_param.html#a1401dbd94a7a23903f22013af44c4648">Ox::ModelT2TwoParam< MeasureType ></a>.</p>
</div>
</div>
<a class="anchor" id="a694868476dd17a4d203f4ebc57047d2f"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename MeasureType> </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><MeasureType>* <a class="el" href="class_ox_1_1_model.html">Ox::Model</a>< MeasureType >::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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>cloning </p>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
<p>Implemented in <a class="el" href="class_ox_1_1_model_t1_shmolli.html#a846fb817183738d5c2b3f9f126c1597b">Ox::ModelT1Shmolli< MeasureType ></a>, <a class="el" href="class_ox_1_1_model_t1_three_param.html#afc6ffe41934c513e12a45cc5821fddca">Ox::ModelT1ThreeParam< MeasureType ></a>, <a class="el" href="class_ox_1_1_model_t1_two_param.html#aa090c6834141f00a966eebd6b0415e44">Ox::ModelT1TwoParam< MeasureType ></a>, <a class="el" href="class_ox_1_1_model_t2_three_param.html#a7a6d2bae4e394a99e9e8943af9f344d0">Ox::ModelT2ThreeParam< MeasureType ></a>, and <a class="el" href="class_ox_1_1_model_t2_two_param.html#a64afe7ef809a611d93df0d8f695f1a22">Ox::ModelT2TwoParam< MeasureType ></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_8h_source.html">OxModel.h</a></li>
<li>lib/<a class="el" href="_ox_model_8hxx_source.html">OxModel.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.html">Model</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>
