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

« back to all changes in this revision

Viewing changes to doc/html/structOpenSwath_1_1Chromatogram.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>Chromatogram Struct 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="namespaceOpenSwath.html">OpenSwath</a></li><li class="navelem"><a class="el" href="structOpenSwath_1_1Chromatogram.html">Chromatogram</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="#pub-attribs">Public Attributes</a> &#124;
 
26
<a href="#pri-methods">Private Member Functions</a> &#124;
 
27
<a href="structOpenSwath_1_1Chromatogram-members.html">List of all members</a>  </div>
 
28
  <div class="headertitle">
 
29
<div class="title">Chromatogram Struct Reference</div>  </div>
 
30
</div><!--header-->
 
31
<div class="contents">
 
32
 
 
33
<p>A single chromatogram.  
 
34
 <a href="structOpenSwath_1_1Chromatogram.html#details">More...</a></p>
 
35
 
 
36
<p><code>#include &lt;<a class="el" href="ANALYSIS_2OPENSWATH_2OPENSWATHALGO_2DATAACCESS_2DataStructures_8h_source.html">OpenMS/ANALYSIS/OPENSWATH/OPENSWATHALGO/DATAACCESS/DataStructures.h</a>&gt;</code></p>
 
37
<table class="memberdecls">
 
38
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 
39
Public Member Functions</h2></td></tr>
 
40
<tr class="memitem:a45a1ae3641d8ed6b63623ac65dbb58c3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenSwath_1_1Chromatogram.html#a45a1ae3641d8ed6b63623ac65dbb58c3">Chromatogram</a> ()</td></tr>
 
41
<tr class="separator:a45a1ae3641d8ed6b63623ac65dbb58c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
42
<tr class="memitem:afe15c0e9feb69ef688f3057ef284c18d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceOpenSwath.html#a8aaa5999a567d0b9a393ea480244162b">BinaryDataArrayPtr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenSwath_1_1Chromatogram.html#afe15c0e9feb69ef688f3057ef284c18d">getTimeArray</a> ()</td></tr>
 
43
<tr class="memdesc:afe15c0e9feb69ef688f3057ef284c18d"><td class="mdescLeft">&#160;</td><td class="mdescRight">get time array (may be null)  <a href="#afe15c0e9feb69ef688f3057ef284c18d">More...</a><br/></td></tr>
 
44
<tr class="separator:afe15c0e9feb69ef688f3057ef284c18d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
45
<tr class="memitem:a387683e6f5ed3edf848b31849e5e5b73"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenSwath_1_1Chromatogram.html#a387683e6f5ed3edf848b31849e5e5b73">setTimeArray</a> (<a class="el" href="namespaceOpenSwath.html#a8aaa5999a567d0b9a393ea480244162b">BinaryDataArrayPtr</a> data)</td></tr>
 
46
<tr class="separator:a387683e6f5ed3edf848b31849e5e5b73"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
47
<tr class="memitem:a74fe481958ca3dfde8f2393e36d63ed3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceOpenSwath.html#a8aaa5999a567d0b9a393ea480244162b">BinaryDataArrayPtr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenSwath_1_1Chromatogram.html#a74fe481958ca3dfde8f2393e36d63ed3">getIntensityArray</a> ()</td></tr>
 
48
<tr class="memdesc:a74fe481958ca3dfde8f2393e36d63ed3"><td class="mdescLeft">&#160;</td><td class="mdescRight">get intensity array (may be null)  <a href="#a74fe481958ca3dfde8f2393e36d63ed3">More...</a><br/></td></tr>
 
49
<tr class="separator:a74fe481958ca3dfde8f2393e36d63ed3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
50
<tr class="memitem:a0ded7b0a96059e265954c78cb13833f1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenSwath_1_1Chromatogram.html#a0ded7b0a96059e265954c78cb13833f1">setIntensityArray</a> (<a class="el" href="namespaceOpenSwath.html#a8aaa5999a567d0b9a393ea480244162b">BinaryDataArrayPtr</a> data)</td></tr>
 
51
<tr class="separator:a0ded7b0a96059e265954c78cb13833f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
52
</table><table class="memberdecls">
 
53
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
 
54
Public Attributes</h2></td></tr>
 
