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

« back to all changes in this revision

Viewing changes to doc/html/structOpenMS_1_1PeakIndex.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>PeakIndex 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="namespaceOpenMS.html">OpenMS</a></li><li class="navelem"><a class="el" href="structOpenMS_1_1PeakIndex.html">PeakIndex</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="structOpenMS_1_1PeakIndex-members.html">List of all members</a>  </div>
 
27
  <div class="headertitle">
 
28
<div class="title">PeakIndex Struct Reference</div>  </div>
 
29
</div><!--header-->
 
30
<div class="contents">
 
31
 
 
32
<p>Index of a peak or feature.  
 
33
 <a href="structOpenMS_1_1PeakIndex.html#details">More...</a></p>
 
34
 
 
35
<p><code>#include &lt;<a class="el" href="PeakIndex_8h_source.html">OpenMS/KERNEL/PeakIndex.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:ab14f4e82cafc32dff9a8686205403caa"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1PeakIndex.html#ab14f4e82cafc32dff9a8686205403caa">PeakIndex</a> ()</td></tr>
 
40
<tr class="memdesc:ab14f4e82cafc32dff9a8686205403caa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. Creates an invalid peak reference.  <a href="#ab14f4e82cafc32dff9a8686205403caa">More...</a><br/></td></tr>
 
41
<tr class="separator:ab14f4e82cafc32dff9a8686205403caa"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
42
<tr class="memitem:aa935f1f446781e9ca689807077f6d70c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1PeakIndex.html#aa935f1f446781e9ca689807077f6d70c">PeakIndex</a> (<a class="el" href="group__Concept.html#gaf9ecec2d692138fab9167164a457cbd4">Size</a> <a class="el" href="structOpenMS_1_1PeakIndex.html#af40104dc784144260a2345e53e5f0305">peak</a>)</td></tr>
 
43
<tr class="memdesc:aa935f1f446781e9ca689807077f6d70c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor that sets the peak index (for feaure maps)  <a href="#aa935f1f446781e9ca689807077f6d70c">More...</a><br/></td></tr>
 
44
<tr class="separator:aa935f1f446781e9ca689807077f6d70c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
45
<tr class="memitem:afaa7b5a3871130dfe747528bf71f51eb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1PeakIndex.html#afaa7b5a3871130dfe747528bf71f51eb">PeakIndex</a> (<a class="el" href="group__Concept.html#gaf9ecec2d692138fab9167164a457cbd4">Size</a> <a class="el" href="structOpenMS_1_1PeakIndex.html#ae90f6d024629703c9ba0dbd5eb5ef4b2">spectrum</a>, <a class="el" href="group__Concept.html#gaf9ecec2d692138fab9167164a457cbd4">Size</a> <a class="el" href="structOpenMS_1_1PeakIndex.html#af40104dc784144260a2345e53e5f0305">peak</a>)</td></tr>
 
46
<tr class="memdesc:afaa7b5a3871130dfe747528bf71f51eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor that sets the peak and spectrum index (for peak maps)  <a href="#afaa7b5a3871130dfe747528bf71f51eb">More...</a><br/></td></tr>
 
47
<tr class="separator:afaa7b5a3871130dfe747528bf71f51eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
48
<tr class="memitem:aac1b70a2ed67ead038c4d3f5ac4d8a81"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1PeakIndex.html#aac1b70a2ed67ead038c4d3f5ac4d8a81">isValid</a> () const </td></tr>
 
49
<tr class="memdesc:aac1b70a2ed67ead038c4d3f5ac4d8a81"><td class="mdescLeft">&#160;</td><td class="mdescRight">returns if the current peak ref is valid  <a href="#aac1b70a2ed67ead038c4d3f5ac4d8a81">More...</a><br/></td></tr>
 
50
<tr class="separator:aac1b70a2ed67ead038c4d3f5ac4d8a81"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
51
<tr class="memitem:ac8bb3912a3ce86b15842e79d0b421204"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1PeakIndex.html#ac8bb3912a3ce86b15842e79d0b421204">clear</a> ()</td></tr>
 
