← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/html/classOpenMS_1_1MsInspectFile.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_1MsInspectFile.html
 
1
<HTML>
 
2
<HEAD>
 
3
<TITLE>MsInspectFile 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_1MsInspectFile.html">MsInspectFile</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="classOpenMS_1_1MsInspectFile-members.html">List of all members</a>  </div>
 
26
  <div class="headertitle">
 
27
<div class="title">MsInspectFile Class Reference<div class="ingroups"><a class="el" href="group__FileIO.html">File IO</a></div></div>  </div>
 
28
</div><!--header-->
 
29
<div class="contents">
 
30
 
 
31
<p><a class="el" href="classOpenMS_1_1File.html" title="Basic file handling operations. ">File</a> adapter for MsInspect files.  
 
32
 <a href="classOpenMS_1_1MsInspectFile.html#details">More...</a></p>
 
33
 
 
34
<p><code>#include &lt;<a class="el" href="MsInspectFile_8h_source.html">OpenMS/FORMAT/MsInspectFile.h</a>&gt;</code></p>
 
35
<table class="memberdecls">
 
36
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 
37
Public Member Functions</h2></td></tr>
 
38
<tr class="memitem:ac7aec82f88d79ba9240a0c17ae1e1ead"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1MsInspectFile.html#ac7aec82f88d79ba9240a0c17ae1e1ead">MsInspectFile</a> ()</td></tr>
 
39
<tr class="memdesc:ac7aec82f88d79ba9240a0c17ae1e1ead"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#ac7aec82f88d79ba9240a0c17ae1e1ead">More...</a><br/></td></tr>
 
40
<tr class="separator:ac7aec82f88d79ba9240a0c17ae1e1ead"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
41
<tr class="memitem:a3ca29a9d8938fdb89e833634a3b7c2f6"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1MsInspectFile.html#a3ca29a9d8938fdb89e833634a3b7c2f6">~MsInspectFile</a> ()</td></tr>
 
42
<tr class="memdesc:a3ca29a9d8938fdb89e833634a3b7c2f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#a3ca29a9d8938fdb89e833634a3b7c2f6">More...</a><br/></td></tr>
 
43
<tr class="separator:a3ca29a9d8938fdb89e833634a3b7c2f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
44
<tr class="memitem:aa4e73ca60efa3ca29e203f46b5187c6c"><td class="memTemplParams" colspan="2">template&lt;typename FeatureMapType &gt; </td></tr>
 
45
<tr class="memitem:aa4e73ca60efa3ca29e203f46b5187c6c"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1MsInspectFile.html#aa4e73ca60efa3ca29e203f46b5187c6c">load</a> (const <a class="el" href="classOpenMS_1_1String.html">String</a> &amp;filename, FeatureMapType &amp;feature_map)</td></tr>
 
46
<tr class="memdesc:aa4e73ca60efa3ca29e203f46b5187c6c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Loads a MsInspect file into a featureXML.  <a href="#aa4e73ca60efa3ca29e203f46b5187c6c">More...</a><br/></td></tr>
 
47
<tr class="separator:aa4e73ca60efa3ca29e203f46b5187c6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
48
<tr class="memitem:aad1400476baaa9e6ff74301f6395c5e8"><td class="memTemplParams" colspan="2">template&lt;typename SpectrumType &gt; </td></tr>
 
49
<tr class="memitem:aad1400476baaa9e6ff74301f6395c5e8"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1MsInspectFile.html#aad1400476baaa9e6ff74301f6395c5e8">store</a> (const <a class="el" href="classOpenMS_1_1String.html">String</a> &amp;filename, const SpectrumType &amp;spectrum) const </td></tr>
 
50
<tr class="memdesc:aad1400476baaa9e6ff74301f6395c5e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stores a featureXML as a MsInspect file.  <a href="#aad1400476baaa9e6ff74301f6395c5e8">More...</a><br/></td></tr>
 
51
<tr class="separator:aad1400476baaa9e6ff74301f6395c5e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
52
</table>
 