55
<tr class="memitem:a34fb9d754d1c8754aff4fc29ce297673"><td class="memItemLeft" align="right" valign="top">std::size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenSwath_1_1Chromatogram.html#a34fb9d754d1c8754aff4fc29ce297673">defaultArrayLength</a></td></tr>
 
56
<tr class="memdesc:a34fb9d754d1c8754aff4fc29ce297673"><td class="mdescLeft">&#160;</td><td class="mdescRight">default length of binary data arrays contained in this element.  <a href="#a34fb9d754d1c8754aff4fc29ce297673">More...</a><br/></td></tr>
 
57
<tr class="separator:a34fb9d754d1c8754aff4fc29ce297673"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
58
<tr class="memitem:a6653badb8b8fe80b0b18490b822f97ed"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="namespaceOpenSwath.html#a8aaa5999a567d0b9a393ea480244162b">BinaryDataArrayPtr</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenSwath_1_1Chromatogram.html#a6653badb8b8fe80b0b18490b822f97ed">binaryDataArrayPtrs</a></td></tr>
 
59
<tr class="memdesc:a6653badb8b8fe80b0b18490b822f97ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">this attribute can optionally reference the 'id' of the appropriate dataProcessing.  <a href="#a6653badb8b8fe80b0b18490b822f97ed">More...</a><br/></td></tr>
 
60
<tr class="separator:a6653badb8b8fe80b0b18490b822f97ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
61
</table><table class="memberdecls">
 
62
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
 
63
Private Member Functions</h2></td></tr>
 
64
<tr class="memitem:ab1b44139fa2eaa056843a586c8d85987"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenSwath_1_1Chromatogram.html#ab1b44139fa2eaa056843a586c8d85987">initvec</a> ()</td></tr>
 
65
<tr class="separator:ab1b44139fa2eaa056843a586c8d85987"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
66
</table>
 
67
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 
68
<div class="textblock"><p>A single chromatogram. </p>
 
69
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 
70
<a class="anchor" id="a45a1ae3641d8ed6b63623ac65dbb58c3"></a>
 
71
<div class="memitem">
 
72
<div class="memproto">
 
73
<table class="mlabels">
 
74
  <tr>
 
75
  <td class="mlabels-left">
 
76
      <table class="memname">
 
77
        <tr>
 
78
          <td class="memname"><a class="el" href="structOpenSwath_1_1Chromatogram.html">Chromatogram</a> </td>
 
79
          <td>(</td>
 
80
          <td class="paramname"></td><td>)</td>
 
81
          <td></td>
 
82
        </tr>
 
83
      </table>
 
84
  </td>
 
85
  <td class="mlabels-right">
 
86
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 
87
  </tr>
 
88
</table>
 
89
</div><div class="memdoc">
 
90
 
 
91
<p>References <a class="el" href="structOpenSwath_1_1Chromatogram.html#ab1b44139fa2eaa056843a586c8d85987">Chromatogram::initvec()</a>.</p>
 
92
 
 
93
</div>
 
94
</div>
 
95
<h2 class="groupheader">Member Function Documentation</h2>
 
96
<a class="anchor" id="a74fe481958ca3dfde8f2393e36d63ed3"></a>
 
97
<div class="memitem">
 
98
<div class="memproto">
 
99
<table class="mlabels">
 
100
  <tr>
 
101
  <td class="mlabels-left">
 
102
      <table class="memname">
 
103
        <tr>
 
104
          <td class="memname"><a class="el" href="namespaceOpenSwath.html#a8aaa5999a567d0b9a393ea480244162b">BinaryDataArrayPtr</a> getIntensityArray </td>
 
105
          <td>(</td>
 
106
          <td class="paramname"></td><td>)</td>
 
107
          <td></td>
 
108
        </tr>
 
109
      </table>
 
110
  </td>
 
111
  <td class="mlabels-right">
 
112
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 
113
  </tr>
 
114
</table>
 
115
</div><div class="memdoc">
 
116
 
 
117
<p>get intensity array (may be null) </p>
 
118
 
 
119
<p>References <a class="el" href="structOpenSwath_1_1Chromatogram.html#a6653badb8b8fe80b0b18490b822f97ed">Chromatogram::binaryDataArrayPtrs</a>.</p>
 