52
<tr class="memdesc:ac8bb3912a3ce86b15842e79d0b421204"><td class="mdescLeft">&#160;</td><td class="mdescRight">Invalidates the current index.  <a href="#ac8bb3912a3ce86b15842e79d0b421204">More...</a><br/></td></tr>
 
53
<tr class="separator:ac8bb3912a3ce86b15842e79d0b421204"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
54
<tr class="memitem:a7964d7f08b6732699e3e86111f185649"><td class="memTemplParams" colspan="2">template&lt;typename FeatureMapType &gt; </td></tr>
 
55
<tr class="memitem:a7964d7f08b6732699e3e86111f185649"><td class="memTemplItemLeft" align="right" valign="top">const FeatureMapType::value_type &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1PeakIndex.html#a7964d7f08b6732699e3e86111f185649">getFeature</a> (const FeatureMapType &amp;map) const </td></tr>
 
56
<tr class="memdesc:a7964d7f08b6732699e3e86111f185649"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access to the feature (or consensus feature) corresponding to this index.  <a href="#a7964d7f08b6732699e3e86111f185649">More...</a><br/></td></tr>
 
57
<tr class="separator:a7964d7f08b6732699e3e86111f185649"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
58
<tr class="memitem:a7fc5292f4ba9ca9642d565c0bc52f5af"><td class="memTemplParams" colspan="2">template&lt;typename PeakMapType &gt; </td></tr>
 
59
<tr class="memitem:a7fc5292f4ba9ca9642d565c0bc52f5af"><td class="memTemplItemLeft" align="right" valign="top">const PeakMapType::PeakType &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1PeakIndex.html#a7fc5292f4ba9ca9642d565c0bc52f5af">getPeak</a> (const PeakMapType &amp;map) const </td></tr>
 
60
<tr class="memdesc:a7fc5292f4ba9ca9642d565c0bc52f5af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access to a peak corresponding to this index.  <a href="#a7fc5292f4ba9ca9642d565c0bc52f5af">More...</a><br/></td></tr>
 
61
<tr class="separator:a7fc5292f4ba9ca9642d565c0bc52f5af"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
62
<tr class="memitem:ae1302e8c1dc9de4b726ea79347bf2dd9"><td class="memTemplParams" colspan="2">template&lt;typename PeakMapType &gt; </td></tr>
 
63
<tr class="memitem:ae1302e8c1dc9de4b726ea79347bf2dd9"><td class="memTemplItemLeft" align="right" valign="top">const PeakMapType::SpectrumType &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1PeakIndex.html#ae1302e8c1dc9de4b726ea79347bf2dd9">getSpectrum</a> (const PeakMapType &amp;map) const </td></tr>
 
64
<tr class="memdesc:ae1302e8c1dc9de4b726ea79347bf2dd9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access to a spectrum corresponding to this index.  <a href="#ae1302e8c1dc9de4b726ea79347bf2dd9">More...</a><br/></td></tr>
 
65
<tr class="separator:ae1302e8c1dc9de4b726ea79347bf2dd9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
66
<tr class="memitem:a6ff004bc484a723c1903508f27ea3d4c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1PeakIndex.html#a6ff004bc484a723c1903508f27ea3d4c">operator==</a> (const <a class="el" href="structOpenMS_1_1PeakIndex.html">PeakIndex</a> &amp;rhs) const </td></tr>
 
67
<tr class="memdesc:a6ff004bc484a723c1903508f27ea3d4c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Equality operator.  <a href="#a6ff004bc484a723c1903508f27ea3d4c">More...</a><br/></td></tr>
 
68
<tr class="separator:a6ff004bc484a723c1903508f27ea3d4c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
69
<tr class="memitem:a180ac47a3cf1d8780eaf2797610df1a5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1PeakIndex.html#a180ac47a3cf1d8780eaf2797610df1a5">operator!=</a> (const <a class="el" href="structOpenMS_1_1PeakIndex.html">PeakIndex</a> &amp;rhs) const </td></tr>
 
70
<tr class="memdesc:a180ac47a3cf1d8780eaf2797610df1a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inequality operator.  <a href="#a180ac47a3cf1d8780eaf2797610df1a5">More...</a><br/></td></tr>
 
