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

« back to all changes in this revision

Viewing changes to doc/html/classOpenMS_1_1ComplementFilter.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>ComplementFilter 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_1ComplementFilter.html">ComplementFilter</a></li>  </ul>
 
20
</div>
 
21
</div><!-- top -->
 
22
<div class="header">
 
23
  <div class="summary">
 
24
<a href="classOpenMS_1_1ComplementFilter-members.html">List of all members</a>  </div>
 
25
  <div class="headertitle">
 
26
<div class="title">ComplementFilter Class Reference<div class="ingroups"><a class="el" href="group__SpectraFilter.html">Spectra Filters</a></div></div>  </div>
 
27
</div><!--header-->
 
28
<div class="contents">
 
29
 
 
30
<p>total intensity of peak pairs that could result from complementing fragments of charge state 1  
 
31
 <a href="classOpenMS_1_1ComplementFilter.html#details">More...</a></p>
 
32
 
 
33
<p><code>#include &lt;<a class="el" href="ComplementFilter_8h_source.html">OpenMS/FILTERING/TRANSFORMERS/ComplementFilter.h</a>&gt;</code></p>
 
34
<div class="dynheader">
 
35
Inheritance diagram for ComplementFilter:</div>
 
36
<div class="dyncontent">
 
37
 <div class="center">
 
38
  <img src="classOpenMS_1_1ComplementFilter.png" usemap="#ComplementFilter_map" alt=""/>
 
39
  <map id="ComplementFilter_map" name="ComplementFilter_map">
 
40
<area href="classOpenMS_1_1FilterFunctor.html" title="A FilterFunctor extracts some spectrum characteristics for quality assessment. " alt="FilterFunctor" shape="rect" coords="0,56,133,80"/>
 
41
<area href="classOpenMS_1_1DefaultParamHandler.html" title="A base class for all classes handling default parameters. " alt="DefaultParamHandler" shape="rect" coords="0,0,133,24"/>
 
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><td colspan="2"><div class="groupHeader"></div></td></tr>
 
48
<tr class="memitem:a345330dcef78eb44534b6d91a417a99f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ComplementFilter.html#a345330dcef78eb44534b6d91a417a99f">ComplementFilter</a> ()</td></tr>
 
49
<tr class="memdesc:a345330dcef78eb44534b6d91a417a99f"><td class="mdescLeft">&#160;</td><td class="mdescRight">standard constructor  <a href="#a345330dcef78eb44534b6d91a417a99f">More...</a><br/></td></tr>
 
50
<tr class="separator:a345330dcef78eb44534b6d91a417a99f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
51
<tr class="memitem:a6207757e8913a4c7f69adc3234ab58a6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ComplementFilter.html#a6207757e8913a4c7f69adc3234ab58a6">ComplementFilter</a> (const <a class="el" href="classOpenMS_1_1ComplementFilter.html">ComplementFilter</a> &amp;source)</td></tr>
 
52
<tr class="memdesc:a6207757e8913a4c7f69adc3234ab58a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">copy constructor  <a href="#a6207757e8913a4c7f69adc3234ab58a6">More...</a><br/></td></tr>
 
53
<tr class="separator:a6207757e8913a4c7f69adc3234ab58a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
54
<tr class="memitem:adf248bacfa995957b6411982f8d534b0"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ComplementFilter.html#adf248bacfa995957b6411982f8d534b0">~ComplementFilter</a> ()</td></tr>
 
55
<tr class="memdesc:adf248bacfa995957b6411982f8d534b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">destructor  <a href="#adf248bacfa995957b6411982f8d534b0">More...</a><br/></td></tr>
 
56
<tr class="separator:adf248bacfa995957b6411982f8d534b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
57
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
 
58
<tr class="memitem:add96d529b0a3d946fd775dd707f32e09"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1ComplementFilter.html">ComplementFilter</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ComplementFilter.html#add96d529b0a3d946fd775dd707f32e09">operator=</a> (const <a class="el" href="classOpenMS_1_1ComplementFilter.html">ComplementFilter</a> &amp;source)</td></tr>
 
59
<tr class="memdesc:add96d529b0a3d946fd775dd707f32e09"><td class="mdescLeft">&#160;</td><td class="mdescRight">assignment operator  <a href="#add96d529b0a3d946fd775dd707f32e09">More...</a><br/></td></tr>
 
