← Back to branch summary

~ubuntu-branches/ubuntu/wily/openms/wily

« back to all changes in this revision

Viewing changes to doc/html/classOpenMS_1_1SvmTheoreticalSpectrumGeneratorSet.html

  • Committer: Package Import Robot
  • Author(s): Filippo Rusconi
  • Date: 2013-12-20 11:30:16 UTC
  • mfrom: (5.1.2 sid)
  • Revision ID: package-import@ubuntu.com-20131220113016-wre5g9bteeheq6he
Tags: 1.11.1-3
* remove version number from libbost development package names;
* ensure that AUTHORS is correctly shipped in all packages.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/classOpenMS_1_1SvmTheoreticalSpectrumGeneratorSet.html
 
1
<HTML>
 
2
<HEAD>
 
3
<TITLE>SvmTheoreticalSpectrumGeneratorSet Class Reference</TITLE>
 
4
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
 
5
<LINK HREF="style_ini.css" REL="stylesheet" TYPE="text/css">
 
6
</HEAD>
 
7
<BODY BGCOLOR="#FFFFFF">
 
8
<A href="index.html">Home</A> &nbsp;&middot;
 
9
<A href="classes.html">Classes</A> &nbsp;&middot;
 
10
<A href="annotated.html">Annotated Classes</A> &nbsp;&middot;
 
11
<A href="modules.html">Modules</A> &nbsp;&middot;
 
12
<A href="functions_func.html">Members</A> &nbsp;&middot;
 
13
<A href="namespaces.html">Namespaces</A> &nbsp;&middot;
 
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">
 
18
  <ul>
 
19
<li class="navelem"><a class="el" href="namespaceOpenMS.html">OpenMS</a></li><li class="navelem"><a class="el" href="classOpenMS_1_1SvmTheoreticalSpectrumGeneratorSet.html">SvmTheoreticalSpectrumGeneratorSet</a></li>  </ul>
 
20
</div>
 
21
</div><!-- top -->
 
22
<div class="header">
 
23
  <div class="summary">
 
24
<a href="#pub-methods">Public Member Functions</a> &#124;
 
25
<a href="#pro-attribs">Protected Attributes</a> &#124;
 
26
<a href="classOpenMS_1_1SvmTheoreticalSpectrumGeneratorSet-members.html">List of all members</a>  </div>
 
27
  <div class="headertitle">
 
28
<div class="title">SvmTheoreticalSpectrumGeneratorSet Class Reference<div class="ingroups"><a class="el" href="group__Chemistry.html">Chemistry</a></div></div>  </div>
 
29
</div><!--header-->
 
30
<div class="contents">
 
31
 
 
32
<p>Loads <a class="el" href="classOpenMS_1_1SvmTheoreticalSpectrumGenerator.html" title="Simulates ms2 spectra with support vector machines. ">SvmTheoreticalSpectrumGenerator</a> instances for different charges.  
 
33
 <a href="classOpenMS_1_1SvmTheoreticalSpectrumGeneratorSet.html#details">More...</a></p>
 
34
 
 
35
<p><code>#include &lt;<a class="el" href="SvmTheoreticalSpectrumGeneratorSet_8h_source.html">OpenMS/CHEMISTRY/SvmTheoreticalSpectrumGeneratorSet.h</a>&gt;</code></p>
 
36
<table class="memberdecls">
 
37
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 
38
Public Member Functions</h2></td></tr>
 
39
<tr class="memitem:aa49f9091bbcf1f989add1ed0e8d606a4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1SvmTheoreticalSpectrumGeneratorSet.html">SvmTheoreticalSpectrumGeneratorSet</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1SvmTheoreticalSpectrumGeneratorSet.html#aa49f9091bbcf1f989add1ed0e8d606a4">operator=</a> (const <a class="el" href="classOpenMS_1_1SvmTheoreticalSpectrumGeneratorSet.html">SvmTheoreticalSpectrumGeneratorSet</a> &amp;tsg)</td></tr>
 
40
<tr class="memdesc:aa49f9091bbcf1f989add1ed0e8d606a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assignment operator.  <a href="#aa49f9091bbcf1f989add1ed0e8d606a4">More...</a><br/></td></tr>
 