71
<tr class="separator:a180ac47a3cf1d8780eaf2797610df1a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
72
</table><table class="memberdecls">
 
73
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
 
74
Public Attributes</h2></td></tr>
 
75
<tr class="memitem:af40104dc784144260a2345e53e5f0305"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__Concept.html#gaf9ecec2d692138fab9167164a457cbd4">Size</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1PeakIndex.html#af40104dc784144260a2345e53e5f0305">peak</a></td></tr>
 
76
<tr class="memdesc:af40104dc784144260a2345e53e5f0305"><td class="mdescLeft">&#160;</td><td class="mdescRight">Peak or feature index.  <a href="#af40104dc784144260a2345e53e5f0305">More...</a><br/></td></tr>
 
77
<tr class="separator:af40104dc784144260a2345e53e5f0305"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
78
<tr class="memitem:ae90f6d024629703c9ba0dbd5eb5ef4b2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__Concept.html#gaf9ecec2d692138fab9167164a457cbd4">Size</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1PeakIndex.html#ae90f6d024629703c9ba0dbd5eb5ef4b2">spectrum</a></td></tr>
 
79
<tr class="memdesc:ae90f6d024629703c9ba0dbd5eb5ef4b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Spectrum index.  <a href="#ae90f6d024629703c9ba0dbd5eb5ef4b2">More...</a><br/></td></tr>
 
80
<tr class="separator:ae90f6d024629703c9ba0dbd5eb5ef4b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
81
</table>
 
82
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 
83
<div class="textblock"><p>Index of a peak or feature. </p>
 
84
<p>This struct can be used to store both peak or feature indices. </p>
 
85
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 
86
<a class="anchor" id="ab14f4e82cafc32dff9a8686205403caa"></a>
 
87
<div class="memitem">
 
88
<div class="memproto">
 
89
<table class="mlabels">
 
90
  <tr>
 
91
  <td class="mlabels-left">
 
92
      <table class="memname">
 
93
        <tr>
 
94
          <td class="memname"><a class="el" href="structOpenMS_1_1PeakIndex.html">PeakIndex</a> </td>
 
95
          <td>(</td>
 
96
          <td class="paramname"></td><td>)</td>
 
97
          <td></td>
 
98
        </tr>
 
99
      </table>
 
100
  </td>
 
101
  <td class="mlabels-right">
 
102
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 
103
  </tr>
 
104
</table>
 
105
</div><div class="memdoc">
 
106
 
 
107
<p>Default constructor. Creates an invalid peak reference. </p>
 
108
 
 
109
</div>
 
110
</div>
 
111
<a class="anchor" id="aa935f1f446781e9ca689807077f6d70c"></a>
 
112
<div class="memitem">
 
113
<div class="memproto">
 
114
<table class="mlabels">
 
115
  <tr>
 
116
  <td class="mlabels-left">
 
117
      <table class="memname">
 
118
        <tr>
 
119
          <td class="memname"><a class="el" href="structOpenMS_1_1PeakIndex.html">PeakIndex</a> </td>
 
120
          <td>(</td>
 
121
          <td class="paramtype"><a class="el" href="group__Concept.html#gaf9ecec2d692138fab9167164a457cbd4">Size</a>&#160;</td>
 
122
          <td class="paramname"><em>peak</em></td><td>)</td>
 
123
          <td></td>
 
124
        </tr>
 
125
      </table>
 
126
  </td>
 
127
  <td class="mlabels-right">
 
128
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span>  </td>
 
129
  </tr>
 
130
</table>
 
131
</div><div class="memdoc">
 
132
 
 
133
<p>Constructor that sets the peak index (for feaure maps) </p>
 
134
 
 
135
</div>
 
136
</div>
 
137
<a class="anchor" id="afaa7b5a3871130dfe747528bf71f51eb"></a>
 
138
<div class="memitem">
 
139
<div class="memproto">
 
140
<table class="mlabels">
 
141
  <tr>
 
142
  <td class="mlabels-left">
 
143
      <table class="memname">
 
144
        <tr>
 
145
          <td class="memname"><a class="el" href="structOpenMS_1_1PeakIndex.html">PeakIndex</a> </td>
 