60
<tr class="separator:add96d529b0a3d946fd775dd707f32e09"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
61
<tr class="inherit_header pub_methods_classOpenMS_1_1FilterFunctor"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classOpenMS_1_1FilterFunctor')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classOpenMS_1_1FilterFunctor.html">FilterFunctor</a></td></tr>
 
62
<tr class="memitem:a956848dc11bb906ba39969cae520b19b inherit pub_methods_classOpenMS_1_1FilterFunctor"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1FilterFunctor.html#a956848dc11bb906ba39969cae520b19b">FilterFunctor</a> ()</td></tr>
 
63
<tr class="memdesc:a956848dc11bb906ba39969cae520b19b inherit pub_methods_classOpenMS_1_1FilterFunctor"><td class="mdescLeft">&#160;</td><td class="mdescRight">default constructor  <a href="#a956848dc11bb906ba39969cae520b19b">More...</a><br/></td></tr>
 
64
<tr class="separator:a956848dc11bb906ba39969cae520b19b inherit pub_methods_classOpenMS_1_1FilterFunctor"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
65
<tr class="memitem:a29b1055105e6e109aa8ba2e414ba9622 inherit pub_methods_classOpenMS_1_1FilterFunctor"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1FilterFunctor.html#a29b1055105e6e109aa8ba2e414ba9622">FilterFunctor</a> (const <a class="el" href="classOpenMS_1_1FilterFunctor.html">FilterFunctor</a> &amp;source)</td></tr>
 
66
<tr class="memdesc:a29b1055105e6e109aa8ba2e414ba9622 inherit pub_methods_classOpenMS_1_1FilterFunctor"><td class="mdescLeft">&#160;</td><td class="mdescRight">copy constructor  <a href="#a29b1055105e6e109aa8ba2e414ba9622">More...</a><br/></td></tr>
 
67
<tr class="separator:a29b1055105e6e109aa8ba2e414ba9622 inherit pub_methods_classOpenMS_1_1FilterFunctor"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
68
<tr class="memitem:ac17055975aba7e9a99b83d43d2586fe6 inherit pub_methods_classOpenMS_1_1FilterFunctor"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1FilterFunctor.html#ac17055975aba7e9a99b83d43d2586fe6">~FilterFunctor</a> ()</td></tr>
 
69
<tr class="memdesc:ac17055975aba7e9a99b83d43d2586fe6 inherit pub_methods_classOpenMS_1_1FilterFunctor"><td class="mdescLeft">&#160;</td><td class="mdescRight">destructor  <a href="#ac17055975aba7e9a99b83d43d2586fe6">More...</a><br/></td></tr>
 
70
<tr class="separator:ac17055975aba7e9a99b83d43d2586fe6 inherit pub_methods_classOpenMS_1_1FilterFunctor"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
71
<tr class="memitem:a304322dac1ecf6dc3ff7c1f249943017 inherit pub_methods_classOpenMS_1_1FilterFunctor"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1FilterFunctor.html">FilterFunctor</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1FilterFunctor.html#a304322dac1ecf6dc3ff7c1f249943017">operator=</a> (const <a class="el" href="classOpenMS_1_1FilterFunctor.html">FilterFunctor</a> &amp;source)</td></tr>
 
72
<tr class="memdesc:a304322dac1ecf6dc3ff7c1f249943017 inherit pub_methods_classOpenMS_1_1FilterFunctor"><td class="mdescLeft">&#160;</td><td class="mdescRight">assignment operator  <a href="#a304322dac1ecf6dc3ff7c1f249943017">More...</a><br/></td></tr>
 
73
<tr class="separator:a304322dac1ecf6dc3ff7c1f249943017 inherit pub_methods_classOpenMS_1_1FilterFunctor"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
74
<tr class="memitem:a0d67c27ffb3b69222c17c8b3744ae645 inherit pub_methods_classOpenMS_1_1FilterFunctor"><td class="memTemplParams" colspan="2">template&lt;typename SpectrumType &gt; </td></tr>
 
75
<tr class="memitem:a0d67c27ffb3b69222c17c8b3744ae645 inherit pub_methods_classOpenMS_1_1FilterFunctor"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classdouble.html">double</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1FilterFunctor.html#a0d67c27ffb3b69222c17c8b3744ae645">apply</a> (SpectrumType &amp;)</td></tr>
 
