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

« back to all changes in this revision

Viewing changes to doc/html/classOpenMS_1_1OpenSwathDataAccessHelper.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:
 
1
<HTML>
 
2
<HEAD>
 
3
<TITLE>OpenSwathDataAccessHelper 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_1OpenSwathDataAccessHelper.html">OpenSwathDataAccessHelper</a></li>  </ul>
 
20
</div>
 
21
</div><!-- top -->
 
22
<div class="header">
 
23
  <div class="summary">
 
24
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
 
25
<a href="classOpenMS_1_1OpenSwathDataAccessHelper-members.html">List of all members</a>  </div>
 
26
  <div class="headertitle">
 
27
<div class="title">OpenSwathDataAccessHelper Class Reference</div>  </div>
 
28
</div><!--header-->
 
29
<div class="contents">
 
30
 
 
31
<p>Several helpers to convert <a class="el" href="namespaceOpenMS.html" title="Main OpenMS namespace. ">OpenMS</a> datastructures to structures that implement the OpenSWATH interfaces.  
 
32
 <a href="classOpenMS_1_1OpenSwathDataAccessHelper.html#details">More...</a></p>
 
33
 
 
34
<p><code>#include &lt;<a class="el" href="DataAccessHelper_8h_source.html">OpenMS/ANALYSIS/OPENSWATH/DATAACCESS/DataAccessHelper.h</a>&gt;</code></p>
 
35
<table class="memberdecls">
 
36
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
 
37
Static Public Member Functions</h2></td></tr>
 
38
<tr class="memitem:abdfea944b47657cb07679cb723bb7d1e"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1OpenSwathDataAccessHelper.html#abdfea944b47657cb07679cb723bb7d1e">convertToOpenMSSpectrum</a> (const <a class="el" href="namespaceOpenSwath.html#a93e7d6a13eb66ccae0357dbae6f33523">OpenSwath::SpectrumPtr</a> sptr, <a class="el" href="classOpenMS_1_1MSSpectrum.html">OpenMS::MSSpectrum</a>&lt;&gt; &amp;spectrum)</td></tr>
 
39
<tr class="memdesc:abdfea944b47657cb07679cb723bb7d1e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert a SpectrumPtr to an <a class="el" href="namespaceOpenMS.html" title="Main OpenMS namespace. ">OpenMS</a> Spectrum.  <a href="#abdfea944b47657cb07679cb723bb7d1e">More...</a><br/></td></tr>
 
40
<tr class="separator:abdfea944b47657cb07679cb723bb7d1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
41
<tr class="memitem:a13d17d1899b239966950b8124acb38ae"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespaceOpenSwath.html#a93e7d6a13eb66ccae0357dbae6f33523">OpenSwath::SpectrumPtr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1OpenSwathDataAccessHelper.html#a13d17d1899b239966950b8124acb38ae">convertToSpectrumPtr</a> (const <a class="el" href="classOpenMS_1_1MSSpectrum.html">OpenMS::MSSpectrum</a>&lt;&gt; &amp;spectrum)</td></tr>
 
42
<tr class="memdesc:a13d17d1899b239966950b8124acb38ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert an <a class="el" href="namespaceOpenMS.html" title="Main OpenMS namespace. ">OpenMS</a> Spectrum to an SpectrumPtr.  <a href="#a13d17d1899b239966950b8124acb38ae">More...</a><br/></td></tr>
 
43
<tr class="separator:a13d17d1899b239966950b8124acb38ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
44
<tr class="memitem:a64343e3d648cde97d9d7970c08eea3f7"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1OpenSwathDataAccessHelper.html#a64343e3d648cde97d9d7970c08eea3f7">convertToOpenMSChromatogram</a> (<a class="el" href="classOpenMS_1_1MSChromatogram.html">OpenMS::MSChromatogram</a>&lt;&gt; &amp;chromatogram, const <a class="el" href="namespaceOpenSwath.html#a159d76e81a041373752ffca5f953a5ca">OpenSwath::ChromatogramPtr</a> cptr)</td></tr>
 
