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

« back to all changes in this revision

Viewing changes to doc/html/structOpenMS_1_1PeakShape.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>PeakShape Struct Reference</TITLE>
 
4
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
 
5
<LINK HREF="style_ini.css" REL="stylesheet" TYPE="text/css">
 
6
</HEAD>
 
7
<BODY BGCOLOR="#FFFFFF">
 
8
<A href="index.html">Home</A> &nbsp;&middot;
 
9
<A href="classes.html">Classes</A> &nbsp;&middot;
 
10
<A href="annotated.html">Annotated Classes</A> &nbsp;&middot;
 
11
<A href="modules.html">Modules</A> &nbsp;&middot;
 
12
<A href="functions_func.html">Members</A> &nbsp;&middot;
 
13
<A href="namespaces.html">Namespaces</A> &nbsp;&middot;
 
14
<A href="pages.html">Related Pages</A>
 
15
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
 
16
<!-- Generated by Doxygen 1.8.5 -->
 
17
<div id="nav-path" class="navpath">
 
18
  <ul>
 
19
<li class="navelem"><a class="el" href="namespaceOpenMS.html">OpenMS</a></li><li class="navelem"><a class="el" href="structOpenMS_1_1PeakShape.html">PeakShape</a></li>  </ul>
 
20
</div>
 
21
</div><!-- top -->
 
22
<div class="header">
 
23
  <div class="summary">
 
24
<a href="#nested-classes">Classes</a> &#124;
 
25
<a href="#pub-types">Public Types</a> &#124;
 
26
<a href="#pub-methods">Public Member Functions</a> &#124;
 
27
<a href="#pub-attribs">Public Attributes</a> &#124;
 
28
<a href="#pro-attribs">Protected Attributes</a> &#124;
 
29
<a href="structOpenMS_1_1PeakShape-members.html">List of all members</a>  </div>
 
30
  <div class="headertitle">
 
31
<div class="title">PeakShape Struct Reference</div>  </div>
 
32
</div><!--header-->
 
33
<div class="contents">
 
34
 
 
35
<p><a class="el" href="namespaceOpenMS_1_1Internal.html" title="Namespace used to hide implementation details from users. ">Internal</a> representation of a peak shape (used by the <a class="el" href="classOpenMS_1_1PeakPickerCWT.html" title="This class implements a peak picking algorithm using wavelet techniques. ">PeakPickerCWT</a>)  
 
36
 <a href="structOpenMS_1_1PeakShape.html#details">More...</a></p>
 
37
 
 
38
<p><code>#include &lt;<a class="el" href="PeakShape_8h_source.html">OpenMS/TRANSFORMATIONS/RAW2PEAK/PeakShape.h</a>&gt;</code></p>
 
39
<table class="memberdecls">
 
40
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
 
41
Classes</h2></td></tr>
 
42
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1PeakShape_1_1PositionLess.html">PositionLess</a></td></tr>
 
43
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Comparison of mz_positions.  <a href="classOpenMS_1_1PeakShape_1_1PositionLess.html#details">More...</a><br/></td></tr>
 
44
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
45
</table><table class="memberdecls">
 
46
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
 
47
Public Types</h2></td></tr>
 
48
<tr class="memitem:a1d1cfd8ffb84e947f82999c682b666a7"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1PeakShape.html#a1d1cfd8ffb84e947f82999c682b666a7">Type</a> { <a class="el" href="structOpenMS_1_1PeakShape.html#a1d1cfd8ffb84e947f82999c682b666a7a6ba0b50b9f0f84a5ad13827c57240f76">LORENTZ_PEAK</a>, 
 
49
<a class="el" href="structOpenMS_1_1PeakShape.html#a1d1cfd8ffb84e947f82999c682b666a7a13a1459b1209f4aac3d4bf4a6c184f14">SECH_PEAK</a>, 
 
50
<a class="el" href="structOpenMS_1_1PeakShape.html#a1d1cfd8ffb84e947f82999c682b666a7a605159e8a4c32319fd69b5d151369d93">UNDEFINED</a>
 
51
 }</td></tr>
 
52
<tr class="memdesc:a1d1cfd8ffb84e947f82999c682b666a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Peak shape type (asymmetric lorentzian or asymmetric hyperbolic secans squared).  <a href="structOpenMS_1_1PeakShape.html#a1d1cfd8ffb84e947f82999c682b666a7">More...</a><br/></td></tr>
 
53
<tr class="separator:a1d1cfd8ffb84e947f82999c682b666a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
54
<tr class="memitem:a7b57a1b9b462900850eaaab16539b923"><td class="memItemLeft" align="right" valign="top">typedef MSSpectrum::const_iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1PeakShape.html#a7b57a1b9b462900850eaaab16539b923">PeakIterator</a></td></tr>
 
55
<tr class="memdesc:a7b57a1b9b462900850eaaab16539b923"><td class="mdescLeft">&#160;</td><td class="mdescRight">Iterator to the raw data vector.  <a href="#a7b57a1b9b462900850eaaab16539b923">More...</a><br/></td></tr>
 
56
<tr class="separator:a7b57a1b9b462900850eaaab16539b923"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
57
</table><table class="memberdecls">
 
58
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 
59
Public Member Functions</h2></td></tr>
 
60
<tr class="memitem:af3d4e7b137cfecc5b93a7dbeb997db15"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1PeakShape.html#af3d4e7b137cfecc5b93a7dbeb997db15">PeakShape</a> ()</td></tr>
 
61
<tr class="memdesc:af3d4e7b137cfecc5b93a7dbeb997db15"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#af3d4e7b137cfecc5b93a7dbeb997db15">More...</a><br/></td></tr>
 
62
<tr class="separator:af3d4e7b137cfecc5b93a7dbeb997db15"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
63
<tr class="memitem:a7ca57a91c9ac7f0c58e43f66044ec59a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1PeakShape.html#a7ca57a91c9ac7f0c58e43f66044ec59a">PeakShape</a> (<a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a> height_, <a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a> mz_position_, <a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a> left_width_, <a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a> right_width_, <a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a> area_, <a class="el" href="structOpenMS_1_1PeakShape.html#a7b57a1b9b462900850eaaab16539b923">PeakIterator</a> left_, <a class="el" href="structOpenMS_1_1PeakShape.html#a7b57a1b9b462900850eaaab16539b923">PeakIterator</a> right_, <a class="el" href="structOpenMS_1_1PeakShape.html#a1d1cfd8ffb84e947f82999c682b666a7">Type</a> type_)</td></tr>
 