76
<tr class="memdesc:a0d67c27ffb3b69222c17c8b3744ae645 inherit pub_methods_classOpenMS_1_1FilterFunctor"><td class="mdescLeft">&#160;</td><td class="mdescRight">function call operator  <a href="#a0d67c27ffb3b69222c17c8b3744ae645">More...</a><br/></td></tr>
 
77
<tr class="separator:a0d67c27ffb3b69222c17c8b3744ae645 inherit pub_methods_classOpenMS_1_1FilterFunctor"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
78
<tr class="inherit_header pub_methods_classOpenMS_1_1DefaultParamHandler"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classOpenMS_1_1DefaultParamHandler')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classOpenMS_1_1DefaultParamHandler.html">DefaultParamHandler</a></td></tr>
 
79
<tr class="memitem:afb6802fda161cb0c1a4a05597f94aecc inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DefaultParamHandler.html#afb6802fda161cb0c1a4a05597f94aecc">DefaultParamHandler</a> (const <a class="el" href="classOpenMS_1_1String.html">String</a> &amp;name)</td></tr>
 
80
<tr class="memdesc:afb6802fda161cb0c1a4a05597f94aecc inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor with name that is displayed in error messages.  <a href="#afb6802fda161cb0c1a4a05597f94aecc">More...</a><br/></td></tr>
 
81
<tr class="separator:afb6802fda161cb0c1a4a05597f94aecc inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
82
<tr class="memitem:a954da7eef3cfddda446574eaadd20abb inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DefaultParamHandler.html#a954da7eef3cfddda446574eaadd20abb">DefaultParamHandler</a> (const <a class="el" href="classOpenMS_1_1DefaultParamHandler.html">DefaultParamHandler</a> &amp;rhs)</td></tr>
 
83
<tr class="memdesc:a954da7eef3cfddda446574eaadd20abb inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy constructor.  <a href="#a954da7eef3cfddda446574eaadd20abb">More...</a><br/></td></tr>
 
84
<tr class="separator:a954da7eef3cfddda446574eaadd20abb inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
85
<tr class="memitem:a11e9d6dd34fe8860874aa8abe0ec121b inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DefaultParamHandler.html#a11e9d6dd34fe8860874aa8abe0ec121b">~DefaultParamHandler</a> ()</td></tr>
 
86
<tr class="memdesc:a11e9d6dd34fe8860874aa8abe0ec121b inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#a11e9d6dd34fe8860874aa8abe0ec121b">More...</a><br/></td></tr>
 
87
<tr class="separator:a11e9d6dd34fe8860874aa8abe0ec121b inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
88
<tr class="memitem:ae6b6d68036a573a44f6609460ba2dfb6 inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classOpenMS_1_1DefaultParamHandler.html">DefaultParamHandler</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DefaultParamHandler.html#ae6b6d68036a573a44f6609460ba2dfb6">operator=</a> (const <a class="el" href="classOpenMS_1_1DefaultParamHandler.html">DefaultParamHandler</a> &amp;rhs)</td></tr>
 
89
<tr class="memdesc:ae6b6d68036a573a44f6609460ba2dfb6 inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assignment operator.  <a href="#ae6b6d68036a573a44f6609460ba2dfb6">More...</a><br/></td></tr>
 
90
<tr class="separator:ae6b6d68036a573a44f6609460ba2dfb6 inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
91
<tr class="memitem:ac435f2dd4d9f9328db83af97129a8d7e inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DefaultParamHandler.html#ac435f2dd4d9f9328db83af97129a8d7e">operator==</a> (const <a class="el" href="classOpenMS_1_1DefaultParamHandler.html">DefaultParamHandler</a> &amp;rhs) const </td></tr>
 
92
<tr class="memdesc:ac435f2dd4d9f9328db83af97129a8d7e inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="mdescLeft">&#160;</td><td class="mdescRight">Equality operator.  <a href="#ac435f2dd4d9f9328db83af97129a8d7e">More...</a><br/></td></tr>
 
93
<tr class="separator:ac435f2dd4d9f9328db83af97129a8d7e inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
94
<tr class="memitem:abc8067511cfc949ae942ea2b08588f81 inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DefaultParamHandler.html#abc8067511cfc949ae942ea2b08588f81">setParameters</a> (const <a class="el" href="classOpenMS_1_1Param.html">Param</a> &amp;param)</td></tr>
 
95
<tr class="memdesc:abc8067511cfc949ae942ea2b08588f81 inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the parameters.  <a href="#abc8067511cfc949ae942ea2b08588f81">More...</a><br/></td></tr>
 