41
<tr class="separator:aa49f9091bbcf1f989add1ed0e8d606a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
42
<tr class="memitem:a5c8a302c628f40855e96653849c430e7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1SvmTheoreticalSpectrumGeneratorSet.html#a5c8a302c628f40855e96653849c430e7">simulate</a> (<a class="el" href="group__Kernel.html#gae09df17325d781f23b1486a2db006e0d">RichPeakSpectrum</a> &amp;spectrum, const <a class="el" href="classOpenMS_1_1AASequence.html">AASequence</a> &amp;peptide, const gsl_rng *rng, <a class="el" href="group__Concept.html#gaf9ecec2d692138fab9167164a457cbd4">Size</a> precursor_charge)</td></tr>
 
43
<tr class="memdesc:a5c8a302c628f40855e96653849c430e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate the MS/MS according to the model for the given precursor_charge.  <a href="#a5c8a302c628f40855e96653849c430e7">More...</a><br/></td></tr>
 
44
<tr class="separator:a5c8a302c628f40855e96653849c430e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
45
<tr class="memitem:a32fa3ddac343965c7fc4d7d95e9315ed"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1SvmTheoreticalSpectrumGeneratorSet.html#a32fa3ddac343965c7fc4d7d95e9315ed">load</a> (<a class="el" href="classOpenMS_1_1String.html">String</a>)</td></tr>
 
46
<tr class="memdesc:a32fa3ddac343965c7fc4d7d95e9315ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Load a trained Svm and Prob. models.  <a href="#a32fa3ddac343965c7fc4d7d95e9315ed">More...</a><br/></td></tr>
 
47
<tr class="separator:a32fa3ddac343965c7fc4d7d95e9315ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
48
<tr class="memitem:a4967829a2f2eb38a784897772117ed58"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1SvmTheoreticalSpectrumGeneratorSet.html#a4967829a2f2eb38a784897772117ed58">getSupportedCharges</a> (std::set&lt; <a class="el" href="group__Concept.html#gaf9ecec2d692138fab9167164a457cbd4">Size</a> &gt; &amp;charges)</td></tr>
 
49
<tr class="memdesc:a4967829a2f2eb38a784897772117ed58"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return precursor charges for which a model is contained in the set.  <a href="#a4967829a2f2eb38a784897772117ed58">More...</a><br/></td></tr>
 
50
<tr class="separator:a4967829a2f2eb38a784897772117ed58"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
51
<tr class="memitem:a28b846ed3327e34dbf7f03be273b4e3d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1SvmTheoreticalSpectrumGenerator.html">SvmTheoreticalSpectrumGenerator</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1SvmTheoreticalSpectrumGeneratorSet.html#a28b846ed3327e34dbf7f03be273b4e3d">getSvmModel</a> (<a class="el" href="group__Concept.html#gaf9ecec2d692138fab9167164a457cbd4">Size</a>)</td></tr>
 
52
<tr class="memdesc:a28b846ed3327e34dbf7f03be273b4e3d"><td class="mdescLeft">&#160;</td><td class="mdescRight">return a modifiable reference to the SVM model with given charge. If charge is not supported throw exception  <a href="#a28b846ed3327e34dbf7f03be273b4e3d">More...</a><br/></td></tr>
 
53
<tr class="separator:a28b846ed3327e34dbf7f03be273b4e3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
54
<tr><td colspan="2"><div class="groupHeader">Constructors and Destructors</div></td></tr>
 
55
<tr class="memitem:a07d31cc173af2e894d620f39ef6000fc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1SvmTheoreticalSpectrumGeneratorSet.html#a07d31cc173af2e894d620f39ef6000fc">SvmTheoreticalSpectrumGeneratorSet</a> ()</td></tr>
 
56
<tr class="memdesc:a07d31cc173af2e894d620f39ef6000fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#a07d31cc173af2e894d620f39ef6000fc">More...</a><br/></td></tr>
 
57
<tr class="separator:a07d31cc173af2e894d620f39ef6000fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
58
<tr class="memitem:a29d9f15cfeb96288300a0f58a1d818a3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1SvmTheoreticalSpectrumGeneratorSet.html#a29d9f15cfeb96288300a0f58a1d818a3">SvmTheoreticalSpectrumGeneratorSet</a> (const <a class="el" href="classOpenMS_1_1SvmTheoreticalSpectrumGeneratorSet.html">SvmTheoreticalSpectrumGeneratorSet</a> &amp;source)</td></tr>
 