64
<tr class="memdesc:a7ca57a91c9ac7f0c58e43f66044ec59a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor that sets most of the members.  <a href="#a7ca57a91c9ac7f0c58e43f66044ec59a">More...</a><br/></td></tr>
 
65
<tr class="separator:a7ca57a91c9ac7f0c58e43f66044ec59a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
66
<tr class="memitem:a55b238be22070133965d3eec542d2c3b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1PeakShape.html#a55b238be22070133965d3eec542d2c3b">PeakShape</a> (<a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a> height_, <a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a> mz_position_, <a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a> left_width_, <a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a> right_width_, <a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a> area_, <a class="el" href="structOpenMS_1_1PeakShape.html#a1d1cfd8ffb84e947f82999c682b666a7">Type</a> type_)</td></tr>
 
67
<tr class="memdesc:a55b238be22070133965d3eec542d2c3b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor that sets most of the members.  <a href="#a55b238be22070133965d3eec542d2c3b">More...</a><br/></td></tr>
 
68
<tr class="separator:a55b238be22070133965d3eec542d2c3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
69
<tr class="memitem:a753266dba5c366bc6bde3d4cee4b823c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1PeakShape.html#a753266dba5c366bc6bde3d4cee4b823c">PeakShape</a> (const <a class="el" href="structOpenMS_1_1PeakShape.html">PeakShape</a> &amp;rhs)</td></tr>
 
70
<tr class="memdesc:a753266dba5c366bc6bde3d4cee4b823c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy constructor.  <a href="#a753266dba5c366bc6bde3d4cee4b823c">More...</a><br/></td></tr>
 
71
<tr class="separator:a753266dba5c366bc6bde3d4cee4b823c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
72
<tr class="memitem:a83c0fe1aa378a13a95703f1729ce27b2"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1PeakShape.html#a83c0fe1aa378a13a95703f1729ce27b2">~PeakShape</a> ()</td></tr>
 
73
<tr class="memdesc:a83c0fe1aa378a13a95703f1729ce27b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#a83c0fe1aa378a13a95703f1729ce27b2">More...</a><br/></td></tr>
 
74
<tr class="separator:a83c0fe1aa378a13a95703f1729ce27b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
75
<tr class="memitem:a4e48fdc45c9e5f7b49574931e3abc58e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structOpenMS_1_1PeakShape.html">PeakShape</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1PeakShape.html#a4e48fdc45c9e5f7b49574931e3abc58e">operator=</a> (const <a class="el" href="structOpenMS_1_1PeakShape.html">PeakShape</a> &amp;rhs)</td></tr>
 
76
<tr class="memdesc:a4e48fdc45c9e5f7b49574931e3abc58e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assignment operator.  <a href="#a4e48fdc45c9e5f7b49574931e3abc58e">More...</a><br/></td></tr>
 
77
<tr class="separator:a4e48fdc45c9e5f7b49574931e3abc58e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
78
<tr class="memitem:ade24ef25fa8dc501b536c99797c659a8"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1PeakShape.html#ade24ef25fa8dc501b536c99797c659a8">operator==</a> (const <a class="el" href="structOpenMS_1_1PeakShape.html">PeakShape</a> &amp;rhs) const </td></tr>
 
79
<tr class="separator:ade24ef25fa8dc501b536c99797c659a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
80
<tr class="memitem:aa71b98c845308a75da85dc947166f5bc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1PeakShape.html#aa71b98c845308a75da85dc947166f5bc">operator!=</a> (const <a class="el" href="structOpenMS_1_1PeakShape.html">PeakShape</a> &amp;rhs) const </td></tr>
 
81
<tr class="separator:aa71b98c845308a75da85dc947166f5bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
82
<tr class="memitem:a9496f160b7569a32f6746fcea5bf1aac"><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="structOpenMS_1_1PeakShape.html#a9496f160b7569a32f6746fcea5bf1aac">operator()</a> (<a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a> x) const </td></tr>
 
83
<tr class="memdesc:a9496f160b7569a32f6746fcea5bf1aac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compute the intensity of the peaks shape at position x.  <a href="#a9496f160b7569a32f6746fcea5bf1aac">More...</a><br/></td></tr>
 
84
<tr class="separator:a9496f160b7569a32f6746fcea5bf1aac"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
85
<tr class="memitem:ab430ff72ada6384f0363ffe590c39a92"><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="structOpenMS_1_1PeakShape.html#ab430ff72ada6384f0363ffe590c39a92">getSymmetricMeasure</a> () const </td></tr>
 
86
<tr class="memdesc:ab430ff72ada6384f0363ffe590c39a92"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes symmetry measure of the peak shape, which is corresponds to th ratio of the left and right width parameters.  <a href="#ab430ff72ada6384f0363ffe590c39a92">More...</a><br/></td></tr>
 
87
<tr class="separator:ab430ff72ada6384f0363ffe590c39a92"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
88
<tr class="memitem:af78548d2419bdbe09b16dfcb1296c047"><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="structOpenMS_1_1PeakShape.html#af78548d2419bdbe09b16dfcb1296c047">getFWHM</a> () const </td></tr>
 
89
<tr class="memdesc:af78548d2419bdbe09b16dfcb1296c047"><td class="mdescLeft">&#160;</td><td class="mdescRight">Estimates the full width at half maximum.  <a href="#af78548d2419bdbe09b16dfcb1296c047">More...</a><br/></td></tr>
 
90
<tr class="separator:af78548d2419bdbe09b16dfcb1296c047"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
91
<tr class="memitem:abd32e89f174b023eeaa9a4cc00f16ef9"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1PeakShape.html#abd32e89f174b023eeaa9a4cc00f16ef9">iteratorsSet</a> () const </td></tr>
 
92
<tr class="memdesc:abd32e89f174b023eeaa9a4cc00f16ef9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if endpoint iterators.  <a href="#abd32e89f174b023eeaa9a4cc00f16ef9">More...</a><br/></td></tr>
 
93
<tr class="separator:abd32e89f174b023eeaa9a4cc00f16ef9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
94
<tr class="memitem:a37d1f3fbac0050668e0768fffe3a53bb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structOpenMS_1_1PeakShape.html#a7b57a1b9b462900850eaaab16539b923">PeakIterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1PeakShape.html#a37d1f3fbac0050668e0768fffe3a53bb">getLeftEndpoint</a> () const </td></tr>
 