96
<tr class="separator:abc8067511cfc949ae942ea2b08588f81 inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
97
<tr class="memitem:a7f6aab5a7dfbdd1c062a4352a29361f3 inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classOpenMS_1_1Param.html">Param</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DefaultParamHandler.html#a7f6aab5a7dfbdd1c062a4352a29361f3">getParameters</a> () const </td></tr>
 
98
<tr class="memdesc:a7f6aab5a7dfbdd1c062a4352a29361f3 inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="mdescLeft">&#160;</td><td class="mdescRight">Non-mutable access to the parameters.  <a href="#a7f6aab5a7dfbdd1c062a4352a29361f3">More...</a><br/></td></tr>
 
99
<tr class="separator:a7f6aab5a7dfbdd1c062a4352a29361f3 inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
100
<tr class="memitem:a02f02fa9832ca3e8d47c575a39803a2a inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classOpenMS_1_1Param.html">Param</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DefaultParamHandler.html#a02f02fa9832ca3e8d47c575a39803a2a">getDefaults</a> () const </td></tr>
 
101
<tr class="memdesc:a02f02fa9832ca3e8d47c575a39803a2a inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="mdescLeft">&#160;</td><td class="mdescRight">Non-mutable access to the default parameters.  <a href="#a02f02fa9832ca3e8d47c575a39803a2a">More...</a><br/></td></tr>
 
102
<tr class="separator:a02f02fa9832ca3e8d47c575a39803a2a inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
103
<tr class="memitem:aaee0f2845288173de9f6ad47e6ad31d5 inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classOpenMS_1_1String.html">String</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DefaultParamHandler.html#aaee0f2845288173de9f6ad47e6ad31d5">getName</a> () const </td></tr>
 
104
<tr class="memdesc:aaee0f2845288173de9f6ad47e6ad31d5 inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="mdescLeft">&#160;</td><td class="mdescRight">Non-mutable access to the name.  <a href="#aaee0f2845288173de9f6ad47e6ad31d5">More...</a><br/></td></tr>
 
105
<tr class="separator:aaee0f2845288173de9f6ad47e6ad31d5 inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
106
<tr class="memitem:a77d37f2e1c12e8bd33ea0e660a89e927 inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DefaultParamHandler.html#a77d37f2e1c12e8bd33ea0e660a89e927">setName</a> (const <a class="el" href="classOpenMS_1_1String.html">String</a> &amp;name)</td></tr>
 
107
<tr class="memdesc:a77d37f2e1c12e8bd33ea0e660a89e927 inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mutable access to the name.  <a href="#a77d37f2e1c12e8bd33ea0e660a89e927">More...</a><br/></td></tr>
 
108
<tr class="separator:a77d37f2e1c12e8bd33ea0e660a89e927 inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
109
<tr class="memitem:a768d4a2093627a2f34728656a9721bdf inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="memItemLeft" align="right" valign="top">const std::vector&lt; <a class="el" href="classOpenMS_1_1String.html">String</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DefaultParamHandler.html#a768d4a2093627a2f34728656a9721bdf">getSubsections</a> () const </td></tr>
 
110
<tr class="memdesc:a768d4a2093627a2f34728656a9721bdf inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="mdescLeft">&#160;</td><td class="mdescRight">Non-mutable access to the registered subsections.  <a href="#a768d4a2093627a2f34728656a9721bdf">More...</a><br/></td></tr>
 
111
<tr class="separator:a768d4a2093627a2f34728656a9721bdf inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
112
<tr class="memitem:adf638fa1a8dfe5de7d7fa39735e3d7fd"><td class="memTemplParams" colspan="2">template&lt;typename SpectrumType &gt; </td></tr>
 
113
<tr class="memitem:adf638fa1a8dfe5de7d7fa39735e3d7fd"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classdouble.html">double</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ComplementFilter.html#adf638fa1a8dfe5de7d7fa39735e3d7fd">apply</a> (SpectrumType &amp;spectrum)</td></tr>
 
114
<tr class="memdesc:adf638fa1a8dfe5de7d7fa39735e3d7fd"><td class="mdescLeft">&#160;</td><td class="mdescRight">returns the total intensity of peak pairs which could result from complementing fragments  <a href="#adf638fa1a8dfe5de7d7fa39735e3d7fd">More...</a><br/></td></tr>
 