146
          <td>(</td>
 
147
          <td class="paramtype"><a class="el" href="group__Concept.html#gaf9ecec2d692138fab9167164a457cbd4">Size</a>&#160;</td>
 
148
          <td class="paramname"><em>spectrum</em>, </td>
 
149
        </tr>
 
150
        <tr>
 
151
          <td class="paramkey"></td>
 
152
          <td></td>
 
153
          <td class="paramtype"><a class="el" href="group__Concept.html#gaf9ecec2d692138fab9167164a457cbd4">Size</a>&#160;</td>
 
154
          <td class="paramname"><em>peak</em>&#160;</td>
 
155
        </tr>
 
156
        <tr>
 
157
          <td></td>
 
158
          <td>)</td>
 
159
          <td></td><td></td>
 
160
        </tr>
 
161
      </table>
 
162
  </td>
 
163
  <td class="mlabels-right">
 
164
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 
165
  </tr>
 
166
</table>
 
167
</div><div class="memdoc">
 
168
 
 
169
<p>Constructor that sets the peak and spectrum index (for peak maps) </p>
 
170
 
 
171
</div>
 
172
</div>
 
173
<h2 class="groupheader">Member Function Documentation</h2>
 
174
<a class="anchor" id="ac8bb3912a3ce86b15842e79d0b421204"></a>
 
175
<div class="memitem">
 
176
<div class="memproto">
 
177
<table class="mlabels">
 
178
  <tr>
 
179
  <td class="mlabels-left">
 
180
      <table class="memname">
 
181
        <tr>
 
182
          <td class="memname">void clear </td>
 
183
          <td>(</td>
 
184
          <td class="paramname"></td><td>)</td>
 
185
          <td></td>
 
186
        </tr>
 
187
      </table>
 
188
  </td>
 
189
  <td class="mlabels-right">
 
190
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 
191
  </tr>
 
192
</table>
 
193
</div><div class="memdoc">
 
194
 
 
195
<p>Invalidates the current index. </p>
 
196
 
 
197
<p>References <a class="el" href="structOpenMS_1_1PeakIndex.html#af40104dc784144260a2345e53e5f0305">PeakIndex::peak</a>, and <a class="el" href="structOpenMS_1_1PeakIndex.html#ae90f6d024629703c9ba0dbd5eb5ef4b2">PeakIndex::spectrum</a>.</p>
 
198
 
 
199
</div>
 
200
</div>
 
201
<a class="anchor" id="a7964d7f08b6732699e3e86111f185649"></a>
 
202
<div class="memitem">
 
203
<div class="memproto">
 
204
<table class="mlabels">
 
205
  <tr>
 
206
  <td class="mlabels-left">
 
207
      <table class="memname">
 
208
        <tr>
 
209
          <td class="memname">const FeatureMapType::value_type&amp; getFeature </td>
 
210
          <td>(</td>
 
211
          <td class="paramtype">const FeatureMapType &amp;&#160;</td>
 
212
          <td class="paramname"><em>map</em></td><td>)</td>
 
213
          <td> const</td>
 
214
        </tr>
 
215
      </table>
 
216
  </td>
 
217
  <td class="mlabels-right">
 
218
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 
219
  </tr>
 
220
</table>
 
221
</div><div class="memdoc">
 
222
 
 
223
<p>Access to the feature (or consensus feature) corresponding to this index. </p>
 
224
<p>This method is intended for arrays of features e.g. <a class="el" href="classOpenMS_1_1FeatureMap.html" title="A container for features. ">FeatureMap</a></p>
 
225
<p>The main advantage of using this method instead accessing the data directly is that range check performed in debug mode.</p>
 
226
<dl class="exception"><dt>Exceptions</dt><dd>
 
227
  <table class="exception">
 
228
    <tr><td class="paramname"><a class="el" href="classOpenMS_1_1Exception_1_1Precondition.html" title="Precondition failed exception. ">Exception::Precondition</a></td><td>is thrown if this index is invalid for the <code>map</code> (only in debug mode) </td></tr>
 
229
  </table>
 
230
  </dd>
 
