File: TOPP_MassTraceExtractor.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 (74 lines) | stat: -rw-r--r-- 4,319 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
<HTML>
<HEAD>
<TITLE>MassTraceExtractor</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><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">MassTraceExtractor </div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>MassTraceExtractor extracts mass traces from a MSExperiment map and stores them into a FeatureXMLFile.</p>
<center> <table class="doxtable">
<tr>
<td align="center" bgcolor="#EBEBEB">pot. predecessor tools  </td><td valign="middle" rowspan="3"><img class="formulaInl" alt="$ \longrightarrow $" src="form_91.png"/> MassTraceExtractor <img class="formulaInl" alt="$ \longrightarrow $" src="form_91.png"/> </td><td align="center" bgcolor="#EBEBEB">pot. successor tools   </td></tr>
<tr>
<td valign="middle" align="center" rowspan="1"><a class="el" href="TOPP_PeakPickerHiRes.html">PeakPickerHiRes</a>  </td><td valign="middle" align="center" rowspan="1"><a class="el" href="TOPP_FeatureFinderMetabo.html">FeatureFinderMetabo</a>  </td></tr>
<tr>
<td valign="middle" align="center" rowspan="1"><a class="el" href="TOPP_PeakPickerWavelet.html">PeakPickerWavelet</a>  </td><td valign="middle" align="center" rowspan="1"><a class="el" href="TOPP_TextExporter.html">TextExporter</a>   </td></tr>
</table>
</center><p>This TOPP tool detects mass traces in centroided LC-MS maps and stores them as features in a FeatureMap. These features may be either used directly as input for an metabolite ID approach or further be assembled to aggregate features according to a theoretical isotope pattern. For metabolomics experiments, the <a class="el" href="TOPP_FeatureFinderMetabo.html">FeatureFinderMetabo</a> tool offers both mass trace extraction and isotope pattern assembly. For proteomics data, please refer to the <a class="el" href="TOPP_FeatureFinderCentroided.html">FeatureFinderCentroided</a> tool.</p>
<p><b>The command line parameters of this tool are:</b> </p>
<pre class="fragment">
MassTraceExtractor -- Detects mass traces in centroided LC-MS data.
Version: 1.11.1 Nov 14 2013, 11:18:15, Revision: 11976

Usage:
  MassTraceExtractor &lt;options&gt;

This tool has algoritm parameters that are not shown here! Please check the ini file for a detailed descripti
on or use the --helphelp option.

Options (mandatory options marked with '*'):
  -in &lt;file&gt;*        Input centroided mzML file (valid formats: 'mzML')
  -out &lt;file&gt;*       Output featureXML file with mass traces (valid formats: 'featureXML', 'consensusXML')
  -out_type &lt;type&gt;   Output file type -- default: determined from file extension or content
                     (valid: 'featureXML', 'consensusXML')
                     
                     
Common TOPP options:
  -ini &lt;file&gt;        Use the given TOPP INI file
  -threads &lt;n&gt;       Sets the number of threads allowed to be used by the TOPP tool (default: '1')
  -write_ini &lt;file&gt;  Writes the default configuration file
  --help             Shows options
  --helphelp         Shows all options (including advanced)

The following configuration subsections are valid:
 - algorithm   Algorithm parameters section

You can write an example INI file using the '-write_ini' option.
Documentation of subsection parameters can be found in the doxygen documentation or the INIFileEditor.
Have a look at the OpenMS documentation for more information.

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