115
<tr class="separator:adf638fa1a8dfe5de7d7fa39735e3d7fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
116
<tr class="memitem:a688dd7fe92ebbbb74ca8a20934bfaed9"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classOpenMS_1_1FilterFunctor.html">FilterFunctor</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ComplementFilter.html#a688dd7fe92ebbbb74ca8a20934bfaed9">create</a> ()</td></tr>
 
117
<tr class="separator:a688dd7fe92ebbbb74ca8a20934bfaed9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
118
<tr class="memitem:af73fd15708e50e77665070023a09cc87"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classOpenMS_1_1String.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ComplementFilter.html#af73fd15708e50e77665070023a09cc87">getProductName</a> ()</td></tr>
 
119
<tr class="memdesc:af73fd15708e50e77665070023a09cc87"><td class="mdescLeft">&#160;</td><td class="mdescRight">returns the name for registration at the factory  <a href="#af73fd15708e50e77665070023a09cc87">More...</a><br/></td></tr>
 
120
<tr class="separator:af73fd15708e50e77665070023a09cc87"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
121
</table><table class="memberdecls">
 
122
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
 
123
Additional Inherited Members</h2></td></tr>
 
124
<tr class="inherit_header pub_static_methods_classOpenMS_1_1FilterFunctor"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classOpenMS_1_1FilterFunctor')"><img src="closed.png" alt="-"/>&#160;Static Public Member Functions inherited from <a class="el" href="classOpenMS_1_1FilterFunctor.html">FilterFunctor</a></td></tr>
 
125
<tr class="memitem:a7899dbe105534dc1f81971dd71a26ff0 inherit pub_static_methods_classOpenMS_1_1FilterFunctor"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1FilterFunctor.html#a7899dbe105534dc1f81971dd71a26ff0">registerChildren</a> ()</td></tr>
 
126
<tr class="separator:a7899dbe105534dc1f81971dd71a26ff0 inherit pub_static_methods_classOpenMS_1_1FilterFunctor"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
127
<tr class="inherit_header pro_methods_classOpenMS_1_1DefaultParamHandler"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classOpenMS_1_1DefaultParamHandler')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classOpenMS_1_1DefaultParamHandler.html">DefaultParamHandler</a></td></tr>
 
128
<tr class="memitem:a776f7572fc4f466e9527ca233471920d inherit pro_methods_classOpenMS_1_1DefaultParamHandler"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DefaultParamHandler.html#a776f7572fc4f466e9527ca233471920d">updateMembers_</a> ()</td></tr>
 
129
<tr class="memdesc:a776f7572fc4f466e9527ca233471920d inherit pro_methods_classOpenMS_1_1DefaultParamHandler"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method is used to update extra member variables at the end of the <a class="el" href="classOpenMS_1_1DefaultParamHandler.html#abc8067511cfc949ae942ea2b08588f81" title="Sets the parameters. ">setParameters()</a> method.  <a href="#a776f7572fc4f466e9527ca233471920d">More...</a><br/></td></tr>
 
130
<tr class="separator:a776f7572fc4f466e9527ca233471920d inherit pro_methods_classOpenMS_1_1DefaultParamHandler"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
131
<tr class="memitem:a2802c591e6d7fd3fd9cc35f5e875d0ba inherit pro_methods_classOpenMS_1_1DefaultParamHandler"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DefaultParamHandler.html#a2802c591e6d7fd3fd9cc35f5e875d0ba">defaultsToParam_</a> ()</td></tr>
 
132
<tr class="memdesc:a2802c591e6d7fd3fd9cc35f5e875d0ba inherit pro_methods_classOpenMS_1_1DefaultParamHandler"><td class="mdescLeft">&#160;</td><td class="mdescRight">Updates the parameters after the defaults have been set in the constructor.  <a href="#a2802c591e6d7fd3fd9cc35f5e875d0ba">More...</a><br/></td></tr>
 
133
<tr class="separator:a2802c591e6d7fd3fd9cc35f5e875d0ba inherit pro_methods_classOpenMS_1_1DefaultParamHandler"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
134
<tr class="inherit_header pro_attribs_classOpenMS_1_1DefaultParamHandler"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classOpenMS_1_1DefaultParamHandler')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classOpenMS_1_1DefaultParamHandler.html">DefaultParamHandler</a></td></tr>
 
135
<tr class="memitem:a28c73e623c63a4fe3bfceb1ae8274f39 inherit pro_attribs_classOpenMS_1_1DefaultParamHandler"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1Param.html">Param</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DefaultParamHandler.html#a28c73e623c63a4fe3bfceb1ae8274f39">param_</a></td></tr>
 
