3
<TITLE>SteinScottImproveScore Class Reference</TITLE>
4
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
5
<LINK HREF="style_ini.css" REL="stylesheet" TYPE="text/css">
7
<BODY BGCOLOR="#FFFFFF">
8
<A href="index.html">Home</A> ·
9
<A href="classes.html">Classes</A> ·
10
<A href="annotated.html">Annotated Classes</A> ·
11
<A href="modules.html">Modules</A> ·
12
<A href="functions_func.html">Members</A> ·
13
<A href="namespaces.html">Namespaces</A> ·
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">
19
<li class="navelem"><a class="el" href="namespaceOpenMS.html">OpenMS</a></li><li class="navelem"><a class="el" href="classOpenMS_1_1SteinScottImproveScore.html">SteinScottImproveScore</a></li> </ul>
24
<a href="#pub-methods">Public Member Functions</a> |
25
<a href="#pub-static-methods">Static Public Member Functions</a> |
26
<a href="classOpenMS_1_1SteinScottImproveScore-members.html">List of all members</a> </div>
27
<div class="headertitle">
28
<div class="title">SteinScottImproveScore Class Reference<div class="ingroups"><a class="el" href="group__SpectraComparison.html">Spectrum Comparison</a></div></div> </div>
30
<div class="contents">
32
<p>Similarity score based of Stein & Scott.
33
<a href="classOpenMS_1_1SteinScottImproveScore.html#details">More...</a></p>
35
<p><code>#include <<a class="el" href="SteinScottImproveScore_8h_source.html">OpenMS/COMPARISON/SPECTRA/SteinScottImproveScore.h</a>></code></p>
36
<div class="dynheader">
37
Inheritance diagram for SteinScottImproveScore:</div>
38
<div class="dyncontent">
40
<img src="classOpenMS_1_1SteinScottImproveScore.png" usemap="#SteinScottImproveScore_map" alt=""/>
41
<map id="SteinScottImproveScore_map" name="SteinScottImproveScore_map">
42
<area href="classOpenMS_1_1PeakSpectrumCompareFunctor.html" title="Base class for compare functors of spectra, that return a similiarity value for two spectra..." alt="PeakSpectrumCompareFunctor" shape="rect" coords="0,56,188,80"/>
43
<area href="classOpenMS_1_1DefaultParamHandler.html" title="A base class for all classes handling default parameters. " alt="DefaultParamHandler" shape="rect" coords="0,0,188,24"/>
46
<table class="memberdecls">
47
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
48
Public Member Functions</h2></td></tr>
49
<tr class="memitem:ae3b4098c759fc987d7e2264e27f91f30"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1SteinScottImproveScore.html#ae3b4098c759fc987d7e2264e27f91f30">SteinScottImproveScore</a> ()</td></tr>
50
<tr class="memdesc:ae3b4098c759fc987d7e2264e27f91f30"><td class="mdescLeft"> </td><td class="mdescRight">default constructor <a href="#ae3b4098c759fc987d7e2264e27f91f30">More...</a><br/></td></tr>
51
<tr class="separator:ae3b4098c759fc987d7e2264e27f91f30"><td class="memSeparator" colspan="2"> </td></tr>
52
<tr class="memitem:a7bd85bc52b5c32f2243280310dc77ee2"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1SteinScottImproveScore.html#a7bd85bc52b5c32f2243280310dc77ee2">SteinScottImproveScore</a> (const <a class="el" href="classOpenMS_1_1SteinScottImproveScore.html">SteinScottImproveScore</a> &source)</td></tr>
53
<tr class="memdesc:a7bd85bc52b5c32f2243280310dc77ee2"><td class="mdescLeft"> </td><td class="mdescRight">copy constructor <a href="#a7bd85bc52b5c32f2243280310dc77ee2">More...</a><br/></td></tr>
54
<tr class="separator:a7bd85bc52b5c32f2243280310dc77ee2"><td class="memSeparator" colspan="2"> </td></tr>
55
<tr class="memitem:a53fdb1e0d4d169210f82bf1e089c1ff6"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1SteinScottImproveScore.html#a53fdb1e0d4d169210f82bf1e089c1ff6">~SteinScottImproveScore</a> ()</td></tr>
56
<tr class="memdesc:a53fdb1e0d4d169210f82bf1e089c1ff6"><td class="mdescLeft"> </td><td class="mdescRight">destructor <a href="#a53fdb1e0d4d169210f82bf1e089c1ff6">More...</a><br/></td></tr>
57
<tr class="separator:a53fdb1e0d4d169210f82bf1e089c1ff6"><td class="memSeparator" colspan="2"> </td></tr>
58
<tr class="memitem:a7b6769dea664cfc1e6050480752f83bb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1SteinScottImproveScore.html">SteinScottImproveScore</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1SteinScottImproveScore.html#a7b6769dea664cfc1e6050480752f83bb">operator=</a> (const <a class="el" href="classOpenMS_1_1SteinScottImproveScore.html">SteinScottImproveScore</a> &source)</td></tr>
59
<tr class="memdesc:a7b6769dea664cfc1e6050480752f83bb"><td class="mdescLeft"> </td><td class="mdescRight">assignment operator <a href="#a7b6769dea664cfc1e6050480752f83bb">More...</a><br/></td></tr>
60
<tr class="separator:a7b6769dea664cfc1e6050480752f83bb"><td class="memSeparator" colspan="2"> </td></tr>
61
<tr class="memitem:aa4cca8a4ef8ae9a12a0dd752abb7bbbc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdouble.html">double</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1SteinScottImproveScore.html#aa4cca8a4ef8ae9a12a0dd752abb7bbbc">operator()</a> (const <a class="el" href="group__Kernel.html#ga3ba16951dc40c7a6c7457f3452e096ab">PeakSpectrum</a> &spec1, const <a class="el" href="group__Kernel.html#ga3ba16951dc40c7a6c7457f3452e096ab">PeakSpectrum</a> &spec2) const </td></tr>
62
<tr class="memdesc:aa4cca8a4ef8ae9a12a0dd752abb7bbbc"><td class="mdescLeft"> </td><td class="mdescRight">Similarity pairwise score. <a href="#aa4cca8a4ef8ae9a12a0dd752abb7bbbc">More...</a><br/></td></tr>
63
<tr class="separator:aa4cca8a4ef8ae9a12a0dd752abb7bbbc"><td class="memSeparator" colspan="2"> </td></tr>
64
<tr class="memitem:ae40bd10bbd057a8032c2ee259fab5cd8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdouble.html">double</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1SteinScottImproveScore.html#ae40bd10bbd057a8032c2ee259fab5cd8">operator()</a> (const <a class="el" href="group__Kernel.html#ga3ba16951dc40c7a6c7457f3452e096ab">PeakSpectrum</a> &spec) const </td></tr>
65
<tr class="memdesc:ae40bd10bbd057a8032c2ee259fab5cd8"><td class="mdescLeft"> </td><td class="mdescRight">Similarity pairwise score itself. <a href="#ae40bd10bbd057a8032c2ee259fab5cd8">More...</a><br/></td></tr>
66
<tr class="separator:ae40bd10bbd057a8032c2ee259fab5cd8"><td class="memSeparator" colspan="2"> </td></tr>
67
<tr class="inherit_header pub_methods_classOpenMS_1_1PeakSpectrumCompareFunctor"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classOpenMS_1_1PeakSpectrumCompareFunctor')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classOpenMS_1_1PeakSpectrumCompareFunctor.html">PeakSpectrumCompareFunctor</a></td></tr>
68
<tr class="memitem:aa94067fde55bc9222f8743b27e32b3f1 inherit pub_methods_classOpenMS_1_1PeakSpectrumCompareFunctor"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1PeakSpectrumCompareFunctor.html#aa94067fde55bc9222f8743b27e32b3f1">PeakSpectrumCompareFunctor</a> ()</td></tr>
69
<tr class="memdesc:aa94067fde55bc9222f8743b27e32b3f1 inherit pub_methods_classOpenMS_1_1PeakSpectrumCompareFunctor"><td class="mdescLeft"> </td><td class="mdescRight">default constructor <a href="#aa94067fde55bc9222f8743b27e32b3f1">More...</a><br/></td></tr>
70
<tr class="separator:aa94067fde55bc9222f8743b27e32b3f1 inherit pub_methods_classOpenMS_1_1PeakSpectrumCompareFunctor"><td class="memSeparator" colspan="2"> </td></tr>
71
<tr class="memitem:a3d6a3451fd30c5edc780cee37cef38c9 inherit pub_methods_classOpenMS_1_1PeakSpectrumCompareFunctor"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1PeakSpectrumCompareFunctor.html#a3d6a3451fd30c5edc780cee37cef38c9">PeakSpectrumCompareFunctor</a> (const <a class="el" href="classOpenMS_1_1PeakSpectrumCompareFunctor.html">PeakSpectrumCompareFunctor</a> &source)</td></tr>
72
<tr class="memdesc:a3d6a3451fd30c5edc780cee37cef38c9 inherit pub_methods_classOpenMS_1_1PeakSpectrumCompareFunctor"><td class="mdescLeft"> </td><td class="mdescRight">copy constructor <a href="#a3d6a3451fd30c5edc780cee37cef38c9">More...</a><br/></td></tr>
73
<tr class="separator:a3d6a3451fd30c5edc780cee37cef38c9 inherit pub_methods_classOpenMS_1_1PeakSpectrumCompareFunctor"><td class="memSeparator" colspan="2"> </td></tr>
74
<tr class="memitem:a695d3eee5bc48c6168e9df8c81e8e1f3 inherit pub_methods_classOpenMS_1_1PeakSpectrumCompareFunctor"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1PeakSpectrumCompareFunctor.html#a695d3eee5bc48c6168e9df8c81e8e1f3">~PeakSpectrumCompareFunctor</a> ()</td></tr>
75
<tr class="memdesc:a695d3eee5bc48c6168e9df8c81e8e1f3 inherit pub_methods_classOpenMS_1_1PeakSpectrumCompareFunctor"><td class="mdescLeft"> </td><td class="mdescRight">destructor <a href="#a695d3eee5bc48c6168e9df8c81e8e1f3">More...</a><br/></td></tr>
76
<tr class="separator:a695d3eee5bc48c6168e9df8c81e8e1f3 inherit pub_methods_classOpenMS_1_1PeakSpectrumCompareFunctor"><td class="memSeparator" colspan="2"> </td></tr>
77
<tr class="memitem:a0e88bb1b164535dcfbc1eb5d872af850 inherit pub_methods_classOpenMS_1_1PeakSpectrumCompareFunctor"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1PeakSpectrumCompareFunctor.html">PeakSpectrumCompareFunctor</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1PeakSpectrumCompareFunctor.html#a0e88bb1b164535dcfbc1eb5d872af850">operator=</a> (const <a class="el" href="classOpenMS_1_1PeakSpectrumCompareFunctor.html">PeakSpectrumCompareFunctor</a> &source)</td></tr>
78
<tr class="memdesc:a0e88bb1b164535dcfbc1eb5d872af850 inherit pub_methods_classOpenMS_1_1PeakSpectrumCompareFunctor"><td class="mdescLeft"> </td><td class="mdescRight">assignment operator <a href="#a0e88bb1b164535dcfbc1eb5d872af850">More...</a><br/></td></tr>
79
<tr class="separator:a0e88bb1b164535dcfbc1eb5d872af850 inherit pub_methods_classOpenMS_1_1PeakSpectrumCompareFunctor"><td class="memSeparator" colspan="2"> </td></tr>
80
<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="-"/> Public Member Functions inherited from <a class="el" href="classOpenMS_1_1DefaultParamHandler.html">DefaultParamHandler</a></td></tr>
81
<tr class="memitem:afb6802fda161cb0c1a4a05597f94aecc inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="memItemLeft" align="right" valign="top"> </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> &name)</td></tr>
82
<tr class="memdesc:afb6802fda161cb0c1a4a05597f94aecc inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="mdescLeft"> </td><td class="mdescRight">Constructor with name that is displayed in error messages. <a href="#afb6802fda161cb0c1a4a05597f94aecc">More...</a><br/></td></tr>
83
<tr class="separator:afb6802fda161cb0c1a4a05597f94aecc inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="memSeparator" colspan="2"> </td></tr>
84
<tr class="memitem:a954da7eef3cfddda446574eaadd20abb inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="memItemLeft" align="right" valign="top"> </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> &rhs)</td></tr>
85
<tr class="memdesc:a954da7eef3cfddda446574eaadd20abb inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#a954da7eef3cfddda446574eaadd20abb">More...</a><br/></td></tr>
86
<tr class="separator:a954da7eef3cfddda446574eaadd20abb inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="memSeparator" colspan="2"> </td></tr>
87
<tr class="memitem:a11e9d6dd34fe8860874aa8abe0ec121b inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DefaultParamHandler.html#a11e9d6dd34fe8860874aa8abe0ec121b">~DefaultParamHandler</a> ()</td></tr>
88
<tr class="memdesc:a11e9d6dd34fe8860874aa8abe0ec121b inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a11e9d6dd34fe8860874aa8abe0ec121b">More...</a><br/></td></tr>
89
<tr class="separator:a11e9d6dd34fe8860874aa8abe0ec121b inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="memSeparator" colspan="2"> </td></tr>
90
<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> & </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> &rhs)</td></tr>
91
<tr class="memdesc:ae6b6d68036a573a44f6609460ba2dfb6 inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <a href="#ae6b6d68036a573a44f6609460ba2dfb6">More...</a><br/></td></tr>
92
<tr class="separator:ae6b6d68036a573a44f6609460ba2dfb6 inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="memSeparator" colspan="2"> </td></tr>
93
<tr class="memitem:ac435f2dd4d9f9328db83af97129a8d7e inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="memItemLeft" align="right" valign="top">virtual bool </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> &rhs) const </td></tr>
94
<tr class="memdesc:ac435f2dd4d9f9328db83af97129a8d7e inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="mdescLeft"> </td><td class="mdescRight">Equality operator. <a href="#ac435f2dd4d9f9328db83af97129a8d7e">More...</a><br/></td></tr>
95
<tr class="separator:ac435f2dd4d9f9328db83af97129a8d7e inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="memSeparator" colspan="2"> </td></tr>
96
<tr class="memitem:abc8067511cfc949ae942ea2b08588f81 inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="memItemLeft" align="right" valign="top">void </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> &param)</td></tr>
97
<tr class="memdesc:abc8067511cfc949ae942ea2b08588f81 inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="mdescLeft"> </td><td class="mdescRight">Sets the parameters. <a href="#abc8067511cfc949ae942ea2b08588f81">More...</a><br/></td></tr>
98
<tr class="separator:abc8067511cfc949ae942ea2b08588f81 inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="memSeparator" colspan="2"> </td></tr>
99
<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> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DefaultParamHandler.html#a7f6aab5a7dfbdd1c062a4352a29361f3">getParameters</a> () const </td></tr>
100
<tr class="memdesc:a7f6aab5a7dfbdd1c062a4352a29361f3 inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="mdescLeft"> </td><td class="mdescRight">Non-mutable access to the parameters. <a href="#a7f6aab5a7dfbdd1c062a4352a29361f3">More...</a><br/></td></tr>
101
<tr class="separator:a7f6aab5a7dfbdd1c062a4352a29361f3 inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="memSeparator" colspan="2"> </td></tr>
102
<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> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DefaultParamHandler.html#a02f02fa9832ca3e8d47c575a39803a2a">getDefaults</a> () const </td></tr>
103
<tr class="memdesc:a02f02fa9832ca3e8d47c575a39803a2a inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="mdescLeft"> </td><td class="mdescRight">Non-mutable access to the default parameters. <a href="#a02f02fa9832ca3e8d47c575a39803a2a">More...</a><br/></td></tr>
104
<tr class="separator:a02f02fa9832ca3e8d47c575a39803a2a inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="memSeparator" colspan="2"> </td></tr>
105
<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> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DefaultParamHandler.html#aaee0f2845288173de9f6ad47e6ad31d5">getName</a> () const </td></tr>
106
<tr class="memdesc:aaee0f2845288173de9f6ad47e6ad31d5 inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="mdescLeft"> </td><td class="mdescRight">Non-mutable access to the name. <a href="#aaee0f2845288173de9f6ad47e6ad31d5">More...</a><br/></td></tr>
107
<tr class="separator:aaee0f2845288173de9f6ad47e6ad31d5 inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="memSeparator" colspan="2"> </td></tr>
108
<tr class="memitem:a77d37f2e1c12e8bd33ea0e660a89e927 inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="memItemLeft" align="right" valign="top">void </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> &name)</td></tr>
109
<tr class="memdesc:a77d37f2e1c12e8bd33ea0e660a89e927 inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="mdescLeft"> </td><td class="mdescRight">Mutable access to the name. <a href="#a77d37f2e1c12e8bd33ea0e660a89e927">More...</a><br/></td></tr>
110
<tr class="separator:a77d37f2e1c12e8bd33ea0e660a89e927 inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="memSeparator" colspan="2"> </td></tr>
111
<tr class="memitem:a768d4a2093627a2f34728656a9721bdf inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="memItemLeft" align="right" valign="top">const std::vector< <a class="el" href="classOpenMS_1_1String.html">String</a> > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DefaultParamHandler.html#a768d4a2093627a2f34728656a9721bdf">getSubsections</a> () const </td></tr>
112
<tr class="memdesc:a768d4a2093627a2f34728656a9721bdf inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="mdescLeft"> </td><td class="mdescRight">Non-mutable access to the registered subsections. <a href="#a768d4a2093627a2f34728656a9721bdf">More...</a><br/></td></tr>
113
<tr class="separator:a768d4a2093627a2f34728656a9721bdf inherit pub_methods_classOpenMS_1_1DefaultParamHandler"><td class="memSeparator" colspan="2"> </td></tr>
114
</table><table class="memberdecls">
115
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
116
Static Public Member Functions</h2></td></tr>
117
<tr class="memitem:aea33b1d3b12fac714a9b5a9489d9ce10"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classOpenMS_1_1PeakSpectrumCompareFunctor.html">PeakSpectrumCompareFunctor</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1SteinScottImproveScore.html#aea33b1d3b12fac714a9b5a9489d9ce10">create</a> ()</td></tr>
118
<tr class="separator:aea33b1d3b12fac714a9b5a9489d9ce10"><td class="memSeparator" colspan="2"> </td></tr>
119
<tr class="memitem:af73fd15708e50e77665070023a09cc87"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classOpenMS_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1SteinScottImproveScore.html#af73fd15708e50e77665070023a09cc87">getProductName</a> ()</td></tr>
120
<tr class="separator:af73fd15708e50e77665070023a09cc87"><td class="memSeparator" colspan="2"> </td></tr>
121
<tr class="inherit_header pub_static_methods_classOpenMS_1_1PeakSpectrumCompareFunctor"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classOpenMS_1_1PeakSpectrumCompareFunctor')"><img src="closed.png" alt="-"/> Static Public Member Functions inherited from <a class="el" href="classOpenMS_1_1PeakSpectrumCompareFunctor.html">PeakSpectrumCompareFunctor</a></td></tr>
122
<tr class="memitem:a7899dbe105534dc1f81971dd71a26ff0 inherit pub_static_methods_classOpenMS_1_1PeakSpectrumCompareFunctor"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1PeakSpectrumCompareFunctor.html#a7899dbe105534dc1f81971dd71a26ff0">registerChildren</a> ()</td></tr>
123
<tr class="memdesc:a7899dbe105534dc1f81971dd71a26ff0 inherit pub_static_methods_classOpenMS_1_1PeakSpectrumCompareFunctor"><td class="mdescLeft"> </td><td class="mdescRight">registers all derived products <a href="#a7899dbe105534dc1f81971dd71a26ff0">More...</a><br/></td></tr>
124
<tr class="separator:a7899dbe105534dc1f81971dd71a26ff0 inherit pub_static_methods_classOpenMS_1_1PeakSpectrumCompareFunctor"><td class="memSeparator" colspan="2"> </td></tr>
125
<tr class="memitem:af73fd15708e50e77665070023a09cc87 inherit pub_static_methods_classOpenMS_1_1PeakSpectrumCompareFunctor"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classOpenMS_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1PeakSpectrumCompareFunctor.html#af73fd15708e50e77665070023a09cc87">getProductName</a> ()</td></tr>
126
<tr class="separator:af73fd15708e50e77665070023a09cc87 inherit pub_static_methods_classOpenMS_1_1PeakSpectrumCompareFunctor"><td class="memSeparator" colspan="2"> </td></tr>
127
</table><table class="memberdecls">
128
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
129
Additional Inherited Members</h2></td></tr>
130
<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="-"/> Protected Member Functions inherited from <a class="el" href="classOpenMS_1_1DefaultParamHandler.html">DefaultParamHandler</a></td></tr>
131
<tr class="memitem:a776f7572fc4f466e9527ca233471920d inherit pro_methods_classOpenMS_1_1DefaultParamHandler"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DefaultParamHandler.html#a776f7572fc4f466e9527ca233471920d">updateMembers_</a> ()</td></tr>
132
<tr class="memdesc:a776f7572fc4f466e9527ca233471920d inherit pro_methods_classOpenMS_1_1DefaultParamHandler"><td class="mdescLeft"> </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>
133
<tr class="separator:a776f7572fc4f466e9527ca233471920d inherit pro_methods_classOpenMS_1_1DefaultParamHandler"><td class="memSeparator" colspan="2"> </td></tr>
134
<tr class="memitem:a2802c591e6d7fd3fd9cc35f5e875d0ba inherit pro_methods_classOpenMS_1_1DefaultParamHandler"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DefaultParamHandler.html#a2802c591e6d7fd3fd9cc35f5e875d0ba">defaultsToParam_</a> ()</td></tr>
135
<tr class="memdesc:a2802c591e6d7fd3fd9cc35f5e875d0ba inherit pro_methods_classOpenMS_1_1DefaultParamHandler"><td class="mdescLeft"> </td><td class="mdescRight">Updates the parameters after the defaults have been set in the constructor. <a href="#a2802c591e6d7fd3fd9cc35f5e875d0ba">More...</a><br/></td></tr>
136
<tr class="separator:a2802c591e6d7fd3fd9cc35f5e875d0ba inherit pro_methods_classOpenMS_1_1DefaultParamHandler"><td class="memSeparator" colspan="2"> </td></tr>
137
<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="-"/> Protected Attributes inherited from <a class="el" href="classOpenMS_1_1DefaultParamHandler.html">DefaultParamHandler</a></td></tr>
138
<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> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DefaultParamHandler.html#a28c73e623c63a4fe3bfceb1ae8274f39">param_</a></td></tr>
139
<tr class="memdesc:a28c73e623c63a4fe3bfceb1ae8274f39 inherit pro_attribs_classOpenMS_1_1DefaultParamHandler"><td class="mdescLeft"> </td><td class="mdescRight">Container for current parameters. <a href="#a28c73e623c63a4fe3bfceb1ae8274f39">More...</a><br/></td></tr>
140
<tr class="separator:a28c73e623c63a4fe3bfceb1ae8274f39 inherit pro_attribs_classOpenMS_1_1DefaultParamHandler"><td class="memSeparator" colspan="2"> </td></tr>
141
<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> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DefaultParamHandler.html#a761b1937850c141d0c6fff0e4d633a04">defaults_</a></td></tr>
142
<tr class="memdesc:a761b1937850c141d0c6fff0e4d633a04 inherit pro_attribs_classOpenMS_1_1DefaultParamHandler"><td class="mdescLeft"> </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>
143
<tr class="separator:a761b1937850c141d0c6fff0e4d633a04 inherit pro_attribs_classOpenMS_1_1DefaultParamHandler"><td class="memSeparator" colspan="2"> </td></tr>
144
<tr class="memitem:ac4b0e20bc59c7a5afe016c69067e428c inherit pro_attribs_classOpenMS_1_1DefaultParamHandler"><td class="memItemLeft" align="right" valign="top">std::vector< <a class="el" href="classOpenMS_1_1String.html">String</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DefaultParamHandler.html#ac4b0e20bc59c7a5afe016c69067e428c">subsections_</a></td></tr>
145
<tr class="memdesc:ac4b0e20bc59c7a5afe016c69067e428c inherit pro_attribs_classOpenMS_1_1DefaultParamHandler"><td class="mdescLeft"> </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>
146
<tr class="separator:ac4b0e20bc59c7a5afe016c69067e428c inherit pro_attribs_classOpenMS_1_1DefaultParamHandler"><td class="memSeparator" colspan="2"> </td></tr>
147
<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> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DefaultParamHandler.html#a5a51f3f150b09068256195e934339a19">error_name_</a></td></tr>
148
<tr class="memdesc:a5a51f3f150b09068256195e934339a19 inherit pro_attribs_classOpenMS_1_1DefaultParamHandler"><td class="mdescLeft"> </td><td class="mdescRight">Name that is displayed in error messages during the parameter checking. <a href="#a5a51f3f150b09068256195e934339a19">More...</a><br/></td></tr>
149
<tr class="separator:a5a51f3f150b09068256195e934339a19 inherit pro_attribs_classOpenMS_1_1DefaultParamHandler"><td class="memSeparator" colspan="2"> </td></tr>
150
<tr class="memitem:a7c3b265b697a57615da5cd3274780efd inherit pro_attribs_classOpenMS_1_1DefaultParamHandler"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DefaultParamHandler.html#a7c3b265b697a57615da5cd3274780efd">check_defaults_</a></td></tr>
151
<tr class="memdesc:a7c3b265b697a57615da5cd3274780efd inherit pro_attribs_classOpenMS_1_1DefaultParamHandler"><td class="mdescLeft"> </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>
152
<tr class="separator:a7c3b265b697a57615da5cd3274780efd inherit pro_attribs_classOpenMS_1_1DefaultParamHandler"><td class="memSeparator" colspan="2"> </td></tr>
153
<tr class="memitem:aba444910e4fccb93f91bf7ab135f508a inherit pro_attribs_classOpenMS_1_1DefaultParamHandler"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DefaultParamHandler.html#aba444910e4fccb93f91bf7ab135f508a">warn_empty_defaults_</a></td></tr>
154
<tr class="memdesc:aba444910e4fccb93f91bf7ab135f508a inherit pro_attribs_classOpenMS_1_1DefaultParamHandler"><td class="mdescLeft"> </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>
155
<tr class="separator:aba444910e4fccb93f91bf7ab135f508a inherit pro_attribs_classOpenMS_1_1DefaultParamHandler"><td class="memSeparator" colspan="2"> </td></tr>
157
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
158
<div class="textblock"><p>Similarity score based of Stein & Scott. </p>
159
<p>This is a pairwise based score function. The spectrum contains peaks, and each peak can be defined by two values (mz and the intensity). The score function takes the sum of the product of the peak intensities from Spectrum 1 and Spectrum 2, only if the mz-ratio distance between the two spectrums is smaller than a given window size. In the default status, the window size is (accuracy of the mass spectrometer). This sum is normalised by dividing it with a distance function. sqrt(sum of the Intensity of square Spectrum1 sum of the Intensity of square Spectrum2). This is all based on SteinScott score. To distinguish the close from the distant spectra an additional term is calculated. It denotes the expected value of both Spectrums under the random placement of all peaks, within the given mass-to-charge range. The probability that two peaks with randomized intensity values lie within two epsilon of each other is a constant. This constant is proportional to epsilon. So the additional term is the sum over all peaks of Spectrum 1 and Spectrum 2 of the products of their intensities multiplied with the constant.</p>
160
<p>The details of the score can be found in: Signal Maps for Mass Spectrometry-based Comparative Proteomics Amol Prakash, Parag Mallick , Jeffrey Whiteaker, Heidi Zhang, Amanda Paulovich, Mark Flory, Hookeun Lee, Ruedi Aebersold, and Benno Schwikowski</p>
161
<B>Parameters of this class are:</B><BR><BR>
162
<table border="1" style="border-style:solid; border-collapse:collapse; border-color:#c0c0c0;" width="100%" cellpadding="4">
163
<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>
165
<td style="vertical-align:top"><b>tolerance</b></td>
166
<td style="vertical-align:top">float</td><td style="vertical-align:top">0.2</td>
167
<td style="vertical-align:top"> </td><td style="vertical-align:top">defines the absolute error of the mass spectrometer</td>
170
<td style="vertical-align:top"><b>threshold</b></td>
171
<td style="vertical-align:top">float</td><td style="vertical-align:top">0.2</td>
172
<td style="vertical-align:top"> </td><td style="vertical-align:top">if the calculated score is smaller than the threshold, a zero is given back</td>
177
<UL style="margin-top:0px;">
178
<LI> If a section name is documented, the documentation is displayed as tooltip.
179
<LI> Advanced parameter names are italic.
181
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
182
<a class="anchor" id="ae3b4098c759fc987d7e2264e27f91f30"></a>
183
<div class="memitem">
184
<div class="memproto">
185
<table class="memname">
187
<td class="memname"><a class="el" href="classOpenMS_1_1SteinScottImproveScore.html">SteinScottImproveScore</a> </td>
189
<td class="paramname"></td><td>)</td>
193
</div><div class="memdoc">
195
<p>default constructor </p>
199
<a class="anchor" id="a7bd85bc52b5c32f2243280310dc77ee2"></a>
200
<div class="memitem">
201
<div class="memproto">
202
<table class="memname">
204
<td class="memname"><a class="el" href="classOpenMS_1_1SteinScottImproveScore.html">SteinScottImproveScore</a> </td>
206
<td class="paramtype">const <a class="el" href="classOpenMS_1_1SteinScottImproveScore.html">SteinScottImproveScore</a> & </td>
207
<td class="paramname"><em>source</em></td><td>)</td>
211
</div><div class="memdoc">
213
<p>copy constructor </p>
217
<a class="anchor" id="a53fdb1e0d4d169210f82bf1e089c1ff6"></a>
218
<div class="memitem">
219
<div class="memproto">
220
<table class="mlabels">
222
<td class="mlabels-left">
223
<table class="memname">
225
<td class="memname">virtual ~<a class="el" href="classOpenMS_1_1SteinScottImproveScore.html">SteinScottImproveScore</a> </td>
227
<td class="paramname"></td><td>)</td>
232
<td class="mlabels-right">
233
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
236
</div><div class="memdoc">
242
<h2 class="groupheader">Member Function Documentation</h2>
243
<a class="anchor" id="aea33b1d3b12fac714a9b5a9489d9ce10"></a>
244
<div class="memitem">
245
<div class="memproto">
246
<table class="mlabels">
248
<td class="mlabels-left">
249
<table class="memname">
251
<td class="memname">static <a class="el" href="classOpenMS_1_1PeakSpectrumCompareFunctor.html">PeakSpectrumCompareFunctor</a>* create </td>
253
<td class="paramname"></td><td>)</td>
258
<td class="mlabels-right">
259
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
262
</div><div class="memdoc">
266
<a class="anchor" id="af73fd15708e50e77665070023a09cc87"></a>
267
<div class="memitem">
268
<div class="memproto">
269
<table class="mlabels">
271
<td class="mlabels-left">
272
<table class="memname">
274
<td class="memname">static const <a class="el" href="classOpenMS_1_1String.html">String</a> getProductName </td>
276
<td class="paramname"></td><td>)</td>
281
<td class="mlabels-right">
282
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
285
</div><div class="memdoc">
289
<a class="anchor" id="aa4cca8a4ef8ae9a12a0dd752abb7bbbc"></a>
290
<div class="memitem">
291
<div class="memproto">
292
<table class="mlabels">
294
<td class="mlabels-left">
295
<table class="memname">
297
<td class="memname"><a class="el" href="classdouble.html">double</a> operator() </td>
299
<td class="paramtype">const <a class="el" href="group__Kernel.html#ga3ba16951dc40c7a6c7457f3452e096ab">PeakSpectrum</a> & </td>
300
<td class="paramname"><em>spec1</em>, </td>
303
<td class="paramkey"></td>
305
<td class="paramtype">const <a class="el" href="group__Kernel.html#ga3ba16951dc40c7a6c7457f3452e096ab">PeakSpectrum</a> & </td>
306
<td class="paramname"><em>spec2</em> </td>
311
<td></td><td> const</td>
315
<td class="mlabels-right">
316
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
319
</div><div class="memdoc">
321
<p>Similarity pairwise score. </p>
322
<p>This function return the similarity score of two Spectrums based on SteinScott. </p>
324
<p>Implements <a class="el" href="classOpenMS_1_1PeakSpectrumCompareFunctor.html#a1bdb502bb510e9a61ad5762ff98d5edc">PeakSpectrumCompareFunctor</a>.</p>
328
<a class="anchor" id="ae40bd10bbd057a8032c2ee259fab5cd8"></a>
329
<div class="memitem">
330
<div class="memproto">
331
<table class="mlabels">
333
<td class="mlabels-left">
334
<table class="memname">
336
<td class="memname"><a class="el" href="classdouble.html">double</a> operator() </td>
338
<td class="paramtype">const <a class="el" href="group__Kernel.html#ga3ba16951dc40c7a6c7457f3452e096ab">PeakSpectrum</a> & </td>
339
<td class="paramname"><em>spec</em></td><td>)</td>
344
<td class="mlabels-right">
345
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
348
</div><div class="memdoc">
350
<p>Similarity pairwise score itself. </p>
351
<p>This function return the similarity score of itself based on SteinScott. </p>
353
<p>Implements <a class="el" href="classOpenMS_1_1PeakSpectrumCompareFunctor.html#a59481527ad716059d361e32eb1ed5cb3">PeakSpectrumCompareFunctor</a>.</p>
357
<a class="anchor" id="a7b6769dea664cfc1e6050480752f83bb"></a>
358
<div class="memitem">
359
<div class="memproto">
360
<table class="memname">
362
<td class="memname"><a class="el" href="classOpenMS_1_1SteinScottImproveScore.html">SteinScottImproveScore</a>& operator= </td>
364
<td class="paramtype">const <a class="el" href="classOpenMS_1_1SteinScottImproveScore.html">SteinScottImproveScore</a> & </td>
365
<td class="paramname"><em>source</em></td><td>)</td>
369
</div><div class="memdoc">
371
<p>assignment operator </p>
375
</div><!-- contents -->
376
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
377
<TABLE width="100%" border="0">
379
<TD><font color="#c0c0c0">OpenMS / TOPP release 1.11.1</font></TD>
380
<TD align="right"><font color="#c0c0c0">Documentation generated on Thu Nov 14 2013 11:19:28 using doxygen 1.8.5</font></TD>
added
removed
doc/html/classOpenMS_1_1SteinScottImproveScore.html
