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
|
<HTML>
<HEAD>
<TITLE>SpectraFilterWindowMower</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> ·
<A href="classes.html">Classes</A> ·
<A href="annotated.html">Annotated Classes</A> ·
<A href="modules.html">Modules</A> ·
<A href="functions_func.html">Members</A> ·
<A href="namespaces.html">Namespaces</A> ·
<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">SpectraFilterWindowMower </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Filters the top Peaks in the given spectra according to a given schema/thresholdset</p>
<center> <table class="doxtable">
<tr>
<td align="center" bgcolor="#EBEBEB">pot. predecessor tools </td><td valign="middle" rowspan="2"><img class="formulaInl" alt="$ \longrightarrow $" src="form_91.png"/> SpectraFilter <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_PeakPickerWavelet.html">PeakPickerWavelet</a> </td><td valign="middle" align="center" rowspan="1">any tool operating on MS peak data <br/>
(in mzML format) </td></tr>
</table>
</center><p><b>The command line parameters of this tool are:</b> </p>
<pre class="fragment">
SpectraFilterWindowMower -- Applies thresholdfilter to peak spectra.
Version: 1.11.1 Nov 14 2013, 11:18:15, Revision: 11976
Usage:
SpectraFilterWindowMower <options>
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 <file>* Input file (valid formats: 'mzML')
-out <file>* Output file (valid formats: 'mzML')
Common TOPP options:
-ini <file> Use the given TOPP INI file
-threads <n> Sets the number of threads allowed to be used by the TOPP tool (default: '1')
-write_ini <file> Writes the default configuration file
--help Shows options
--helphelp Shows all options (including advanced)
The following configuration subsections are valid:
- algorithm Algorithm parameter subsection.
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><p> <b>INI file documentation of this tool:</b> <div class="ini_global">
<div class="legend">
<b>Legend:</b><br>
<div class="item item_required">required parameter</div>
<div class="item item_advanced">advanced parameter</div>
</div>
<div class="node"><span class="node_name">+SpectraFilterWindowMower</span><span class="node_description">Applies thresholdfilter to peak spectra.</span></div>
<div class="item item_advanced"><span class="item_name" style="padding-left:16px;">version</span><span class="item_value">1.11.1</span>
<span class="item_description">Version of the tool that generated this parameters file.</span><span class="item_tags"></span><span class="item_restrictions"> </span></div> <div class="node"><span class="node_name">++1</span><span class="node_description">Instance '1' section for 'SpectraFilterWindowMower'</span></div>
<div class="item"><span class="item_name item_required" style="padding-left:24px;">in</span><span class="item_value"></span>
<span class="item_description">input file </span><span class="item_tags">input file</span><span class="item_restrictions">*.mzML</span></div> <div class="item"><span class="item_name item_required" style="padding-left:24px;">out</span><span class="item_value"></span>
<span class="item_description">output file </span><span class="item_tags">output file</span><span class="item_restrictions">*.mzML</span></div> <div class="item item_advanced"><span class="item_name" style="padding-left:24px;">log</span><span class="item_value"></span>
<span class="item_description">Name of log file (created only when specified)</span><span class="item_tags"></span><span class="item_restrictions"> </span></div> <div class="item item_advanced"><span class="item_name" style="padding-left:24px;">debug</span><span class="item_value">0</span>
<span class="item_description">Sets the debug level</span><span class="item_tags"></span><span class="item_restrictions"> </span></div> <div class="item"><span class="item_name" style="padding-left:24px;">threads</span><span class="item_value">1</span>
<span class="item_description">Sets the number of threads allowed to be used by the TOPP tool</span><span class="item_tags"></span><span class="item_restrictions"> </span></div> <div class="item item_advanced"><span class="item_name" style="padding-left:24px;">no_progress</span><span class="item_value">false</span>
<span class="item_description">Disables progress logging to command line</span><span class="item_tags"></span><span class="item_restrictions">true,false</span></div> <div class="item item_advanced"><span class="item_name" style="padding-left:24px;">test</span><span class="item_value">false</span>
<span class="item_description">Enables the test mode (needed for internal use only)</span><span class="item_tags"></span><span class="item_restrictions">true,false</span></div> <div class="node"><span class="node_name">+++algorithm</span><span class="node_description">Algorithm parameter subsection.</span></div>
<div class="item"><span class="item_name" style="padding-left:32px;">windowsize</span><span class="item_value">50</span>
<span class="item_description">The size of the sliding window along the m/z axis.</span><span class="item_tags"></span><span class="item_restrictions"> </span></div> <div class="item"><span class="item_name" style="padding-left:32px;">peakcount</span><span class="item_value">2</span>
<span class="item_description">The number of peaks that should be kept.</span><span class="item_tags"></span><span class="item_restrictions"> </span></div> <div class="item"><span class="item_name" style="padding-left:32px;">movetype</span><span class="item_value">slide</span>
<span class="item_description">Whether sliding window (one peak steps) or jumping window (window size steps) should be used.</span><span class="item_tags"></span><span class="item_restrictions">slide,jump</span></div></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:24 using doxygen 1.8.5</font></TD>
</TR>
</TABLE>
</BODY>
</HTML>
|