231
</dl>
 
232
 
 
233
<p>References <a class="el" href="group__Conditions.html#ga45a74ea28109e7e1ed992fbd2ee97778">OPENMS_PRECONDITION</a>, and <a class="el" href="structOpenMS_1_1PeakIndex.html#af40104dc784144260a2345e53e5f0305">PeakIndex::peak</a>.</p>
 
234
 
 
235
</div>
 
236
</div>
 
237
<a class="anchor" id="a7fc5292f4ba9ca9642d565c0bc52f5af"></a>
 
238
<div class="memitem">
 
239
<div class="memproto">
 
240
<table class="mlabels">
 
241
  <tr>
 
242
  <td class="mlabels-left">
 
243
      <table class="memname">
 
244
        <tr>
 
245
          <td class="memname">const PeakMapType::PeakType&amp; getPeak </td>
 
246
          <td>(</td>
 
247
          <td class="paramtype">const PeakMapType &amp;&#160;</td>
 
248
          <td class="paramname"><em>map</em></td><td>)</td>
 
249
          <td> const</td>
 
250
        </tr>
 
251
      </table>
 
252
  </td>
 
253
  <td class="mlabels-right">
 
254
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 
255
  </tr>
 
256
</table>
 
257
</div><div class="memdoc">
 
258
 
 
259
<p>Access to a peak corresponding to this index. </p>
 
260
<p>This method is intended for arrays of DSpectra e.g. <a class="el" href="classOpenMS_1_1MSExperiment.html" title="Representation of a mass spectrometry experiment. ">MSExperiment</a></p>
 
261
<p>The main advantage of using this method instead accessing the data directly is that range check performed in debug mode.</p>
 
262
<dl class="exception"><dt>Exceptions</dt><dd>
 
263
  <table class="exception">
 
264
    <tr><td class="paramname"><a class="el" href="classOpenMS_1_1Exception_1_1Precondition.html" title="Precondition failed exception. ">Exception::Precondition</a></td><td>is thrown if this index is invalid for the <code>map</code> (only in debug mode) </td></tr>
 
265
  </table>
 
266
  </dd>
 
267
</dl>
 
268
 
 
269
<p>References <a class="el" href="group__Conditions.html#ga45a74ea28109e7e1ed992fbd2ee97778">OPENMS_PRECONDITION</a>, <a class="el" href="structOpenMS_1_1PeakIndex.html#af40104dc784144260a2345e53e5f0305">PeakIndex::peak</a>, and <a class="el" href="structOpenMS_1_1PeakIndex.html#ae90f6d024629703c9ba0dbd5eb5ef4b2">PeakIndex::spectrum</a>.</p>
 
270
 
 
271
</div>
 
272
</div>
 
273
<a class="anchor" id="ae1302e8c1dc9de4b726ea79347bf2dd9"></a>
 
274
<div class="memitem">
 
275
<div class="memproto">
 
276
<table class="mlabels">
 
277
  <tr>
 
278
  <td class="mlabels-left">
 
279
      <table class="memname">
 
280
        <tr>
 
281
          <td class="memname">const PeakMapType::SpectrumType&amp; getSpectrum </td>
 
282
          <td>(</td>
 
283
          <td class="paramtype">const PeakMapType &amp;&#160;</td>
 
284
          <td class="paramname"><em>map</em></td><td>)</td>
 
285
          <td> const</td>
 
286
        </tr>
 
287
      </table>
 
288
  </td>
 
289
  <td class="mlabels-right">
 
290
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 
291
  </tr>
 
292
</table>
 
293
</div><div class="memdoc">
 
294
 
 
295
<p>Access to a spectrum corresponding to this index. </p>
 
296
<p>This method is intended for arrays of DSpectra e.g. <a class="el" href="classOpenMS_1_1MSExperiment.html" title="Representation of a mass spectrometry experiment. ">MSExperiment</a>.</p>
 
297
<p>The main advantage of using this method instead accessing the data directly is that range check performed in debug mode.</p>
 
298
<dl class="exception"><dt>Exceptions</dt><dd>
 
299
  <table class="exception">
 
