annotate baseline_filter.xml @ 0:ba86fd127f5a draft

Uploaded
author galaxyp
date Wed, 19 Dec 2012 00:32:25 -0500
parents
children cf0d72c7b482
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
1 <tool id="openms_baseline_filter" version="0.1.0" name="Baseline Filter">
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
2 <description>
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
3 Executes the top-hat filter to remove the baseline of an MS experiment.
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
4 </description>
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
5 <requirements>
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
6 <requirement type="package">openms</requirement>
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
7 </requirements>
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
8 <command interpreter="python">
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
9 openms_wrapper.py --executable 'BaselineFilter' --config $config
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
10 </command>
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
11 <configfiles>
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
12 <configfile name="config">[simple_options]
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
13 in=${in}
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
14 out=${out}
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
15 </configfile>
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
16 </configfiles>
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
17 <inputs>
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
18 <param format="mzml" name="in" type="data" label="Input mzML"/>
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
19 </inputs>
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
20 <outputs>
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
21 <data format="mzml" name="out" />
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
22 </outputs>
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
23 <help>
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
24 **What it does**
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
25
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
26 This nonlinear filter, known as the top-hat operator in morphological mathematics (see Soille, ''Morphological Image Analysis''), is independent of the underlying baseline shape. It is able to detect an over brightness even if the environment is not uniform. The principle is based on the subtraction of a signal from its opening (erosion followed by a dilation). The size the structuring element (here a flat line) being conditioned by the width of the lineament (in our case the maximum width of a mass spectrometric peak) to be detected.
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
27
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
28 http://ftp.mi.fu-berlin.de/OpenMS/doc-1.9-official/html/TOPP_BaselineFilter.html
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
29 http://ftp.mi.fu-berlin.de/OpenMS/doc-1.9-official/html/TOPP_example_signalprocessing.html#TOPP_example_signalprocessing_parameters
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
30
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
31 **Citation**
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
32
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
33 For the underlying tool, please cite ``Marc Sturm, Andreas Bertsch, Clemens Gröpl, Andreas Hildebrandt, Rene Hussong, Eva Lange, Nico Pfeifer, Ole Schulz-Trieglaff, Alexandra Zerck, Knut Reinert, and Oliver Kohlbacher, 2008. OpenMS – an Open-Source Software Framework for Mass Spectrometry. BMC Bioinformatics 9: 163. doi:10.1186/1471-2105-9-163.``
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
34
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
35 If you use this tool in Galaxy, please cite Chilton J, et al. https://bitbucket.org/galaxyp/galaxyp-toolshed-openms
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
36 </help>
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
37 </tool>