136
<tr class="memdesc:a28c73e623c63a4fe3bfceb1ae8274f39 inherit pro_attribs_classOpenMS_1_1DefaultParamHandler"><td class="mdescLeft">&#160;</td><td class="mdescRight">Container for current parameters.  <a href="#a28c73e623c63a4fe3bfceb1ae8274f39">More...</a><br/></td></tr>
 
137
<tr class="separator:a28c73e623c63a4fe3bfceb1ae8274f39 inherit pro_attribs_classOpenMS_1_1DefaultParamHandler"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
138
<tr class="memitem:a761b1937850c141d0c6fff0e4d633a04 inherit pro_attribs_classOpenMS_1_1DefaultParamHandler"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1Param.html">Param</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DefaultParamHandler.html#a761b1937850c141d0c6fff0e4d633a04">defaults_</a></td></tr>
 
139
<tr class="memdesc:a761b1937850c141d0c6fff0e4d633a04 inherit pro_attribs_classOpenMS_1_1DefaultParamHandler"><td class="mdescLeft">&#160;</td><td class="mdescRight">Container for default parameters. This member should be filled in the constructor of derived classes!  <a href="#a761b1937850c141d0c6fff0e4d633a04">More...</a><br/></td></tr>
 
140
<tr class="separator:a761b1937850c141d0c6fff0e4d633a04 inherit pro_attribs_classOpenMS_1_1DefaultParamHandler"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
141
<tr class="memitem:ac4b0e20bc59c7a5afe016c69067e428c inherit pro_attribs_classOpenMS_1_1DefaultParamHandler"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="classOpenMS_1_1String.html">String</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DefaultParamHandler.html#ac4b0e20bc59c7a5afe016c69067e428c">subsections_</a></td></tr>
 
142
<tr class="memdesc:ac4b0e20bc59c7a5afe016c69067e428c inherit pro_attribs_classOpenMS_1_1DefaultParamHandler"><td class="mdescLeft">&#160;</td><td class="mdescRight">Container for registered subsections. This member should be filled in the constructor of derived classes!  <a href="#ac4b0e20bc59c7a5afe016c69067e428c">More...</a><br/></td></tr>
 
143
<tr class="separator:ac4b0e20bc59c7a5afe016c69067e428c inherit pro_attribs_classOpenMS_1_1DefaultParamHandler"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
144
<tr class="memitem:a5a51f3f150b09068256195e934339a19 inherit pro_attribs_classOpenMS_1_1DefaultParamHandler"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1String.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DefaultParamHandler.html#a5a51f3f150b09068256195e934339a19">error_name_</a></td></tr>
 
145
<tr class="memdesc:a5a51f3f150b09068256195e934339a19 inherit pro_attribs_classOpenMS_1_1DefaultParamHandler"><td class="mdescLeft">&#160;</td><td class="mdescRight">Name that is displayed in error messages during the parameter checking.  <a href="#a5a51f3f150b09068256195e934339a19">More...</a><br/></td></tr>
 
146
<tr class="separator:a5a51f3f150b09068256195e934339a19 inherit pro_attribs_classOpenMS_1_1DefaultParamHandler"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
147
<tr class="memitem:a7c3b265b697a57615da5cd3274780efd inherit pro_attribs_classOpenMS_1_1DefaultParamHandler"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DefaultParamHandler.html#a7c3b265b697a57615da5cd3274780efd">check_defaults_</a></td></tr>
 
148
<tr class="memdesc:a7c3b265b697a57615da5cd3274780efd inherit pro_attribs_classOpenMS_1_1DefaultParamHandler"><td class="mdescLeft">&#160;</td><td class="mdescRight">If this member is set to false no checking if parameters in done;.  <a href="#a7c3b265b697a57615da5cd3274780efd">More...</a><br/></td></tr>
 
149
<tr class="separator:a7c3b265b697a57615da5cd3274780efd inherit pro_attribs_classOpenMS_1_1DefaultParamHandler"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
150
<tr class="memitem:aba444910e4fccb93f91bf7ab135f508a inherit pro_attribs_classOpenMS_1_1DefaultParamHandler"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DefaultParamHandler.html#aba444910e4fccb93f91bf7ab135f508a">warn_empty_defaults_</a></td></tr>
 