59
<tr class="memdesc:a29d9f15cfeb96288300a0f58a1d818a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy constructor.  <a href="#a29d9f15cfeb96288300a0f58a1d818a3">More...</a><br/></td></tr>
 
60
<tr class="separator:a29d9f15cfeb96288300a0f58a1d818a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
61
<tr class="memitem:ab0c9aec2aff8d88dcefa095ec75ef947"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1SvmTheoreticalSpectrumGeneratorSet.html#ab0c9aec2aff8d88dcefa095ec75ef947">~SvmTheoreticalSpectrumGeneratorSet</a> ()</td></tr>
 
62
<tr class="memdesc:ab0c9aec2aff8d88dcefa095ec75ef947"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#ab0c9aec2aff8d88dcefa095ec75ef947">More...</a><br/></td></tr>
 
63
<tr class="separator:ab0c9aec2aff8d88dcefa095ec75ef947"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
64
</table><table class="memberdecls">
 
65
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
 
66
Protected Attributes</h2></td></tr>
 
67
<tr class="memitem:a60d537cc4998816bcdd12fd450dc80d2"><td class="memItemLeft" align="right" valign="top">std::map&lt; <a class="el" href="group__Concept.html#gaf9ecec2d692138fab9167164a457cbd4">Size</a>, <br class="typebreak"/>
 
68
<a class="el" href="classOpenMS_1_1SvmTheoreticalSpectrumGenerator.html">SvmTheoreticalSpectrumGenerator</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1SvmTheoreticalSpectrumGeneratorSet.html#a60d537cc4998816bcdd12fd450dc80d2">simulators_</a></td></tr>
 
69
<tr class="separator:a60d537cc4998816bcdd12fd450dc80d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
70
</table>
 
71
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 
72
<div class="textblock"><p>Loads <a class="el" href="classOpenMS_1_1SvmTheoreticalSpectrumGenerator.html" title="Simulates ms2 spectra with support vector machines. ">SvmTheoreticalSpectrumGenerator</a> instances for different charges. </p>
 
73
<p>The input file contains pairs of charge and svm models separated by a ":" (see share/OpenMS/examples/simulation/SvmModelSet.model)</p>
 
74
<p>Actually only a test model is shipped with <a class="el" href="namespaceOpenMS.html" title="Main OpenMS namespace. ">OpenMS</a>.<br/>
 
75
 Please find trained models at: <a href="http://sourceforge.net/projects/open-ms/files/Supplementary/Simulation/">http://sourceforge.net/projects/open-ms/files/Supplementary/Simulation/</a>. </p>
 
76
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 
77
<a class="anchor" id="a07d31cc173af2e894d620f39ef6000fc"></a>
 
78
<div class="memitem">
 
79
<div class="memproto">
 
80
      <table class="memname">
 
81
        <tr>
 
82
          <td class="memname"><a class="el" href="classOpenMS_1_1SvmTheoreticalSpectrumGeneratorSet.html">SvmTheoreticalSpectrumGeneratorSet</a> </td>
 
83
          <td>(</td>
 
84
          <td class="paramname"></td><td>)</td>
 
85
          <td></td>
 
86
        </tr>
 
87
      </table>
 
88
</div><div class="memdoc">
 
89
 
 
90
<p>Default constructor. </p>
 
91
 
 
92
</div>
 
93
</div>
 
94
<a class="anchor" id="a29d9f15cfeb96288300a0f58a1d818a3"></a>
 
95
<div class="memitem">
 
96
<div class="memproto">
 
97
      <table class="memname">
 
98
        <tr>
 
99
          <td class="memname"><a class="el" href="classOpenMS_1_1SvmTheoreticalSpectrumGeneratorSet.html">SvmTheoreticalSpectrumGeneratorSet</a> </td>
 
100
          <td>(</td>
 
101
          <td class="paramtype">const <a class="el" href="classOpenMS_1_1SvmTheoreticalSpectrumGeneratorSet.html">SvmTheoreticalSpectrumGeneratorSet</a> &amp;&#160;</td>
 
102
          <td class="paramname"><em>source</em></td><td>)</td>
 
