File: classOpenMS_1_1ProductModel.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 (78 lines) | stat: -rw-r--r-- 4,345 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
<HTML>
<HEAD>
<TITLE>ProductModel&lt; D &gt; Class Template 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_1ProductModel.html">ProductModel</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">ProductModel&lt; D &gt; Class Template Reference<div class="ingroups"><a class="el" href="group__FeatureFinder.html">FeatureFinder</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>Class for product models i.e. models with D independent dimensions.  
 <a href="classOpenMS_1_1ProductModel.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="ProductModel_8h_source.html">OpenMS/TRANSFORMATIONS/FEATUREFINDER/ProductModel.h</a>&gt;</code></p>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;UInt D&gt;<br/>
class OpenMS::ProductModel&lt; D &gt;</h3>

<p>Class for product models i.e. models with D independent dimensions. </p>
<p>The predicted intensity is simply the product of the intensities in each dimension</p>
<B>Parameters of this class are:</B><BR><BR>
<table border="1" style="border-style:solid; border-collapse:collapse; border-color:#c0c0c0;" width="100%" cellpadding="4">
<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>
<tr>
  <td style="vertical-align:top"><b>cutoff</b></td>
  <td style="vertical-align:top">float</td><td style="vertical-align:top">0</td>
  <td style="vertical-align:top">&nbsp;</td><td style="vertical-align:top">Low intensity cutoff of the model.  Peaks below this intensity are not considered part of the model.</td>
</tr>
<tr>
  <td style="vertical-align:top"><b>RT</b></td>
  <td style="vertical-align:top">string</td><td style="vertical-align:top">GaussModel</td>
  <td style="vertical-align:top">&nbsp;</td><td style="vertical-align:top">Name of the model used for this dimension</td>
</tr>
<tr>
  <td style="vertical-align:top"><b>MZ</b></td>
  <td style="vertical-align:top">string</td><td style="vertical-align:top">GaussModel</td>
  <td style="vertical-align:top">&nbsp;</td><td style="vertical-align:top">Name of the model used for this dimension</td>
</tr>
<tr>
  <td style="vertical-align:top"><b>intensity_scaling</b></td>
  <td style="vertical-align:top">float</td><td style="vertical-align:top">1</td>
  <td style="vertical-align:top">&nbsp;</td><td style="vertical-align:top">Scaling factor used to adjust the model distribution to the intensities of the data</td>
</tr>
</table>
<br>
<b>Note:</b>
<UL style="margin-top:0px;">
  <LI> If a section name is documented, the documentation is displayed as tooltip.
  <LI> Advanced parameter names are italic.
</UL>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000023">Todo:</a></b></dt><dd>This class provides new member functions, which makes <a class="el" href="classOpenMS_1_1Factory.html" title="Returns FactoryProduct* based on the name of the desired concrete FactoryProduct. ...">Factory</a>&lt;<a class="el" href="classOpenMS_1_1BaseModel.html">BaseModel&lt;2&gt;</a> &gt;::create("ProductModel2D") pretty much useless! (Clemens)</dd></dl>
</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>