95
<tr class="separator:a37d1f3fbac0050668e0768fffe3a53bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
96
<tr class="memitem:ad3e784fbfcd0e91cfea2a297f3599152"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1PeakShape.html#ad3e784fbfcd0e91cfea2a297f3599152">setLeftEndpoint</a> (<a class="el" href="structOpenMS_1_1PeakShape.html#a7b57a1b9b462900850eaaab16539b923">PeakIterator</a> left_endpoint)</td></tr>
 
97
<tr class="separator:ad3e784fbfcd0e91cfea2a297f3599152"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
98
<tr class="memitem:a10157f541773947a77ff68a5dc397ce0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structOpenMS_1_1PeakShape.html#a7b57a1b9b462900850eaaab16539b923">PeakIterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1PeakShape.html#a10157f541773947a77ff68a5dc397ce0">getRightEndpoint</a> () const </td></tr>
 
99
<tr class="separator:a10157f541773947a77ff68a5dc397ce0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
100
<tr class="memitem:a46153468d71f6c67f31d2b407509d1e8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1PeakShape.html#a46153468d71f6c67f31d2b407509d1e8">setRightEndpoint</a> (<a class="el" href="structOpenMS_1_1PeakShape.html#a7b57a1b9b462900850eaaab16539b923">PeakIterator</a> right_endpoint)</td></tr>
 
101
<tr class="separator:a46153468d71f6c67f31d2b407509d1e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
102
</table><table class="memberdecls">
 
103
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
 
104
Public Attributes</h2></td></tr>
 
105
<tr class="memitem:a5343d7f469d61e6d3f4808a609094175"><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="structOpenMS_1_1PeakShape.html#a5343d7f469d61e6d3f4808a609094175">height</a></td></tr>
 
106
<tr class="memdesc:a5343d7f469d61e6d3f4808a609094175"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum intensity of the peak shape.  <a href="#a5343d7f469d61e6d3f4808a609094175">More...</a><br/></td></tr>
 
107
<tr class="separator:a5343d7f469d61e6d3f4808a609094175"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
108
<tr class="memitem:a0b633e3762805bc447c451f262a8f405"><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="structOpenMS_1_1PeakShape.html#a0b633e3762805bc447c451f262a8f405">mz_position</a></td></tr>
 
109
<tr class="memdesc:a0b633e3762805bc447c451f262a8f405"><td class="mdescLeft">&#160;</td><td class="mdescRight">Centroid position.  <a href="#a0b633e3762805bc447c451f262a8f405">More...</a><br/></td></tr>
 
110
<tr class="separator:a0b633e3762805bc447c451f262a8f405"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
111
<tr class="memitem:a6bd93679898a199380f450a9351fde28"><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="structOpenMS_1_1PeakShape.html#a6bd93679898a199380f450a9351fde28">left_width</a></td></tr>
 
112
<tr class="memdesc:a6bd93679898a199380f450a9351fde28"><td class="mdescLeft">&#160;</td><td class="mdescRight">Left width parameter.  <a href="#a6bd93679898a199380f450a9351fde28">More...</a><br/></td></tr>
 
113
<tr class="separator:a6bd93679898a199380f450a9351fde28"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
114
<tr class="memitem:aee68061fb00b7a84b354bac91e492039"><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="structOpenMS_1_1PeakShape.html#aee68061fb00b7a84b354bac91e492039">right_width</a></td></tr>
 
115
<tr class="memdesc:aee68061fb00b7a84b354bac91e492039"><td class="mdescLeft">&#160;</td><td class="mdescRight">Right width parameter.  <a href="#aee68061fb00b7a84b354bac91e492039">More...</a><br/></td></tr>
 
116
<tr class="separator:aee68061fb00b7a84b354bac91e492039"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
117
<tr class="memitem:ab711e0c5eaae04e02713b6cbd5a6a954"><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="structOpenMS_1_1PeakShape.html#ab711e0c5eaae04e02713b6cbd5a6a954">area</a></td></tr>
 
118
<tr class="memdesc:ab711e0c5eaae04e02713b6cbd5a6a954"><td class="mdescLeft">&#160;</td><td class="mdescRight">Area of the peak shape.  <a href="#ab711e0c5eaae04e02713b6cbd5a6a954">More...</a><br/></td></tr>
 
119
<tr class="separator:ab711e0c5eaae04e02713b6cbd5a6a954"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
120
<tr class="memitem:acec96c76b28be5f89d2966092930e242"><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="structOpenMS_1_1PeakShape.html#acec96c76b28be5f89d2966092930e242">r_value</a></td></tr>
 
121
<tr class="memdesc:acec96c76b28be5f89d2966092930e242"><td class="mdescLeft">&#160;</td><td class="mdescRight">Correlation coefficient.  <a href="#acec96c76b28be5f89d2966092930e242">More...</a><br/></td></tr>
 
122
<tr class="separator:acec96c76b28be5f89d2966092930e242"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
123
<tr class="memitem:acfd893e5679e13dbae94440f76fa3dbd"><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="structOpenMS_1_1PeakShape.html#acfd893e5679e13dbae94440f76fa3dbd">signal_to_noise</a></td></tr>
 
124
<tr class="memdesc:acfd893e5679e13dbae94440f76fa3dbd"><td class="mdescLeft">&#160;</td><td class="mdescRight">The signal to noise ratio at the mz_position.  <a href="#acfd893e5679e13dbae94440f76fa3dbd">More...</a><br/></td></tr>
 
125
<tr class="separator:acfd893e5679e13dbae94440f76fa3dbd"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
126
<tr class="memitem:ab6f4e6d3fde00ce906e46494f60dfe7a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structOpenMS_1_1PeakShape.html#a1d1cfd8ffb84e947f82999c682b666a7">Type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1PeakShape.html#ab6f4e6d3fde00ce906e46494f60dfe7a">type</a></td></tr>
 
127
<tr class="memdesc:ab6f4e6d3fde00ce906e46494f60dfe7a"><td class="mdescLeft">&#160;</td><td class="mdescRight">peak shape type  <a href="#ab6f4e6d3fde00ce906e46494f60dfe7a">More...</a><br/></td></tr>
 
128
<tr class="separator:ab6f4e6d3fde00ce906e46494f60dfe7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
129
</table><table class="memberdecls">
 
130
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
 
131
Protected Attributes</h2></td></tr>
 
132
<tr class="memitem:abcc8b3e1ca93a4a4a5d23aa09f78f8ce"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structOpenMS_1_1PeakShape.html#a7b57a1b9b462900850eaaab16539b923">PeakIterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1PeakShape.html#abcc8b3e1ca93a4a4a5d23aa09f78f8ce">left_endpoint_</a></td></tr>
 
