← Back to branch summary

~ubuntu-branches/ubuntu/wily/openms/wily

« back to all changes in this revision

Viewing changes to doc/html/classOpenMS_1_1TransformationModelLinear.html

  • Committer: Package Import Robot
  • Author(s): Filippo Rusconi
  • Date: 2013-12-20 11:30:16 UTC
  • mfrom: (5.1.2 sid)
  • Revision ID: package-import@ubuntu.com-20131220113016-wre5g9bteeheq6he
Tags: 1.11.1-3
* remove version number from libbost development package names;
* ensure that AUTHORS is correctly shipped in all packages.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/classOpenMS_1_1TransformationModelLinear.html
 
1
<HTML>
 
2
<HEAD>
 
3
<TITLE>TransformationModelLinear Class Reference</TITLE>
 
4
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
 
5
<LINK HREF="style_ini.css" REL="stylesheet" TYPE="text/css">
 
6
</HEAD>
 
7
<BODY BGCOLOR="#FFFFFF">
 
8
<A href="index.html">Home</A> &nbsp;&middot;
 
9
<A href="classes.html">Classes</A> &nbsp;&middot;
 
10
<A href="annotated.html">Annotated Classes</A> &nbsp;&middot;
 
11
<A href="modules.html">Modules</A> &nbsp;&middot;
 
12
<A href="functions_func.html">Members</A> &nbsp;&middot;
 
13
<A href="namespaces.html">Namespaces</A> &nbsp;&middot;
 
14
<A href="pages.html">Related Pages</A>
 
15
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
 
16
<!-- Generated by Doxygen 1.8.5 -->
 
17
<div id="nav-path" class="navpath">
 
18
  <ul>
 
19
<li class="navelem"><a class="el" href="namespaceOpenMS.html">OpenMS</a></li><li class="navelem"><a class="el" href="classOpenMS_1_1TransformationModelLinear.html">TransformationModelLinear</a></li>  </ul>
 
20
</div>
 
21
</div><!-- top -->
 
22
<div class="header">
 
23
  <div class="summary">
 
24
<a href="#pub-methods">Public Member Functions</a> &#124;
 
25
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
 
26
<a href="#pro-attribs">Protected Attributes</a> &#124;
 
27
<a href="classOpenMS_1_1TransformationModelLinear-members.html">List of all members</a>  </div>
 
28
  <div class="headertitle">
 
29
<div class="title">TransformationModelLinear Class Reference<div class="ingroups"><a class="el" href="group__MapAlignment.html">MapAlignment</a></div></div>  </div>
 
30
</div><!--header-->
 
31
<div class="contents">
 
32
 
 
33
<p>Linear model for transformations.  
 
34
 <a href="classOpenMS_1_1TransformationModelLinear.html#details">More...</a></p>
 
35
 
 
36
<p><code>#include &lt;<a class="el" href="TransformationModel_8h_source.html">OpenMS/ANALYSIS/MAPMATCHING/TransformationModel.h</a>&gt;</code></p>
 
37
<div class="dynheader">
 
38
Inheritance diagram for TransformationModelLinear:</div>
 
39
<div class="dyncontent">
 
40
 <div class="center">
 
41
  <img src="classOpenMS_1_1TransformationModelLinear.png" usemap="#TransformationModelLinear_map" alt=""/>
 
42
  <map id="TransformationModelLinear_map" name="TransformationModelLinear_map">
 
43
<area href="classOpenMS_1_1TransformationModel.html" title="Base class for transformation models. " alt="TransformationModel" shape="rect" coords="0,0,167,24"/>
 
44
</map>
 
45
 </div></div>
 
46
<table class="memberdecls">
 
47
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 
48
Public Member Functions</h2></td></tr>
 