45
<tr class="memdesc:a64343e3d648cde97d9d7970c08eea3f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert a ChromatogramPtr to an <a class="el" href="namespaceOpenMS.html" title="Main OpenMS namespace. ">OpenMS</a> Chromatogram.  <a href="#a64343e3d648cde97d9d7970c08eea3f7">More...</a><br/></td></tr>
 
46
<tr class="separator:a64343e3d648cde97d9d7970c08eea3f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
47
<tr class="memitem:a0476f3ea925f584d9064efee48c7db6a"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1OpenSwathDataAccessHelper.html#a0476f3ea925f584d9064efee48c7db6a">convertTargetedExp</a> (const <a class="el" href="classOpenMS_1_1TargetedExperiment.html">OpenMS::TargetedExperiment</a> &amp;transition_exp_, <a class="el" href="structOpenSwath_1_1LightTargetedExperiment.html">OpenSwath::LightTargetedExperiment</a> &amp;transition_exp)</td></tr>
 
48
<tr class="memdesc:a0476f3ea925f584d9064efee48c7db6a"><td class="mdescLeft">&#160;</td><td class="mdescRight">convert from the <a class="el" href="namespaceOpenMS.html" title="Main OpenMS namespace. ">OpenMS</a> Targeted experiment to the light Targeted Experiment  <a href="#a0476f3ea925f584d9064efee48c7db6a">More...</a><br/></td></tr>
 
49
<tr class="separator:a0476f3ea925f584d9064efee48c7db6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
50
<tr class="memitem:a8ae154a5964d69f913d864b169b7310e"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1OpenSwathDataAccessHelper.html#a8ae154a5964d69f913d864b169b7310e">convertPeptideToAASequence</a> (const <a class="el" href="structOpenSwath_1_1LightPeptide.html">OpenSwath::LightPeptide</a> &amp;peptide, <a class="el" href="classOpenMS_1_1AASequence.html">AASequence</a> &amp;aa_sequence)</td></tr>
 
51
<tr class="memdesc:a8ae154a5964d69f913d864b169b7310e"><td class="mdescLeft">&#160;</td><td class="mdescRight">convert from the LightPeptide to an <a class="el" href="namespaceOpenMS.html" title="Main OpenMS namespace. ">OpenMS</a> <a class="el" href="classOpenMS_1_1AASequence.html" title="Representation of a peptide/protein sequence. ">AASequence</a> (with correct modifications)  <a href="#a8ae154a5964d69f913d864b169b7310e">More...</a><br/></td></tr>
 
52
<tr class="separator:a8ae154a5964d69f913d864b169b7310e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
53
</table>
 
54
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 
55
<div class="textblock"><p>Several helpers to convert <a class="el" href="namespaceOpenMS.html" title="Main OpenMS namespace. ">OpenMS</a> datastructures to structures that implement the OpenSWATH interfaces. </p>
 
56
</div><h2 class="groupheader">Member Function Documentation</h2>
 
57
<a class="anchor" id="a8ae154a5964d69f913d864b169b7310e"></a>
 
58
<div class="memitem">
 
59
<div class="memproto">
 
60
<table class="mlabels">
 
61
  <tr>
 
62
  <td class="mlabels-left">
 
63
      <table class="memname">
 
64
        <tr>
 
65
          <td class="memname">static void convertPeptideToAASequence </td>
 
66
          <td>(</td>
 
67
          <td class="paramtype">const <a class="el" href="structOpenSwath_1_1LightPeptide.html">OpenSwath::LightPeptide</a> &amp;&#160;</td>
 
68
          <td class="paramname"><em>peptide</em>, </td>
 
69
        </tr>
 
70
        <tr>
 
71
          <td class="paramkey"></td>
 
72
          <td></td>
 
73
          <td class="paramtype"><a class="el" href="classOpenMS_1_1AASequence.html">AASequence</a> &amp;&#160;</td>
 
74
          <td class="paramname"><em>aa_sequence</em>&#160;</td>
 
75
        </tr>
 
76
        <tr>
 
77
          <td></td>
 
78
          <td>)</td>
 
79
          <td></td><td></td>
 