151
<tr class="memdesc:aba444910e4fccb93f91bf7ab135f508a inherit pro_attribs_classOpenMS_1_1DefaultParamHandler"><td class="mdescLeft">&#160;</td><td class="mdescRight">If this member is set to false no warning is emitted when defaults are empty;.  <a href="#aba444910e4fccb93f91bf7ab135f508a">More...</a><br/></td></tr>
 
152
<tr class="separator:aba444910e4fccb93f91bf7ab135f508a inherit pro_attribs_classOpenMS_1_1DefaultParamHandler"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
153
</table>
 
154
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 
155
<div class="textblock"><p>total intensity of peak pairs that could result from complementing fragments of charge state 1 </p>
 
156
<B>Parameters of this class are:</B><BR><BR>
 
157
<table border="1" style="border-style:solid; border-collapse:collapse; border-color:#c0c0c0;" width="100%" cellpadding="4">
 
158
<tr style="border-bottom:1px solid black; background:#fffff0"><th>Name</th><th>Type</th><th>Default</th><th>Restrictions</th><th>Description</th></tr>
 
159
<tr>
 
160
  <td style="vertical-align:top"><b>tolerance</b></td>
 
161
  <td style="vertical-align:top">float</td><td style="vertical-align:top">0.37</td>
 
162
  <td style="vertical-align:top">&nbsp;</td><td style="vertical-align:top">Tolerance value as defined by Bern et al.</td>
 
163
</tr>
 
164
</table>
 
165
<br>
 
166
<b>Note:</b>
 
167
<UL style="margin-top:0px;">
 
168
  <LI> If a section name is documented, the documentation is displayed as tooltip.
 
169
  <LI> Advanced parameter names are italic.
 
170
</UL>
 
171
 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 
172
<a class="anchor" id="a345330dcef78eb44534b6d91a417a99f"></a>
 
173
<div class="memitem">
 
174
<div class="memproto">
 
175
      <table class="memname">
 
176
        <tr>
 
177
          <td class="memname"><a class="el" href="classOpenMS_1_1ComplementFilter.html">ComplementFilter</a> </td>
 
178
          <td>(</td>
 
179
          <td class="paramname"></td><td>)</td>
 
180
          <td></td>
 
181
        </tr>
 
182
      </table>
 
183
</div><div class="memdoc">
 
184
 
 
185
<p>standard constructor </p>
 
186
 
 
187
</div>
 
188
</div>
 
189
<a class="anchor" id="a6207757e8913a4c7f69adc3234ab58a6"></a>
 
190
<div class="memitem">
 
191
<div class="memproto">
 
192
      <table class="memname">
 
193
        <tr>
 
194
          <td class="memname"><a class="el" href="classOpenMS_1_1ComplementFilter.html">ComplementFilter</a> </td>
 
195
          <td>(</td>
 
196
          <td class="paramtype">const <a class="el" href="classOpenMS_1_1ComplementFilter.html">ComplementFilter</a> &amp;&#160;</td>
 
197
          <td class="paramname"><em>source</em></td><td>)</td>
 
198
          <td></td>
 
199
        </tr>
 
200
      </table>
 
201
</div><div class="memdoc">
 
202
 
 
203
<p>copy constructor </p>
 
204
 
 
205
</div>
 
206
</div>
 
207
<a class="anchor" id="adf248bacfa995957b6411982f8d534b0"></a>
 
208
<div class="memitem">
 
209
<div class="memproto">
 
210
<table class="mlabels">
 
211
  <tr>
 
212
  <td class="mlabels-left">
 
213
      <table class="memname">
 
214
        <tr>
 
215
          <td class="memname">virtual ~<a class="el" href="classOpenMS_1_1ComplementFilter.html">ComplementFilter</a> </td>
 
216
          <td>(</td>
 
217
          <td class="paramname"></td><td>)</td>
 
218
          <td></td>
 
219
        </tr>
 
220
      </table>
 
221
  </td>
 
222
  <td class="mlabels-right">
 
223
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
 
224
  </tr>
 
225
</table>
 
226
</div><div class="memdoc">
 
227
 
 
228
<p>destructor </p>
 
229
 
 
230
</div>
 
231
</div>
 
232
<h2 class="groupheader">Member Function Documentation</h2>
 
233
<a class="anchor" id="adf638fa1a8dfe5de7d7fa39735e3d7fd"></a>
 
234
<div class="memitem">
 
235
<div class="memproto">
 
