File: structOpenMS_1_1FeatureFinderAlgorithmPickedHelperStructs_1_1TheoreticalIsotopePattern.html

package info (click to toggle)
openms 1.11.1-5
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 436,688 kB
  • ctags: 150,907
  • sloc: cpp: 387,126; xml: 71,547; python: 7,764; ansic: 2,626; php: 2,499; sql: 737; ruby: 342; sh: 325; makefile: 128
file content (179 lines) | stat: -rw-r--r-- 12,541 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
<HTML>
<HEAD>
<TITLE>FeatureFinderAlgorithmPickedHelperStructs::TheoreticalIsotopePattern Struct Reference</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
<LINK HREF="style_ini.css" REL="stylesheet" TYPE="text/css">
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<A href="index.html">Home</A> &nbsp;&middot;
<A href="classes.html">Classes</A> &nbsp;&middot;
<A href="annotated.html">Annotated Classes</A> &nbsp;&middot;
<A href="modules.html">Modules</A> &nbsp;&middot;
<A href="functions_func.html">Members</A> &nbsp;&middot;
<A href="namespaces.html">Namespaces</A> &nbsp;&middot;
<A href="pages.html">Related Pages</A>
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
<!-- Generated by Doxygen 1.8.5 -->
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceOpenMS.html">OpenMS</a></li><li class="navelem"><a class="el" href="structOpenMS_1_1FeatureFinderAlgorithmPickedHelperStructs.html">FeatureFinderAlgorithmPickedHelperStructs</a></li><li class="navelem"><a class="el" href="structOpenMS_1_1FeatureFinderAlgorithmPickedHelperStructs_1_1TheoreticalIsotopePattern.html">TheoreticalIsotopePattern</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structOpenMS_1_1FeatureFinderAlgorithmPickedHelperStructs_1_1TheoreticalIsotopePattern-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">FeatureFinderAlgorithmPickedHelperStructs::TheoreticalIsotopePattern Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Helper structure for a theoretical isotope pattern used in <a class="el" href="classOpenMS_1_1FeatureFinderAlgorithmPicked.html" title="FeatureFinderAlgorithm for picked peaks. ">FeatureFinderAlgorithmPicked</a>.  
 <a href="structOpenMS_1_1FeatureFinderAlgorithmPickedHelperStructs_1_1TheoreticalIsotopePattern.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="FeatureFinderAlgorithmPickedHelperStructs_8h_source.html">OpenMS/TRANSFORMATIONS/FEATUREFINDER/FeatureFinderAlgorithmPickedHelperStructs.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a9d78a687cf2a391198bb3cbc08bc06cb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__Concept.html#gaf9ecec2d692138fab9167164a457cbd4">Size</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1FeatureFinderAlgorithmPickedHelperStructs_1_1TheoreticalIsotopePattern.html#a9d78a687cf2a391198bb3cbc08bc06cb">size</a> () const </td></tr>
<tr class="memdesc:a9d78a687cf2a391198bb3cbc08bc06cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the size.  <a href="#a9d78a687cf2a391198bb3cbc08bc06cb">More...</a><br/></td></tr>
<tr class="separator:a9d78a687cf2a391198bb3cbc08bc06cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ac102a03577b6512164d6e4ff3cf78df0"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1FeatureFinderAlgorithmPickedHelperStructs_1_1TheoreticalIsotopePattern.html#ac102a03577b6512164d6e4ff3cf78df0">intensity</a></td></tr>
<tr class="memdesc:ac102a03577b6512164d6e4ff3cf78df0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Vector of intensity contributions.  <a href="#ac102a03577b6512164d6e4ff3cf78df0">More...</a><br/></td></tr>
<tr class="separator:ac102a03577b6512164d6e4ff3cf78df0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af2e76e2f5a4b1549e43a4dac9a3c35c2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__Concept.html#gaf9ecec2d692138fab9167164a457cbd4">Size</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1FeatureFinderAlgorithmPickedHelperStructs_1_1TheoreticalIsotopePattern.html#af2e76e2f5a4b1549e43a4dac9a3c35c2">optional_begin</a></td></tr>
<tr class="memdesc:af2e76e2f5a4b1549e43a4dac9a3c35c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of optional peaks at the beginning of the pattern.  <a href="#af2e76e2f5a4b1549e43a4dac9a3c35c2">More...</a><br/></td></tr>
<tr class="separator:af2e76e2f5a4b1549e43a4dac9a3c35c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a511873304a043cc9222285de3a2c2913"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__Concept.html#gaf9ecec2d692138fab9167164a457cbd4">Size</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1FeatureFinderAlgorithmPickedHelperStructs_1_1TheoreticalIsotopePattern.html#a511873304a043cc9222285de3a2c2913">optional_end</a></td></tr>
<tr class="memdesc:a511873304a043cc9222285de3a2c2913"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of optional peaks at the end of the pattern.  <a href="#a511873304a043cc9222285de3a2c2913">More...</a><br/></td></tr>
<tr class="separator:a511873304a043cc9222285de3a2c2913"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a22e8cde44cef1cd6e10cb313348feacb"><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_1FeatureFinderAlgorithmPickedHelperStructs_1_1TheoreticalIsotopePattern.html#a22e8cde44cef1cd6e10cb313348feacb">max</a></td></tr>
<tr class="memdesc:a22e8cde44cef1cd6e10cb313348feacb"><td class="mdescLeft">&#160;</td><td class="mdescRight">The maximum intensity contribution before scaling the pattern to 1.  <a href="#a22e8cde44cef1cd6e10cb313348feacb">More...</a><br/></td></tr>
<tr class="separator:a22e8cde44cef1cd6e10cb313348feacb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe90dc4ba735b87228bfe913b490f9f2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__Concept.html#gaf9ecec2d692138fab9167164a457cbd4">Size</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1FeatureFinderAlgorithmPickedHelperStructs_1_1TheoreticalIsotopePattern.html#abe90dc4ba735b87228bfe913b490f9f2">trimmed_left</a></td></tr>
<tr class="memdesc:abe90dc4ba735b87228bfe913b490f9f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of isotopes trimmed on the left side. This is needed to reconstruct the monoisotopic peak.  <a href="#abe90dc4ba735b87228bfe913b490f9f2">More...</a><br/></td></tr>
<tr class="separator:abe90dc4ba735b87228bfe913b490f9f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Helper structure for a theoretical isotope pattern used in <a class="el" href="classOpenMS_1_1FeatureFinderAlgorithmPicked.html" title="FeatureFinderAlgorithm for picked peaks. ">FeatureFinderAlgorithmPicked</a>. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a9d78a687cf2a391198bb3cbc08bc06cb"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__Concept.html#gaf9ecec2d692138fab9167164a457cbd4">Size</a> size </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns the size. </p>