49
<tr class="memitem:a21a3debb15429fd0860f74ba73b8a47e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1TransformationModelLinear.html#a21a3debb15429fd0860f74ba73b8a47e">TransformationModelLinear</a> (const <a class="el" href="classOpenMS_1_1TransformationModel.html#a4067970d097e9b2f62de2058276b0c24">DataPoints</a> &amp;data, const <a class="el" href="classOpenMS_1_1Param.html">Param</a> &amp;params)</td></tr>
 
50
<tr class="memdesc:a21a3debb15429fd0860f74ba73b8a47e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a21a3debb15429fd0860f74ba73b8a47e">More...</a><br/></td></tr>
 
51
<tr class="separator:a21a3debb15429fd0860f74ba73b8a47e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
52
<tr class="memitem:a80eb9727e140a0c508961a736a505d22"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1TransformationModelLinear.html#a80eb9727e140a0c508961a736a505d22">~TransformationModelLinear</a> ()</td></tr>
 
53
<tr class="memdesc:a80eb9727e140a0c508961a736a505d22"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#a80eb9727e140a0c508961a736a505d22">More...</a><br/></td></tr>
 
54
<tr class="separator:a80eb9727e140a0c508961a736a505d22"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
55
<tr class="memitem:a1562399d507d343b4cb759a6e3d5470a"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1TransformationModelLinear.html#a1562399d507d343b4cb759a6e3d5470a">evaluate</a> (const <a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a> value) const </td></tr>
 
56
<tr class="memdesc:a1562399d507d343b4cb759a6e3d5470a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Evaluates the model at the given value.  <a href="#a1562399d507d343b4cb759a6e3d5470a">More...</a><br/></td></tr>
 
57
<tr class="separator:a1562399d507d343b4cb759a6e3d5470a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
58
<tr class="memitem:a95d2535c860edfd293b86d4d09603800"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1TransformationModelLinear.html#a95d2535c860edfd293b86d4d09603800">getParameters</a> (<a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a> &amp;slope, <a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a> &amp;intercept) const </td></tr>
 
59
<tr class="memdesc:a95d2535c860edfd293b86d4d09603800"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the "real" parameters.  <a href="#a95d2535c860edfd293b86d4d09603800">More...</a><br/></td></tr>
 
60
<tr class="separator:a95d2535c860edfd293b86d4d09603800"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
61
<tr class="memitem:a7fa1616cc61c19a5efcc863c950f7f30"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1TransformationModelLinear.html#a7fa1616cc61c19a5efcc863c950f7f30">invert</a> ()</td></tr>
 
62
<tr class="memdesc:a7fa1616cc61c19a5efcc863c950f7f30"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes the inverse.  <a href="#a7fa1616cc61c19a5efcc863c950f7f30">More...</a><br/></td></tr>
 
63
<tr class="separator:a7fa1616cc61c19a5efcc863c950f7f30"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
64
<tr class="inherit_header pub_methods_classOpenMS_1_1TransformationModel"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classOpenMS_1_1TransformationModel')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classOpenMS_1_1TransformationModel.html">TransformationModel</a></td></tr>
 
65
<tr class="memitem:a2b84910d6d7bd930ff4651f01616d95f inherit pub_methods_classOpenMS_1_1TransformationModel"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1TransformationModel.html#a2b84910d6d7bd930ff4651f01616d95f">TransformationModel</a> ()</td></tr>
 
66
<tr class="memdesc:a2b84910d6d7bd930ff4651f01616d95f inherit pub_methods_classOpenMS_1_1TransformationModel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a2b84910d6d7bd930ff4651f01616d95f">More...</a><br/></td></tr>
 
67
<tr class="separator:a2b84910d6d7bd930ff4651f01616d95f inherit pub_methods_classOpenMS_1_1TransformationModel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
68
<tr class="memitem:a30dddf822bf60a5b250a5b3da95e2bd4 inherit pub_methods_classOpenMS_1_1TransformationModel"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1TransformationModel.html#a30dddf822bf60a5b250a5b3da95e2bd4">TransformationModel</a> (const <a class="el" href="classOpenMS_1_1TransformationModel.html#a4067970d097e9b2f62de2058276b0c24">TransformationModel::DataPoints</a> &amp;, const <a class="el" href="classOpenMS_1_1Param.html">Param</a> &amp;)</td></tr>
 