133
<tr class="memdesc:abcc8b3e1ca93a4a4a5d23aa09f78f8ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Left peak endpoint in the data.  <a href="#abcc8b3e1ca93a4a4a5d23aa09f78f8ce">More...</a><br/></td></tr>
 
134
<tr class="separator:abcc8b3e1ca93a4a4a5d23aa09f78f8ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
135
<tr class="memitem:a8c4f642d031eb6b58645c8664a4a6edc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structOpenMS_1_1PeakShape.html#a7b57a1b9b462900850eaaab16539b923">PeakIterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1PeakShape.html#a8c4f642d031eb6b58645c8664a4a6edc">right_endpoint_</a></td></tr>
 
136
<tr class="memdesc:a8c4f642d031eb6b58645c8664a4a6edc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Right peak endpoint in the data.  <a href="#a8c4f642d031eb6b58645c8664a4a6edc">More...</a><br/></td></tr>
 
137
<tr class="separator:a8c4f642d031eb6b58645c8664a4a6edc"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
138
<tr class="memitem:abc2dae237eadd7367b32b97a695eee69"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1MSSpectrum.html">MSSpectrum</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1PeakShape.html#abc2dae237eadd7367b32b97a695eee69">exp_</a></td></tr>
 
139
<tr class="memdesc:abc2dae237eadd7367b32b97a695eee69"><td class="mdescLeft">&#160;</td><td class="mdescRight">Needed for initialisation of endpoint iterators.  <a href="#abc2dae237eadd7367b32b97a695eee69">More...</a><br/></td></tr>
 
140
<tr class="separator:abc2dae237eadd7367b32b97a695eee69"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
141
<tr class="memitem:a2dfb6cdff8be09761c34083959f62e51"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1PeakShape.html#a2dfb6cdff8be09761c34083959f62e51">left_iterator_set_</a></td></tr>
 
142
<tr class="memdesc:a2dfb6cdff8be09761c34083959f62e51"><td class="mdescLeft">&#160;</td><td class="mdescRight">flag if left endpoint iterator differs from default value  <a href="#a2dfb6cdff8be09761c34083959f62e51">More...</a><br/></td></tr>
 
143
<tr class="separator:a2dfb6cdff8be09761c34083959f62e51"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
144
<tr class="memitem:ad854a86aa9b4a56b0d270ac1eee81174"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1PeakShape.html#ad854a86aa9b4a56b0d270ac1eee81174">right_iterator_set_</a></td></tr>
 
145
<tr class="memdesc:ad854a86aa9b4a56b0d270ac1eee81174"><td class="mdescLeft">&#160;</td><td class="mdescRight">flag if left endpoint iterator differs from default value  <a href="#ad854a86aa9b4a56b0d270ac1eee81174">More...</a><br/></td></tr>
 
146
<tr class="separator:ad854a86aa9b4a56b0d270ac1eee81174"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
147
</table>
 
148
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 
149
<div class="textblock"><p><a class="el" href="namespaceOpenMS_1_1Internal.html" title="Namespace used to hide implementation details from users. ">Internal</a> representation of a peak shape (used by the <a class="el" href="classOpenMS_1_1PeakPickerCWT.html" title="This class implements a peak picking algorithm using wavelet techniques. ">PeakPickerCWT</a>) </p>
 
150
<p>It defines an asymmetric lorentzian and asymmetric hyperbolic squared secan function. </p>
 
151
</div><h2 class="groupheader">Member Typedef Documentation</h2>
 
152
<a class="anchor" id="a7b57a1b9b462900850eaaab16539b923"></a>
 
153
<div class="memitem">
 
154
<div class="memproto">
 
155
      <table class="memname">
 
156
        <tr>
 
157
          <td class="memname">typedef <a class="el" href="classOpenMS_1_1MSSpectrum.html">MSSpectrum</a> ::const_iterator <a class="el" href="structOpenMS_1_1PeakShape.html#a7b57a1b9b462900850eaaab16539b923">PeakIterator</a></td>
 
158
        </tr>
 
159
      </table>
 
160
</div><div class="memdoc">
 
161
 
 
162
<p>Iterator to the raw data vector. </p>
 
163
 
 
164
</div>
 
165
</div>
 
166
<h2 class="groupheader">Member Enumeration Documentation</h2>
 
167
<a class="anchor" id="a1d1cfd8ffb84e947f82999c682b666a7"></a>
 
168
<div class="memitem">
 
169
<div class="memproto">
 
170
      <table class="memname">
 
171
        <tr>
 
172
          <td class="memname">enum <a class="el" href="structOpenMS_1_1PeakShape.html#a1d1cfd8ffb84e947f82999c682b666a7">Type</a></td>
 
173
        </tr>
 
174
      </table>
 
175
</div><div class="memdoc">
 
176
 
 
177
<p>Peak shape type (asymmetric lorentzian or asymmetric hyperbolic secans squared). </p>
 
178
<p>The peak shape can represent an asymmetric lorentzian function, given by</p>
 
179
<p>l(x) = height/(1.+pow(left_width*(x - mz_position), 2)) (x&lt;=mz_position)</p>
 
180
<p>l(x) = height/(1.+pow(right_width*(x - mz_position), 2)) (x&gt;mz_position)</p>
 
181
<p>or an asymmetric hyperbolic secans squared function</p>
 
182
<p>s(x) = height/pow(cosh(left_width*(x-mz_position)), 2) (x&lt;=mz_position)</p>
 
183
<p>s(x) = height/pow(cosh(right_width*(x-mz_position)), 2) (x&gt;mz_position) </p>
 
184
<table class="fieldtable">
 
185
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a1d1cfd8ffb84e947f82999c682b666a7a6ba0b50b9f0f84a5ad13827c57240f76"></a>LORENTZ_PEAK</em>&nbsp;</td><td class="fielddoc">
 
186
</td></tr>
 
187
<tr><td class="fieldname"><em><a class="anchor" id="a1d1cfd8ffb84e947f82999c682b666a7a13a1459b1209f4aac3d4bf4a6c184f14"></a>SECH_PEAK</em>&nbsp;</td><td class="fielddoc">
 
188
</td></tr>
 
189
<tr><td class="fieldname"><em><a class="anchor" id="a1d1cfd8ffb84e947f82999c682b666a7a605159e8a4c32319fd69b5d151369d93"></a>UNDEFINED</em>&nbsp;</td><td class="fielddoc">
 
190
</td></tr>
 
