File: namespaceOpenMS_1_1ims.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 (218 lines) | stat: -rw-r--r-- 13,862 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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
<HTML>
<HEAD>
<TITLE>OpenMS::ims Namespace Reference</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="namespaceOpenMS.html">OpenMS</a></li><li class="navelem"><a class="el" href="namespaceOpenMS_1_1ims.html">ims</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">OpenMS::ims Namespace Reference</div>  </div>
</div><!--header-->
<div class="contents">
<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_1ims_1_1IMSAlphabet.html">IMSAlphabet</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Holds an indexed list of bio-chemical elements.  <a href="classOpenMS_1_1ims_1_1IMSAlphabet.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_1ims_1_1IMSAlphabetParser.html">IMSAlphabetParser</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">An abstract templatized parser to load the data that is used to initialize <code>Alphabet</code> objects.  <a href="classOpenMS_1_1ims_1_1IMSAlphabetParser.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_1ims_1_1IMSAlphabetTextParser.html">IMSAlphabetTextParser</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implements abstract <code>AlphabetParser</code> to read data from the plain text format.  <a href="classOpenMS_1_1ims_1_1IMSAlphabetTextParser.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_1ims_1_1IMSElement.html">IMSElement</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents a chemical atom with name and isotope distribution.  <a href="classOpenMS_1_1ims_1_1IMSElement.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_1ims_1_1IMSIsotopeDistribution.html">IMSIsotopeDistribution</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents a distribution of isotopes restricted to the first K elements.  <a href="classOpenMS_1_1ims_1_1IMSIsotopeDistribution.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_1ims_1_1IntegerMassDecomposer.html">IntegerMassDecomposer</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implements <code><a class="el" href="classOpenMS_1_1ims_1_1MassDecomposer.html" title="An inteface to handle decomposing of integer values/masses over a set of integer weights (alphabet)...">MassDecomposer</a></code> interface using algorithm and data structures described in paper "Efficient Mass Decomposition" S. Bcker, Zs. Liptk, ACM SAC-BIO, 2004.  <a href="classOpenMS_1_1ims_1_1IntegerMassDecomposer.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_1ims_1_1MassDecomposer.html">MassDecomposer</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">An inteface to handle decomposing of integer values/masses over a set of integer weights (alphabet).  <a href="classOpenMS_1_1ims_1_1MassDecomposer.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_1ims_1_1RealMassDecomposer.html">RealMassDecomposer</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Handles decomposing of non-integer values/masses over a set of non-integer weights with an error allowed.  <a href="classOpenMS_1_1ims_1_1RealMassDecomposer.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_1ims_1_1Weights.html">Weights</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents a set of weights (double values and scaled with a certain precision their integer counterparts) with a quick access.  <a href="classOpenMS_1_1ims_1_1Weights.html#details">More...</a><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="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a98ad29ea6eda375e52432d546bdd9a48"><td class="memItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceOpenMS_1_1ims.html#a98ad29ea6eda375e52432d546bdd9a48">operator&lt;&lt;</a> (std::ostream &amp;os, const <a class="el" href="classOpenMS_1_1ims_1_1IMSAlphabet.html">IMSAlphabet</a> &amp;alphabet)</td></tr>
<tr class="separator:a98ad29ea6eda375e52432d546bdd9a48"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a794461a38c014cfbe0d0abae1b2d4c52"><td class="memItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceOpenMS_1_1ims.html#a794461a38c014cfbe0d0abae1b2d4c52">operator&lt;&lt;</a> (std::ostream &amp;os, const <a class="el" href="classOpenMS_1_1ims_1_1IMSElement.html">IMSElement</a> &amp;element)</td></tr>
<tr class="separator:a794461a38c014cfbe0d0abae1b2d4c52"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab8bc54ab1da86f5e6680750bc1862ec4"><td class="memItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceOpenMS_1_1ims.html#ab8bc54ab1da86f5e6680750bc1862ec4">operator&lt;&lt;</a> (std::ostream &amp;os, const <a class="el" href="classOpenMS_1_1ims_1_1IMSIsotopeDistribution.html">IMSIsotopeDistribution</a> &amp;distribution)</td></tr>
<tr class="separator:ab8bc54ab1da86f5e6680750bc1862ec4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5402454b841f3950a873efa085e54bf8"><td class="memItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceOpenMS_1_1ims.html#a5402454b841f3950a873efa085e54bf8">operator&lt;&lt;</a> (std::ostream &amp;os, const <a class="el" href="classOpenMS_1_1ims_1_1Weights.html">Weights</a> &amp;weights)</td></tr>
<tr class="separator:a5402454b841f3950a873efa085e54bf8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a5402454b841f3950a873efa085e54bf8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::ostream&amp; OpenMS::ims::operator&lt;&lt; </td>
          <td>(</td>
          <td class="paramtype">std::ostream &amp;&#160;</td>
          <td class="paramname"><em>os</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const Weights &amp;&#160;</td>
          <td class="paramname"><em>weights</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Prints weights to the stream <code>os</code>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">os</td><td>Output stream to which weights are written. </td></tr>
    <tr><td class="paramname">weights</td><td><a class="el" href="classOpenMS_1_1ims_1_1Weights.html" title="Represents a set of weights (double values and scaled with a certain precision their integer counterp...">Weights</a> to be written. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a794461a38c014cfbe0d0abae1b2d4c52"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::ostream&amp; OpenMS::ims::operator&lt;&lt; </td>
          <td>(</td>
          <td class="paramtype">std::ostream &amp;&#160;</td>
          <td class="paramname"><em>os</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const IMSElement &amp;&#160;</td>
          <td class="paramname"><em>element</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Prints element to the stream <code>os</code>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">os</td><td>Output stream to which element is printed out. </td></tr>
    <tr><td class="paramname">element</td><td><a class="el" href="classOpenMS_1_1Element.html" title="Representation of an element. ">Element</a> to be printed out. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ab8bc54ab1da86f5e6680750bc1862ec4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::ostream&amp; OpenMS::ims::operator&lt;&lt; </td>
          <td>(</td>
          <td class="paramtype">std::ostream &amp;&#160;</td>
          <td class="paramname"><em>os</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const IMSIsotopeDistribution &amp;&#160;</td>
          <td class="paramname"><em>distribution</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Prints isotope distribution to the stream <code>os</code>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">os</td><td>Output stream to which distribution is printed out. </td></tr>
    <tr><td class="paramname">distribution</td><td>Distribution to be printed out. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a98ad29ea6eda375e52432d546bdd9a48"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::ostream&amp; OpenMS::ims::operator&lt;&lt; </td>
          <td>(</td>
          <td class="paramtype">std::ostream &amp;&#160;</td>
          <td class="paramname"><em>os</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const IMSAlphabet &amp;&#160;</td>
          <td class="paramname"><em>alphabet</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Prints alphabet to the stream <code>os</code>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">os</td><td>Output stream to which alphabet is written </td></tr>
    <tr><td class="paramname">alphabet</td><td>Alphabet to be written. </td></tr>
  </table>
  </dd>
</dl>

</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:37 using doxygen 1.8.5</font></TD>
</TR>
</TABLE>
</BODY>
</HTML>