69
<tr class="memdesc:a30dddf822bf60a5b250a5b3da95e2bd4 inherit pub_methods_classOpenMS_1_1TransformationModel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Alternative constructor (derived classes should implement this one!)  <a href="#a30dddf822bf60a5b250a5b3da95e2bd4">More...</a><br/></td></tr>
 
70
<tr class="separator:a30dddf822bf60a5b250a5b3da95e2bd4 inherit pub_methods_classOpenMS_1_1TransformationModel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
71
<tr class="memitem:a7f0376d313bdd03d5b99111f85a589bd inherit pub_methods_classOpenMS_1_1TransformationModel"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1TransformationModel.html#a7f0376d313bdd03d5b99111f85a589bd">~TransformationModel</a> ()</td></tr>
 
72
<tr class="memdesc:a7f0376d313bdd03d5b99111f85a589bd inherit pub_methods_classOpenMS_1_1TransformationModel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#a7f0376d313bdd03d5b99111f85a589bd">More...</a><br/></td></tr>
 
73
<tr class="separator:a7f0376d313bdd03d5b99111f85a589bd inherit pub_methods_classOpenMS_1_1TransformationModel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
74
<tr class="memitem:a4d012735f1d877dc02a0041f459b7891 inherit pub_methods_classOpenMS_1_1TransformationModel"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1TransformationModel.html#a4d012735f1d877dc02a0041f459b7891">getParameters</a> (<a class="el" href="classOpenMS_1_1Param.html">Param</a> &amp;params) const </td></tr>
 
75
<tr class="memdesc:a4d012735f1d877dc02a0041f459b7891 inherit pub_methods_classOpenMS_1_1TransformationModel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the (actual) parameters.  <a href="#a4d012735f1d877dc02a0041f459b7891">More...</a><br/></td></tr>
 
76
<tr class="separator:a4d012735f1d877dc02a0041f459b7891 inherit pub_methods_classOpenMS_1_1TransformationModel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
77
</table><table class="memberdecls">
 
78
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
 
79
Static Public Member Functions</h2></td></tr>
 
80
<tr class="memitem:a39100a3d6235b7512df3d2731d016934"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1TransformationModelLinear.html#a39100a3d6235b7512df3d2731d016934">getDefaultParameters</a> (<a class="el" href="classOpenMS_1_1Param.html">Param</a> &amp;params)</td></tr>
 
81
<tr class="memdesc:a39100a3d6235b7512df3d2731d016934"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the default parameters.  <a href="#a39100a3d6235b7512df3d2731d016934">More...</a><br/></td></tr>
 
82
<tr class="separator:a39100a3d6235b7512df3d2731d016934"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
83
<tr class="inherit_header pub_static_methods_classOpenMS_1_1TransformationModel"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classOpenMS_1_1TransformationModel')"><img src="closed.png" alt="-"/>&#160;Static Public Member Functions inherited from <a class="el" href="classOpenMS_1_1TransformationModel.html">TransformationModel</a></td></tr>
 
84
<tr class="memitem:a39100a3d6235b7512df3d2731d016934 inherit pub_static_methods_classOpenMS_1_1TransformationModel"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1TransformationModel.html#a39100a3d6235b7512df3d2731d016934">getDefaultParameters</a> (<a class="el" href="classOpenMS_1_1Param.html">Param</a> &amp;params)</td></tr>
 
85
<tr class="memdesc:a39100a3d6235b7512df3d2731d016934 inherit pub_static_methods_classOpenMS_1_1TransformationModel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the default parameters.  <a href="#a39100a3d6235b7512df3d2731d016934">More...</a><br/></td></tr>
 
86
<tr class="separator:a39100a3d6235b7512df3d2731d016934 inherit pub_static_methods_classOpenMS_1_1TransformationModel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
87
</table><table class="memberdecls">
 
