Mercurial > repos > gregor.m > spyboat

annotate spyboat.xml @ 5:d5a4180410c4 draft default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
"planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
author gregor.m
date Sat, 28 Nov 2020 18:50:09 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
1 <tool id="spyboat" name="SpyBOAT" version="@TOOL_VERSION@" profile="20.01" license="GPL-3.0-or-later">
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
2 <description>wavelet transforms image stacks</description>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
3 <macros>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
4 <token name="@TOOL_VERSION@">0.1.1</token>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
5 </macros>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
6 <requirements>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
7 <requirement type="package" version="@TOOL_VERSION@">spyboat</requirement>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
8 </requirements>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
9 <version_command>python '$__tool_directory__/spyboat_cli.py' --version</version_command>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
10 <command detect_errors="exit_code"><![CDATA[
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
11 ## needed for pulsar combat
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
12 cat '$__tool_directory__/output_report.py' > /dev/null &&
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
13 ## run tool
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
14 python '$__tool_directory__/spyboat_cli.py'
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
15 --input_path '$movie'
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
16 #if str($PreProc.gauss_sigma):
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
17 --gauss_sigma $PreProc.gauss_sigma
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
18 #end if
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
19 #if str($PreProc.rescale_factor):
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
20 --rescale $PreProc.rescale_factor
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
21 #end if
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
22
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
23 #if $masking.selection_mode == "create_static_mask":
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
24 --masking static
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
25 --mask_frame $masking.mask_frame
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
26 --mask_thresh $masking.mask_thresh
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
27 #else if $masking.selection_mode == "create_dynamic_mask":
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
28 --masking dynamic
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
29 --mask_thresh $masking.mask_thresh
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
30 #end if
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
31
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
32 --dt $wavana.dt
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
33 --Tmin $wavana.tmin
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
34 --Tmax $wavana.tmax
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
35 --nT $wavana.nt
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
36 #if str($wavana.tcutoff)
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
37 --Tcutoff $wavana.tcutoff
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
38 #end if
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
39 #if str($wavana.win_size):
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
40 --win_size $wavana.win_size
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
41 #end if
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
42
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
43 #if 'save_phase' in $outputs:
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
44 --phase_out '$phase_out'
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
45 #end if
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
46
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
47 #if 'save_period' in $outputs:
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
48 --period_out '$period_out'
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
49 #end if
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
50
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
51 #if 'save_power' in $outputs:
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
52 --power_out '$power_out'
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
53 #end if
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
54
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
55 #if 'save_amplitude' in $outputs:
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
56 --amplitude_out '$amplitude_out'
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
57 #end if
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
58
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
59 #if 'save_preprocessed' in $outputs:
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
60 --preprocessed_out '$preprocessed_out'
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
61 #end if
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
62
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
63 --html_fname '$html_out'
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
64 --report_img_path '$html_out.extra_files_path'
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
65
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
66 --ncpu "\${GALAXY_SLOTS:-8}"
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
67
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
68
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
69 ]]></command>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
70 <inputs>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
71 <param name="movie" type="data" format="tiff" label="Movie to analyze" help="Select a movie to wavelet analyze"/>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
72
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
73 <!--
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
74 The following Wavelet parameters must have the same numerical type as defined in the
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
75 argparse parser in spyboat_cli.py
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
76 -->
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
77 <section name="PreProc" title="Preprocessing" expanded="true">
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
78 <param argument="gauss_sigma" type="float" min="0" max="9999999" optional="true" label="Sigma"
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
79 help="Width of the Gaussian smoothing kernel, leave blank if no pre-smoothing desired" />
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
80 <param argument="rescale_factor" type="integer" value="" min="0" max="99" optional="true" label="Rescale factor"
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
81 help="Downsamples the input movie by this factor given in %, leave blank to disable downsampling" />
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
82 </section>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
83 <section name="wavana" title="Wavelet Analysis" expanded="true">
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
84 <param name="dt" type="float" value="1" min="0" max="9999999" label="Sampling interval" help="Time span between two frames" />
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
85 <param name="tmin" type="float" value="20" min="0" max="9999999" label="Smallest period" help="Lowest period for the wavelet transform" />
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
86 <param name="tmax" type="float" value="30" min="0" max="9999999" label="Largest period"
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
87 help="Largest period for the wavelet transform" />
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
88 <param name="nt" type="integer" value="150" min="0" max="9999999" label="Number of periods to scan for"
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
89 help="Determines period resolution of the Wavelet power spectra" />
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
90 <param name="tcutoff" type="float" value="40" min="0" max="9999999" label="T cutoff"
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
91 help="Cut-off-period for sinc filter detrending, a blank field disables detrending" optional="true" />
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
92 <param name="win_size" type="float" value="" min="0" max="9999999" optional="true" label="Sliding window size"
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
93 help="Window size for amplitude envelope estimation, leave blank to disable normalization" />
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
94 </section>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
95 <conditional name="masking">
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
96 <param name="selection_mode" type="select" label="Masking the output" help="Create a mask from the (blurred/rescaled) input to mask out regions without oscillations/signal in the output">
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
97 <option selected="true" value="no_masking">No masking</option>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
98 <option value="create_static_mask">Create a static mask</option>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
99 <option value="create_dynamic_mask">Create a dynamic mask</option>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
100 </param>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
101 <when value="no_masking" />
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
102 <when value="create_static_mask">
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
103 <param name="mask_frame" type="integer" value="1" min="1" max="99999" label="Create mask from frame"
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
104 help="Creates a static mask from the chosen frame of the input movie." />
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
105 <param name="mask_thresh" type="float" value="0" min="0" max="999999" label="Threshold"
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
106 help="All pixels below this threshold will be masked in the output." />
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
107 </when>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
108 <when value="create_dynamic_mask">
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
109 <param name="mask_thresh" type="float" value="0" min="0" max="999999" label="Threshold"
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
110 help="For each frame of the input, all pixels below this threshold will be masked in the output." />
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
111 </when>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
112 </conditional>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
113 <param name="outputs" type="select" optional="true" multiple="true" label="Select optional outputs" help="">
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
114 <option value="save_phase">Phase Movie</option>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
115 <option value="save_period">Period Movie</option>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
116 <option value="save_amplitude">Amplitude Movie</option>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
117 <option value="save_power">Power Movie</option>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
118 <option value="save_preprocessed">Preprocessed Movie</option>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
119 </param>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
120 </inputs>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
121
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
122 <outputs>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
123 <data name="phase_out" format="tiff" label="${movie.name[:-4]}_phase">
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
124 <filter>'save_phase' in ouputs</filter>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
125 </data>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
126 <data name="period_out" format="tiff" label="${movie.name[:-4]}_period">
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
127 <filter>'save_period' in outputs</filter>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
128 </data>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
129 <data name="power_out" format="tiff" label="${movie.name[:-4]}_power">
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
130 <filter>'save_power' in outputs</filter>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
131 </data>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
132 <data name="amplitude_out" format="tiff" label="${movie.name[:-4]}_amplitude">
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
133 <filter>'save_amplitude' in outputs</filter>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
134 </data>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
135 <data name="preprocessed_out" format="tiff" label="${movie.name[:-4]}_preproc">
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
136 <filter>'save_preprocessed' in outputs</filter>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
137 </data>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
138 <data name="html_out" format="html" label="Report ${movie.name[:-4]}" />
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
139 </outputs>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
140
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
141 <tests>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
142 <test expect_num_outputs="2">
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
143 <param name="movie" value="test-movie.tif" ftype="tiff"/>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
144 <param name="outputs" value="save_phase"/>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
145 <conditional name="masking">
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
146 <param name="selection_mode" value="no_masking" />
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
147 </conditional>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
148 <output name="phase_out" ftype="tiff">
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
149 <assert_contents>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
150 <has_size value="1764430" delta="100" />
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
151 </assert_contents>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
152 </output>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
153 <output name="html_out" file="output1.html" ftype="html"/>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
154 </test>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
155 <test expect_num_outputs="4">
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
156 <section name="wavana">
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
157 <param name="tmin" value="20"/>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
158 <param name="nt" value="150"/>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
159 <param name="tcutoff" value="40"/>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
160 </section>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
161 <conditional name="masking">
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
162 <param name="selection_mode" value="create_static_mask" />
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
163 </conditional>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
164 <param name="movie" value="test-movie.tif" ftype="tiff"/>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
165 <param name="outputs" value="save_phase,save_preprocessed,save_power"/>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
166 <output name="phase_out" ftype="tiff">
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
167 <assert_contents>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
168 <has_size value="1764430" delta="100" />
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
169 </assert_contents>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
170 </output>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
171 <output name="html_out" file="output1.html" ftype="html"/>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
172 </test>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
173 <test expect_num_outputs="4">
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
174 <section name="wavana">
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
175 <param name="tmin" value="20"/>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
176 <param name="nt" value="150"/>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
177 <param name="tcutoff" value="40"/>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
178 </section>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
179 <conditional name="masking">
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
180 <param name="selection_mode" value="create_dynamic_mask" />
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
181 </conditional>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
182 <param name="movie" value="test-movie.tif" ftype="tiff"/>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
183 <param name="outputs" value="save_phase,save_preprocessed,save_power"/>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
184 <output name="phase_out" ftype="tiff">
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
185 <assert_contents>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
186 <has_size value="1764430" delta="100" />
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
187 </assert_contents>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
188 </output>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
189 <output name="html_out" file="output1.html" ftype="html"/>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
190 </test>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
191 </tests>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
192 <help><![CDATA[
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
193 .. class:: infomark
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
194
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
195 **What it does**
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
196
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
197 -------------------
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
198
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
199 Wavelet transforms a 3d-image stack (time,Y,X) pixel by pixel along the time axis and extracts/evaluates the wavelet ridge. Removal of low-frequency trends is provided via sinc filtering.
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
200 There are four output movies generated (phase, period, amplitude and power). They have exactly the same dimensions (time,Y,X) as the (rescaled) input.
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
201
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
202 Pre-smoothing of the data with Gaussian kernels is supported and often recommendable.
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
203
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
204 To limit the number of Wavelet transformations (computing time), downscaling of the input movie resolution is recommended.
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
205 Trimming away parts of the movie with no relevant data (e.g. outer dark edges) also speeds up the processing.
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
206
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
207 If multiple channels are present in your data, extract the channel of interest beforehand (e.g. with Fiji).
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
208
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
209 **Author**: Gregor Mönke (gregor.moenke@embl.de).
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
210
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
211 **Wrapper by**: Jelle Scholtalbers (jelle.scholtalbers@embl.de).
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
212
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
213 **Know what you are doing**
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
214
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
215 .. class:: warningmark
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
216
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
217 You need to have a basic understanding of time-frequency analysis with Wavelets, find more information about the analysis strategy employed at https://github.com/tensionhead/pyBOAT or the publication cited below.
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
218
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
219 -------------------
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
220
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
221 **Parameter List**
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
222
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
223 - Sigma:
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
224 The Kernel bandwidth (in pixels) for the Gaussian kernels to use for pre-smoothing the input data. The default value of zero means that no pre-smoothing is done. Set this number to a desired kernel width to turn on pre-smoothing.
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
225
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
226 - Rescale factor:
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
227 Given in %, downsamples the spatial resolution of the input movie. This speeds up the whole analysis by a lot.
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
228
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
229 - Masking:
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
230 SpyBOAT offers 'static' and 'dynamic' masking. 'static' means that a single mask is created by thresholding from a user selected frame. 'dynamic' creates a mask for each frame by thresholding, works better for moving/expanding/shrinking oscillatory fields.
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
231
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
232 - Sampling interval:
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
233 Time passed between consecutive measurements, e.g 'an image every 10 minutes'.
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
234
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
235 - Smallest Period:
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
236 The minimal period to scan for, this is the higher (in frequency) end of the spectrum. A warning will be given during processing if the chosen value deceeds the Nyquist limit (2 times the sampling interval).
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
237
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
238 - Largest period:
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
239 The maximal period to scan for, this is the lower (in frequency) end of the spectrum. The inbuild Sinc filter will remove any periods larger than this form the data. Due to the 'roll off' of the filter, this value should be chosen generously. A warning will be given during processing if the chosen value exceeds the length of the time series.
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
240
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
241 - Number of periods to scan for:
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
242 This is the the number of convolutions computed per pixel.
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
243
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
244 Spectral resolution = ( biggest period - smallest period ) / number of periods
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
245
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
246 - Tcutoff:
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
247 The cut-off period for the sinc filter, periods larger than this one will
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
248 be removed from the signal before the transform. If no value is given,
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
249 no detrending is performed. At least a gracious cut-off of around ~3 times
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
250 the largest period to be expected is recommended.
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
251
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
252 - Sliding window size
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
253 Length (in time units, e.g. hours) of the sliding window to estimate
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
254 an amplitude envelope. The signal then gets normalized by this envelope,
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
255 meaning that all amplitudes will be around ~1 after the transform. The
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
256 advantage is that signal with strong amplitude trends will have more
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
257 meaningful Wavelet powers after normalization.
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
258
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
259
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
260 ]]></help>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
261 <citations>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
262 <citation type="doi">10.1101/2020.04.29.067744</citation>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
263 </citations>
d5a4180410c4 "planemo upload commit 7bc843096b70fe1c8fc149e69d8f87fceac4eb3b"
gregor.m
parents:
diff changeset
264 </tool>