1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
|
<HTML>
<HEAD>
<TITLE>Clustering</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> ·
<A href="classes.html">Classes</A> ·
<A href="annotated.html">Annotated Classes</A> ·
<A href="modules.html">Modules</A> ·
<A href="functions_func.html">Members</A> ·
<A href="namespaces.html">Namespaces</A> ·
<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><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Clustering<div class="ingroups"><a class="el" href="group__Analysis.html">Analysis</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>This class contains SpectraClustering classes These classes are components for clustering all kinds of data for which a distance relation, normalizable in the range of [0,1], is available. Mainly this will be data for which there is a corresponding CompareFunctor given (e.g. PeakSpectrum) that is yielding the similarity normalized in the range of [0,1] of such two elements, so it can easily converted to the needed distances.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1AverageLinkage.html">AverageLinkage</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classOpenMS_1_1AverageLinkage.html" title="AverageLinkage ClusterMethod. ">AverageLinkage</a> ClusterMethod. <a href="classOpenMS_1_1AverageLinkage.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ClusterAnalyzer.html">ClusterAnalyzer</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Bundles analyzing tools for a clustering (given as sequence of <a class="el" href="classOpenMS_1_1BinaryTreeNode.html" title="Elements of a binary tree used to represent a hierarchical clustering process. ">BinaryTreeNode</a>'s) <a href="classOpenMS_1_1ClusterAnalyzer.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ClusterFunctor.html">ClusterFunctor</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Base class for cluster functors. <a href="classOpenMS_1_1ClusterFunctor.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ClusterHierarchical.html">ClusterHierarchical</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Hierarchical clustering with generic clustering functions. <a href="classOpenMS_1_1ClusterHierarchical.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1CompleteLinkage.html">CompleteLinkage</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classOpenMS_1_1CompleteLinkage.html" title="CompleteLinkage ClusterMethod. ">CompleteLinkage</a> ClusterMethod. <a href="classOpenMS_1_1CompleteLinkage.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1SingleLinkage.html">SingleLinkage</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classOpenMS_1_1SingleLinkage.html" title="SingleLinkage ClusterMethod. ">SingleLinkage</a> ClusterMethod. <a href="classOpenMS_1_1SingleLinkage.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga58561325974d89bab2c7ccbd25dfc5cc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SpectraClustering.html#ga58561325974d89bab2c7ccbd25dfc5cc">cluster</a> (std::vector< PeakSpectrum > &data, const BinnedSpectrumCompareFunctor &comparator, <a class="el" href="classdouble.html">double</a> sz, UInt sp, const ClusterFunctor &clusterer, std::vector< BinaryTreeNode > &cluster_tree, DistanceMatrix< <a class="el" href="classReal.html">Real</a> > &original_distance)</td></tr>
<tr class="memdesc:ga58561325974d89bab2c7ccbd25dfc5cc"><td class="mdescLeft"> </td><td class="mdescRight">clustering function for binned PeakSpectrum <a href="#ga58561325974d89bab2c7ccbd25dfc5cc">More...</a><br/></td></tr>
<tr class="separator:ga58561325974d89bab2c7ccbd25dfc5cc"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>This class contains SpectraClustering classes These classes are components for clustering all kinds of data for which a distance relation, normalizable in the range of [0,1], is available. Mainly this will be data for which there is a corresponding CompareFunctor given (e.g. PeakSpectrum) that is yielding the similarity normalized in the range of [0,1] of such two elements, so it can easily converted to the needed distances. </p>
<dl class="section see"><dt>See Also</dt><dd>PeakSpectrumCompareFunctor. </dd></dl>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga58561325974d89bab2c7ccbd25dfc5cc"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void cluster </td>
<td>(</td>
<td class="paramtype">std::vector< <a class="el" href="group__Kernel.html#ga3ba16951dc40c7a6c7457f3452e096ab">PeakSpectrum</a> > & </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classOpenMS_1_1BinnedSpectrumCompareFunctor.html">BinnedSpectrumCompareFunctor</a> & </td>
<td class="paramname"><em>comparator</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classdouble.html">double</a> </td>
<td class="paramname"><em>sz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__Concept.html#gaba0996d26f7be2572973245b51852757">UInt</a> </td>
<td class="paramname"><em>sp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classOpenMS_1_1ClusterFunctor.html">ClusterFunctor</a> & </td>
<td class="paramname"><em>clusterer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::vector< <a class="el" href="classOpenMS_1_1BinaryTreeNode.html">BinaryTreeNode</a> > & </td>
<td class="paramname"><em>cluster_tree</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classOpenMS_1_1DistanceMatrix.html">DistanceMatrix</a>< <a class="el" href="group__Concept.html#gab685845059e8a2c92743427d9a698c70">Real</a> > & </td>
<td class="paramname"><em>original_distance</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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>clustering function for binned PeakSpectrum </p>
<p>A version of the clustering function for PeakSpectra employing binned similarity methods. From the given PeakSpectrum <a class="el" href="classOpenMS_1_1BinnedSpectrum.html" title="This is a binned representation of a PeakSpectrum. ">BinnedSpectrum</a> are generated, so the similarity functor </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classOpenMS_1_1BinnedSpectrumCompareFunctor.html" title="Base class for compare functors of BinnedSpectra. ">BinnedSpectrumCompareFunctor</a> can be applied.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>vector of <a class="el" href="group__Kernel.html#ga3ba16951dc40c7a6c7457f3452e096ab">PeakSpectrum</a> s to be clustered </td></tr>
<tr><td class="paramname">comparator</td><td>a <a class="el" href="classOpenMS_1_1BinnedSpectrumCompareFunctor.html" title="Base class for compare functors of BinnedSpectra. ">BinnedSpectrumCompareFunctor</a> </td></tr>
<tr><td class="paramname">sz</td><td>the desired binsize for the <a class="el" href="classOpenMS_1_1BinnedSpectrum.html">BinnedSpectrum</a> s </td></tr>
<tr><td class="paramname">sp</td><td>the desired binspread for the <a class="el" href="classOpenMS_1_1BinnedSpectrum.html">BinnedSpectrum</a> s </td></tr>
<tr><td class="paramname">clusterer</td><td>a clustermethod implementation, baseclass <a class="el" href="classOpenMS_1_1ClusterFunctor.html" title="Base class for cluster functors. ">ClusterFunctor</a> </td></tr>
<tr><td class="paramname">cluster_tree</td><td>the vector that will hold the BinaryTreeNodes representing the clustering (for further investigation with the <a class="el" href="classOpenMS_1_1ClusterAnalyzer.html" title="Bundles analyzing tools for a clustering (given as sequence of BinaryTreeNode's) ">ClusterAnalyzer</a> methods) </td></tr>
<tr><td class="paramname">original_distance</td><td>the <a class="el" href="classOpenMS_1_1DistanceMatrix.html" title="A two-dimensional distance matrix, similar to OpenMS::Matrix. ">DistanceMatrix</a> holding the pairwise distances of the elements in <code>data</code>, will be made newly if given size does not fit to the number of elements given in <code>data</code> </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classOpenMS_1_1ClusterFunctor.html" title="Base class for cluster functors. ">ClusterFunctor</a>, <a class="el" href="classOpenMS_1_1BinaryTreeNode.html" title="Elements of a binary tree used to represent a hierarchical clustering process. ">BinaryTreeNode</a>, <a class="el" href="classOpenMS_1_1ClusterAnalyzer.html" title="Bundles analyzing tools for a clustering (given as sequence of BinaryTreeNode's) ">ClusterAnalyzer</a>, <a class="el" href="classOpenMS_1_1BinnedSpectrum.html" title="This is a binned representation of a PeakSpectrum. ">BinnedSpectrum</a>, <a class="el" href="classOpenMS_1_1BinnedSpectrumCompareFunctor.html" title="Base class for compare functors of BinnedSpectra. ">BinnedSpectrumCompareFunctor</a> </dd></dl>
<p>References <a class="el" href="classOpenMS_1_1DistanceMatrix.html#ac8bb3912a3ce86b15842e79d0b421204">DistanceMatrix< Value >::clear()</a>, <a class="el" href="classOpenMS_1_1DistanceMatrix.html#ae89192ad76ef6362bda69ab08117c3f2">DistanceMatrix< Value >::resize()</a>, and <a class="el" href="classOpenMS_1_1DistanceMatrix.html#a2e841e704b21daa5788812746ee1cf7e">DistanceMatrix< Value >::setValue()</a>.</p>
</div>
</div>
</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:25 using doxygen 1.8.5</font></TD>
</TR>
</TABLE>
</BODY>
</HTML>
|