80
        </tr>
 
81
      </table>
 
82
  </td>
 
83
  <td class="mlabels-right">
 
84
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
 
85
  </tr>
 
86
</table>
 
87
</div><div class="memdoc">
 
88
 
 
89
<p>convert from the LightPeptide to an <a class="el" href="namespaceOpenMS.html" title="Main OpenMS namespace. ">OpenMS</a> <a class="el" href="classOpenMS_1_1AASequence.html" title="Representation of a peptide/protein sequence. ">AASequence</a> (with correct modifications) </p>
 
90
 
 
91
<p>Referenced by <a class="el" href="classOpenMS_1_1MRMFeatureFinderScoring.html#a7aa7123edb723725ec69f259c69d46d0">MRMFeatureFinderScoring::calculateSwathScores_()</a>.</p>
 
92
 
 
93
</div>
 
94
</div>
 
95
<a class="anchor" id="a0476f3ea925f584d9064efee48c7db6a"></a>
 
96
<div class="memitem">
 
97
<div class="memproto">
 
98
<table class="mlabels">
 
99
  <tr>
 
100
  <td class="mlabels-left">
 
101
      <table class="memname">
 
102
        <tr>
 
103
          <td class="memname">static void convertTargetedExp </td>
 
104
          <td>(</td>
 
105
          <td class="paramtype">const <a class="el" href="classOpenMS_1_1TargetedExperiment.html">OpenMS::TargetedExperiment</a> &amp;&#160;</td>
 
106
          <td class="paramname"><em>transition_exp_</em>, </td>
 
107
        </tr>
 
108
        <tr>
 
109
          <td class="paramkey"></td>
 
110
          <td></td>
 
111
          <td class="paramtype"><a class="el" href="structOpenSwath_1_1LightTargetedExperiment.html">OpenSwath::LightTargetedExperiment</a> &amp;&#160;</td>
 
112
          <td class="paramname"><em>transition_exp</em>&#160;</td>
 
113
        </tr>
 
114
        <tr>
 
115
          <td></td>
 
116
          <td>)</td>
 
117
          <td></td><td></td>
 
118
        </tr>
 
119
      </table>
 
120
  </td>
 
121
  <td class="mlabels-right">
 
122
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
 
123
  </tr>
 
124
</table>
 
125
</div><div class="memdoc">
 
126
 
 
127
<p>convert from the <a class="el" href="namespaceOpenMS.html" title="Main OpenMS namespace. ">OpenMS</a> Targeted experiment to the light Targeted Experiment </p>
 
128
 
 
129
<p>Referenced by <a class="el" href="classOpenMS_1_1MRMFeatureFinderScoring.html#af879ba2bc9bcc83bed021af39c24e9d6">MRMFeatureFinderScoring::pickExperiment()</a>.</p>
 
130
 
 
131
</div>
 
132
</div>
 
133
<a class="anchor" id="a64343e3d648cde97d9d7970c08eea3f7"></a>
 
134
<div class="memitem">
 
135
<div class="memproto">
 
136
<table class="mlabels">
 
137
  <tr>
 
138
  <td class="mlabels-left">
 
139
      <table class="memname">
 
140
        <tr>
 
141
          <td class="memname">static void convertToOpenMSChromatogram </td>
 
142
          <td>(</td>
 
143
          <td class="paramtype"><a class="el" href="classOpenMS_1_1MSChromatogram.html">OpenMS::MSChromatogram</a>&lt;&gt; &amp;&#160;</td>
 
144
          <td class="paramname"><em>chromatogram</em>, </td>
 
145
        </tr>
 
146
        <tr>
 
147
          <td class="paramkey"></td>
 
148
          <td></td>
 
149
          <td class="paramtype">const <a class="el" href="namespaceOpenSwath.html#a159d76e81a041373752ffca5f953a5ca">OpenSwath::ChromatogramPtr</a>&#160;</td>
 
150
          <td class="paramname"><em>cptr</em>&#160;</td>
 
151
        </tr>
 
152
        <tr>
 
153
          <td></td>
 
154
          <td>)</td>
 
155
          <td></td><td></td>
 
