File: group__RangeUtils.html

package info (click to toggle)
openms 1.11.1-5
links: PTS, VCS
area: main
in suites: jessie, jessie-kfreebsd
size: 436,688 kB
ctags: 150,907
sloc: cpp: 387,126; xml: 71,547; python: 7,764; ansic: 2,626; php: 2,499; sql: 737; ruby: 342; sh: 325; makefile: 128
file content (106 lines) | stat: -rw-r--r-- 11,019 bytes
<HTML>
<HEAD>
<TITLE>RangeUtils</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
<LINK HREF="style_ini.css" REL="stylesheet" TYPE="text/css">
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<A href="index.html">Home</A> &nbsp;&middot;
<A href="classes.html">Classes</A> &nbsp;&middot;
<A href="annotated.html">Annotated Classes</A> &nbsp;&middot;
<A href="modules.html">Modules</A> &nbsp;&middot;
<A href="functions_func.html">Members</A> &nbsp;&middot;
<A href="namespaces.html">Namespaces</A> &nbsp;&middot;
<A href="pages.html">Related Pages</A>
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
<!-- Generated by Doxygen 1.8.5 -->
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a>  </div>
  <div class="headertitle">
<div class="title">RangeUtils<div class="ingroups"><a class="el" href="group__Kernel.html">Kernel</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>Predicates for range operations.  
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1HasMetaValue.html">HasMetaValue&lt; MetaContainer &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Predicate that determines if a class has a certain metavalue.  <a href="classOpenMS_1_1HasMetaValue.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1InRTRange.html">InRTRange&lt; SpectrumType &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Predicate that determines if a spectrum lies inside/outside a specific retention time range.  <a href="classOpenMS_1_1InRTRange.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1InMSLevelRange.html">InMSLevelRange&lt; SpectrumType &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Predicate that determines if a spectrum lies inside/outside a specific MS level set.  <a href="classOpenMS_1_1InMSLevelRange.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1HasScanMode.html">HasScanMode&lt; SpectrumType &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Predicate that determines if a spectrum has a certain scan mode.  <a href="classOpenMS_1_1HasScanMode.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1IsEmptySpectrum.html">IsEmptySpectrum&lt; SpectrumType &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Predicate that determines if a spectrum is empty.  <a href="classOpenMS_1_1IsEmptySpectrum.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1IsZoomSpectrum.html">IsZoomSpectrum&lt; SpectrumType &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Predicate that determines if a spectrum is a zoom (enhanced resolution) spectrum.  <a href="classOpenMS_1_1IsZoomSpectrum.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1HasActivationMethod.html">HasActivationMethod&lt; SpectrumType &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Predicate that determines if a spectrum was generated using any activation method given in the constructor list.  <a href="classOpenMS_1_1HasActivationMethod.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1InPrecursorMZRange.html">InPrecursorMZRange&lt; SpectrumType &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Predicate that determines if a spectrum's precursor is within a certain m/z range.  <a href="classOpenMS_1_1InPrecursorMZRange.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1HasPrecursorCharge.html">HasPrecursorCharge&lt; SpectrumType &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Predicate that determines if a spectrum has a certain precursor charge as given in the constructor list.  <a href="classOpenMS_1_1HasPrecursorCharge.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1InMzRange.html">InMzRange&lt; PeakType &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Predicate that determines if a peak lies inside/outside a specific m/z range.  <a href="classOpenMS_1_1InMzRange.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1InIntensityRange.html">InIntensityRange&lt; PeakType &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Predicate that determines if a peak lies inside/outside a specific intensity range.  <a href="classOpenMS_1_1InIntensityRange.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1IsInCollisionEnergyRange.html">IsInCollisionEnergyRange&lt; SpectrumType &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Predicate that determines if an MSn spectrum was generated with a collision energy in the given range.  <a href="classOpenMS_1_1IsInCollisionEnergyRange.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1IsInIsolationWindowSizeRange.html">IsInIsolationWindowSizeRange&lt; SpectrumType &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Predicate that determines if the width of the isolation window of an MSn spectrum is in the given range.  <a href="classOpenMS_1_1IsInIsolationWindowSizeRange.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Predicates for range operations. </p>
<p>A group of predicates that can be used to perform range operations on MS data. They operate on classes that have the save interface as Spectrum or <a class="el" href="classOpenMS_1_1Peak1D.html" title="A 1-dimensional raw data point or peak. ">Peak1D</a> or <a class="el" href="classOpenMS_1_1Peak2D.html" title="A 2-dimensional raw data point or peak. ">Peak2D</a>, respectively. <br/>
 <br/>
 The code for the removal of spectra in a certain retention time range from a vector of spectra might look like this:</p>
<div class="fragment"><div class="line"><span class="comment">//data</span></div>
<div class="line">std::vector&lt; MSSpectrum&lt;&gt; &gt; spectra;</div>
<div class="line"></div>
<div class="line"><span class="comment">//... spectra are added to the vector ...</span></div>
<div class="line"></div>
<div class="line"><span class="comment">//range from 0.0 to 36.0 s</span></div>
<div class="line">InRTRange&lt; MSSpectrum&lt;&gt; &gt; range(0.0, 36.0);</div>
<div class="line"></div>
<div class="line"><span class="comment">//remove the range</span></div>
<div class="line">spectra.erase(remove_if(spectra.begin(), spectra.end(), range), spectra.end());</div>
</div><!-- fragment --><p>The code for the removal of peaks within certain intensity range from a spectrum might look like this:</p>
<div class="fragment"><div class="line"><span class="comment">//data</span></div>
<div class="line"><a class="code" href="classOpenMS_1_1MSSpectrum.html">MSSpectrum&lt;&gt;</a> spectrum;</div>
<div class="line"></div>
<div class="line"><span class="comment">//... peaks are added to the spectrum ...</span></div>
<div class="line"></div>
<div class="line"><span class="comment">//range from 0.0 to 5000.0 intensity</span></div>
<div class="line">InIntensityRange range&lt; Peak1D &gt;(0.0, 5000.0);</div>
<div class="line"></div>
<div class="line"><span class="comment">//remove the range</span></div>
<div class="line">spectrum.erase(remove_if(spectrum.begin(), spectrum.end(), range), spectrum.end());</div>
</div><!-- fragment --> </div><!-- contents -->
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
<TABLE width="100%" border="0">
<TR>
<TD><font color="#c0c0c0">OpenMS / TOPP release 1.11.1</font></TD>
<TD align="right"><font color="#c0c0c0">Documentation generated on Thu Nov 14 2013 11:19:25 using doxygen 1.8.5</font></TD>
</TR>
</TABLE>
</BODY>
</HTML>