300
    <tr><td class="paramname"><a class="el" href="classOpenMS_1_1Exception_1_1Precondition.html" title="Precondition failed exception. ">Exception::Precondition</a></td><td>is thrown if this index is invalid for the <code>map</code> (only in debug mode) </td></tr>
 
301
  </table>
 
302
  </dd>
 
303
</dl>
 
304
 
 
305
<p>References <a class="el" href="group__Conditions.html#ga45a74ea28109e7e1ed992fbd2ee97778">OPENMS_PRECONDITION</a>, and <a class="el" href="structOpenMS_1_1PeakIndex.html#ae90f6d024629703c9ba0dbd5eb5ef4b2">PeakIndex::spectrum</a>.</p>
 
306
 
 
307
</div>
 
308
</div>
 
309
<a class="anchor" id="aac1b70a2ed67ead038c4d3f5ac4d8a81"></a>
 
310
<div class="memitem">
 
311
<div class="memproto">
 
312
<table class="mlabels">
 
313
  <tr>
 
314
  <td class="mlabels-left">
 
315
      <table class="memname">
 
316
        <tr>
 
317
          <td class="memname">bool isValid </td>
 
318
          <td>(</td>
 
319
          <td class="paramname"></td><td>)</td>
 
320
          <td> const</td>
 
321
        </tr>
 
322
      </table>
 
323
  </td>
 
324
  <td class="mlabels-right">
 
325
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 
326
  </tr>
 
327
</table>
 
328
</div><div class="memdoc">
 
329
 
 
330
<p>returns if the current peak ref is valid </p>
 
331
 
 
332
<p>References <a class="el" href="structOpenMS_1_1PeakIndex.html#af40104dc784144260a2345e53e5f0305">PeakIndex::peak</a>.</p>
 
333
 
 
334
</div>
 
335
</div>
 
336
<a class="anchor" id="a180ac47a3cf1d8780eaf2797610df1a5"></a>
 
337
<div class="memitem">
 
338
<div class="memproto">
 
339
<table class="mlabels">
 
340
  <tr>
 
341
  <td class="mlabels-left">
 
342
      <table class="memname">
 
343
        <tr>
 
344
          <td class="memname">bool operator!= </td>
 
345
          <td>(</td>
 
346
          <td class="paramtype">const <a class="el" href="structOpenMS_1_1PeakIndex.html">PeakIndex</a> &amp;&#160;</td>
 
347
          <td class="paramname"><em>rhs</em></td><td>)</td>
 
348
          <td> const</td>
 
349
        </tr>
 
350
      </table>
 
351
  </td>
 
352
  <td class="mlabels-right">
 
353
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 
354
  </tr>
 
355
</table>
 
356
</div><div class="memdoc">
 
357
 
 
358
<p>Inequality operator. </p>
 
359
 
 
360
<p>References <a class="el" href="structOpenMS_1_1PeakIndex.html#af40104dc784144260a2345e53e5f0305">PeakIndex::peak</a>, and <a class="el" href="structOpenMS_1_1PeakIndex.html#ae90f6d024629703c9ba0dbd5eb5ef4b2">PeakIndex::spectrum</a>.</p>
 
361
 
 
362
</div>
 
363
</div>
 
364
<a class="anchor" id="a6ff004bc484a723c1903508f27ea3d4c"></a>
 
365
<div class="memitem">
 
366
<div class="memproto">
 
367
<table class="mlabels">
 
368
  <tr>
 
369
  <td class="mlabels-left">
 
370
      <table class="memname">
 
371
        <tr>
 
372
          <td class="memname">bool operator== </td>
 
373
          <td>(</td>
 
374
          <td class="paramtype">const <a class="el" href="structOpenMS_1_1PeakIndex.html">PeakIndex</a> &amp;&#160;</td>
 
375
          <td class="paramname"><em>rhs</em></td><td>)</td>
 
376
          <td> const</td>
 
377
        </tr>
 
378
      </table>
 
379
  </td>
 
380
  <td class="mlabels-right">
 
381
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 
382
  </tr>
 
383
</table>
 
384
</div><div class="memdoc">
 
385
 
 
386
<p>Equality operator. </p>
 