156
        </tr>
 
157
      </table>
 
158
  </td>
 
159
  <td class="mlabels-right">
 
160
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
 
161
  </tr>
 
162
</table>
 
163
</div><div class="memdoc">
 
164
 
 
165
<p>Convert a ChromatogramPtr to an <a class="el" href="namespaceOpenMS.html" title="Main OpenMS namespace. ">OpenMS</a> Chromatogram. </p>
 
166
 
 
167
</div>
 
168
</div>
 
169
<a class="anchor" id="abdfea944b47657cb07679cb723bb7d1e"></a>
 
170
<div class="memitem">
 
171
<div class="memproto">
 
172
<table class="mlabels">
 
173
  <tr>
 
174
  <td class="mlabels-left">
 
175
      <table class="memname">
 
176
        <tr>
 
177
          <td class="memname">static void convertToOpenMSSpectrum </td>
 
178
          <td>(</td>
 
179
          <td class="paramtype">const <a class="el" href="namespaceOpenSwath.html#a93e7d6a13eb66ccae0357dbae6f33523">OpenSwath::SpectrumPtr</a>&#160;</td>
 
180
          <td class="paramname"><em>sptr</em>, </td>
 
181
        </tr>
 
182
        <tr>
 
183
          <td class="paramkey"></td>
 
184
          <td></td>
 
185
          <td class="paramtype"><a class="el" href="classOpenMS_1_1MSSpectrum.html">OpenMS::MSSpectrum</a>&lt;&gt; &amp;&#160;</td>
 
186
          <td class="paramname"><em>spectrum</em>&#160;</td>
 
187
        </tr>
 
188
        <tr>
 
189
          <td></td>
 
190
          <td>)</td>
 
191
          <td></td><td></td>
 
192
        </tr>
 
193
      </table>
 
194
  </td>
 
195
  <td class="mlabels-right">
 
196
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
 
197
  </tr>
 
198
</table>
 
199
</div><div class="memdoc">
 
200
 
 
201
<p>Convert a SpectrumPtr to an <a class="el" href="namespaceOpenMS.html" title="Main OpenMS namespace. ">OpenMS</a> Spectrum. </p>
 
202
 
 
203
</div>
 
204
</div>
 
205
<a class="anchor" id="a13d17d1899b239966950b8124acb38ae"></a>
 
206
<div class="memitem">
 
207
<div class="memproto">
 
208
<table class="mlabels">
 
209
  <tr>
 
210
  <td class="mlabels-left">
 
211
      <table class="memname">
 
212
        <tr>
 
213
          <td class="memname">static <a class="el" href="namespaceOpenSwath.html#a93e7d6a13eb66ccae0357dbae6f33523">OpenSwath::SpectrumPtr</a> convertToSpectrumPtr </td>
 
214
          <td>(</td>
 
215
          <td class="paramtype">const <a class="el" href="classOpenMS_1_1MSSpectrum.html">OpenMS::MSSpectrum</a>&lt;&gt; &amp;&#160;</td>
 
216
          <td class="paramname"><em>spectrum</em></td><td>)</td>
 
217
          <td></td>
 
218
        </tr>
 
219
      </table>
 
220
  </td>
 
221
  <td class="mlabels-right">
 
222
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
 
223
  </tr>
 
224
</table>
 
225
</div><div class="memdoc">
 
226
 
 
227
<p>Convert an <a class="el" href="namespaceOpenMS.html" title="Main OpenMS namespace. ">OpenMS</a> Spectrum to an SpectrumPtr. </p>
 
228
 
 
229
</div>
 
230
</div>
 
231
</div><!-- contents -->
 
232
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
 
233
<TABLE width="100%" border="0">
 
234
<TR>
 
235
<TD><font color="#c0c0c0">OpenMS / TOPP release 1.11.1</font></TD>
 
236
<TD align="right"><font color="#c0c0c0">Documentation generated on Thu Nov 14 2013 11:19:26 using doxygen 1.8.5</font></TD>
 
237
</TR>
 
238
</TABLE>
 
239
</BODY>
 
240
</HTML>