← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/html/classOpenMS_1_1InMzRange.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_1InMzRange.html
 
1
<HTML>
 
2
<HEAD>
 
3
<TITLE>InMzRange&lt; PeakType &gt; Class Template 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_1InMzRange.html">InMzRange</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_1InMzRange-members.html">List of all members</a>  </div>
 
27
  <div class="headertitle">
 
28
<div class="title">InMzRange&lt; PeakType &gt; Class Template Reference<div class="ingroups"><a class="el" href="group__RangeUtils.html">RangeUtils</a></div></div>  </div>
 
29
</div><!--header-->
 
30
<div class="contents">
 
31
 
 
32
<p>Predicate that determines if a peak lies inside/outside a specific m/z range.  
 
33
 <a href="classOpenMS_1_1InMzRange.html#details">More...</a></p>
 
34
 
 
35
<p><code>#include &lt;<a class="el" href="RangeUtils_8h_source.html">OpenMS/KERNEL/RangeUtils.h</a>&gt;</code></p>
 
36
<div class="dynheader">
 
37
Inheritance diagram for InMzRange&lt; PeakType &gt;:</div>
 
38
<div class="dyncontent">
 
39
 <div class="center">
 
40
  <img src="classOpenMS_1_1InMzRange.png" usemap="#InMzRange&lt; PeakType &gt;_map" alt=""/>
 
41
  <map id="InMzRange&lt; PeakType &gt;_map" name="InMzRange&lt; PeakType &gt;_map">
 
42
</map>
 
43
 </div></div>
 
44
<table class="memberdecls">
 
45
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 
46
Public Member Functions</h2></td></tr>
 
47
<tr class="memitem:a4da1548b4e5c95f3cb30abbdb0c75c12"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1InMzRange.html#a4da1548b4e5c95f3cb30abbdb0c75c12">InMzRange</a> (<a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a> min, <a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a> max, bool reverse=false)</td></tr>
 
48
<tr class="memdesc:a4da1548b4e5c95f3cb30abbdb0c75c12"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a4da1548b4e5c95f3cb30abbdb0c75c12">More...</a><br/></td></tr>
 
49
<tr class="separator:a4da1548b4e5c95f3cb30abbdb0c75c12"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
50
<tr class="memitem:a240338d12f9e0d5b56c34ee79111b9ab"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1InMzRange.html#a240338d12f9e0d5b56c34ee79111b9ab">operator()</a> (const <a class="el" href="namespaceOpenMS.html#a013338b7bdbb5c3b4c78666656070e23">PeakType</a> &amp;p) const </td></tr>
 
51
<tr class="separator:a240338d12f9e0d5b56c34ee79111b9ab"><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="pro-attribs"></a>
 
54
Protected Attributes</h2></td></tr>
 
55
<tr class="memitem:ad27842357656a80459c67a7c57ea1f33"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1InMzRange.html#ad27842357656a80459c67a7c57ea1f33">min_</a></td></tr>
 
56
<tr class="separator:ad27842357656a80459c67a7c57ea1f33"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
57
<tr class="memitem:ac35428ad5c3c0dff76d57b000961a4c4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1InMzRange.html#ac35428ad5c3c0dff76d57b000961a4c4">max_</a></td></tr>
 
58
<tr class="separator:ac35428ad5c3c0dff76d57b000961a4c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
59
<tr class="memitem:aeae704668ea77ad91c0d84485ef7677e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1InMzRange.html#aeae704668ea77ad91c0d84485ef7677e">reverse_</a></td></tr>
 
60
<tr class="separator:aeae704668ea77ad91c0d84485ef7677e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
61
</table>
 
62
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 
63
<div class="textblock"><h3>template&lt;class PeakType&gt;<br/>
 
64
class OpenMS::InMzRange&lt; PeakType &gt;</h3>
 
65
 
 
66
<p>Predicate that determines if a peak lies inside/outside a specific m/z range. </p>
 
67
<p>PeakType must have a getPosition() method.</p>
 
68
<dl class="section note"><dt>Note</dt><dd>It is assumed that the m/z dimension is dimension 0! </dd></dl>
 
69
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 
70
<a class="anchor" id="a4da1548b4e5c95f3cb30abbdb0c75c12"></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="classOpenMS_1_1InMzRange.html">InMzRange</a> </td>
 
79
          <td>(</td>
 
80
          <td class="paramtype"><a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a>&#160;</td>
 
81
          <td class="paramname"><em>min</em>, </td>
 
82
        </tr>
 
83
        <tr>
 
84
          <td class="paramkey"></td>
 
85
          <td></td>
 
86
          <td class="paramtype"><a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a>&#160;</td>
 
87
          <td class="paramname"><em>max</em>, </td>
 
88
        </tr>
 
89
        <tr>
 
90
          <td class="paramkey"></td>
 
91
          <td></td>
 
92
          <td class="paramtype">bool&#160;</td>
 
93
          <td class="paramname"><em>reverse</em> = <code>false</code>&#160;</td>
 
94
        </tr>
 
95
        <tr>
 
96
          <td></td>
 
97
          <td>)</td>
 
98
          <td></td><td></td>
 
99
        </tr>
 
100
      </table>
 
101
  </td>
 
102
  <td class="mlabels-right">
 
103
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 
104
  </tr>
 
105
</table>
 
106
</div><div class="memdoc">
 
107
 
 
108
<p>Constructor. </p>
 
109
<dl class="params"><dt>Parameters</dt><dd>
 
110
  <table class="params">
 