88
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
 
89
Protected Attributes</h2></td></tr>
 
90
<tr class="memitem:a7810770fb0835d5813492491bc0e5e87"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1TransformationModelLinear.html#a7810770fb0835d5813492491bc0e5e87">slope_</a></td></tr>
 
91
<tr class="memdesc:a7810770fb0835d5813492491bc0e5e87"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parameters of the linear model.  <a href="#a7810770fb0835d5813492491bc0e5e87">More...</a><br/></td></tr>
 
92
<tr class="separator:a7810770fb0835d5813492491bc0e5e87"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
93
<tr class="memitem:a257ff0c4f1b2ff5b9ddbe141ed5cacd5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1TransformationModelLinear.html#a257ff0c4f1b2ff5b9ddbe141ed5cacd5">intercept_</a></td></tr>
 
94
<tr class="separator:a257ff0c4f1b2ff5b9ddbe141ed5cacd5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
95
<tr class="memitem:aa5d41f3562d8f5dfc128c7fe47202275"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1TransformationModelLinear.html#aa5d41f3562d8f5dfc128c7fe47202275">data_given_</a></td></tr>
 
96
<tr class="memdesc:aa5d41f3562d8f5dfc128c7fe47202275"><td class="mdescLeft">&#160;</td><td class="mdescRight">Was the model estimated from data?  <a href="#aa5d41f3562d8f5dfc128c7fe47202275">More...</a><br/></td></tr>
 
97
<tr class="separator:aa5d41f3562d8f5dfc128c7fe47202275"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
98
<tr class="memitem:ab4bda0318b186ad5113740ee5102ddb6"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1TransformationModelLinear.html#ab4bda0318b186ad5113740ee5102ddb6">symmetric_</a></td></tr>
 
99
<tr class="memdesc:ab4bda0318b186ad5113740ee5102ddb6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Use symmetric regression?  <a href="#ab4bda0318b186ad5113740ee5102ddb6">More...</a><br/></td></tr>
 
100
<tr class="separator:ab4bda0318b186ad5113740ee5102ddb6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
101
<tr class="inherit_header pro_attribs_classOpenMS_1_1TransformationModel"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classOpenMS_1_1TransformationModel')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classOpenMS_1_1TransformationModel.html">TransformationModel</a></td></tr>
 
102
<tr class="memitem:a20793411214daa54c7571bf9fccd5ccf inherit pro_attribs_classOpenMS_1_1TransformationModel"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1Param.html">Param</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1TransformationModel.html#a20793411214daa54c7571bf9fccd5ccf">params_</a></td></tr>
 
103
<tr class="memdesc:a20793411214daa54c7571bf9fccd5ccf inherit pro_attribs_classOpenMS_1_1TransformationModel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parameters.  <a href="#a20793411214daa54c7571bf9fccd5ccf">More...</a><br/></td></tr>
 
104
<tr class="separator:a20793411214daa54c7571bf9fccd5ccf inherit pro_attribs_classOpenMS_1_1TransformationModel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
105
</table><table class="memberdecls">
 
106
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
 
107
Additional Inherited Members</h2></td></tr>
 
108
<tr class="inherit_header pub_types_classOpenMS_1_1TransformationModel"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classOpenMS_1_1TransformationModel')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="classOpenMS_1_1TransformationModel.html">TransformationModel</a></td></tr>
 
109
<tr class="memitem:ac93bbaab8952124bfb6a32870b773ac1 inherit pub_types_classOpenMS_1_1TransformationModel"><td class="memItemLeft" align="right" valign="top">typedef std::pair&lt; <a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a>, <br class="typebreak"/>
 
110
<a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1TransformationModel.html#ac93bbaab8952124bfb6a32870b773ac1">DataPoint</a></td></tr>
 