191
</table>
 
192
 
 
193
</div>
 
194
</div>
 
195
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 
196
<a class="anchor" id="af3d4e7b137cfecc5b93a7dbeb997db15"></a>
 
197
<div class="memitem">
 
198
<div class="memproto">
 
199
<table class="mlabels">
 
200
  <tr>
 
201
  <td class="mlabels-left">
 
202
      <table class="memname">
 
203
        <tr>
 
204
          <td class="memname"><a class="el" href="structOpenMS_1_1PeakShape.html">PeakShape</a> </td>
 
205
          <td>(</td>
 
206
          <td class="paramname"></td><td>)</td>
 
207
          <td></td>
 
208
        </tr>
 
209
      </table>
 
210
  </td>
 
211
  <td class="mlabels-right">
 
212
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 
213
  </tr>
 
214
</table>
 
215
</div><div class="memdoc">
 
216
 
 
217
<p>Default constructor. </p>
 
218
 
 
219
</div>
 
220
</div>
 
221
<a class="anchor" id="a7ca57a91c9ac7f0c58e43f66044ec59a"></a>
 
222
<div class="memitem">
 
223
<div class="memproto">
 
224
      <table class="memname">
 
225
        <tr>
 
226
          <td class="memname"><a class="el" href="structOpenMS_1_1PeakShape.html">PeakShape</a> </td>
 
227
          <td>(</td>
 
228
          <td class="paramtype"><a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a>&#160;</td>
 
229
          <td class="paramname"><em>height_</em>, </td>
 
230
        </tr>
 
231
        <tr>
 
232
          <td class="paramkey"></td>
 
233
          <td></td>
 
234
          <td class="paramtype"><a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a>&#160;</td>
 
235
          <td class="paramname"><em>mz_position_</em>, </td>
 
236
        </tr>
 
237
        <tr>
 
238
          <td class="paramkey"></td>
 
239
          <td></td>
 
240
          <td class="paramtype"><a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a>&#160;</td>
 
241
          <td class="paramname"><em>left_width_</em>, </td>
 
242
        </tr>
 
243
        <tr>
 
244
          <td class="paramkey"></td>
 
245
          <td></td>
 
246
          <td class="paramtype"><a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a>&#160;</td>
 
247
          <td class="paramname"><em>right_width_</em>, </td>
 
248
        </tr>
 
249
        <tr>
 
250
          <td class="paramkey"></td>
 
251
          <td></td>
 
252
          <td class="paramtype"><a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a>&#160;</td>
 
253
          <td class="paramname"><em>area_</em>, </td>
 
254
        </tr>
 
255
        <tr>
 
256
          <td class="paramkey"></td>
 
257
          <td></td>
 
258
          <td class="paramtype"><a class="el" href="structOpenMS_1_1PeakShape.html#a7b57a1b9b462900850eaaab16539b923">PeakIterator</a>&#160;</td>
 
259
          <td class="paramname"><em>left_</em>, </td>
 
260
        </tr>
 
261
        <tr>
 
262
          <td class="paramkey"></td>
 
263
          <td></td>
 
264
          <td class="paramtype"><a class="el" href="structOpenMS_1_1PeakShape.html#a7b57a1b9b462900850eaaab16539b923">PeakIterator</a>&#160;</td>
 
265
          <td class="paramname"><em>right_</em>, </td>
 
266
        </tr>
 
267
        <tr>
 
268
          <td class="paramkey"></td>
 
269
          <td></td>
 
270
          <td class="paramtype"><a class="el" href="structOpenMS_1_1PeakShape.html#a1d1cfd8ffb84e947f82999c682b666a7">Type</a>&#160;</td>
 
271
          <td class="paramname"><em>type_</em>&#160;</td>
 
272
        </tr>
 
273
        <tr>
 
274
          <td></td>
 
275
          <td>)</td>
 
276
          <td></td><td></td>
 
277
        </tr>
 
278
      </table>
 
279
</div><div class="memdoc">
 
280
 
 
281
<p>Constructor that sets most of the members. </p>
 
282
 
 
283
</div>
 
284
</div>
 
285
<a class="anchor" id="a55b238be22070133965d3eec542d2c3b"></a>
 
286
<div class="memitem">
 
287
<div class="memproto">
 
288
      <table class="memname">
 
289
        <tr>
 
290
          <td class="memname"><a class="el" href="structOpenMS_1_1PeakShape.html">PeakShape</a> </td>
 
291
          <td>(</td>
 
292
          <td class="paramtype"><a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a>&#160;</td>
 
293
          <td class="paramname"><em>height_</em>, </td>
 
294
        </tr>
 
295
        <tr>
 
296
          <td class="paramkey"></td>
 
297
          <td></td>
 
298
          <td class="paramtype"><a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a>&#160;</td>
 
299
          <td class="paramname"><em>mz_position_</em>, </td>
 
300
        </tr>
 
301
        <tr>
 
302
          <td class="paramkey"></td>
 
303
          <td></td>
 
304
          <td class="paramtype"><a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a>&#160;</td>
 
305
          <td class="paramname"><em>left_width_</em>, </td>
 
306
        </tr>
 
307
        <tr>
 
308
          <td class="paramkey"></td>
 
309
          <td></td>
 
310
          <td class="paramtype"><a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a>&#160;</td>
 
311
          <td class="paramname"><em>right_width_</em>, </td>
 
312
        </tr>
 
313
        <tr>
 
314
          <td class="paramkey"></td>
 
315
          <td></td>
 
316
          <td class="paramtype"><a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a>&#160;</td>
 
317
          <td class="paramname"><em>area_</em>, </td>
 
318
        </tr>
 
319
        <tr>
 
320
          <td class="paramkey"></td>
 
321
          <td></td>
 
322
          <td class="paramtype"><a class="el" href="structOpenMS_1_1PeakShape.html#a1d1cfd8ffb84e947f82999c682b666a7">Type</a>&#160;</td>
 
323
          <td class="paramname"><em>type_</em>&#160;</td>
 
324
        </tr>
 
325
        <tr>
 
326
          <td></td>
 
327
          <td>)</td>
 
328
          <td></td><td></td>
 
329
        </tr>
 
330
      </table>
 
331
</div><div class="memdoc">
 
332
 
 
333
<p>Constructor that sets most of the members. </p>
 
334
 
 
335
</div>
 
336
</div>
 
337
<a class="anchor" id="a753266dba5c366bc6bde3d4cee4b823c"></a>
 
338
<div class="memitem">
 
339
<div class="memproto">
 
