File: structOpenMS_1_1FeatureFinderDefs.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 (154 lines) | stat: -rw-r--r-- 11,660 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
<HTML>
<HEAD>
<TITLE>FeatureFinderDefs 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_1FeatureFinderDefs.html">FeatureFinderDefs</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-types">Public Types</a> &#124;
<a href="structOpenMS_1_1FeatureFinderDefs-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">FeatureFinderDefs Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>The purpose of this struct is to provide definitions of classes and typedefs which are used throughout all <a class="el" href="classOpenMS_1_1FeatureFinder.html" title="The main feature finder class. ">FeatureFinder</a> classes.  
 <a href="structOpenMS_1_1FeatureFinderDefs.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="FeatureFinderDefs_8h_source.html">OpenMS/TRANSFORMATIONS/FEATUREFINDER/FeatureFinderDefs.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for FeatureFinderDefs:</div>
<div class="dyncontent">
 <div class="center">
  <img src="structOpenMS_1_1FeatureFinderDefs.png" usemap="#FeatureFinderDefs_map" alt=""/>
  <map id="FeatureFinderDefs_map" name="FeatureFinderDefs_map">
<area href="classOpenMS_1_1FeatureFinder.html" title="The main feature finder class. " alt="FeatureFinder" shape="rect" coords="363,56,716,80"/>
<area href="classOpenMS_1_1FeatureFinderAlgorithmMRM.html" title="FeatureFinderAlgorithm for MRM experiments. " alt="FeatureFinderAlgorithmMRM&lt; PeakType, FeatureType &gt;" shape="rect" coords="363,112,716,136"/>
<area href="classOpenMS_1_1FeatureFinderAlgorithmPicked.html" title="FeatureFinderAlgorithm for picked peaks. " alt="FeatureFinderAlgorithmPicked&lt; PeakType, FeatureType &gt;" shape="rect" coords="363,168,716,192"/>
<area href="classOpenMS_1_1FeatureFinderAlgorithmSH.html" title="The Superhirn FeatureFinderAlgorithm. " alt="FeatureFinderAlgorithmSH&lt; PeakType, FeatureType &gt;" shape="rect" coords="363,224,716,248"/>
<area href="classOpenMS_1_1FeatureFinderAlgorithmSimple.html" title="FeatureFinderAlgorithm implementation using the Simple* modules. " alt="FeatureFinderAlgorithmSimple&lt; PeakType, FeatureType &gt;" shape="rect" coords="363,280,716,304"/>
<area href="classOpenMS_1_1FeatureFinderAlgorithmSimplest.html" title="FeatureFinderAlgorithm implementation using the Simple* modules. " alt="FeatureFinderAlgorithmSimplest&lt; PeakType, FeatureType &gt;" shape="rect" coords="363,336,716,360"/>
<area href="classOpenMS_1_1Fitter1D.html" title="Abstract base class for all 1D-dimensional model fitter. " alt="Fitter1D" shape="rect" coords="363,392,716,416"/>
<area href="classOpenMS_1_1ModelFitter.html" title="Tests a group of data points in an LC-MS map for goodness-of-fit with a 2D averagine model..." alt="ModelFitter&lt; PeakType, FeatureType &gt;" shape="rect" coords="363,448,716,472"/>
<area href="classOpenMS_1_1SimpleExtender.html" title="Simple feature extension algorithm. " alt="SimpleExtender&lt; PeakType, FeatureType &gt;" shape="rect" coords="363,504,716,528"/>
<area href="classOpenMS_1_1SimpleSeeder.html" title="Simple seeding class that uses the strongest peak as next seed. " alt="SimpleSeeder&lt; PeakType, FeatureType &gt;" shape="rect" coords="363,560,716,584"/>
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1FeatureFinderDefs_1_1NoSuccessor.html">NoSuccessor</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="namespaceOpenMS_1_1Exception.html" title="Exception namespace ">Exception</a> that is thrown if a method an invalid IndexPair is given.  <a href="classOpenMS_1_1FeatureFinderDefs_1_1NoSuccessor.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a3f3de3e0d751949b8d0b60ffb302944a"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1FeatureFinderDefs.html#a3f3de3e0d751949b8d0b60ffb302944a">Flag</a> { <a class="el" href="structOpenMS_1_1FeatureFinderDefs.html#a3f3de3e0d751949b8d0b60ffb302944aaa09b651ef326a9d8efcee5cc5b720ab4">UNUSED</a>, 
<a class="el" href="structOpenMS_1_1FeatureFinderDefs.html#a3f3de3e0d751949b8d0b60ffb302944aa1e780c62cb3fd2edcac39f739bbe6f6c">USED</a>
 }</td></tr>
