← Back to branch summary

~ubuntu-branches/ubuntu/wily/openms/wily

« back to all changes in this revision

Viewing changes to doc/html/TOPP_SpectraFilterSqrtMower.html

  • Committer: Package Import Robot
  • Author(s): Filippo Rusconi
  • Date: 2013-12-20 11:30:16 UTC
  • mfrom: (5.1.2 sid)
  • Revision ID: package-import@ubuntu.com-20131220113016-wre5g9bteeheq6he
Tags: 1.11.1-3
* remove version number from libbost development package names;
* ensure that AUTHORS is correctly shipped in all packages.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/TOPP_SpectraFilterSqrtMower.html
 
1
<HTML>
 
2
<HEAD>
 
3
<TITLE>SpectraFilterSqrtMower</TITLE>
 
4
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
 
5
<LINK HREF="style_ini.css" REL="stylesheet" TYPE="text/css">
 
6
</HEAD>
 
7
<BODY BGCOLOR="#FFFFFF">
 
8
<A href="index.html">Home</A> &nbsp;&middot;
 
9
<A href="classes.html">Classes</A> &nbsp;&middot;
 
10
<A href="annotated.html">Annotated Classes</A> &nbsp;&middot;
 
11
<A href="modules.html">Modules</A> &nbsp;&middot;
 
12
<A href="functions_func.html">Members</A> &nbsp;&middot;
 
13
<A href="namespaces.html">Namespaces</A> &nbsp;&middot;
 
14
<A href="pages.html">Related Pages</A>
 
15
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
 
16
<!-- Generated by Doxygen 1.8.5 -->
 
17
</div><!-- top -->
 
18
<div class="header">
 
19
  <div class="headertitle">
 
20
<div class="title">SpectraFilterSqrtMower </div>  </div>
 
21
</div><!--header-->
 
22
<div class="contents">
 
23
<div class="textblock"><p>Filters the top Peaks in the given spectra according to a given schema/thresholdset</p>
 
24
<center> <table class="doxtable">
 
25
<tr>
 
26
<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>
 
27
<tr>
 
28
<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/>
 
29
 (in mzML format)  </td></tr>
 
30
</table>
 
31
</center><p><b>The command line parameters of this tool are:</b> </p>
 
32
<pre class="fragment">
 
33
SpectraFilterSqrtMower -- Applies thresholdfilter to peak spectra.
 
34
Version: 1.11.1 Nov 14 2013, 11:18:15, Revision: 11976
 
35
 
 
36
Usage:
 
37
  SpectraFilterSqrtMower &lt;options&gt;
 
38
 
 
39
This tool has algoritm parameters that are not shown here! Please check the ini file for a detailed descripti
 
40
on or use the --helphelp option.
 
41
 
 
42
Options (mandatory options marked with '*'):
 
43
  -in &lt;file&gt;*        Input file  (valid formats: 'mzML')
 
44
  -out &lt;file&gt;*       Output file  (valid formats: 'mzML')
 
45
                     
 
46
Common TOPP options:
 
47
  -ini &lt;file&gt;        Use the given TOPP INI file
 
48
  -threads &lt;n&gt;       Sets the number of threads allowed to be used by the TOPP tool (default: '1')
 
49
  -write_ini &lt;file&gt;  Writes the default configuration file
 
50
  --help             Shows options
 
51
  --helphelp         Shows all options (including advanced)
 
52
 
 
53
The following configuration subsections are valid:
 
54
 - algorithm   Algorithm parameter subsection.
 
55
 
 
56
You can write an example INI file using the '-write_ini' option.
 
57
Documentation of subsection parameters can be found in the doxygen documentation or the INIFileEditor.
 
58
Have a look at the OpenMS documentation for more information.
 
59
 
 
60
</pre><p> <b>INI file documentation of this tool:</b> <div class="ini_global">
 
61
<div class="legend">
 
62
<b>Legend:</b><br>
 
63
 <div class="item item_required">required parameter</div>
 
64
 <div class="item item_advanced">advanced parameter</div>
 
65
</div>
 
66
  <div class="node"><span class="node_name">+SpectraFilterSqrtMower</span><span class="node_description">Applies thresholdfilter to peak spectra.</span></div>
 
67
    <div class="item item_advanced"><span class="item_name" style="padding-left:16px;">version</span><span class="item_value">1.11.1</span>
 
68
<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 'SpectraFilterSqrtMower'</span></div>
 
69
      <div class="item"><span class="item_name item_required" style="padding-left:24px;">in</span><span class="item_value"></span>
 
70
<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>
 
71
<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>
 
72
<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>
 
73
<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>
 
74
<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>
 
75
<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>
 
76
<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>
 
77
 </div></div><!-- contents -->
 
78
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
 
79
<TABLE width="100%" border="0">
 
80
<TR>
 
81
<TD><font color="#c0c0c0">OpenMS / TOPP release 1.11.1</font></TD>
 
82
<TD align="right"><font color="#c0c0c0">Documentation generated on Thu Nov 14 2013 11:19:24 using doxygen 1.8.5</font></TD>
 
83
</TR>
 
84
</TABLE>
 
85
</BODY>
 
86
</HTML>