53
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 
54
<div class="textblock"><p><a class="el" href="classOpenMS_1_1File.html" title="Basic file handling operations. ">File</a> adapter for MsInspect files. </p>
 
55
<p>Lines with "#" are comments and are ignored.</p>
 
56
<p>The first non-comment line is the header and contains the column names:<br/>
 
57
 scan time mz accurateMZ mass intensity charge chargeStates kl background median peaks scanFirst scanLast scanCount totalIntensity sumSquaresDist description</p>
 
58
<p>Every subsequent line is a feature. </p>
 
59
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 
60
<a class="anchor" id="ac7aec82f88d79ba9240a0c17ae1e1ead"></a>
 
61
<div class="memitem">
 
62
<div class="memproto">
 
63
      <table class="memname">
 
64
        <tr>
 
65
          <td class="memname"><a class="el" href="classOpenMS_1_1MsInspectFile.html">MsInspectFile</a> </td>
 
66
          <td>(</td>
 
67
          <td class="paramname"></td><td>)</td>
 
68
          <td></td>
 
69
        </tr>
 
70
      </table>
 
71
</div><div class="memdoc">
 
72
 
 
73
<p>Default constructor. </p>
 
74
 
 
75
</div>
 
76
</div>
 
77
<a class="anchor" id="a3ca29a9d8938fdb89e833634a3b7c2f6"></a>
 
78
<div class="memitem">
 
79
<div class="memproto">
 
80
<table class="mlabels">
 
81
  <tr>
 
82
  <td class="mlabels-left">
 
83
      <table class="memname">
 
84
        <tr>
 
85
          <td class="memname">virtual ~<a class="el" href="classOpenMS_1_1MsInspectFile.html">MsInspectFile</a> </td>
 
86
          <td>(</td>
 
87
          <td class="paramname"></td><td>)</td>
 
88
          <td></td>
 
89
        </tr>
 
90
      </table>
 
91
  </td>
 
92
  <td class="mlabels-right">
 
93
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
 
94
  </tr>
 
95
</table>
 
96
</div><div class="memdoc">
 
97
 
 
98
<p>Destructor. </p>
 
99
 
 
100
</div>
 
101
</div>
 
102
<h2 class="groupheader">Member Function Documentation</h2>
 
103
<a class="anchor" id="aa4e73ca60efa3ca29e203f46b5187c6c"></a>
 
104
<div class="memitem">
 
105
<div class="memproto">
 
106
<table class="mlabels">
 
107
  <tr>
 
108
  <td class="mlabels-left">
 
109
      <table class="memname">
 
110
        <tr>
 
111
          <td class="memname">void load </td>
 
112
          <td>(</td>
 
113
          <td class="paramtype">const <a class="el" href="classOpenMS_1_1String.html">String</a> &amp;&#160;</td>
 
114
          <td class="paramname"><em>filename</em>, </td>
 
115
        </tr>
 
116
        <tr>
 
117
          <td class="paramkey"></td>
 
118
          <td></td>
 
119
          <td class="paramtype">FeatureMapType &amp;&#160;</td>
 
120
          <td class="paramname"><em>feature_map</em>&#160;</td>
 
121
        </tr>
 
122
        <tr>
 
123
          <td></td>
 
124
          <td>)</td>
 
125
          <td></td><td></td>
 
126
        </tr>
 
127
      </table>
 
128
  </td>
 
129
  <td class="mlabels-right">
 
130
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 
131
  </tr>
 
132
</table>
 
133
</div><div class="memdoc">
 
134
 
 
135
<p>Loads a MsInspect file into a featureXML. </p>
 
136
<p>The content of the file is stored in <code>features</code>.</p>
 
137
<dl class="exception"><dt>Exceptions</dt><dd>
 
138
  <table class="exception">
 
139
    <tr><td class="paramname"><a class="el" href="classOpenMS_1_1Exception_1_1FileNotFound.html" title="File not found exception. ">Exception::FileNotFound</a></td><td>is thrown if the file could not be opened </td></tr>
 