236
<table class="mlabels">
 
237
  <tr>
 
238
  <td class="mlabels-left">
 
239
      <table class="memname">
 
240
        <tr>
 
241
          <td class="memname"><a class="el" href="classdouble.html">double</a> apply </td>
 
242
          <td>(</td>
 
243
          <td class="paramtype">SpectrumType &amp;&#160;</td>
 
244
          <td class="paramname"><em>spectrum</em></td><td>)</td>
 
245
          <td></td>
 
246
        </tr>
 
247
      </table>
 
248
  </td>
 
249
  <td class="mlabels-right">
 
250
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 
251
  </tr>
 
252
</table>
 
253
</div><div class="memdoc">
 
254
 
 
255
<p>returns the total intensity of peak pairs which could result from complementing fragments </p>
 
256
<dl class="improvement"><dt><b><a class="el" href="improvement.html#_improvement000007">Improvement:</a></b></dt><dd>think about an correct fast algorithm, not just an heuristic (Andreas) </dd></dl>
 
257
 
 
258
<p>References <a class="el" href="group__MathFunctionsStatistics.html#ga55edf7ee469b3d635c367d9c83fe87f5">OpenMS::Math::sum()</a>.</p>
 
259
 
 
260
</div>
 
261
</div>
 
262
<a class="anchor" id="a688dd7fe92ebbbb74ca8a20934bfaed9"></a>
 
263
<div class="memitem">
 
264
<div class="memproto">
 
265
<table class="mlabels">
 
266
  <tr>
 
267
  <td class="mlabels-left">
 
268
      <table class="memname">
 
269
        <tr>
 
270
          <td class="memname">static <a class="el" href="classOpenMS_1_1FilterFunctor.html">FilterFunctor</a>* create </td>
 
271
          <td>(</td>
 
272
          <td class="paramname"></td><td>)</td>
 
273
          <td></td>
 
274
        </tr>
 
275
      </table>
 
276
  </td>
 
277
  <td class="mlabels-right">
 
278
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 
279
  </tr>
 
280
</table>
 
281
</div><div class="memdoc">
 
282
 
 
283
</div>
 
284
</div>
 
285
<a class="anchor" id="af73fd15708e50e77665070023a09cc87"></a>
 
286
<div class="memitem">
 
287
<div class="memproto">
 
288
<table class="mlabels">
 
289
  <tr>
 
290
  <td class="mlabels-left">
 
291
      <table class="memname">
 
292
        <tr>
 
293
          <td class="memname">static const <a class="el" href="classOpenMS_1_1String.html">String</a> getProductName </td>
 
294
          <td>(</td>
 
295
          <td class="paramname"></td><td>)</td>
 
296
          <td></td>
 
297
        </tr>
 
298
      </table>
 
299
  </td>
 
300
  <td class="mlabels-right">
 
301
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 
302
  </tr>
 
303
</table>
 
304
</div><div class="memdoc">
 
305
 
 
306
<p>returns the name for registration at the factory </p>
 
307
 
 
308
</div>
 
309
</div>
 
310
<a class="anchor" id="add96d529b0a3d946fd775dd707f32e09"></a>
 
311
<div class="memitem">
 
312
<div class="memproto">
 
313
      <table class="memname">
 
314
        <tr>
 
315
          <td class="memname"><a class="el" href="classOpenMS_1_1ComplementFilter.html">ComplementFilter</a>&amp; operator= </td>
 
316
          <td>(</td>
 
317
          <td class="paramtype">const <a class="el" href="classOpenMS_1_1ComplementFilter.html">ComplementFilter</a> &amp;&#160;</td>
 
318
          <td class="paramname"><em>source</em></td><td>)</td>
 
319
          <td></td>
 
320
        </tr>
 
321
      </table>
 
322
</div><div class="memdoc">
 
323
 
 
324
<p>assignment operator </p>
 
325
 
 
326
</div>
 
327
</div>
 
328
</div><!-- contents -->
 
329
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
 
330
<TABLE width="100%" border="0">
 
331
<TR>
 
332
<TD><font color="#c0c0c0">OpenMS / TOPP release 1.11.1</font></TD>
 
333
<TD align="right"><font color="#c0c0c0">Documentation generated on Thu Nov 14 2013 11:19:30 using doxygen 1.8.5</font></TD>
 
334
</TR>
 
335
</TABLE>
 
336
</BODY>
 
337
</HTML>