103
          <td></td>
 
104
        </tr>
 
105
      </table>
 
106
</div><div class="memdoc">
 
107
 
 
108
<p>Copy constructor. </p>
 
109
 
 
110
</div>
 
111
</div>
 
112
<a class="anchor" id="ab0c9aec2aff8d88dcefa095ec75ef947"></a>
 
113
<div class="memitem">
 
114
<div class="memproto">
 
115
<table class="mlabels">
 
116
  <tr>
 
117
  <td class="mlabels-left">
 
118
      <table class="memname">
 
119
        <tr>
 
120
          <td class="memname">virtual ~<a class="el" href="classOpenMS_1_1SvmTheoreticalSpectrumGeneratorSet.html">SvmTheoreticalSpectrumGeneratorSet</a> </td>
 
121
          <td>(</td>
 
122
          <td class="paramname"></td><td>)</td>
 
123
          <td></td>
 
124
        </tr>
 
125
      </table>
 
126
  </td>
 
127
  <td class="mlabels-right">
 
128
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
 
129
  </tr>
 
130
</table>
 
131
</div><div class="memdoc">
 
132
 
 
133
<p>Destructor. </p>
 
134
 
 
135
</div>
 
136
</div>
 
137
<h2 class="groupheader">Member Function Documentation</h2>
 
138
<a class="anchor" id="a4967829a2f2eb38a784897772117ed58"></a>
 
139
<div class="memitem">
 
140
<div class="memproto">
 
141
      <table class="memname">
 
142
        <tr>
 
143
          <td class="memname">void getSupportedCharges </td>
 
144
          <td>(</td>
 
145
          <td class="paramtype">std::set&lt; <a class="el" href="group__Concept.html#gaf9ecec2d692138fab9167164a457cbd4">Size</a> &gt; &amp;&#160;</td>
 
146
          <td class="paramname"><em>charges</em></td><td>)</td>
 
147
          <td></td>
 
148
        </tr>
 
149
      </table>
 
150
</div><div class="memdoc">
 
151
 
 
152
<p>Return precursor charges for which a model is contained in the set. </p>
 
153
 
 
154
</div>
 
155
</div>
 
156
<a class="anchor" id="a28b846ed3327e34dbf7f03be273b4e3d"></a>
 
157
<div class="memitem">
 
158
<div class="memproto">
 
159
      <table class="memname">
 
160
        <tr>
 
161
          <td class="memname"><a class="el" href="classOpenMS_1_1SvmTheoreticalSpectrumGenerator.html">SvmTheoreticalSpectrumGenerator</a>&amp; getSvmModel </td>
 
162
          <td>(</td>
 
163
          <td class="paramtype"><a class="el" href="group__Concept.html#gaf9ecec2d692138fab9167164a457cbd4">Size</a>&#160;</td>
 
164
          <td class="paramname"></td><td>)</td>
 
165
          <td></td>
 
166
        </tr>
 
167
      </table>
 
168
</div><div class="memdoc">
 
169
 
 
170
<p>return a modifiable reference to the SVM model with given charge. If charge is not supported throw exception </p>
 
171
 
 
172
</div>
 
173
</div>
 
174
<a class="anchor" id="a32fa3ddac343965c7fc4d7d95e9315ed"></a>
 
175
<div class="memitem">
 
176
<div class="memproto">
 
177
      <table class="memname">
 
178
        <tr>
 
179
          <td class="memname">void load </td>
 
180
          <td>(</td>
 
181
          <td class="paramtype"><a class="el" href="classOpenMS_1_1String.html">String</a>&#160;</td>
 
182
          <td class="paramname"></td><td>)</td>
 
183
          <td></td>
 
184
        </tr>
 
185
      </table>
 
186
</div><div class="memdoc">
 
187
 
 
188
<p>Load a trained Svm and Prob. models. </p>
 
189
 
 
190
</div>
 
191
</div>
 
192
<a class="anchor" id="aa49f9091bbcf1f989add1ed0e8d606a4"></a>
 
193
<div class="memitem">
 
194
<div class="memproto">
 
195
      <table class="memname">
 
196
        <tr>
 