<tr class="memdesc:a3f3de3e0d751949b8d0b60ffb302944a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flags that indicate if a peak is already used in a feature.  <a href="structOpenMS_1_1FeatureFinderDefs.html#a3f3de3e0d751949b8d0b60ffb302944a">More...</a><br/></td></tr>
<tr class="separator:a3f3de3e0d751949b8d0b60ffb302944a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaee0bfd850887fdc58115cead9e9b8b9"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="structOpenMS_1_1IsotopeCluster.html#a0cab124671a3ada269f0553e1c8934da">IsotopeCluster::IndexPair</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1FeatureFinderDefs.html#aaee0bfd850887fdc58115cead9e9b8b9">IndexPair</a></td></tr>
<tr class="memdesc:aaee0bfd850887fdc58115cead9e9b8b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Index to peak consisting of two UInts (scan index / peak index)  <a href="#aaee0bfd850887fdc58115cead9e9b8b9">More...</a><br/></td></tr>
<tr class="separator:aaee0bfd850887fdc58115cead9e9b8b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af01a99958d0b18999737158daf8820ac"><td class="memItemLeft" align="right" valign="top">typedef <br class="typebreak"/>
<a class="el" href="structOpenMS_1_1IsotopeCluster_1_1ChargedIndexSet.html">IsotopeCluster::ChargedIndexSet</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1FeatureFinderDefs.html#af01a99958d0b18999737158daf8820ac">ChargedIndexSet</a></td></tr>
<tr class="memdesc:af01a99958d0b18999737158daf8820ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Index to peak consisting of two UInts (scan index / peak index) with charge information.  <a href="#af01a99958d0b18999737158daf8820ac">More...</a><br/></td></tr>
<tr class="separator:af01a99958d0b18999737158daf8820ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af7439235b89a75354a2e87350e36834f"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="structOpenMS_1_1IsotopeCluster.html#aed4049efd4228c847ab300ac4c466eca">IsotopeCluster::IndexSet</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1FeatureFinderDefs.html#af7439235b89a75354a2e87350e36834f">IndexSet</a></td></tr>
<tr class="memdesc:af7439235b89a75354a2e87350e36834f"><td class="mdescLeft">&#160;</td><td class="mdescRight">A set of peak indices.  <a href="#af7439235b89a75354a2e87350e36834f">More...</a><br/></td></tr>
<tr class="separator:af7439235b89a75354a2e87350e36834f"><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>The purpose of this struct is to provide definitions of classes and typedefs which are used throughout all <a class="el" href="classOpenMS_1_1FeatureFinder.html" title="The main feature finder class. ">FeatureFinder</a> classes. </p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="af01a99958d0b18999737158daf8820ac"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="structOpenMS_1_1IsotopeCluster_1_1ChargedIndexSet.html">IsotopeCluster::ChargedIndexSet</a> <a class="el" href="structOpenMS_1_1FeatureFinderDefs.html#af01a99958d0b18999737158daf8820ac">ChargedIndexSet</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Index to peak consisting of two UInts (scan index / peak index) with charge information. </p>

</div>
</div>
<a class="anchor" id="aaee0bfd850887fdc58115cead9e9b8b9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="structOpenMS_1_1IsotopeCluster.html#a0cab124671a3ada269f0553e1c8934da">IsotopeCluster::IndexPair</a> <a class="el" href="structOpenMS_1_1FeatureFinderDefs.html#aaee0bfd850887fdc58115cead9e9b8b9">IndexPair</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Index to peak consisting of two UInts (scan index / peak index) </p>

</div>
</div>
<a class="anchor" id="af7439235b89a75354a2e87350e36834f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="structOpenMS_1_1IsotopeCluster.html#aed4049efd4228c847ab300ac4c466eca">IsotopeCluster::IndexSet</a> <a class="el" href="structOpenMS_1_1FeatureFinderDefs.html#af7439235b89a75354a2e87350e36834f">IndexSet</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>A set of peak indices. </p>

</div>
</div>
<h2 class="groupheader">Member Enumeration Documentation</h2>
<a class="anchor" id="a3f3de3e0d751949b8d0b60ffb302944a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="structOpenMS_1_1FeatureFinderDefs.html#a3f3de3e0d751949b8d0b60ffb302944a">Flag</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Flags that indicate if a peak is already used in a feature. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a3f3de3e0d751949b8d0b60ffb302944aaa09b651ef326a9d8efcee5cc5b720ab4"></a>UNUSED</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a3f3de3e0d751949b8d0b60ffb302944aa1e780c62cb3fd2edcac39f739bbe6f6c"></a>USED</em>&nbsp;</td><td class="fielddoc">
</td></tr>
</table>

</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>