<p>Referenced by <a class="el" href="classOpenMS_1_1FeatureFinderAlgorithmPicked.html#ad47e8e2093326bd3a2476713d538dd9e">FeatureFinderAlgorithmPicked&lt; PeakType, FeatureType &gt;::findBestIsotopeFit_()</a>, <a class="el" href="classOpenMS_1_1FeatureFinderAlgorithmPicked.html#a55abad1b592c5e19bfaddfc9f9c4a43e">FeatureFinderAlgorithmPicked&lt; PeakType, FeatureType &gt;::isotopeScore_()</a>, and <a class="el" href="classOpenMS_1_1FeatureFinderAlgorithmPicked.html#a72fcb26a14f6beb1c3fbace9ab3e7dbb">FeatureFinderAlgorithmPicked&lt; PeakType, FeatureType &gt;::run()</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="ac102a03577b6512164d6e4ff3cf78df0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::vector&lt;<a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a>&gt; intensity</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Vector of intensity contributions. </p>

<p>Referenced by <a class="el" href="classOpenMS_1_1FeatureFinderAlgorithmPicked.html#a00f443c46b1d9f3485ef02d844b2433d">FeatureFinderAlgorithmPicked&lt; PeakType, FeatureType &gt;::extendMassTraces_()</a>, <a class="el" href="classOpenMS_1_1FeatureFinderAlgorithmPicked.html#a55abad1b592c5e19bfaddfc9f9c4a43e">FeatureFinderAlgorithmPicked&lt; PeakType, FeatureType &gt;::isotopeScore_()</a>, and <a class="el" href="classOpenMS_1_1FeatureFinderAlgorithmPicked.html#a72fcb26a14f6beb1c3fbace9ab3e7dbb">FeatureFinderAlgorithmPicked&lt; PeakType, FeatureType &gt;::run()</a>.</p>

</div>
</div>
<a class="anchor" id="a22e8cde44cef1cd6e10cb313348feacb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a> max</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The maximum intensity contribution before scaling the pattern to 1. </p>

</div>
</div>
<a class="anchor" id="af2e76e2f5a4b1549e43a4dac9a3c35c2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__Concept.html#gaf9ecec2d692138fab9167164a457cbd4">Size</a> optional_begin</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Number of optional peaks at the beginning of the pattern. </p>

<p>Referenced by <a class="el" href="classOpenMS_1_1FeatureFinderAlgorithmPicked.html#a55abad1b592c5e19bfaddfc9f9c4a43e">FeatureFinderAlgorithmPicked&lt; PeakType, FeatureType &gt;::isotopeScore_()</a>.</p>

</div>
</div>
<a class="anchor" id="a511873304a043cc9222285de3a2c2913"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__Concept.html#gaf9ecec2d692138fab9167164a457cbd4">Size</a> optional_end</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Number of optional peaks at the end of the pattern. </p>

<p>Referenced by <a class="el" href="classOpenMS_1_1FeatureFinderAlgorithmPicked.html#a55abad1b592c5e19bfaddfc9f9c4a43e">FeatureFinderAlgorithmPicked&lt; PeakType, FeatureType &gt;::isotopeScore_()</a>.</p>

</div>
</div>
<a class="anchor" id="abe90dc4ba735b87228bfe913b490f9f2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__Concept.html#gaf9ecec2d692138fab9167164a457cbd4">Size</a> trimmed_left</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The number of isotopes trimmed on the left side. This is needed to reconstruct the monoisotopic peak. </p>

<p>Referenced by <a class="el" href="classOpenMS_1_1FeatureFinderAlgorithmPicked.html#a72fcb26a14f6beb1c3fbace9ab3e7dbb">FeatureFinderAlgorithmPicked&lt; PeakType, FeatureType &gt;::run()</a>.</p>

</div>
</div>
</div><!-- contents -->
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
<TABLE width="100%" border="0">
<TR>
<TD><font color="#c0c0c0">OpenMS / TOPP release 1.11.1</font></TD>
<TD align="right"><font color="#c0c0c0">Documentation generated on Thu Nov 14 2013 11:19:34 using doxygen 1.8.5</font></TD>
</TR>
</TABLE>
</BODY>
</HTML>