111
    <tr><td class="paramname">min</td><td>lower boundary </td></tr>
 
112
    <tr><td class="paramname">max</td><td>upper boundary </td></tr>
 
113
    <tr><td class="paramname">reverse</td><td>if <code>reverse</code> is true, operator() returns true if the peak lies outside the range </td></tr>
 
114
  </table>
 
115
  </dd>
 
116
</dl>
 
117
 
 
118
</div>
 
119
</div>
 
120
<h2 class="groupheader">Member Function Documentation</h2>
 
121
<a class="anchor" id="a240338d12f9e0d5b56c34ee79111b9ab"></a>
 
122
<div class="memitem">
 
123
<div class="memproto">
 
124
<table class="mlabels">
 
125
  <tr>
 
126
  <td class="mlabels-left">
 
127
      <table class="memname">
 
128
        <tr>
 
129
          <td class="memname">bool operator() </td>
 
130
          <td>(</td>
 
131
          <td class="paramtype">const <a class="el" href="namespaceOpenMS.html#a013338b7bdbb5c3b4c78666656070e23">PeakType</a> &amp;&#160;</td>
 
132
          <td class="paramname"><em>p</em></td><td>)</td>
 
133
          <td> const</td>
 
134
        </tr>
 
135
      </table>
 
136
  </td>
 
137
  <td class="mlabels-right">
 
138
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 
139
  </tr>
 
140
</table>
 
141
</div><div class="memdoc">
 
142
 
 
143
<p>References <a class="el" href="classOpenMS_1_1Peak2D.html#a7d8aef8a439ca984c2dfb1bc01ce0845">Peak2D::getPosition()</a>, <a class="el" href="classOpenMS_1_1InMzRange.html#ac35428ad5c3c0dff76d57b000961a4c4">InMzRange&lt; PeakType &gt;::max_</a>, <a class="el" href="classOpenMS_1_1InMzRange.html#ad27842357656a80459c67a7c57ea1f33">InMzRange&lt; PeakType &gt;::min_</a>, and <a class="el" href="classOpenMS_1_1InMzRange.html#aeae704668ea77ad91c0d84485ef7677e">InMzRange&lt; PeakType &gt;::reverse_</a>.</p>
 
144
 
 
145
</div>
 
146
</div>
 
147
<h2 class="groupheader">Member Data Documentation</h2>
 
148
<a class="anchor" id="ac35428ad5c3c0dff76d57b000961a4c4"></a>
 
149
<div class="memitem">
 
150
<div class="memproto">
 
151
<table class="mlabels">
 
152
  <tr>
 
153
  <td class="mlabels-left">
 
154
      <table class="memname">
 
155
        <tr>
 
156
          <td class="memname"><a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a> max_</td>
 
157
        </tr>
 
158
      </table>
 
159
  </td>
 
160
  <td class="mlabels-right">
 
161
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
 
162
  </tr>
 
163
</table>
 
164
</div><div class="memdoc">
 
165
 
 
166
<p>Referenced by <a class="el" href="classOpenMS_1_1InMzRange.html#a240338d12f9e0d5b56c34ee79111b9ab">InMzRange&lt; PeakType &gt;::operator()()</a>.</p>
 
167
 
 
168
</div>
 
169
</div>
 
170
<a class="anchor" id="ad27842357656a80459c67a7c57ea1f33"></a>
 
171
<div class="memitem">
 
172
<div class="memproto">
 
173
<table class="mlabels">
 
174
  <tr>
 
175
  <td class="mlabels-left">
 
176
      <table class="memname">
 
177
        <tr>
 
178
          <td class="memname"><a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a> min_</td>
 
179
        </tr>
 
180
      </table>
 
181
  </td>
 
182
  <td class="mlabels-right">
 
183
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
 
184
  </tr>
 
185
</table>
 
186
</div><div class="memdoc">
 
187
 
 
188
<p>Referenced by <a class="el" href="classOpenMS_1_1InMzRange.html#a240338d12f9e0d5b56c34ee79111b9ab">InMzRange&lt; PeakType &gt;::operator()()</a>.</p>
 
189
 
 
190
</div>
 
191
</div>
 
192
<a class="anchor" id="aeae704668ea77ad91c0d84485ef7677e"></a>
 
193
<div class="memitem">
 
194
<div class="memproto">
 
195
<table class="mlabels">
 
196
  <tr>
 
197
  <td class="mlabels-left">
 
198
      <table class="memname">
 
199
        <tr>
 
200
          <td class="memname">bool reverse_</td>
 
201
        </tr>
 
202
      </table>
 
203
  </td>
 
204
  <td class="mlabels-right">
 
205
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
 
206
  </tr>
 
207
</table>
 
208
</div><div class="memdoc">
 
209
 
 
210
<p>Referenced by <a class="el" href="classOpenMS_1_1InMzRange.html#a240338d12f9e0d5b56c34ee79111b9ab">InMzRange&lt; PeakType &gt;::operator()()</a>.</p>
 
211
 
 
212
</div>
 
213
</div>
 
214
</div><!-- contents -->
 
215
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
 
216
<TABLE width="100%" border="0">
 
217
<TR>
 
218
<TD><font color="#c0c0c0">OpenMS / TOPP release 1.11.1</font></TD>
 
219
<TD align="right"><font color="#c0c0c0">Documentation generated on Thu Nov 14 2013 11:19:32 using doxygen 1.8.5</font></TD>
 
220
</TR>
 
221
</TABLE>
 
222
</BODY>
 
223
</HTML>