111
<tr class="memdesc:ac93bbaab8952124bfb6a32870b773ac1 inherit pub_types_classOpenMS_1_1TransformationModel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Coordinate pair.  <a href="#ac93bbaab8952124bfb6a32870b773ac1">More...</a><br/></td></tr>
 
112
<tr class="separator:ac93bbaab8952124bfb6a32870b773ac1 inherit pub_types_classOpenMS_1_1TransformationModel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
113
<tr class="memitem:a4067970d097e9b2f62de2058276b0c24 inherit pub_types_classOpenMS_1_1TransformationModel"><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; <a class="el" href="classOpenMS_1_1TransformationModel.html#ac93bbaab8952124bfb6a32870b773ac1">DataPoint</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1TransformationModel.html#a4067970d097e9b2f62de2058276b0c24">DataPoints</a></td></tr>
 
114
<tr class="memdesc:a4067970d097e9b2f62de2058276b0c24 inherit pub_types_classOpenMS_1_1TransformationModel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Vector of coordinate pairs.  <a href="#a4067970d097e9b2f62de2058276b0c24">More...</a><br/></td></tr>
 
115
<tr class="separator:a4067970d097e9b2f62de2058276b0c24 inherit pub_types_classOpenMS_1_1TransformationModel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
116
</table>
 
117
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 
118
<div class="textblock"><p>Linear model for transformations. </p>
 
119
<p>The model can be inferred from data or specified using explicit parameters. If data is given, a least squares fit is used to find the model parameters (slope and intercept). Depending on parameter <code>symmetric_regression</code>, a normal regression (<em>y</em> on <em>x</em>) or symmetric regression ( <img class="formulaInl" alt="$ y - x $" src="form_28.png"/> on <img class="formulaInl" alt="$ y + x $" src="form_29.png"/>) is performed.</p>
 
120
<p>Without data, the model can be specified by giving the parameters <code>slope</code> and <code>intercept</code> explicitly. </p>
 
121
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 
122
<a class="anchor" id="a21a3debb15429fd0860f74ba73b8a47e"></a>
 
123
<div class="memitem">
 
124
<div class="memproto">
 
125
      <table class="memname">
 
126
        <tr>
 
127
          <td class="memname"><a class="el" href="classOpenMS_1_1TransformationModelLinear.html">TransformationModelLinear</a> </td>
 
128
          <td>(</td>
 
129
          <td class="paramtype">const <a class="el" href="classOpenMS_1_1TransformationModel.html#a4067970d097e9b2f62de2058276b0c24">DataPoints</a> &amp;&#160;</td>
 
130
          <td class="paramname"><em>data</em>, </td>
 
131
        </tr>
 
132
        <tr>
 
133
          <td class="paramkey"></td>
 
134
          <td></td>
 
135
          <td class="paramtype">const <a class="el" href="classOpenMS_1_1Param.html">Param</a> &amp;&#160;</td>
 
136
          <td class="paramname"><em>params</em>&#160;</td>
 
137
        </tr>
 
138
        <tr>
 
139
          <td></td>
 
140
          <td>)</td>
 
141
          <td></td><td></td>
 
142
        </tr>
 
143
      </table>
 
144
</div><div class="memdoc">
 
145
 
 
146
<p>Constructor. </p>
 
147
<dl class="exception"><dt>Exceptions</dt><dd>
 
148
  <table class="exception">
 
149
    <tr><td class="paramname">IllegalArgument</td><td>is thrown if neither data points nor explicit parameters (slope/intercept) are given. </td></tr>
 
150
  </table>
 
151
  </dd>
 
152
</dl>
 
153
 
 
154
</div>
 
155
</div>
 
156
<a class="anchor" id="a80eb9727e140a0c508961a736a505d22"></a>
 
157
<div class="memitem">
 
158
<div class="memproto">
 
159
      <table class="memname">
 
160
        <tr>
 
161
          <td class="memname">~<a class="el" href="classOpenMS_1_1TransformationModelLinear.html">TransformationModelLinear</a> </td>
 
162
          <td>(</td>
 
163
          <td class="paramname"></td><td>)</td>
 
