File: classOpenMS_1_1IsotopeDistributionCache.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 (186 lines) | stat: -rw-r--r-- 10,777 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
180
181
182
183
184
185
186
 
<HTML>
<HEAD>
<TITLE>IsotopeDistributionCache Class 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="classOpenMS_1_1IsotopeDistributionCache.html">IsotopeDistributionCache</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classOpenMS_1_1IsotopeDistributionCache-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">IsotopeDistributionCache Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Prealculate isotope distributions for interesting mass ranges.  
 <a href="classOpenMS_1_1IsotopeDistributionCache.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="IsotopeDistributionCache_8h_source.html">OpenMS/FILTERING/DATAREDUCTION/IsotopeDistributionCache.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:adb93f7d18f3a19b45d1a05e7c29dbeaa"><td class="memItemLeft" align="right" valign="top">typedef <br class="typebreak"/>
<a class="el" href="structOpenMS_1_1FeatureFinderAlgorithmPickedHelperStructs_1_1TheoreticalIsotopePattern.html">FeatureFinderAlgorithmPickedHelperStructs::TheoreticalIsotopePattern</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1IsotopeDistributionCache.html#adb93f7d18f3a19b45d1a05e7c29dbeaa">TheoreticalIsotopePattern</a></td></tr>
<tr class="separator:adb93f7d18f3a19b45d1a05e7c29dbeaa"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a4e0fce508af89de66ba886fd67eaba42"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1IsotopeDistributionCache.html#a4e0fce508af89de66ba886fd67eaba42">IsotopeDistributionCache</a> (<a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a> max_mass, <a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a> mass_window_width, <a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a> intensity_percentage=0, <a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a> intensity_percentage_optional=0)</td></tr>
<tr class="separator:a4e0fce508af89de66ba886fd67eaba42"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af84b16dcdde491d9afa6868bbc956cae"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classOpenMS_1_1IsotopeDistributionCache.html#adb93f7d18f3a19b45d1a05e7c29dbeaa">TheoreticalIsotopePattern</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1IsotopeDistributionCache.html#af84b16dcdde491d9afa6868bbc956cae">getIsotopeDistribution</a> (<a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a> mass) const </td></tr>
<tr class="memdesc:af84b16dcdde491d9afa6868bbc956cae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the isotope distribution for a certain mass window.  <a href="#af84b16dcdde491d9afa6868bbc956cae">More...</a><br/></td></tr>
<tr class="separator:af84b16dcdde491d9afa6868bbc956cae"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:afd3d2147a4dba98319002b876781f9ee"><td class="memItemLeft" align="right" valign="top">std::vector<br class="typebreak"/>
&lt; <a class="el" href="classOpenMS_1_1IsotopeDistributionCache.html#adb93f7d18f3a19b45d1a05e7c29dbeaa">TheoreticalIsotopePattern</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1IsotopeDistributionCache.html#afd3d2147a4dba98319002b876781f9ee">isotope_distributions_</a></td></tr>
<tr class="memdesc:afd3d2147a4dba98319002b876781f9ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Vector of precalculated isotope distributions for several mass winows.  <a href="#afd3d2147a4dba98319002b876781f9ee">More...</a><br/></td></tr>
<tr class="separator:afd3d2147a4dba98319002b876781f9ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac58a0fa7d6013c1855f905dbaa13c22f"><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="classOpenMS_1_1IsotopeDistributionCache.html#ac58a0fa7d6013c1855f905dbaa13c22f">mass_window_width_</a></td></tr>
<tr class="separator:ac58a0fa7d6013c1855f905dbaa13c22f"><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>Prealculate isotope distributions for interesting mass ranges. </p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="adb93f7d18f3a19b45d1a05e7c29dbeaa"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="structOpenMS_1_1FeatureFinderAlgorithmPickedHelperStructs_1_1TheoreticalIsotopePattern.html">FeatureFinderAlgorithmPickedHelperStructs::TheoreticalIsotopePattern</a> <a class="el" href="classOpenMS_1_1IsotopeDistributionCache.html#adb93f7d18f3a19b45d1a05e7c29dbeaa">TheoreticalIsotopePattern</a></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a4e0fce508af89de66ba886fd67eaba42"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classOpenMS_1_1IsotopeDistributionCache.html">IsotopeDistributionCache</a> </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a>&#160;</td>
          <td class="paramname"><em>max_mass</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a>&#160;</td>
          <td class="paramname"><em>mass_window_width</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a>&#160;</td>
          <td class="paramname"><em>intensity_percentage</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a>&#160;</td>
          <td class="paramname"><em>intensity_percentage_optional</em> = <code>0</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="af84b16dcdde491d9afa6868bbc956cae"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="classOpenMS_1_1IsotopeDistributionCache.html#adb93f7d18f3a19b45d1a05e7c29dbeaa">TheoreticalIsotopePattern</a>&amp; getIsotopeDistribution </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a>&#160;</td>
          <td class="paramname"><em>mass</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the isotope distribution for a certain mass window. </p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="afd3d2147a4dba98319002b876781f9ee"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">std::vector&lt;<a class="el" href="classOpenMS_1_1IsotopeDistributionCache.html#adb93f7d18f3a19b45d1a05e7c29dbeaa">TheoreticalIsotopePattern</a>&gt; isotope_distributions_</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Vector of precalculated isotope distributions for several mass winows. </p>

</div>
</div>
<a class="anchor" id="ac58a0fa7d6013c1855f905dbaa13c22f"></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#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a> mass_window_width_</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</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:30 using doxygen 1.8.5</font></TD>
</TR>
</TABLE>
</BODY>
</HTML>