197
          <td class="memname"><a class="el" href="classOpenMS_1_1SvmTheoreticalSpectrumGeneratorSet.html">SvmTheoreticalSpectrumGeneratorSet</a>&amp; operator= </td>
 
198
          <td>(</td>
 
199
          <td class="paramtype">const <a class="el" href="classOpenMS_1_1SvmTheoreticalSpectrumGeneratorSet.html">SvmTheoreticalSpectrumGeneratorSet</a> &amp;&#160;</td>
 
200
          <td class="paramname"><em>tsg</em></td><td>)</td>
 
201
          <td></td>
 
202
        </tr>
 
203
      </table>
 
204
</div><div class="memdoc">
 
205
 
 
206
<p>Assignment operator. </p>
 
207
 
 
208
</div>
 
209
</div>
 
210
<a class="anchor" id="a5c8a302c628f40855e96653849c430e7"></a>
 
211
<div class="memitem">
 
212
<div class="memproto">
 
213
      <table class="memname">
 
214
        <tr>
 
215
          <td class="memname">void simulate </td>
 
216
          <td>(</td>
 
217
          <td class="paramtype"><a class="el" href="group__Kernel.html#gae09df17325d781f23b1486a2db006e0d">RichPeakSpectrum</a> &amp;&#160;</td>
 
218
          <td class="paramname"><em>spectrum</em>, </td>
 
219
        </tr>
 
220
        <tr>
 
221
          <td class="paramkey"></td>
 
222
          <td></td>
 
223
          <td class="paramtype">const <a class="el" href="classOpenMS_1_1AASequence.html">AASequence</a> &amp;&#160;</td>
 
224
          <td class="paramname"><em>peptide</em>, </td>
 
225
        </tr>
 
226
        <tr>
 
227
          <td class="paramkey"></td>
 
228
          <td></td>
 
229
          <td class="paramtype">const gsl_rng *&#160;</td>
 
230
          <td class="paramname"><em>rng</em>, </td>
 
231
        </tr>
 
232
        <tr>
 
233
          <td class="paramkey"></td>
 
234
          <td></td>
 
235
          <td class="paramtype"><a class="el" href="group__Concept.html#gaf9ecec2d692138fab9167164a457cbd4">Size</a>&#160;</td>
 
236
          <td class="paramname"><em>precursor_charge</em>&#160;</td>
 
237
        </tr>
 
238
        <tr>
 
239
          <td></td>
 
240
          <td>)</td>
 
241
          <td></td><td></td>
 
242
        </tr>
 
243
      </table>
 
244
</div><div class="memdoc">
 
245
 
 
246
<p>Generate the MS/MS according to the model for the given precursor_charge. </p>
 
247
 
 
248
</div>
 
249
</div>
 
250
<h2 class="groupheader">Member Data Documentation</h2>
 
251
<a class="anchor" id="a60d537cc4998816bcdd12fd450dc80d2"></a>
 
252
<div class="memitem">
 
253
<div class="memproto">
 
254
<table class="mlabels">
 
255
  <tr>
 
256
  <td class="mlabels-left">
 
257
      <table class="memname">
 
258
        <tr>
 
259
          <td class="memname">std::map&lt;<a class="el" href="group__Concept.html#gaf9ecec2d692138fab9167164a457cbd4">Size</a>, <a class="el" href="classOpenMS_1_1SvmTheoreticalSpectrumGenerator.html">SvmTheoreticalSpectrumGenerator</a>&gt; simulators_</td>
 
260
        </tr>
 
261
      </table>
 
262
  </td>
 
263
  <td class="mlabels-right">
 
264
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
 
265
  </tr>
 
266
</table>
 
267
</div><div class="memdoc">
 
268
 
 
269
</div>
 
270
</div>
 
271
</div><!-- contents -->
 
272
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
 
273
<TABLE width="100%" border="0">
 
274
<TR>
 
275
<TD><font color="#c0c0c0">OpenMS / TOPP release 1.11.1</font></TD>
 
276
<TD align="right"><font color="#c0c0c0">Documentation generated on Thu Nov 14 2013 11:19:28 using doxygen 1.8.5</font></TD>
 
277
</TR>
 
278
</TABLE>
 
279
</BODY>
 
280
</HTML>