387
 
 
388
<p>References <a class="el" href="structOpenMS_1_1PeakIndex.html#af40104dc784144260a2345e53e5f0305">PeakIndex::peak</a>, and <a class="el" href="structOpenMS_1_1PeakIndex.html#ae90f6d024629703c9ba0dbd5eb5ef4b2">PeakIndex::spectrum</a>.</p>
 
389
 
 
390
</div>
 
391
</div>
 
392
<h2 class="groupheader">Member Data Documentation</h2>
 
393
<a class="anchor" id="af40104dc784144260a2345e53e5f0305"></a>
 
394
<div class="memitem">
 
395
<div class="memproto">
 
396
      <table class="memname">
 
397
        <tr>
 
398
          <td class="memname"><a class="el" href="group__Concept.html#gaf9ecec2d692138fab9167164a457cbd4">Size</a> peak</td>
 
399
        </tr>
 
400
      </table>
 
401
</div><div class="memdoc">
 
402
 
 
403
<p>Peak or feature index. </p>
 
404
 
 
405
<p>Referenced by <a class="el" href="structOpenMS_1_1PeakIndex.html#ac8bb3912a3ce86b15842e79d0b421204">PeakIndex::clear()</a>, <a class="el" href="structOpenMS_1_1PeakIndex.html#a7964d7f08b6732699e3e86111f185649">PeakIndex::getFeature()</a>, <a class="el" href="structOpenMS_1_1PeakIndex.html#a7fc5292f4ba9ca9642d565c0bc52f5af">PeakIndex::getPeak()</a>, <a class="el" href="structOpenMS_1_1PeakIndex.html#aac1b70a2ed67ead038c4d3f5ac4d8a81">PeakIndex::isValid()</a>, <a class="el" href="structOpenMS_1_1PeakIndex.html#a180ac47a3cf1d8780eaf2797610df1a5">PeakIndex::operator!=()</a>, and <a class="el" href="structOpenMS_1_1PeakIndex.html#a6ff004bc484a723c1903508f27ea3d4c">PeakIndex::operator==()</a>.</p>
 
406
 
 
407
</div>
 
408
</div>
 
409
<a class="anchor" id="ae90f6d024629703c9ba0dbd5eb5ef4b2"></a>
 
410
<div class="memitem">
 
411
<div class="memproto">
 
412
      <table class="memname">
 
413
        <tr>
 
414
          <td class="memname"><a class="el" href="group__Concept.html#gaf9ecec2d692138fab9167164a457cbd4">Size</a> spectrum</td>
 
415
        </tr>
 
416
      </table>
 
417
</div><div class="memdoc">
 
418
 
 
419
<p>Spectrum index. </p>
 
420
 
 
421
<p>Referenced by <a class="el" href="structOpenMS_1_1PeakIndex.html#ac8bb3912a3ce86b15842e79d0b421204">PeakIndex::clear()</a>, <a class="el" href="structOpenMS_1_1PeakIndex.html#a7fc5292f4ba9ca9642d565c0bc52f5af">PeakIndex::getPeak()</a>, <a class="el" href="structOpenMS_1_1PeakIndex.html#ae1302e8c1dc9de4b726ea79347bf2dd9">PeakIndex::getSpectrum()</a>, <a class="el" href="structOpenMS_1_1PeakIndex.html#a180ac47a3cf1d8780eaf2797610df1a5">PeakIndex::operator!=()</a>, and <a class="el" href="structOpenMS_1_1PeakIndex.html#a6ff004bc484a723c1903508f27ea3d4c">PeakIndex::operator==()</a>.</p>
 
422
 
 
423
</div>
 
424
</div>
 
425
</div><!-- contents -->
 
426
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
 
427
<TABLE width="100%" border="0">
 
428
<TR>
 
429
<TD><font color="#c0c0c0">OpenMS / TOPP release 1.11.1</font></TD>
 
430
<TD align="right"><font color="#c0c0c0">Documentation generated on Thu Nov 14 2013 11:19:32 using doxygen 1.8.5</font></TD>
 
431
</TR>
 
432
</TABLE>
 
433
</BODY>
 
434
</HTML>