340
      <table class="memname">
 
341
        <tr>
 
342
          <td class="memname"><a class="el" href="structOpenMS_1_1PeakShape.html">PeakShape</a> </td>
 
343
          <td>(</td>
 
344
          <td class="paramtype">const <a class="el" href="structOpenMS_1_1PeakShape.html">PeakShape</a> &amp;&#160;</td>
 
345
          <td class="paramname"><em>rhs</em></td><td>)</td>
 
346
          <td></td>
 
347
        </tr>
 
348
      </table>
 
349
</div><div class="memdoc">
 
350
 
 
351
<p>Copy constructor. </p>
 
352
 
 
353
</div>
 
354
</div>
 
355
<a class="anchor" id="a83c0fe1aa378a13a95703f1729ce27b2"></a>
 
356
<div class="memitem">
 
357
<div class="memproto">
 
358
<table class="mlabels">
 
359
  <tr>
 
360
  <td class="mlabels-left">
 
361
      <table class="memname">
 
362
        <tr>
 
363
          <td class="memname">virtual ~<a class="el" href="structOpenMS_1_1PeakShape.html">PeakShape</a> </td>
 
364
          <td>(</td>
 
365
          <td class="paramname"></td><td>)</td>
 
366
          <td></td>
 
367
        </tr>
 
368
      </table>
 
369
  </td>
 
370
  <td class="mlabels-right">
 
371
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
 
372
  </tr>
 
373
</table>
 
374
</div><div class="memdoc">
 
375
 
 
376
<p>Destructor. </p>
 
377
 
 
378
</div>
 
379
</div>
 
380
<h2 class="groupheader">Member Function Documentation</h2>
 
381
<a class="anchor" id="af78548d2419bdbe09b16dfcb1296c047"></a>
 
382
<div class="memitem">
 
383
<div class="memproto">
 
384
      <table class="memname">
 
385
        <tr>
 
386
          <td class="memname"><a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a> getFWHM </td>
 
387
          <td>(</td>
 
388
          <td class="paramname"></td><td>)</td>
 
389
          <td> const</td>
 
390
        </tr>
 
391
      </table>
 
392
</div><div class="memdoc">
 
393
 
 
394
<p>Estimates the full width at half maximum. </p>
 
395
 
 
396
</div>
 
397
</div>
 
398
<a class="anchor" id="a37d1f3fbac0050668e0768fffe3a53bb"></a>
 
399
<div class="memitem">
 
400
<div class="memproto">
 
401
      <table class="memname">
 
402
        <tr>
 
403
          <td class="memname"><a class="el" href="structOpenMS_1_1PeakShape.html#a7b57a1b9b462900850eaaab16539b923">PeakIterator</a> getLeftEndpoint </td>
 
404
          <td>(</td>
 
405
          <td class="paramname"></td><td>)</td>
 
406
          <td> const</td>
 
407
        </tr>
 
408
      </table>
 
409
</div><div class="memdoc">
 
410
 
 
411
</div>
 
412
</div>
 
413
<a class="anchor" id="a10157f541773947a77ff68a5dc397ce0"></a>
 
414
<div class="memitem">
 
415
<div class="memproto">
 
416
      <table class="memname">
 
417
        <tr>
 
418
          <td class="memname"><a class="el" href="structOpenMS_1_1PeakShape.html#a7b57a1b9b462900850eaaab16539b923">PeakIterator</a> getRightEndpoint </td>
 
419
          <td>(</td>
 
420
          <td class="paramname"></td><td>)</td>
 
421
          <td> const</td>
 
422
        </tr>
 
423
      </table>
 
424
</div><div class="memdoc">
 
425
 
 
426
</div>
 
427
</div>
 
428
<a class="anchor" id="ab430ff72ada6384f0363ffe590c39a92"></a>
 
429
<div class="memitem">
 
430
<div class="memproto">
 
431
      <table class="memname">
 
432
        <tr>
 
433
          <td class="memname"><a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a> getSymmetricMeasure </td>
 
434
          <td>(</td>
 
435
          <td class="paramname"></td><td>)</td>
 
436
          <td> const</td>
 
437
        </tr>
 
438
      </table>
 
439
</div><div class="memdoc">
 
440
 
 
441
<p>Computes symmetry measure of the peak shape, which is corresponds to th ratio of the left and right width parameters. </p>
 
442
 
 
443
</div>
 
444
</div>
 
445
<a class="anchor" id="abd32e89f174b023eeaa9a4cc00f16ef9"></a>
 
446
<div class="memitem">
 
447
<div class="memproto">
 
448
      <table class="memname">
 
449
        <tr>
 
450
          <td class="memname">bool iteratorsSet </td>
 
451
          <td>(</td>
 
452
          <td class="paramname"></td><td>)</td>
 
453
          <td> const</td>
 
454
        </tr>
 
455
      </table>
 
456
</div><div class="memdoc">
 
457
 
 
458
<p>Check if endpoint iterators. </p>
 
459
 
 
460
</div>
 
461
</div>
 
462
<a class="anchor" id="aa71b98c845308a75da85dc947166f5bc"></a>
 
463
<div class="memitem">
 
464
<div class="memproto">
 
465
      <table class="memname">
 
466
        <tr>
 
467
          <td class="memname">bool operator!= </td>
 
468
          <td>(</td>
 
469
          <td class="paramtype">const <a class="el" href="structOpenMS_1_1PeakShape.html">PeakShape</a> &amp;&#160;</td>
 
470
          <td class="paramname"><em>rhs</em></td><td>)</td>
 
471
          <td> const</td>
 
472
        </tr>
 
473
      </table>
 
474
</div><div class="memdoc">
 
475
 
 
476
</div>
 
477
</div>
 
478
<a class="anchor" id="a9496f160b7569a32f6746fcea5bf1aac"></a>
 
479
<div class="memitem">
 
480
<div class="memproto">
 
481
      <table class="memname">
 
482
        <tr>
 
483
          <td class="memname"><a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a> operator() </td>
 
484
          <td>(</td>
 
485
          <td class="paramtype"><a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a>&#160;</td>
 
486
          <td class="paramname"><em>x</em></td><td>)</td>
 
487
          <td> const</td>
 
488
        </tr>
 
489
      </table>
 
490
</div><div class="memdoc">
 
491
 
 
492
<p>Compute the intensity of the peaks shape at position x. </p>
 
493
 
 
494
</div>
 
495
</div>
 
496
<a class="anchor" id="a4e48fdc45c9e5f7b49574931e3abc58e"></a>
 