164
          <td></td>
 
165
        </tr>
 
166
      </table>
 
167
</div><div class="memdoc">
 
168
 
 
169
<p>Destructor. </p>
 
170
 
 
171
</div>
 
172
</div>
 
173
<h2 class="groupheader">Member Function Documentation</h2>
 
174
<a class="anchor" id="a1562399d507d343b4cb759a6e3d5470a"></a>
 
175
<div class="memitem">
 
176
<div class="memproto">
 
177
<table class="mlabels">
 
178
  <tr>
 
179
  <td class="mlabels-left">
 
180
      <table class="memname">
 
181
        <tr>
 
182
          <td class="memname">virtual <a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a> evaluate </td>
 
183
          <td>(</td>
 
184
          <td class="paramtype">const <a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a>&#160;</td>
 
185
          <td class="paramname"><em>value</em></td><td>)</td>
 
186
          <td> const</td>
 
187
        </tr>
 
188
      </table>
 
189
  </td>
 
190
  <td class="mlabels-right">
 
191
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
 
192
  </tr>
 
193
</table>
 
194
</div><div class="memdoc">
 
195
 
 
196
<p>Evaluates the model at the given value. </p>
 
197
 
 
198
<p>Reimplemented from <a class="el" href="classOpenMS_1_1TransformationModel.html#a1562399d507d343b4cb759a6e3d5470a">TransformationModel</a>.</p>
 
199
 
 
200
</div>
 
201
</div>
 
202
<a class="anchor" id="a39100a3d6235b7512df3d2731d016934"></a>
 
203
<div class="memitem">
 
204
<div class="memproto">
 
205
<table class="mlabels">
 
206
  <tr>
 
207
  <td class="mlabels-left">
 
208
      <table class="memname">
 
209
        <tr>
 
210
          <td class="memname">static void getDefaultParameters </td>
 
211
          <td>(</td>
 
212
          <td class="paramtype"><a class="el" href="classOpenMS_1_1Param.html">Param</a> &amp;&#160;</td>
 
213
          <td class="paramname"><em>params</em></td><td>)</td>
 
214
          <td></td>
 
215
        </tr>
 
216
      </table>
 
217
  </td>
 
218
  <td class="mlabels-right">
 
219
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
 
220
  </tr>
 
221
</table>
 
222
</div><div class="memdoc">
 
223
 
 
224
<p>Gets the default parameters. </p>
 
225
 
 
226
</div>
 
227
</div>
 
228
<a class="anchor" id="a95d2535c860edfd293b86d4d09603800"></a>
 
229
<div class="memitem">
 
230
<div class="memproto">
 
231
      <table class="memname">
 
232
        <tr>
 
233
          <td class="memname">void getParameters </td>
 
234
          <td>(</td>
 
235
          <td class="paramtype"><a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a> &amp;&#160;</td>
 
236
          <td class="paramname"><em>slope</em>, </td>
 
237
        </tr>
 
238
        <tr>
 
239
          <td class="paramkey"></td>
 
240
          <td></td>
 
241
          <td class="paramtype"><a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a> &amp;&#160;</td>
 
242
          <td class="paramname"><em>intercept</em>&#160;</td>
 
243
        </tr>
 
244
        <tr>
 
245
          <td></td>
 
246
          <td>)</td>
 
247
          <td></td><td> const</td>
 
248
        </tr>
 
249
      </table>
 
250
</div><div class="memdoc">
 
251
 
 
252
<p>Gets the "real" parameters. </p>
 
253
 
 
254
</div>
 
255
</div>
 
256
<a class="anchor" id="a7fa1616cc61c19a5efcc863c950f7f30"></a>
 
257
<div class="memitem">
 
258
<div class="memproto">
 
259
      <table class="memname">
 
260
        <tr>
 
261
          <td class="memname">void invert </td>
 
262
          <td>(</td>
 
263
          <td class="paramname"></td><td>)</td>
 
