File: group__Kernel.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 (189 lines) | stat: -rw-r--r-- 16,068 bytes parent folder | download 
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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
<HTML>
<HEAD>
<TITLE>Kernel</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><!-- top -->
<div class="header">
  <div class="summary">
<a href="#groups">Modules</a> &#124;
<a href="#nested-classes">Classes</a>  </div>
  <div class="headertitle">
<div class="title">Kernel</div>  </div>
</div><!--header-->
<div class="contents">

<p>Kernel datastructures.  
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Modules</h2></td></tr>
<tr class="memitem:group__ComparatorUtils"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ComparatorUtils.html">ComparatorUtils</a></td></tr>
<tr class="memdesc:group__ComparatorUtils"><td class="mdescLeft">&#160;</td><td class="mdescRight">A collection of utilities for comparators. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__RangeUtils"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__RangeUtils.html">RangeUtils</a></td></tr>
<tr class="memdesc:group__RangeUtils"><td class="mdescLeft">&#160;</td><td class="mdescRight">Predicates for range operations. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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 &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1BaseFeature.html">BaseFeature</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A basic LC-MS feature.  <a href="classOpenMS_1_1BaseFeature.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ChromatogramPeak.html">ChromatogramPeak</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A 1-dimensional raw data point or peak for chromatograms.  <a href="classOpenMS_1_1ChromatogramPeak.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ChromatogramTools.html">ChromatogramTools</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Conversion class to interconvert chromatograms.  <a href="classOpenMS_1_1ChromatogramTools.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ConsensusFeature.html">ConsensusFeature</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A 2-dimensional consensus feature.  <a href="classOpenMS_1_1ConsensusFeature.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ConsensusMap.html">ConsensusMap</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A container for consensus elements.  <a href="classOpenMS_1_1ConsensusMap.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Feature.html">Feature</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">An LC-MS feature.  <a href="classOpenMS_1_1Feature.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1FeatureHandle.html">FeatureHandle</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Representation of a <a class="el" href="classOpenMS_1_1Peak2D.html" title="A 2-dimensional raw data point or peak. ">Peak2D</a>, <a class="el" href="classOpenMS_1_1RichPeak2D.html" title="A 2-dimensional raw data point or peak with meta information. ">RichPeak2D</a> or <a class="el" href="classOpenMS_1_1Feature.html" title="An LC-MS feature. ">Feature</a> .  <a href="classOpenMS_1_1FeatureHandle.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1FeatureMap.html">FeatureMap&lt; FeatureT &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A container for features.  <a href="classOpenMS_1_1FeatureMap.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1MassTrace.html">MassTrace</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A container type that gathers peaks similar in m/z and moving along retention time.  <a href="classOpenMS_1_1MassTrace.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1MSChromatogram.html">MSChromatogram&lt; PeakT &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The representation of a chromatogram.  <a href="classOpenMS_1_1MSChromatogram.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1MSExperiment.html">MSExperiment&lt; PeakT, ChromatogramPeakT &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Representation of a mass spectrometry experiment.  <a href="classOpenMS_1_1MSExperiment.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1MSSpectrum.html">MSSpectrum&lt; PeakT &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The representation of a 1D spectrum.  <a href="classOpenMS_1_1MSSpectrum.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Peak1D.html">Peak1D</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A 1-dimensional raw data point or peak.  <a href="classOpenMS_1_1Peak1D.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Peak2D.html">Peak2D</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A 2-dimensional raw data point or peak.  <a href="classOpenMS_1_1Peak2D.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1RichPeak1D.html">RichPeak1D</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A 1-dimensional raw data point or peak mith meta information.  <a href="classOpenMS_1_1RichPeak1D.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1RichPeak2D.html">RichPeak2D</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A 2-dimensional raw data point or peak with meta information.  <a href="classOpenMS_1_1RichPeak2D.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3ba16951dc40c7a6c7457f3452e096ab"><td class="memItemLeft" align="right" valign="top">typedef MSSpectrum&lt; Peak1D &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Kernel.html#ga3ba16951dc40c7a6c7457f3452e096ab">PeakSpectrum</a></td></tr>
<tr class="memdesc:ga3ba16951dc40c7a6c7457f3452e096ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Spectrum consisting of raw data points or peaks.  <a href="#ga3ba16951dc40c7a6c7457f3452e096ab">More...</a><br/></td></tr>
<tr class="separator:ga3ba16951dc40c7a6c7457f3452e096ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac459ab9d68b68f31561c7763c7da61ef"><td class="memItemLeft" align="right" valign="top">typedef MSExperiment&lt; Peak1D &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Kernel.html#gac459ab9d68b68f31561c7763c7da61ef">PeakMap</a></td></tr>
<tr class="memdesc:gac459ab9d68b68f31561c7763c7da61ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Two-dimensional map of raw data points or peaks.  <a href="#gac459ab9d68b68f31561c7763c7da61ef">More...</a><br/></td></tr>
<tr class="separator:gac459ab9d68b68f31561c7763c7da61ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae09df17325d781f23b1486a2db006e0d"><td class="memItemLeft" align="right" valign="top">typedef MSSpectrum&lt; RichPeak1D &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Kernel.html#gae09df17325d781f23b1486a2db006e0d">RichPeakSpectrum</a></td></tr>
<tr class="memdesc:gae09df17325d781f23b1486a2db006e0d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Spectrum consisting of raw data points or peaks with meta information.  <a href="#gae09df17325d781f23b1486a2db006e0d">More...</a><br/></td></tr>
<tr class="separator:gae09df17325d781f23b1486a2db006e0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga194ebcb2ab563f6bb680c2b1f94bcde7"><td class="memItemLeft" align="right" valign="top">typedef MSExperiment&lt; RichPeak1D &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Kernel.html#ga194ebcb2ab563f6bb680c2b1f94bcde7">RichPeakMap</a></td></tr>
<tr class="memdesc:ga194ebcb2ab563f6bb680c2b1f94bcde7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Two-dimensional map of raw data points or peaks with meta information.  <a href="#ga194ebcb2ab563f6bb680c2b1f94bcde7">More...</a><br/></td></tr>
<tr class="separator:ga194ebcb2ab563f6bb680c2b1f94bcde7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4905fdd829fb6bac174a73740a1a038d"><td class="memItemLeft" align="right" valign="top">typedef MSChromatogram<br class="typebreak"/>
&lt; ChromatogramPeak &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Kernel.html#ga4905fdd829fb6bac174a73740a1a038d">Chromatogram</a></td></tr>
<tr class="memdesc:ga4905fdd829fb6bac174a73740a1a038d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Chromatogram consisting of raw data points or peaks.  <a href="#ga4905fdd829fb6bac174a73740a1a038d">More...</a><br/></td></tr>
<tr class="separator:ga4905fdd829fb6bac174a73740a1a038d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Kernel datastructures. </p>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="ga4905fdd829fb6bac174a73740a1a038d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef MSChromatogram&lt;ChromatogramPeak&gt; Chromatogram</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Chromatogram consisting of raw data points or peaks. </p>

</div>
</div>
<a class="anchor" id="gac459ab9d68b68f31561c7763c7da61ef"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef MSExperiment&lt;Peak1D&gt; PeakMap</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Two-dimensional map of raw data points or peaks. </p>

</div>
</div>
<a class="anchor" id="ga3ba16951dc40c7a6c7457f3452e096ab"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef MSSpectrum&lt;Peak1D&gt; PeakSpectrum</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Spectrum consisting of raw data points or peaks. </p>
<p>Meta information includes retention time and MS-level. </p>

</div>
</div>
<a class="anchor" id="ga194ebcb2ab563f6bb680c2b1f94bcde7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef MSExperiment&lt;RichPeak1D&gt; RichPeakMap</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Two-dimensional map of raw data points or peaks with meta information. </p>

</div>
</div>
<a class="anchor" id="gae09df17325d781f23b1486a2db006e0d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef MSSpectrum&lt;RichPeak1D&gt; RichPeakSpectrum</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Spectrum consisting of raw data points or peaks with meta information. </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>