497
<div class="memitem">
 
498
<div class="memproto">
 
499
      <table class="memname">
 
500
        <tr>
 
501
          <td class="memname"><a class="el" href="structOpenMS_1_1PeakShape.html">PeakShape</a>&amp; operator= </td>
 
502
          <td>(</td>
 
503
          <td class="paramtype">const <a class="el" href="structOpenMS_1_1PeakShape.html">PeakShape</a> &amp;&#160;</td>
 
504
          <td class="paramname"><em>rhs</em></td><td>)</td>
 
505
          <td></td>
 
506
        </tr>
 
507
      </table>
 
508
</div><div class="memdoc">
 
509
 
 
510
<p>Assignment operator. </p>
 
511
 
 
512
</div>
 
513
</div>
 
514
<a class="anchor" id="ade24ef25fa8dc501b536c99797c659a8"></a>
 
515
<div class="memitem">
 
516
<div class="memproto">
 
517
      <table class="memname">
 
518
        <tr>
 
519
          <td class="memname">bool operator== </td>
 
520
          <td>(</td>
 
521
          <td class="paramtype">const <a class="el" href="structOpenMS_1_1PeakShape.html">PeakShape</a> &amp;&#160;</td>
 
522
          <td class="paramname"><em>rhs</em></td><td>)</td>
 
523
          <td> const</td>
 
524
        </tr>
 
525
      </table>
 
526
</div><div class="memdoc">
 
527
 
 
528
</div>
 
529
</div>
 
530
<a class="anchor" id="ad3e784fbfcd0e91cfea2a297f3599152"></a>
 
531
<div class="memitem">
 
532
<div class="memproto">
 
533
      <table class="memname">
 
534
        <tr>
 
535
          <td class="memname">void setLeftEndpoint </td>
 
536
          <td>(</td>
 
537
          <td class="paramtype"><a class="el" href="structOpenMS_1_1PeakShape.html#a7b57a1b9b462900850eaaab16539b923">PeakIterator</a>&#160;</td>
 
538
          <td class="paramname"><em>left_endpoint</em></td><td>)</td>
 
539
          <td></td>
 
540
        </tr>
 
541
      </table>
 
542
</div><div class="memdoc">
 
543
 
 
544
</div>
 
545
</div>
 
546
<a class="anchor" id="a46153468d71f6c67f31d2b407509d1e8"></a>
 
547
<div class="memitem">
 
548
<div class="memproto">
 
549
      <table class="memname">
 
550
        <tr>
 
551
          <td class="memname">void setRightEndpoint </td>
 
552
          <td>(</td>
 
553
          <td class="paramtype"><a class="el" href="structOpenMS_1_1PeakShape.html#a7b57a1b9b462900850eaaab16539b923">PeakIterator</a>&#160;</td>
 
554
          <td class="paramname"><em>right_endpoint</em></td><td>)</td>
 
555
          <td></td>
 
556
        </tr>
 
557
      </table>
 
558
</div><div class="memdoc">
 
559
 
 
560
</div>
 
561
</div>
 
562
<h2 class="groupheader">Member Data Documentation</h2>
 
563
<a class="anchor" id="ab711e0c5eaae04e02713b6cbd5a6a954"></a>
 
564
<div class="memitem">
 
565
<div class="memproto">
 
566
      <table class="memname">
 
567
        <tr>
 
568
          <td class="memname"><a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a> area</td>
 
569
        </tr>
 
570
      </table>
 
571
</div><div class="memdoc">
 
572
 
 
573
<p>Area of the peak shape. </p>
 
574
 
 
575
</div>
 
576
</div>
 
577
<a class="anchor" id="abc2dae237eadd7367b32b97a695eee69"></a>
 
578
<div class="memitem">
 
579
<div class="memproto">
 
580
<table class="mlabels">
 
581
  <tr>
 
582
  <td class="mlabels-left">
 
583
      <table class="memname">
 
584
        <tr>
 
585
          <td class="memname"><a class="el" href="classOpenMS_1_1MSSpectrum.html">MSSpectrum</a> exp_</td>
 
586
        </tr>
 
587
      </table>
 
588
  </td>
 
589
  <td class="mlabels-right">
 
590
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
 
591
  </tr>
 
592
</table>
 
593
</div><div class="memdoc">
 
594
 
 
595
<p>Needed for initialisation of endpoint iterators. </p>
 
596
 
 
597
</div>
 
598
</div>
 
599
<a class="anchor" id="a5343d7f469d61e6d3f4808a609094175"></a>
 
600
<div class="memitem">
 
601
<div class="memproto">
 
602
      <table class="memname">
 
603
        <tr>
 
604
          <td class="memname"><a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a> height</td>
 
605
        </tr>
 
606
      </table>
 
607
</div><div class="memdoc">
 
608
 
 
609
<p>Maximum intensity of the peak shape. </p>
 
610
 
 
611
<p>Referenced by <a class="el" href="classOpenMS_1_1TwoDOptimization.html#adca2617ab638fed2467b9d57b1fe2cfa">TwoDOptimization::optimizeRegionsScanwise_()</a>.</p>
 
612
 
 
613
</div>
 
614
</div>
 
615
<a class="anchor" id="abcc8b3e1ca93a4a4a5d23aa09f78f8ce"></a>
 
616
<div class="memitem">
 
617
<div class="memproto">
 
618
<table class="mlabels">
 
619
  <tr>
 
620
  <td class="mlabels-left">
 
621
      <table class="memname">
 
622
        <tr>
 
623
          <td class="memname"><a class="el" href="structOpenMS_1_1PeakShape.html#a7b57a1b9b462900850eaaab16539b923">PeakIterator</a> left_endpoint_</td>
 
624
        </tr>
 
625
      </table>
 
626
  </td>
 
627
  <td class="mlabels-right">
 
628
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
 
629
  </tr>
 
630
</table>
 
631
</div><div class="memdoc">
 
632
 
 
633
<p>Left peak endpoint in the data. </p>
 
634
 
 
635
</div>
 
636
</div>
 
637
<a class="anchor" id="a2dfb6cdff8be09761c34083959f62e51"></a>
 
638
<div class="memitem">
 
639
<div class="memproto">
 
640
<table class="mlabels">
 
641
  <tr>
 
642
  <td class="mlabels-left">
 
643
      <table class="memname">
 
644
        <tr>
 
645
          <td class="memname">bool left_iterator_set_</td>
 
646
        </tr>
 
647
      </table>
 
648
  </td>
 
