annotate detrend_sci.xml @ 13:0cd4026ab644 draft default tip

Deleted selected files
author jcb-mpl
date Fri, 25 Jun 2021 09:24:51 +0000
parents 3a9c0c99bb54
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
12
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
1 <tool id="V20.10_detrend_sci" name="DT" version="20.05">
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
2 <description>Detrend</description>
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
3
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
4 <requirements>
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
5 <requirement type="package" version="6.0.2" >scilab</requirement>
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
6 </requirements>
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
7
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
8 <stdio>
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
9 <exit_code range="1:" level="fatal" />
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
10 </stdio>
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
11
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
12 <command><![CDATA[
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
13 if [ ! -d /data/singularity ]; then $__root_dir__/packages/scilab-6.1.0/bin/scilab-cli -nb -quit -f $* < ${script_file}; else /usr/local/bin/singularity exec -B /data /data/singularity/scilab.sif scilab-cli -nb -quit -f $* < ${script_file}; fi
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
14 ]]>
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
15 </command>
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
16
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
17 <configfiles>
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
18 <configfile name="script_file">
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
19 lasterror(); ...
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
20 if ~isdef('pls') then ...
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
21 atomsInstall('FACT'); ...
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
22 atomsLoad('FACT'); ...
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
23 end; ...
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
24 lasterror(%f); ...
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
25 x=glx_tab2div("${Xdata.file_name}"); ...
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
26 x2=detrending(x,${degre}); ...
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
27 div2tab(x2,"${DT}"); ...
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
28 if ~isempty(lasterror(%f)) ...
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
29 write(0,lasterror()) ...
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
30 end
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
31 </configfile>
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
32 </configfiles>
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
33
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
34 <inputs>
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
35 <param name="Xdata" type="data" format="tabular" label="Select X data" help="Dataset (n x p) containing the n spectra of p variables."/>
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
36 <param name="degre" type="integer" value="2" min="0" max="5" label="Degree of the polynom"/>
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
37 </inputs>
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
38
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
39 <outputs>
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
40 <data name="DT" format="tabular" label="DT(${Xdata.name})" />
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
41 </outputs>
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
42
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
43 <tests>
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
44 <test>
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
45 <param name="Xdata" value="test_detrend_input.tabular"/>
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
46 <param name="degre" value="2" />
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
47
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
48 <output name="DT" >
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
49 <assert_contents>
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
50 <has_text text="0.000838"/>
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
51 <has_text text="-0.000194"/>
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
52 <has_text text="-0.000131"/>
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
53 <has_text text="0.001114"/>
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
54 </assert_contents>
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
55 </output>
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
56
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
57 </test>
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
58 </tests>
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
59
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
60 <help>
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
61
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
62 .. class:: warningmark
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
63
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
64 **TIP:** If your data is not TAB delimited, use *Convert format data Tools-&gt;Convert*
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
65
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
66 .. class:: infomark
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
67
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
68 **Authors** Fabien Gogé (IRSTEA), Virginie Rossard (INRA), Eric Latrille (INRA), Jean-Michel Roger (IRSTEA), Jean-Claude Boulet (INRA)
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
69
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
70
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
71 ---------------------------------------------------
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
72
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
73 =======
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
74 DETREND
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
75 =======
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
76
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
77 -----------
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
78 Description
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
79 -----------
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
80
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
81
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
82 Performs **Detrend**, a baseline correction by orthogonal projection onto a n-order polynomial.
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
83 Missing values are not allowed. This scripts uses the FACT-version module.
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
84
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
85
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
86 -----------
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
87 Input files
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
88 -----------
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
89
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
90 A matrix of numeric data with headers (tabular format) and decimal separator ".".
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
91
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
92
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
93 +--------+-------+--------+
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
94 | Name | 400 | 402 |
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
95 +========+=======+========+
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
96 |M102T645| 0.63 |0.64 |
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
97 +--------+-------+--------+
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
98 |M105T604| 0.5 |0.49 |
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
99 +--------+-------+--------+
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
100
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
101 ----------
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
102 Parameters
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
103 ----------
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
104
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
105 **Degree of the polynom**
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
106
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
107 The degree of the polynom used in the Detrend correction
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
108
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
109 ------------
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
110 Output files
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
111 ------------
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
112
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
113 **DT(input.file_name)**
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
114
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
115 A dataset containing the input file after the Detrend correction; format = tabular.
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
116
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
117 </help>
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
118
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
119 <citations>
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
120
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
121 <citation type="doi">10.1366/0003702894202201</citation>
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
122
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
123 </citations>
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
124
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
125
3a9c0c99bb54 avec scilab-6.1.0
jcb-mpl
parents:
diff changeset
126 </tool>