annotate g_forest.xml @ 5:0026cd452d0e draft default tip

planemo upload commit 72cee9103c0ae4acb5794afaed179bea2c729f2c-dirty
author stevecassidy
date Sat, 11 Mar 2017 21:37:57 -0500
parents 22e59a5808e8
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
22e59a5808e8 planemo upload commit e5d2a8ba1fcf33758cdc07e0a14e86427752c968-dirty
stevecassidy
parents: 3
diff changeset
1 <tool id="g_forest" name="Compute Formants" version="0.01">
1
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
2 <description>using wrassp formant tracker</description>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
3
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
4 <requirements>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
5 <requirement type="package" version="0.1.4">r-wrassp</requirement>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
6 </requirements>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
7
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
8 <command interpreter="bash">
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
9 r_wrapper.sh $__tool_directory__/g_forest.R --args ${wavfile} ${output}
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
10 ${beginTime} ${endTime} ${windowShift} ${windowSize} ${effectiveLength}
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
11 ${nominalF1} ${gender} ${estimate} ${order} ${incrOrder} ${numFormants}
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
12 ${window} ${preemphasis}
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
13 </command>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
14
3
f188eb0b526d planemo upload commit 2d22bc12c66a3d1949d4bf4c84e7ce7c4610383c-dirty
stevecassidy
parents: 1
diff changeset
15 <stdio>
f188eb0b526d planemo upload commit 2d22bc12c66a3d1949d4bf4c84e7ce7c4610383c-dirty
stevecassidy
parents: 1
diff changeset
16 <regex match="Linux: unexpected operator"
f188eb0b526d planemo upload commit 2d22bc12c66a3d1949d4bf4c84e7ce7c4610383c-dirty
stevecassidy
parents: 1
diff changeset
17 source="stderr"
f188eb0b526d planemo upload commit 2d22bc12c66a3d1949d4bf4c84e7ce7c4610383c-dirty
stevecassidy
parents: 1
diff changeset
18 level="warning"
f188eb0b526d planemo upload commit 2d22bc12c66a3d1949d4bf4c84e7ce7c4610383c-dirty
stevecassidy
parents: 1
diff changeset
19 description="conda r-base bash bug" />
f188eb0b526d planemo upload commit 2d22bc12c66a3d1949d4bf4c84e7ce7c4610383c-dirty
stevecassidy
parents: 1
diff changeset
20 </stdio>
1
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
21
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
22 <inputs>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
23 <param name="wavfile" type="data" format="wav" label="Audio File" help="Audio file in WAV format"/>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
24 <param name="beginTime" type="integer" value="0" label="Start time for analysis (s)"/>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
25 <param name="endTime" type="integer" value="0" label="End Time for analysis (s) 0 means end of signal"/>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
26 <param name="windowShift" type="integer" value="5" label="Window Shift (ms)" help="set analysis window shift to dur ms"/>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
27 <param name="windowSize" type="integer" value="20" label="Window Size (ms)" help="set analysis window size to dur ms"/>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
28 <param name="effectiveLength" type="select" label="make window size effective rather than exact">
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
29 <option value="1" selected="true">Yes</option>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
30 <option value="0">No</option>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
31 </param>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
32 <param name="nominalF1" type="integer" value="500" label="Nominal F1 Frequency (Hz)"/>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
33 <param name="gender" type="select" label="Speaker Gender">
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
34 <option value="m" selected="true">Male</option>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
35 <option value="f">Female</option>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
36 <option value="u">Unknown</option>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
37 </param>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
38 <param name="estimate" type="select" label="Insert rough frequency estimates of missing formants (default: frequency set to zero)">
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
39 <option value="1">Yes</option>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
40 <option value="0" selected="true">No</option>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
41 </param>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
42 <param name="order" type="integer" value="0" label="analysis order (default 0 means automatic)"/>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
43 <param name="incrOrder" type="integer" value="0" label="increment/decrement analysis order"/>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
44 <param name="numFormants" type="integer" value="4" label="Number of formants"/>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
45 <param name="window" type="select">
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
46 <option value="BLACKMAN" selected="true">Blackman</option>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
47 <option value="RECTANGLE">rectangle</option>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
48 <option value="PARABOLA">parabola/Riesz/Welch</option>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
49 <option value="COS" >cosine</option>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
50 <option value="HANN" >Hann/hanning/cosine^2</option>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
51 <option value="COS_4" >cosine^4</option>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
52 <option value="HAMMING" >Hamming</option>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
53 <option value="BLACK_X" >exact Blackman</option>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
54 <option value="BLACK_M3" >min. 3-term Blackman-Nuttal</option>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
55 <option value="BLACK_M4" >min. 4-term Blackman-Nuttal</option>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
56 <option value="NUTTAL_3" >3-term Nuttal (-18 dB/oct)</option>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
57 <option value="NUTTAL_4" >4-term Nuttal (-18 dB/oct)</option>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
58 <option value="KAISER2_0">Kaiser-Bessel (alpha = 2.0)</option>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
59 <option value="KAISER3_0">Kaiser-Bessel (alpha = 3.0)</option>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
60 <option value="KAISER4_0">Kaiser-Bessel (alpha = 4.0)</option>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
61 </param>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
62 <param name="preemphasis" type="float" value="-0.8" min="-1" max="0" label="Pre-emphasis"/>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
63 </inputs>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
64
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
65 <outputs>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
66 <data name="output" format="tabular" label="#echo $wavfile.element_identifier.replace('wav', 'fm') #" />
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
67 </outputs>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
68
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
69
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
70 <tests>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
71 <test>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
72 <param name="wavfile" value="1_1119_2_22_001-ch6-speaker16.wav"/>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
73 <output name="output" file="1_1119_2_22_001-formants.dat"/>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
74 </test>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
75 </tests>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
76
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
77 <help>Calculate the formant tracks for segments of an audio file.
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
78 Raw resonance frequency and bandwidth values are obtained by root-solving of the Linear Prediction polynomial from the autocorrelation method and the Split-Levinson-Algorithm (SLA). Resonances are then classified as formants using the so-called Pisarenko frequencies (by-product of the SLA) and a formant frequeny range table derived from the nominal F1 frequency. The latter may have to be increased by about 12% for female voices (see NominalF1 and Gender options).
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
79 </help>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
80
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
81 <citations>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
82 <citation type='bibtex'>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
83 @Manual{,
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
84 title = {wrassp: an R wrapper to the ASSP Library},
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
85 author = {Lasse Bombien and Raphael Winkelmann and Michel
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
86 Scheffers},
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
87 year = {2016},
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
88 note = {R package version 0.1.4},
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
89 }
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
90 </citation>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
91 </citations>
dbcf9bc275e3 planemo upload commit 063e049d569aeb45e1008cbf044f2dad850eca3d-dirty
stevecassidy
parents:
diff changeset
92 </tool>