File: TransformationDescription_8h_source.html

package info (click to toggle)
openms 1.11.1-5
links: PTS, VCS
area: main
in suites: jessie, jessie-kfreebsd
size: 436,688 kB
ctags: 150,907
sloc: cpp: 387,126; xml: 71,547; python: 7,764; ansic: 2,626; php: 2,499; sql: 737; ruby: 342; sh: 325; makefile: 128
file content (134 lines) | stat: -rw-r--r-- 22,138 bytes
<HTML>
<HEAD>
<TITLE>TransformationDescription.h Source File</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
<LINK HREF="style_ini.css" REL="stylesheet" TYPE="text/css">
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<A href="index.html">Home</A> &nbsp;&middot;
<A href="classes.html">Classes</A> &nbsp;&middot;
<A href="annotated.html">Annotated Classes</A> &nbsp;&middot;
<A href="modules.html">Modules</A> &nbsp;&middot;
<A href="functions_func.html">Members</A> &nbsp;&middot;
<A href="namespaces.html">Namespaces</A> &nbsp;&middot;
<A href="pages.html">Related Pages</A>
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
<!-- Generated by Doxygen 1.8.5 -->
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_e770f0cf77e550adde3f44739ef529fe.html">include</a></li><li class="navelem"><a class="el" href="dir_6a63c4937d4da007e55fff5dcf71e0f8.html">OpenMS</a></li><li class="navelem"><a class="el" href="dir_330fe73d44ce641f33dd6036f80161a5.html">ANALYSIS</a></li><li class="navelem"><a class="el" href="dir_8b5fa5a938a8162745e4cf0197528bc9.html">MAPMATCHING</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">TransformationDescription.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="TransformationDescription_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">// --------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">//                   OpenMS -- Open-Source Mass Spectrometry</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">// --------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment">// ETH Zurich, and Freie Universitaet Berlin 2002-2013.</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment">// This software is released under a three-clause BSD license:</span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment">//  * Redistributions of source code must retain the above copyright</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment">//    notice, this list of conditions and the following disclaimer.</span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment">//  * Redistributions in binary form must reproduce the above copyright</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment">//    notice, this list of conditions and the following disclaimer in the</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment">//    documentation and/or other materials provided with the distribution.</span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment">//  * Neither the name of any author or any participating institution</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment">//    may be used to endorse or promote products derived from this software</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment">//    without specific prior written permission.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment">// For a full list of authors, refer to the file AUTHORS.</span></div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment">// --------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment">// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS &quot;AS IS&quot;</span></div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment">// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</span></div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment">// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</span></div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment">// ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING</span></div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment">// INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,</span></div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment">// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,</span></div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="comment">// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;</span></div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment">// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,</span></div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment">// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR</span></div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment">// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF</span></div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="comment">// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span></div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="comment">// --------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="comment">// $Maintainer: Clemens Groepl $</span></div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="comment">// $Authors: Clemens Groepl, Hendrik Weisser $</span></div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="comment">// --------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;</div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="preprocessor">#ifndef OPENMS_ANALYSIS_MAPMATCHING_TRANSFORMATIONDESCRIPTION_H</span></div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define OPENMS_ANALYSIS_MAPMATCHING_TRANSFORMATIONDESCRIPTION_H</span></div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="Param_8h.html">OpenMS/DATASTRUCTURES/Param.h</a>&gt;</span></div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="TransformationModel_8h.html">OpenMS/ANALYSIS/MAPMATCHING/TransformationModel.h</a>&gt;</span></div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;</div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="keyword">namespace </span>OpenMS</div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;{</div>
<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="classOpenMS_1_1TransformationDescription.html">   59</a></span>&#160;  <span class="keyword">class </span>OPENMS_DLLAPI <a class="code" href="classOpenMS_1_1TransformationDescription.html">TransformationDescription</a></div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;  {</div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;    <span class="comment">// friend class MapAlignmentAlgorithm;</span></div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;</div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;</div>
<div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="classOpenMS_1_1TransformationDescription.html#a8e6cd3d7f43ee94f3bd39d2a1ebf9c2e">   66</a></span>&#160;    <span class="keyword">typedef</span> <a class="code" href="classOpenMS_1_1TransformationModel.html#ac93bbaab8952124bfb6a32870b773ac1">TransformationModel::DataPoint</a> <a class="code" href="classOpenMS_1_1TransformationDescription.html#a8e6cd3d7f43ee94f3bd39d2a1ebf9c2e">DataPoint</a>;</div>
<div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="classOpenMS_1_1TransformationDescription.html#acfd5876dc642e1f35afc2f32dcc65d25">   68</a></span>&#160;    <span class="keyword">typedef</span> <a class="code" href="classOpenMS_1_1TransformationModel.html#a4067970d097e9b2f62de2058276b0c24">TransformationModel::DataPoints</a> <a class="code" href="classOpenMS_1_1TransformationDescription.html#acfd5876dc642e1f35afc2f32dcc65d25">DataPoints</a>;</div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;</div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;    <a class="code" href="classOpenMS_1_1TransformationDescription.html">TransformationDescription</a>();</div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;    <a class="code" href="classOpenMS_1_1TransformationDescription.html">TransformationDescription</a>(<span class="keyword">const</span> <a class="code" href="classOpenMS_1_1TransformationDescription.html#acfd5876dc642e1f35afc2f32dcc65d25">DataPoints</a> &amp; data);</div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;    ~<a class="code" href="classOpenMS_1_1TransformationDescription.html">TransformationDescription</a>();</div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;</div>
<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;    <a class="code" href="classOpenMS_1_1TransformationDescription.html">TransformationDescription</a>(<span class="keyword">const</span> <a class="code" href="classOpenMS_1_1TransformationDescription.html">TransformationDescription</a> &amp; rhs);</div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;    <a class="code" href="classOpenMS_1_1TransformationDescription.html">TransformationDescription</a> &amp; operator=(<span class="keyword">const</span> <a class="code" href="classOpenMS_1_1TransformationDescription.html">TransformationDescription</a> &amp; rhs);</div>
<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;</div>
<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;    <span class="keywordtype">void</span> fitModel(<span class="keyword">const</span> <a class="code" href="classOpenMS_1_1String.html">String</a> &amp; model_type, <span class="keyword">const</span> <a class="code" href="classOpenMS_1_1Param.html">Param</a> &amp; params = <a class="code" href="classOpenMS_1_1Param.html">Param</a>());</div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;</div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;    <a class="code" href="classdouble.html">DoubleReal</a> apply(<a class="code" href="classdouble.html">DoubleReal</a> value) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;</div>
<div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;    <span class="keyword">const</span> <a class="code" href="classOpenMS_1_1String.html">String</a> &amp; getModelType() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;</div>
<div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;    <span class="keyword">static</span> <span class="keywordtype">void</span> getModelTypes(<a class="code" href="classOpenMS_1_1StringList.html">StringList</a> &amp; result);</div>
<div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;</div>
<div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;    <span class="keywordtype">void</span> setDataPoints(<span class="keyword">const</span> <a class="code" href="classOpenMS_1_1TransformationDescription.html#acfd5876dc642e1f35afc2f32dcc65d25">DataPoints</a> &amp; data);</div>
<div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;</div>
<div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;    <span class="keyword">const</span> <a class="code" href="classOpenMS_1_1TransformationDescription.html#acfd5876dc642e1f35afc2f32dcc65d25">DataPoints</a> &amp; getDataPoints() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;</div>
<div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;    <span class="keywordtype">void</span> getModelParameters(<a class="code" href="classOpenMS_1_1Param.html">Param</a> &amp; params) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;</div>
<div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;    <span class="keywordtype">void</span> invert();</div>
<div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;</div>
<div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;<span class="keyword">protected</span>:</div>
<div class="line"><a name="l00117"></a><span class="lineno"><a class="line" href="classOpenMS_1_1TransformationDescription.html#a50cb06485f4046e357f7750176d51783">  117</a></span>&#160;    <a class="code" href="classOpenMS_1_1TransformationDescription.html#acfd5876dc642e1f35afc2f32dcc65d25">DataPoints</a> <a class="code" href="classOpenMS_1_1TransformationDescription.html#a50cb06485f4046e357f7750176d51783">data_</a>;</div>
<div class="line"><a name="l00119"></a><span class="lineno"><a class="line" href="classOpenMS_1_1TransformationDescription.html#a4bc1aa3db307203e7719a96808120858">  119</a></span>&#160;    <a class="code" href="classOpenMS_1_1String.html">String</a> <a class="code" href="classOpenMS_1_1TransformationDescription.html#a4bc1aa3db307203e7719a96808120858">model_type_</a>;</div>
<div class="line"><a name="l00121"></a><span class="lineno"><a class="line" href="classOpenMS_1_1TransformationDescription.html#ae709da349f14f3559e5c038809a0e625">  121</a></span>&#160;    <a class="code" href="classOpenMS_1_1TransformationModel.html">TransformationModel</a> * <a class="code" href="classOpenMS_1_1TransformationDescription.html#ae709da349f14f3559e5c038809a0e625">model_</a>;</div>
<div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;  };</div>
<div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;</div>
<div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;} <span class="comment">// end of namespace OpenMS</span></div>
<div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;</div>
<div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;<span class="preprocessor">#endif  // OPENMS_ANALYSIS_MAPMATCHING_TRANSFORMATIONDESCRIPTION_H</span></div>
<div class="ttc" id="classOpenMS_1_1String_html"><div class="ttname"><a href="classOpenMS_1_1String.html">OpenMS::String</a></div><div class="ttdoc">A more convenient string class. </div><div class="ttdef"><b>Definition:</b> String.h:56</div></div>
<div class="ttc" id="classOpenMS_1_1TransformationDescription_html_ae709da349f14f3559e5c038809a0e625"><div class="ttname"><a href="classOpenMS_1_1TransformationDescription.html#ae709da349f14f3559e5c038809a0e625">OpenMS::TransformationDescription::model_</a></div><div class="ttdeci">TransformationModel * model_</div><div class="ttdoc">Pointer to model. </div><div class="ttdef"><b>Definition:</b> TransformationDescription.h:121</div></div>
<div class="ttc" id="classOpenMS_1_1TransformationDescription_html_a50cb06485f4046e357f7750176d51783"><div class="ttname"><a href="classOpenMS_1_1TransformationDescription.html#a50cb06485f4046e357f7750176d51783">OpenMS::TransformationDescription::data_</a></div><div class="ttdeci">DataPoints data_</div><div class="ttdoc">Data points. </div><div class="ttdef"><b>Definition:</b> TransformationDescription.h:117</div></div>
<div class="ttc" id="classdouble_html"><div class="ttname"><a href="classdouble.html">double</a></div></div>
<div class="ttc" id="Param_8h_html"><div class="ttname"><a href="Param_8h.html">Param.h</a></div></div>
<div class="ttc" id="classOpenMS_1_1TransformationDescription_html_a8e6cd3d7f43ee94f3bd39d2a1ebf9c2e"><div class="ttname"><a href="classOpenMS_1_1TransformationDescription.html#a8e6cd3d7f43ee94f3bd39d2a1ebf9c2e">OpenMS::TransformationDescription::DataPoint</a></div><div class="ttdeci">TransformationModel::DataPoint DataPoint</div><div class="ttdoc">Coordinate pair. </div><div class="ttdef"><b>Definition:</b> TransformationDescription.h:66</div></div>
<div class="ttc" id="TransformationModel_8h_html"><div class="ttname"><a href="TransformationModel_8h.html">TransformationModel.h</a></div></div>
<div class="ttc" id="classOpenMS_1_1TransformationDescription_html_a4bc1aa3db307203e7719a96808120858"><div class="ttname"><a href="classOpenMS_1_1TransformationDescription.html#a4bc1aa3db307203e7719a96808120858">OpenMS::TransformationDescription::model_type_</a></div><div class="ttdeci">String model_type_</div><div class="ttdoc">Type of model. </div><div class="ttdef"><b>Definition:</b> TransformationDescription.h:119</div></div>
<div class="ttc" id="classOpenMS_1_1Param_html"><div class="ttname"><a href="classOpenMS_1_1Param.html">OpenMS::Param</a></div><div class="ttdoc">Management and storage of parameters / INI files. </div><div class="ttdef"><b>Definition:</b> Param.h:69</div></div>
<div class="ttc" id="classOpenMS_1_1TransformationModel_html_ac93bbaab8952124bfb6a32870b773ac1"><div class="ttname"><a href="classOpenMS_1_1TransformationModel.html#ac93bbaab8952124bfb6a32870b773ac1">OpenMS::TransformationModel::DataPoint</a></div><div class="ttdeci">std::pair&lt; DoubleReal, DoubleReal &gt; DataPoint</div><div class="ttdoc">Coordinate pair. </div><div class="ttdef"><b>Definition:</b> TransformationModel.h:56</div></div>
<div class="ttc" id="classOpenMS_1_1StringList_html"><div class="ttname"><a href="classOpenMS_1_1StringList.html">OpenMS::StringList</a></div><div class="ttdoc">String list. </div><div class="ttdef"><b>Definition:</b> StringList.h:56</div></div>
<div class="ttc" id="classOpenMS_1_1TransformationModel_html_a4067970d097e9b2f62de2058276b0c24"><div class="ttname"><a href="classOpenMS_1_1TransformationModel.html#a4067970d097e9b2f62de2058276b0c24">OpenMS::TransformationModel::DataPoints</a></div><div class="ttdeci">std::vector&lt; DataPoint &gt; DataPoints</div><div class="ttdoc">Vector of coordinate pairs. </div><div class="ttdef"><b>Definition:</b> TransformationModel.h:58</div></div>
<div class="ttc" id="classOpenMS_1_1TransformationModel_html"><div class="ttname"><a href="classOpenMS_1_1TransformationModel.html">OpenMS::TransformationModel</a></div><div class="ttdoc">Base class for transformation models. </div><div class="ttdef"><b>Definition:</b> TransformationModel.h:52</div></div>
<div class="ttc" id="classOpenMS_1_1TransformationDescription_html"><div class="ttname"><a href="classOpenMS_1_1TransformationDescription.html">OpenMS::TransformationDescription</a></div><div class="ttdoc">Generic description of a coordinate transformation. </div><div class="ttdef"><b>Definition:</b> TransformationDescription.h:59</div></div>
<div class="ttc" id="classOpenMS_1_1TransformationDescription_html_acfd5876dc642e1f35afc2f32dcc65d25"><div class="ttname"><a href="classOpenMS_1_1TransformationDescription.html#acfd5876dc642e1f35afc2f32dcc65d25">OpenMS::TransformationDescription::DataPoints</a></div><div class="ttdeci">TransformationModel::DataPoints DataPoints</div><div class="ttdoc">Vector of coordinate pairs. </div><div class="ttdef"><b>Definition:</b> TransformationDescription.h:68</div></div>
</div><!-- fragment --></div><!-- contents -->
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
<TABLE width="100%" border="0">
<TR>
<TD><font color="#c0c0c0">OpenMS / TOPP release 1.11.1</font></TD>
<TD align="right"><font color="#c0c0c0">Documentation generated on Thu Nov 14 2013 11:19:22 using doxygen 1.8.5</font></TD>
</TR>
</TABLE>
</BODY>
</HTML>