File: SILACClustering_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 (108 lines) | stat: -rw-r--r-- 15,562 bytes
<HTML>
<HEAD>
<TITLE>SILACClustering.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_d5c86c02180db504975e24557b30e7a8.html">COMPARISON</a></li><li class="navelem"><a class="el" href="dir_cb8dd6e02b22bc637c17697ac03360d1.html">CLUSTERING</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">SILACClustering.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="SILACClustering_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: Lars Nilse $</span></div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="comment">// $Authors: Bastian Blank $</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">#include &lt;<a class="code" href="HierarchicalClustering_8h.html">OpenMS/COMPARISON/CLUSTERING/HierarchicalClustering.h</a>&gt;</span></div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="SILACPattern_8h.html">OpenMS/FILTERING/DATAREDUCTION/SILACPattern.h</a>&gt;</span></div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;</div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="preprocessor">#ifndef OPENMS_COMPARISON_CLUSTERING_SILACCLUSTERING_H</span></div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define OPENMS_COMPARISON_CLUSTERING_SILACCLUSTERING_H</span></div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;<span class="preprocessor"></span></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="l00052"></a><span class="lineno"><a class="line" href="classOpenMS_1_1SILACClustering.html">   52</a></span>&#160;  <span class="keyword">class </span>OPENMS_DLLAPI <a class="code" href="classOpenMS_1_1SILACClustering.html">SILACClustering</a> :</div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;    <span class="keyword">public</span> <a class="code" href="classOpenMS_1_1HierarchicalClustering.html">HierarchicalClustering</a>&lt;SILACPattern *&gt;</div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;  {</div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="classOpenMS_1_1SILACClustering.html#a283c8b2d66dc9ee37e4feb0d82537808">   56</a></span>&#160;    <span class="keyword">const</span> <a class="code" href="classdouble.html">DoubleReal</a> <a class="code" href="classOpenMS_1_1SILACClustering.html#a283c8b2d66dc9ee37e4feb0d82537808">rt_min</a>;</div>
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="classOpenMS_1_1SILACClustering.html#a274c7a9a60aa78250b1475700c0e7ec9">   57</a></span>&#160;    <span class="keyword">const</span> <a class="code" href="classdouble.html">DoubleReal</a> <a class="code" href="classOpenMS_1_1SILACClustering.html#a274c7a9a60aa78250b1475700c0e7ec9">rt_max_spacing</a>;</div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;</div>
<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="classOpenMS_1_1SILACClustering.html#ac1346f7edcb0135605458fa3bff61142">   59</a></span>&#160;    <a class="code" href="classOpenMS_1_1SILACClustering.html#ac1346f7edcb0135605458fa3bff61142">SILACClustering</a>(<span class="keyword">const</span> <a class="code" href="classOpenMS_1_1DPosition.html">PointCoordinate</a> &amp; cluster_dimension, <a class="code" href="classdouble.html">DoubleReal</a> rt_min, <a class="code" href="classdouble.html">DoubleReal</a> rt_max_spacing) :</div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;      <a class="code" href="classOpenMS_1_1HierarchicalClustering.html">HierarchicalClustering</a>&lt;<a class="code" href="classOpenMS_1_1SILACPattern.html">SILACPattern</a> *&gt;(cluster_dimension), rt_min(rt_min), rt_max_spacing(rt_max_spacing)</div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;    {}</div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;</div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;    <span class="keywordtype">void</span> cluster();</div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;</div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;<span class="keyword">protected</span>:</div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;    <span class="keywordtype">void</span> removeSmall_();</div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;    <span class="keywordtype">void</span> joinLarge_();</div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;  };</div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;}</div>
<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;</div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* OPENMS_COMPARISON_CLUSTERING_HIERARCHICALCLUSTERING_H */</span><span class="preprocessor"></span></div>
<div class="ttc" id="classOpenMS_1_1SILACClustering_html_a274c7a9a60aa78250b1475700c0e7ec9"><div class="ttname"><a href="classOpenMS_1_1SILACClustering.html#a274c7a9a60aa78250b1475700c0e7ec9">OpenMS::SILACClustering::rt_max_spacing</a></div><div class="ttdeci">const DoubleReal rt_max_spacing</div><div class="ttdef"><b>Definition:</b> SILACClustering.h:57</div></div>
<div class="ttc" id="classOpenMS_1_1HierarchicalClustering_html"><div class="ttname"><a href="classOpenMS_1_1HierarchicalClustering.html">OpenMS::HierarchicalClustering</a></div><div class="ttdoc">Generic 2-dimensional hierarchical clustering with geometric hashing. </div><div class="ttdef"><b>Definition:</b> HierarchicalClustering.h:67</div></div>
<div class="ttc" id="classdouble_html"><div class="ttname"><a href="classdouble.html">double</a></div></div>
<div class="ttc" id="classOpenMS_1_1SILACClustering_html_a283c8b2d66dc9ee37e4feb0d82537808"><div class="ttname"><a href="classOpenMS_1_1SILACClustering.html#a283c8b2d66dc9ee37e4feb0d82537808">OpenMS::SILACClustering::rt_min</a></div><div class="ttdeci">const DoubleReal rt_min</div><div class="ttdef"><b>Definition:</b> SILACClustering.h:56</div></div>
<div class="ttc" id="classOpenMS_1_1SILACClustering_html"><div class="ttname"><a href="classOpenMS_1_1SILACClustering.html">OpenMS::SILACClustering</a></div><div class="ttdoc">Clustering implementation for SILAC stuff. </div><div class="ttdef"><b>Definition:</b> SILACClustering.h:52</div></div>
<div class="ttc" id="HierarchicalClustering_8h_html"><div class="ttname"><a href="HierarchicalClustering_8h.html">HierarchicalClustering.h</a></div></div>
<div class="ttc" id="classOpenMS_1_1DPosition_html"><div class="ttname"><a href="classOpenMS_1_1DPosition.html">OpenMS::DPosition</a></div><div class="ttdoc">Representation of a coordinate in D-dimensional space. </div><div class="ttdef"><b>Definition:</b> DPosition.h:52</div></div>
<div class="ttc" id="classOpenMS_1_1SILACClustering_html_ac1346f7edcb0135605458fa3bff61142"><div class="ttname"><a href="classOpenMS_1_1SILACClustering.html#ac1346f7edcb0135605458fa3bff61142">OpenMS::SILACClustering::SILACClustering</a></div><div class="ttdeci">SILACClustering(const PointCoordinate &amp;cluster_dimension, DoubleReal rt_min, DoubleReal rt_max_spacing)</div><div class="ttdef"><b>Definition:</b> SILACClustering.h:59</div></div>
<div class="ttc" id="classOpenMS_1_1SILACPattern_html"><div class="ttname"><a href="classOpenMS_1_1SILACPattern.html">OpenMS::SILACPattern</a></div><div class="ttdoc">A single SILAC pattern containing multiple found points. </div><div class="ttdef"><b>Definition:</b> SILACPattern.h:47</div></div>
<div class="ttc" id="SILACPattern_8h_html"><div class="ttname"><a href="SILACPattern_8h.html">SILACPattern.h</a></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:20 using doxygen 1.8.5</font></TD>
</TR>
</TABLE>
</BODY>
</HTML>