120
 
 
121
</div>
 
122
</div>
 
123
<a class="anchor" id="afe15c0e9feb69ef688f3057ef284c18d"></a>
 
124
<div class="memitem">
 
125
<div class="memproto">
 
126
<table class="mlabels">
 
127
  <tr>
 
128
  <td class="mlabels-left">
 
129
      <table class="memname">
 
130
        <tr>
 
131
          <td class="memname"><a class="el" href="namespaceOpenSwath.html#a8aaa5999a567d0b9a393ea480244162b">BinaryDataArrayPtr</a> getTimeArray </td>
 
132
          <td>(</td>
 
133
          <td class="paramname"></td><td>)</td>
 
134
          <td></td>
 
135
        </tr>
 
136
      </table>
 
137
  </td>
 
138
  <td class="mlabels-right">
 
139
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 
140
  </tr>
 
141
</table>
 
142
</div><div class="memdoc">
 
143
 
 
144
<p>get time array (may be null) </p>
 
145
 
 
146
<p>References <a class="el" href="structOpenSwath_1_1Chromatogram.html#a6653badb8b8fe80b0b18490b822f97ed">Chromatogram::binaryDataArrayPtrs</a>.</p>
 
147
 
 
148
</div>
 
149
</div>
 
150
<a class="anchor" id="ab1b44139fa2eaa056843a586c8d85987"></a>
 
151
<div class="memitem">
 
152
<div class="memproto">
 
153
<table class="mlabels">
 
154
  <tr>
 
155
  <td class="mlabels-left">
 
156
      <table class="memname">
 
157
        <tr>
 
158
          <td class="memname">void initvec </td>
 
159
          <td>(</td>
 
160
          <td class="paramname"></td><td>)</td>
 
161
          <td></td>
 
162
        </tr>
 
163
      </table>
 
164
  </td>
 
165
  <td class="mlabels-right">
 
166
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">private</span></span>  </td>
 
167
  </tr>
 
168
</table>
 
169
</div><div class="memdoc">
 
170
 
 
171
<p>References <a class="el" href="namespaceOpenSwath.html#a8aaa5999a567d0b9a393ea480244162b">OpenSwath::BinaryDataArrayPtr</a>, <a class="el" href="structOpenSwath_1_1Chromatogram.html#a6653badb8b8fe80b0b18490b822f97ed">Chromatogram::binaryDataArrayPtrs</a>, and <a class="el" href="structOpenSwath_1_1Chromatogram.html#a34fb9d754d1c8754aff4fc29ce297673">Chromatogram::defaultArrayLength</a>.</p>
 
172
 
 
173
<p>Referenced by <a class="el" href="structOpenSwath_1_1Chromatogram.html#a45a1ae3641d8ed6b63623ac65dbb58c3">Chromatogram::Chromatogram()</a>.</p>
 
174
 
 
175
</div>
 
176
</div>
 
177
<a class="anchor" id="a0ded7b0a96059e265954c78cb13833f1"></a>
 
178
<div class="memitem">
 
179
<div class="memproto">
 
180
<table class="mlabels">
 
181
  <tr>
 
182
  <td class="mlabels-left">
 
183
      <table class="memname">
 
184
        <tr>
 
185
          <td class="memname">void setIntensityArray </td>
 
186
          <td>(</td>
 
187
          <td class="paramtype"><a class="el" href="namespaceOpenSwath.html#a8aaa5999a567d0b9a393ea480244162b">BinaryDataArrayPtr</a>&#160;</td>
 
188
          <td class="paramname"><em>data</em></td><td>)</td>
 
189
          <td></td>
 
190
        </tr>
 
191
      </table>
 
192
  </td>
 
193
  <td class="mlabels-right">
 
194
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 
195
  </tr>
 
196
</table>
 
197
</div><div class="memdoc">
 
198
 
 
199
<p>References <a class="el" href="structOpenSwath_1_1Chromatogram.html#a6653badb8b8fe80b0b18490b822f97ed">Chromatogram::binaryDataArrayPtrs</a>.</p>
 
200
 
 
201
</div>
 
202
</div>
 
203
<a class="anchor" id="a387683e6f5ed3edf848b31849e5e5b73"></a>
 