140
    <tr><td class="paramname"><a class="el" href="classOpenMS_1_1Exception_1_1ParseError.html" title="Parse Error exception. ">Exception::ParseError</a></td><td>is thrown if an error occurs during parsing </td></tr>
 
141
  </table>
 
142
  </dd>
 
143
</dl>
 
144
 
 
145
<p>References <a class="el" href="classOpenMS_1_1BaseFeature.html#ab595724fe9b9eb5d37011f07d90b9e0b">BaseFeature::setCharge()</a>, <a class="el" href="classOpenMS_1_1Peak2D.html#ab875c2479c6cd2a0189e4684bfa4f97d">Peak2D::setIntensity()</a>, <a class="el" href="classOpenMS_1_1MetaInfoInterface.html#a135a7e818125b31198a8a65d9ac7a3d1">MetaInfoInterface::setMetaValue()</a>, <a class="el" href="classOpenMS_1_1Peak2D.html#a2694f0775c46d9076355cb85d9815425">Peak2D::setMZ()</a>, <a class="el" href="classOpenMS_1_1Feature.html#aeba0cded976431f70fbea5499218ce18">Feature::setOverallQuality()</a>, <a class="el" href="classOpenMS_1_1Peak2D.html#a396c5ebcac2e70f9b9a478bb2456985b">Peak2D::setRT()</a>, and <a class="el" href="classOpenMS_1_1String.html#ae580d960e12c7f0ebc5c95931cf39ad5">String::split()</a>.</p>
 
146
 
 
147
<p>Referenced by <a class="el" href="classOpenMS_1_1FileHandler.html#a5bc5a0452855c2d30d125261783b55cf">FileHandler::loadFeatures()</a>.</p>
 
148
 
 
149
</div>
 
150
</div>
 
151
<a class="anchor" id="aad1400476baaa9e6ff74301f6395c5e8"></a>
 
152
<div class="memitem">
 
153
<div class="memproto">
 
154
<table class="mlabels">
 
155
  <tr>
 
156
  <td class="mlabels-left">
 
157
      <table class="memname">
 
158
        <tr>
 
159
          <td class="memname">void store </td>
 
160
          <td>(</td>
 
161
          <td class="paramtype">const <a class="el" href="classOpenMS_1_1String.html">String</a> &amp;&#160;</td>
 
162
          <td class="paramname"><em>filename</em>, </td>
 
163
        </tr>
 
164
        <tr>
 
165
          <td class="paramkey"></td>
 
166
          <td></td>
 
167
          <td class="paramtype">const SpectrumType &amp;&#160;</td>
 
168
          <td class="paramname"><em>spectrum</em>&#160;</td>
 
169
        </tr>
 
170
        <tr>
 
171
          <td></td>
 
172
          <td>)</td>
 
173
          <td></td><td> const</td>
 
174
        </tr>
 
175
      </table>
 
176
  </td>
 
177
  <td class="mlabels-right">
 
178
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 
179
  </tr>
 
180
</table>
 
181
</div><div class="memdoc">
 
182
 
 
183
<p>Stores a featureXML as a MsInspect file. </p>
 
184
<p>NOT IMPLEMENTED</p>
 
185
<dl class="exception"><dt>Exceptions</dt><dd>
 
186
  <table class="exception">
 
187
    <tr><td class="paramname"><a class="el" href="classOpenMS_1_1Exception_1_1UnableToCreateFile.html" title="Unable to create file exception. ">Exception::UnableToCreateFile</a></td><td>is thrown if the file could not be created </td></tr>
 
188
  </table>
 
189
  </dd>
 
190
</dl>
 
191
 
 
192
</div>
 
193
</div>
 
194
</div><!-- contents -->
 
195
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
 
196
<TABLE width="100%" border="0">
 
197
<TR>
 
198
<TD><font color="#c0c0c0">OpenMS / TOPP release 1.11.1</font></TD>
 
199
<TD align="right"><font color="#c0c0c0">Documentation generated on Thu Nov 14 2013 11:19:31 using doxygen 1.8.5</font></TD>
 
200
</TR>
 
201
</TABLE>
 
202
</BODY>
 
203
</HTML>