3
<TITLE>PoseClusteringShiftSuperimposer.h Source File</TITLE>
4
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
5
<LINK HREF="style_ini.css" REL="stylesheet" TYPE="text/css">
7
<BODY BGCOLOR="#FFFFFF">
8
<A href="index.html">Home</A> ·
9
<A href="classes.html">Classes</A> ·
10
<A href="annotated.html">Annotated Classes</A> ·
11
<A href="modules.html">Modules</A> ·
12
<A href="functions_func.html">Members</A> ·
13
<A href="namespaces.html">Namespaces</A> ·
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">
19
<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>
23
<div class="headertitle">
24
<div class="title">PoseClusteringShiftSuperimposer.h</div> </div>
26
<div class="contents">
27
<a href="PoseClusteringShiftSuperimposer_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> <span class="comment">// --------------------------------------------------------------------------</span></div>
28
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// OpenMS -- Open-Source Mass Spectrometry</span></div>
29
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// --------------------------------------------------------------------------</span></div>
30
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,</span></div>
31
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// ETH Zurich, and Freie Universitaet Berlin 2002-2013.</span></div>
32
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">//</span></div>
33
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// This software is released under a three-clause BSD license:</span></div>
34
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">// * Redistributions of source code must retain the above copyright</span></div>
35
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// notice, this list of conditions and the following disclaimer.</span></div>
36
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// * Redistributions in binary form must reproduce the above copyright</span></div>
37
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// notice, this list of conditions and the following disclaimer in the</span></div>
38
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// documentation and/or other materials provided with the distribution.</span></div>
39
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// * Neither the name of any author or any participating institution</span></div>
40
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// may be used to endorse or promote products derived from this software</span></div>
41
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// without specific prior written permission.</span></div>
42
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// For a full list of authors, refer to the file AUTHORS.</span></div>
43
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">// --------------------------------------------------------------------------</span></div>
44
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"</span></div>
45
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</span></div>
46
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</span></div>
47
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">// ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING</span></div>
48
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">// INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,</span></div>
49
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,</span></div>
50
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;</span></div>
51
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,</span></div>
52
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR</span></div>
53
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF</span></div>
54
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span></div>
55
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">//</span></div>
56
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">// --------------------------------------------------------------------------</span></div>
57
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">// $Maintainer: Clemens Groepl $</span></div>
58
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">// $Authors: Eva Lange, Clemens Groepl $</span></div>
59
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">// --------------------------------------------------------------------------</span></div>
60
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div>
61
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div>
62
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#ifndef OPENMS_ANALYSIS_MAPMATCHING_POSECLUSTERINGSHIFTSUPERIMPOSER_H</span></div>
63
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor"></span><span class="preprocessor">#define OPENMS_ANALYSIS_MAPMATCHING_POSECLUSTERINGSHIFTSUPERIMPOSER_H</span></div>
64
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor"></span></div>
65
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#include <<a class="code" href="BaseSuperimposer_8h.html">OpenMS/ANALYSIS/MAPMATCHING/BaseSuperimposer.h</a>></span></div>
66
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div>
67
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">namespace </span>OpenMS</div>
68
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> {</div>
69
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div>
70
<div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="classOpenMS_1_1PoseClusteringShiftSuperimposer.html"> 65</a></span>  <span class="keyword">class </span>OPENMS_DLLAPI <a class="code" href="classOpenMS_1_1PoseClusteringShiftSuperimposer.html">PoseClusteringShiftSuperimposer</a> :</div>
71
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keyword">public</span> <a class="code" href="classOpenMS_1_1BaseSuperimposer.html">BaseSuperimposer</a></div>
72
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  {</div>
73
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="keyword">public</span>:</div>
74
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div>
75
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <a class="code" href="classOpenMS_1_1PoseClusteringShiftSuperimposer.html">PoseClusteringShiftSuperimposer</a>();</div>
76
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div>
77
<div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="classOpenMS_1_1PoseClusteringShiftSuperimposer.html#a17c72ecbd6cad3f95d216b51fb01ca5c"> 74</a></span>  <span class="keyword">virtual</span> <a class="code" href="classOpenMS_1_1PoseClusteringShiftSuperimposer.html#a17c72ecbd6cad3f95d216b51fb01ca5c">~PoseClusteringShiftSuperimposer</a>()</div>
78
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  {}</div>
79
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div>
80
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> run(<span class="keyword">const</span> <a class="code" href="classOpenMS_1_1ConsensusMap.html">ConsensusMap</a> & map_model, <span class="keyword">const</span> <a class="code" href="classOpenMS_1_1ConsensusMap.html">ConsensusMap</a> & map_scene, <a class="code" href="classOpenMS_1_1TransformationDescription.html">TransformationDescription</a> & transformation);</div>
81
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div>
82
<div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="classOpenMS_1_1PoseClusteringShiftSuperimposer.html#a0c5a095daf28e276b3a6247305da8006"> 94</a></span>  <span class="keyword">static</span> <a class="code" href="classOpenMS_1_1BaseSuperimposer.html">BaseSuperimposer</a> * <a class="code" href="classOpenMS_1_1PoseClusteringShiftSuperimposer.html#a0c5a095daf28e276b3a6247305da8006">create</a>()</div>
83
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  {</div>
84
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordflow">return</span> <span class="keyword">new</span> <a class="code" href="classOpenMS_1_1PoseClusteringShiftSuperimposer.html">PoseClusteringShiftSuperimposer</a>();</div>
85
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  }</div>
86
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div>
87
<div class="line"><a name="l00100"></a><span class="lineno"><a class="line" href="classOpenMS_1_1PoseClusteringShiftSuperimposer.html#af73fd15708e50e77665070023a09cc87"> 100</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="classOpenMS_1_1String.html">String</a> <a class="code" href="classOpenMS_1_1PoseClusteringShiftSuperimposer.html#af73fd15708e50e77665070023a09cc87">getProductName</a>()</div>
88
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  {</div>
89
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keywordflow">return</span> <span class="stringliteral">"poseclustering_shift"</span>;</div>
90
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  }</div>
91
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div>
92
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  };</div>
93
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> } <span class="comment">// namespace OpenMS</span></div>
94
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div>
95
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="preprocessor">#endif // OPENMS_ANALYSIS_MAPMATCHING_POSECLUSTERINGSHIFTSUPERIMPOSER_H</span></div>
96
<div class="ttc" id="classOpenMS_1_1PoseClusteringShiftSuperimposer_html_af73fd15708e50e77665070023a09cc87"><div class="ttname"><a href="classOpenMS_1_1PoseClusteringShiftSuperimposer.html#af73fd15708e50e77665070023a09cc87">OpenMS::PoseClusteringShiftSuperimposer::getProductName</a></div><div class="ttdeci">static const String getProductName()</div><div class="ttdoc">Returns the name of this module. </div><div class="ttdef"><b>Definition:</b> PoseClusteringShiftSuperimposer.h:100</div></div>
97
<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>
98
<div class="ttc" id="classOpenMS_1_1ConsensusMap_html"><div class="ttname"><a href="classOpenMS_1_1ConsensusMap.html">OpenMS::ConsensusMap</a></div><div class="ttdoc">A container for consensus elements. </div><div class="ttdef"><b>Definition:</b> ConsensusMap.h:60</div></div>
99
<div class="ttc" id="classOpenMS_1_1BaseSuperimposer_html"><div class="ttname"><a href="classOpenMS_1_1BaseSuperimposer.html">OpenMS::BaseSuperimposer</a></div><div class="ttdoc">The base class of all superimposer algorithms. </div><div class="ttdef"><b>Definition:</b> BaseSuperimposer.h:55</div></div>
100
<div class="ttc" id="classOpenMS_1_1PoseClusteringShiftSuperimposer_html"><div class="ttname"><a href="classOpenMS_1_1PoseClusteringShiftSuperimposer.html">OpenMS::PoseClusteringShiftSuperimposer</a></div><div class="ttdoc">A superimposer that uses a voting scheme, also known as pose clustering, to find a good shift transfo...</div><div class="ttdef"><b>Definition:</b> PoseClusteringShiftSuperimposer.h:65</div></div>
101
<div class="ttc" id="classOpenMS_1_1PoseClusteringShiftSuperimposer_html_a0c5a095daf28e276b3a6247305da8006"><div class="ttname"><a href="classOpenMS_1_1PoseClusteringShiftSuperimposer.html#a0c5a095daf28e276b3a6247305da8006">OpenMS::PoseClusteringShiftSuperimposer::create</a></div><div class="ttdeci">static BaseSuperimposer * create()</div><div class="ttdoc">Returns an instance of this class. </div><div class="ttdef"><b>Definition:</b> PoseClusteringShiftSuperimposer.h:94</div></div>
102
<div class="ttc" id="BaseSuperimposer_8h_html"><div class="ttname"><a href="BaseSuperimposer_8h.html">BaseSuperimposer.h</a></div></div>
103
<div class="ttc" id="classOpenMS_1_1PoseClusteringShiftSuperimposer_html_a17c72ecbd6cad3f95d216b51fb01ca5c"><div class="ttname"><a href="classOpenMS_1_1PoseClusteringShiftSuperimposer.html#a17c72ecbd6cad3f95d216b51fb01ca5c">OpenMS::PoseClusteringShiftSuperimposer::~PoseClusteringShiftSuperimposer</a></div><div class="ttdeci">virtual ~PoseClusteringShiftSuperimposer()</div><div class="ttdoc">Destructor. </div><div class="ttdef"><b>Definition:</b> PoseClusteringShiftSuperimposer.h:74</div></div>
104
<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>
105
</div><!-- fragment --></div><!-- contents -->
106
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
107
<TABLE width="100%" border="0">
109
<TD><font color="#c0c0c0">OpenMS / TOPP release 1.11.1</font></TD>
110
<TD align="right"><font color="#c0c0c0">Documentation generated on Thu Nov 14 2013 11:19:19 using doxygen 1.8.5</font></TD>
added
removed
doc/html/PoseClusteringShiftSuperimposer_8h_source.html