649
  <td class="mlabels-right">
 
650
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
 
651
  </tr>
 
652
</table>
 
653
</div><div class="memdoc">
 
654
 
 
655
<p>flag if left endpoint iterator differs from default value </p>
 
656
 
 
657
</div>
 
658
</div>
 
659
<a class="anchor" id="a6bd93679898a199380f450a9351fde28"></a>
 
660
<div class="memitem">
 
661
<div class="memproto">
 
662
      <table class="memname">
 
663
        <tr>
 
664
          <td class="memname"><a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a> left_width</td>
 
665
        </tr>
 
666
      </table>
 
667
</div><div class="memdoc">
 
668
 
 
669
<p>Left width parameter. </p>
 
670
 
 
671
<p>Referenced by <a class="el" href="classOpenMS_1_1TwoDOptimization.html#adca2617ab638fed2467b9d57b1fe2cfa">TwoDOptimization::optimizeRegionsScanwise_()</a>.</p>
 
672
 
 
673
</div>
 
674
</div>
 
675
<a class="anchor" id="a0b633e3762805bc447c451f262a8f405"></a>
 
676
<div class="memitem">
 
677
<div class="memproto">
 
678
      <table class="memname">
 
679
        <tr>
 
680
          <td class="memname"><a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a> mz_position</td>
 
681
        </tr>
 
682
      </table>
 
683
</div><div class="memdoc">
 
684
 
 
685
<p>Centroid position. </p>
 
686
 
 
687
<p>Referenced by <a class="el" href="classOpenMS_1_1PeakShape_1_1PositionLess.html#adf694fe80e838d9e0d7509670bcbb68c">PeakShape::PositionLess::operator()()</a>, and <a class="el" href="classOpenMS_1_1TwoDOptimization.html#adca2617ab638fed2467b9d57b1fe2cfa">TwoDOptimization::optimizeRegionsScanwise_()</a>.</p>
 
688
 
 
689
</div>
 
690
</div>
 
691
<a class="anchor" id="acec96c76b28be5f89d2966092930e242"></a>
 
692
<div class="memitem">
 
693
<div class="memproto">
 
694
      <table class="memname">
 
695
        <tr>
 
696
          <td class="memname"><a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a> r_value</td>
 
697
        </tr>
 
698
      </table>
 
699
</div><div class="memdoc">
 
700
 
 
701
<p>Correlation coefficient. </p>
 
702
<p>It represents the squared pearson correlation coefficient with the original data (0 &lt;= r_value &lt;= 1). </p>
 
703
 
 
704
</div>
 
705
</div>
 
706
<a class="anchor" id="a8c4f642d031eb6b58645c8664a4a6edc"></a>
 
707
<div class="memitem">
 
708
<div class="memproto">
 
709
<table class="mlabels">
 
710
  <tr>
 
711
  <td class="mlabels-left">
 
712
      <table class="memname">
 
713
        <tr>
 
714
          <td class="memname"><a class="el" href="structOpenMS_1_1PeakShape.html#a7b57a1b9b462900850eaaab16539b923">PeakIterator</a> right_endpoint_</td>
 
715
        </tr>
 
716
      </table>
 
717
  </td>
 
718
  <td class="mlabels-right">
 
719
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
 
720
  </tr>
 
721
</table>
 
722
</div><div class="memdoc">
 
723
 
 
724
<p>Right peak endpoint in the data. </p>
 
725
 
 
726
</div>
 
727
</div>
 
728
<a class="anchor" id="ad854a86aa9b4a56b0d270ac1eee81174"></a>
 
729
<div class="memitem">
 
730
<div class="memproto">
 
731
<table class="mlabels">
 
732
  <tr>
 
733
  <td class="mlabels-left">
 
734
      <table class="memname">
 
735
        <tr>
 
736
          <td class="memname">bool right_iterator_set_</td>
 
737
        </tr>
 
738
      </table>
 
739
  </td>
 
740
  <td class="mlabels-right">
 
741
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
 
742
  </tr>
 
743
</table>
 
744
</div><div class="memdoc">
 
745
 
 
746
<p>flag if left endpoint iterator differs from default value </p>
 
747
 
 
748
</div>
 
749
</div>
 
750
<a class="anchor" id="aee68061fb00b7a84b354bac91e492039"></a>
 
751
<div class="memitem">
 
752
<div class="memproto">
 
753
      <table class="memname">
 
754
        <tr>
 
755
          <td class="memname"><a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a> right_width</td>
 
756
        </tr>
 
757
      </table>
 
758
</div><div class="memdoc">
 
759
 
 
760
<p>Right width parameter. </p>
 
761
 
 
762
<p>Referenced by <a class="el" href="classOpenMS_1_1TwoDOptimization.html#adca2617ab638fed2467b9d57b1fe2cfa">TwoDOptimization::optimizeRegionsScanwise_()</a>.</p>
 
763
 
 
764
</div>
 
765
</div>
 
766
<a class="anchor" id="acfd893e5679e13dbae94440f76fa3dbd"></a>
 
767
<div class="memitem">
 
768
<div class="memproto">
 
769
      <table class="memname">
 
770
        <tr>
 
771
          <td class="memname"><a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a> signal_to_noise</td>
 
772
        </tr>
 
773
      </table>
 
774
</div><div class="memdoc">
 
775
 
 
776
<p>The signal to noise ratio at the mz_position. </p>
 
777
 
 
778
</div>
 
779
</div>
 
780
<a class="anchor" id="ab6f4e6d3fde00ce906e46494f60dfe7a"></a>
 
781
<div class="memitem">
 
782
<div class="memproto">
 
783
      <table class="memname">
 
784
        <tr>
 
785
          <td class="memname"><a class="el" href="structOpenMS_1_1PeakShape.html#a1d1cfd8ffb84e947f82999c682b666a7">Type</a> type</td>
 
786
        </tr>
 
787
      </table>
 
788
</div><div class="memdoc">
 
789
 
 
790
<p>peak shape type </p>
 
791
 
 
792
</div>
 
793
</div>
 
794
</div><!-- contents -->
 
795
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
 
796
<TABLE width="100%" border="0">
 
797
<TR>
 
798
<TD><font color="#c0c0c0">OpenMS / TOPP release 1.11.1</font></TD>
 
799
<TD align="right"><font color="#c0c0c0">Documentation generated on Thu Nov 14 2013 11:19:35 using doxygen 1.8.5</font></TD>
 
800
</TR>
 
801
</TABLE>
 
802
</BODY>
 
803
</HTML>