204
<div class="memitem">
 
205
<div class="memproto">
 
206
<table class="mlabels">
 
207
  <tr>
 
208
  <td class="mlabels-left">
 
209
      <table class="memname">
 
210
        <tr>
 
211
          <td class="memname">void setTimeArray </td>
 
212
          <td>(</td>
 
213
          <td class="paramtype"><a class="el" href="namespaceOpenSwath.html#a8aaa5999a567d0b9a393ea480244162b">BinaryDataArrayPtr</a>&#160;</td>
 
214
          <td class="paramname"><em>data</em></td><td>)</td>
 
215
          <td></td>
 
216
        </tr>
 
217
      </table>
 
218
  </td>
 
219
  <td class="mlabels-right">
 
220
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 
221
  </tr>
 
222
</table>
 
223
</div><div class="memdoc">
 
224
 
 
225
<p>References <a class="el" href="structOpenSwath_1_1Chromatogram.html#a6653badb8b8fe80b0b18490b822f97ed">Chromatogram::binaryDataArrayPtrs</a>.</p>
 
226
 
 
227
</div>
 
228
</div>
 
229
<h2 class="groupheader">Member Data Documentation</h2>
 
230
<a class="anchor" id="a6653badb8b8fe80b0b18490b822f97ed"></a>
 
231
<div class="memitem">
 
232
<div class="memproto">
 
233
      <table class="memname">
 
234
        <tr>
 
235
          <td class="memname">std::vector&lt;<a class="el" href="namespaceOpenSwath.html#a8aaa5999a567d0b9a393ea480244162b">BinaryDataArrayPtr</a>&gt; binaryDataArrayPtrs</td>
 
236
        </tr>
 
237
      </table>
 
238
</div><div class="memdoc">
 
239
 
 
240
<p>this attribute can optionally reference the 'id' of the appropriate dataProcessing. </p>
 
241
<p>description of precursor ion information (i.e. Q1 settings) description of product ion information (i.e. Q3 settings) list of binary data arrays. </p>
 
242
 
 
243
<p>Referenced by <a class="el" href="structOpenSwath_1_1Chromatogram.html#a74fe481958ca3dfde8f2393e36d63ed3">Chromatogram::getIntensityArray()</a>, <a class="el" href="structOpenSwath_1_1Chromatogram.html#afe15c0e9feb69ef688f3057ef284c18d">Chromatogram::getTimeArray()</a>, <a class="el" href="structOpenSwath_1_1Chromatogram.html#ab1b44139fa2eaa056843a586c8d85987">Chromatogram::initvec()</a>, <a class="el" href="structOpenSwath_1_1Chromatogram.html#a0ded7b0a96059e265954c78cb13833f1">Chromatogram::setIntensityArray()</a>, and <a class="el" href="structOpenSwath_1_1Chromatogram.html#a387683e6f5ed3edf848b31849e5e5b73">Chromatogram::setTimeArray()</a>.</p>
 
244
 
 
245
</div>
 
246
</div>
 
247
<a class="anchor" id="a34fb9d754d1c8754aff4fc29ce297673"></a>
 
248
<div class="memitem">
 
249
<div class="memproto">
 
250
      <table class="memname">
 
251
        <tr>
 
252
          <td class="memname">std::size_t defaultArrayLength</td>
 
253
        </tr>
 
254
      </table>
 
255
</div><div class="memdoc">
 
256
 
 
257
<p>default length of binary data arrays contained in this element. </p>
 
258
 
 
259
<p>Referenced by <a class="el" href="structOpenSwath_1_1Chromatogram.html#ab1b44139fa2eaa056843a586c8d85987">Chromatogram::initvec()</a>.</p>
 
260
 
 
261
</div>
 
262
</div>
 
263
</div><!-- contents -->
 
264
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
 
265
<TABLE width="100%" border="0">
 
266
<TR>
 
267
<TD><font color="#c0c0c0">OpenMS / TOPP release 1.11.1</font></TD>
 
268
<TD align="right"><font color="#c0c0c0">Documentation generated on Thu Nov 14 2013 11:19:38 using doxygen 1.8.5</font></TD>
 
269
</TR>
 
270
</TABLE>
 
271
</BODY>
 
272
</HTML>