264
          <td></td>
 
265
        </tr>
 
266
      </table>
 
267
</div><div class="memdoc">
 
268
 
 
269
<p>Computes the inverse. </p>
 
270
<dl class="exception"><dt>Exceptions</dt><dd>
 
271
  <table class="exception">
 
272
    <tr><td class="paramname">DivisionByZero</td><td>is thrown if the slope is zero. </td></tr>
 
273
  </table>
 
274
  </dd>
 
275
</dl>
 
276
 
 
277
</div>
 
278
</div>
 
279
<h2 class="groupheader">Member Data Documentation</h2>
 
280
<a class="anchor" id="aa5d41f3562d8f5dfc128c7fe47202275"></a>
 
281
<div class="memitem">
 
282
<div class="memproto">
 
283
<table class="mlabels">
 
284
  <tr>
 
285
  <td class="mlabels-left">
 
286
      <table class="memname">
 
287
        <tr>
 
288
          <td class="memname">bool data_given_</td>
 
289
        </tr>
 
290
      </table>
 
291
  </td>
 
292
  <td class="mlabels-right">
 
293
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
 
294
  </tr>
 
295
</table>
 
296
</div><div class="memdoc">
 
297
 
 
298
<p>Was the model estimated from data? </p>
 
299
 
 
300
</div>
 
301
</div>
 
302
<a class="anchor" id="a257ff0c4f1b2ff5b9ddbe141ed5cacd5"></a>
 
303
<div class="memitem">
 
304
<div class="memproto">
 
305
<table class="mlabels">
 
306
  <tr>
 
307
  <td class="mlabels-left">
 
308
      <table class="memname">
 
309
        <tr>
 
310
          <td class="memname"><a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a> intercept_</td>
 
311
        </tr>
 
312
      </table>
 
313
  </td>
 
314
  <td class="mlabels-right">
 
315
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
 
316
  </tr>
 
317
</table>
 
318
</div><div class="memdoc">
 
319
 
 
320
</div>
 
321
</div>
 
322
<a class="anchor" id="a7810770fb0835d5813492491bc0e5e87"></a>
 
323
<div class="memitem">
 
324
<div class="memproto">
 
325
<table class="mlabels">
 
326
  <tr>
 
327
  <td class="mlabels-left">
 
328
      <table class="memname">
 
329
        <tr>
 
330
          <td class="memname"><a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a> slope_</td>
 
331
        </tr>
 
332
      </table>
 
333
  </td>
 
334
  <td class="mlabels-right">
 
335
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
 
336
  </tr>
 
337
</table>
 
338
</div><div class="memdoc">
 
339
 
 
340
<p>Parameters of the linear model. </p>
 
341
 
 
342
</div>
 
343
</div>
 
344
<a class="anchor" id="ab4bda0318b186ad5113740ee5102ddb6"></a>
 
345
<div class="memitem">
 
346
<div class="memproto">
 
347
<table class="mlabels">
 
348
  <tr>
 
349
  <td class="mlabels-left">
 
350
      <table class="memname">
 
351
        <tr>
 
352
          <td class="memname">bool symmetric_</td>
 
353
        </tr>
 
354
      </table>
 
355
  </td>
 
356
  <td class="mlabels-right">
 
357
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
 
358
  </tr>
 
359
</table>
 
360
</div><div class="memdoc">
 
361
 
 
362
<p>Use symmetric regression? </p>
 
363
 
 
364
</div>
 
365
</div>
 
366
</div><!-- contents -->
 
367
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
 
368
<TABLE width="100%" border="0">
 
369
<TR>
 
370
<TD><font color="#c0c0c0">OpenMS / TOPP release 1.11.1</font></TD>
 
371
<TD align="right"><font color="#c0c0c0">Documentation generated on Thu Nov 14 2013 11:19:26 using doxygen 1.8.5</font></TD>
 
372
</TR>
 
373
</TABLE>
 
374
</BODY>
 
375
</HTML>