Blame view

test/data/functions.xml 14.3 KB
0d5a1aa5   Benjamin Renard   Parser: add a fun...
1
2
<?xml version="1.0"?>
<functions xml:id="functions">
66aeb1bf   Benjamin Renard   First step to sup...
3
4
5
6
    <function name="mean_(,)" args="1" kind="time" group="stat">
	<prompts>
        	<prompt>input averaging time in secs</prompt>
	</prompts>
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
7
8
9
        <info_brief>average</info_brief>
        <new_kernel>#sampling_classic</new_kernel>
    </function> 
66aeb1bf   Benjamin Renard   First step to sup...
10
11
12
13
    <function name="median_(,)" args="1" kind="time" group="stat">
	<prompts>
        	<prompt>input averaging time in secs</prompt>
	</prompts>
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
14
15
16
        <info_brief>median average</info_brief>
        <new_kernel>#median</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
17
18
19
20
    <function name="rms_(,)" args="1" kind="time" group="stat">
	<prompts>
        	<prompt>input averaging time in secs</prompt>
	</prompts>
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
21
22
23
        <info_brief>root mean square</info_brief>
        <new_kernel>#rms</new_kernel>
    </function>  
66aeb1bf   Benjamin Renard   First step to sup...
24
25
26
27
    <function name="min_(,)" args="1" kind="time"  group="stat">
	<prompts>
        	<prompt>input window time in secs</prompt>
	</prompts>
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
28
29
30
        <info_brief>min() function</info_brief>
        <new_kernel>#min</new_kernel>
    </function> 
66aeb1bf   Benjamin Renard   First step to sup...
31
32
33
34
    <function name="max_(,)" args="1" kind="time" group="stat">
	<prompts>
        	<prompt>input window time in secs</prompt>
	</prompts>
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
35
36
37
        <info_brief>max() function</info_brief>
        <new_kernel>#max</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
38
39
40
41
    <function name="var_(,)" args="1" kind="time" group="stat">
	<prompts>
        	<prompt>input window time in secs</prompt>
	</prompts>
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
42
43
44
        <info_brief>variance() function</info_brief>
        <new_kernel>#var</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
45
46
47
48
    <function name="skew_(,)" args="1" kind="time" group="stat">
	<prompts>
        	<prompt>input window time in secs</prompt>
	</prompts>
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
49
50
51
        <info_brief>skewness() function</info_brief>
        <new_kernel>#skew</new_kernel>
    </function>
bf7793bf   Hacene SI HADJ MOHAND   correcting kendall
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
    <function name="covariance_(,,)" args="2" kind="time" group="stat">
	<prompts>
        	<prompt>input window time in secs</prompt>
	</prompts>
        <info_brief>covariance() function for two params</info_brief>
        <new_kernel>#covariance</new_kernel>
    </function>
    <function name="pearson_(,,)" args="2" kind="time" group="stat">
	<prompts>
        	<prompt>input window time in secs</prompt>
	</prompts>
        <info_brief>Pearson coefficient of two parameters</info_brief>
        <new_kernel>#pearson</new_kernel>
    </function>
    <function name="kendall_(,,)" args="2" kind="time" group="stat">
	<prompts>
        	<prompt>input window time in secs</prompt>
	</prompts>
        <info_brief>Kendall coefficient of two parameters</info_brief>
        <new_kernel>#kendall</new_kernel>
    </function>
    <function name="spearman_(,,)" args="2" kind="time" group="stat">
	<prompts>
        	<prompt>input window time in secs</prompt>
	</prompts>
        <info_brief>Spearman coefficient of two parameters</info_brief>
        <new_kernel>#spearman</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
80
81
82
83
    <function name="mean_sm_(,)" args="1" kind="sliding" group="stat">
	<prompts>
        	<prompt>input averaging time in secs</prompt>
	</prompts>
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
84
85
86
        <info_brief>average</info_brief>
        <new_kernel>#sliding_average</new_kernel>
    </function> 
66aeb1bf   Benjamin Renard   First step to sup...
87
88
89
90
    <function name="rms_sm_(,)" args="1" kind="sliding" group="stat">
	<prompts>
        	<prompt>input averaging time in secs</prompt>
	</prompts>
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
91
92
93
        <info_brief>root mean square</info_brief>
        <new_kernel>#rms_sm</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
94
95
96
97
    <function name="min_sm_(,)" args="1" kind="sliding" group="stat">
	<prompts>
        	<prompt>input window time in secs</prompt>
	</prompts>
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
98
99
100
        <info_brief>min() function</info_brief>
        <new_kernel>#min_sm</new_kernel>
    </function> 
66aeb1bf   Benjamin Renard   First step to sup...
101
102
103
104
    <function name="max_sm_(,)" args="1" kind="sliding" group="stat">
	<prompts>
        	<prompt>input window time in secs</prompt>
	</prompts>
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
105
106
107
        <info_brief>max() function</info_brief>
        <new_kernel>#max_sm</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
108
109
110
111
    <function name="var_sm_(,)" args="1" kind="sliding" group="stat">
	<prompts>
	        <prompt>input window time in secs</prompt>
	</prompts>
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
112
113
114
        <info_brief>variance() function</info_brief>
        <new_kernel>#var_sm</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
115
116
117
118
    <function name="skew_sm_(,)" args="1" kind="sliding" group="stat">
	<prompts>
        	<prompt>input window time in secs</prompt>
	</prompts>
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
119
120
121
        <info_brief>skewness() function</info_brief>
        <new_kernel>#skew_sm</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
122
123
124
125
    <function name="smooth_(,)" args="1" kind="sliding" group="stat">
	<prompts>
        	<prompt>input averaging time in secs</prompt>
	</prompts>
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
126
127
128
129
130
131
132
        <info_brief>smooths with a boxcar average</info_brief>
        <new_kernel>#boxcar</new_kernel>
    </function> 
    <!--  <function name="shiftN_(,)" args="1" kind="amda">
      <prompt>input number of points  N to delay by</prompt>
      <info_brief>Delays array by N points back (N &lt; 0) and forth (N &gt; 0)</info_brief>
    </function>-->
66aeb1bf   Benjamin Renard   First step to sup...
133
134
135
136
137
    <function name="shiftT_(,)" args="1" kind="amda" group="space">
	<prompts>
        	<prompt>input time interval T in secs to delay by</prompt>
	</prompts>
        <info_brief>Shifts parameter by T secs back (T &lt; 0) and forth (T &gt; 0))</info_brief>
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
138
139
        <new_kernel>#timeShift</new_kernel>
    </function>
a98a1504   Hacene SI HADJ MOHAND   functions.xml upd...
140
141
142
    <function name="filter()" args="3" kind="filter" group="space">
        <default_args>,6,100</default_args>
        <info_brief>Remove Spikes: filter(param, factor,nPoints)</info_brief>
d11d1072   Hacene SI HADJ MOHAND   functions
143
144
        <new_kernel>#filter</new_kernel>
    </function>
fc7667ab   Hacene SI HADJ MOHAND   adding cain function
145
146
147
148
149
    <function name="BCain(,)" args="2" kind="model" group="space">
        <default_args>"",mag</default_args>
        <info_brief>Cain model for Mars Magnetic Field</info_brief>
        <new_kernel>#bcain</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
150
151
152
153
    <function name="vAlfven(,)" args="2" kind="physics" group="space">
        <prompt_param>density[cm^⁻3], b_magnitude[nT]</prompt_param>
        <info_brief>Alfven velocity Valfven(density[cm^⁻3], b_magnitude[nT])</info_brief>
        <new_kernel>alfvenVelocity</new_kernel>
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
154
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
155
156
157
158

     <function name="perreault78(,,)" args="3" kind="model" group="space">
        <info_brief>Perreault and Akasofu 1978 model u = perreault78(E_mag, B_mag, theta_p)</info_brief>
        <new_kernel>perreault78</new_kernel>
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
159
    </function>
68af7c4e   Hacene SI HADJ MOHAND   nOk 7528
160

66aeb1bf   Benjamin Renard   First step to sup...
161
162
163
164
165
    <function name="newell2007(,)" args="3" kind="model" group="space">
        <info_brief>NEWELL et al 2007 solar wind-magnetosphere coupling function d_phi/d_t = newell2007(mu, B_mag, theta) </info_brief>
        <new_kernel>newell2007</new_kernel>
    </function>
 
66aeb1bf   Benjamin Renard   First step to sup...
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
    <function name="fairfield70(,tilt_angle_60)" args="2" kind="model" group="space">
        <prompt_param>xyz_sm (Re), dipole tilt angle (deg)</prompt_param>
        <default_args>,tilt_angle_60</default_args>
        <info_brief>Distance (Re) from s/c location to Fairfield1970 model neutral sheet position.&lt;br/&gt;
            dZ = fairfield70(xyz_sm, tilt_angle),&lt;br/&gt; xyz_sm is the s/c SM coordinates (Re) and  tilt angle is in degrees.&lt;br/&gt; Valid for y_sm &lt; 15 Re.</info_brief>
        <new_kernel>fairfield70</new_kernel>        
    </function>

   <function name="fairfield80(,tilt_angle_60)" args="2" kind="model" group="space">
        <prompt_param>xyz_sm (Re), dipole tilt angle (deg)</prompt_param> 
        <default_args>,tilt_angle_60</default_args>
        <info_brief>Distance (Re) from s/c location to Fairfield1980 model neutral sheet position.&lt;br/&gt;
            dZ = fairfield80(xyz_sm, tilt_angle),&lt;br/&gt; xyz_sm is the s/c SM coordinates (Re) and  tilt angle is in degrees.&lt;br/&gt;</info_brief>
        <new_kernel>fairfield80</new_kernel>
    </function>
    <function name="lopez90(omni_kp,,,tilt_angle_60)" args="4" kind="model" group="space">
        <prompt_param>Kp, MLT (deg), R (Re), dipole tilt angle (deg)</prompt_param>
        <default_args>omni_kp,,,tilt_angle_60</default_args>
        <info_brief>
            Magnetic latitude of the neutral sheet (Lopez1990 model) &lt;br/&gt;   
            MLAT = lopez90(Kp, MLT, R, tilt_angle) &lt;br/&gt;
            Kp is the 3-hour magnetic index, MLT the magnetic local time in degrees (MLT = 0° at midnight)
            R is the radial distance in RE and  dipole tilt angle in degrees
        </info_brief>
        <new_kernel>lopez90</new_kernel>
    </function>
a88dbf1e   Hacene SI HADJ MOHAND   9719 ok
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
    <function name="pv_ionos_dn(,)" args="2" kind="model" group="space">
        <prompt_param></prompt_param>
        <default_args>alt(Km), sza(Radians)</default_args>
        <info_brief>
            Electron Density around Venus &lt;br/&gt;
            dn = pv_ionos_dn(alt, sza) &lt;br/&gt;
	    alt is the altitude in Km 
	    sza is the solat zenith angle in radians 
            dn is the base 10 log of the model electron density in no/cc
        </info_brief>
        <new_kernel>pv_ionos_dn</new_kernel>
    </function>
    <function name="pv_ionos_te(,)" args="2" kind="model" group="space">
        <prompt_param></prompt_param>
        <default_args>alt(Km), sza(Radians)</default_args>
        <info_brief>
            Electron temperature around Venus &lt;br/&gt;
            te = pv_ionos_dn(alt, sza) &lt;br/&gt;
            alt is the altitude in Km
            sza is the solat zenith angle in radians
            te is in log10 deg K
        </info_brief>
        <new_kernel>pv_ionos_te</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
216
217
    <function name="framesTransformation(,,,)" args="1" kind="frames" group="space">
	<prompts>
ea6be348   Benjamin Renard   Support arguments...
218
219
        	<prompt type="list" subtype="frames" default="GSM">Input frame:</prompt>
        	<prompt type="list" subtype="frames" default="GSE">Output frame:</prompt>
86dc0e65   Benjamin Renard   Add GSE2GSM & GSM...
220
                <prompt type="boolean">The vector represent a position in space?</prompt>
66aeb1bf   Benjamin Renard   First step to sup...
221
222
223
224
	</prompts>
        <info_brief>Frames transformation</info_brief>
        <new_kernel>#framesTransformation</new_kernel>
    </function>
1983d56e   Hacene SI HADJ MOHAND   adding spectrum f...
225
226
227
228
229
230
231
    <function name="fourierSpectrum(,)" args="1" kind="amda" group="space">
        <prompts>
                 <prompt type="list" subtype="spectrum" default="Centerd">Sampling type:</prompt>
        </prompts>
        <info_brief>fourier spectrum</info_brief>
        <new_kernel>#spectrum</new_kernel>
    </function>
0ee1c50f   Benjamin Renard   Remove isPosition...
232
    <function name="GSE2GSM()" kind="frames" group="space">
86dc0e65   Benjamin Renard   Add GSE2GSM & GSM...
233
234
235
        <info_brief>GSE to GSM frame transformation</info_brief>
        <new_kernel>#GSE2GSM</new_kernel>
    </function>
0ee1c50f   Benjamin Renard   Remove isPosition...
236
    <function name="GSM2GSE()" kind="frames" group="space">
86dc0e65   Benjamin Renard   Add GSE2GSM & GSM...
237
238
239
        <info_brief>GSM to GSE frame transformation</info_brief>
        <new_kernel>#GSM2GSE</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
240
    <function name="angle(,)" args="2" kind="vectors" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
241
242
243
        <info_brief>Angle between two vectors</info_brief>
        <new_kernel>angle</new_kernel>
    </function>
68af7c4e   Hacene SI HADJ MOHAND   nOk 7528
244

66aeb1bf   Benjamin Renard   First step to sup...
245
246
247
248
    <function name="cross(,)" args="2" kind="vectors" group="math">
        <info_brief>Cross product</info_brief>
        <new_kernel>cross</new_kernel>
    </function>
68af7c4e   Hacene SI HADJ MOHAND   nOk 7528
249

66aeb1bf   Benjamin Renard   First step to sup...
250
    <function name="dot(,)" args="2" kind="vectors" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
251
252
253
        <info_brief>Dot product</info_brief>
        <new_kernel>dot</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
254
255
256
257
258
259
260

    <function name="vector(,,)" args="3" kind="vectors" group="math">
        <info_brief>Build vector from components</info_brief>
        <new_kernel>vector_</new_kernel>
    </function>

    <function name="module()" kind="vectors" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
261
262
263
        <info_brief>Magnitude</info_brief>
        <new_kernel>magnitude</new_kernel>
    </function>
ed087564   Hacene SI HADJ MOHAND   function fairfiel...
264
    
66aeb1bf   Benjamin Renard   First step to sup...
265
    <function name="abs()" kind="math" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
266
267
268
        <info_brief>Absolute value</info_brief>
        <new_kernel>abs</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
269
    <function name="acos()" kind="math" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
270
271
272
        <info_brief>Arc-cosine</info_brief>
        <new_kernel>acos</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
273
    <function name="alog()" kind="math" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
274
275
276
        <info_brief>Natural logarithm</info_brief>
        <new_kernel>log</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
277
    <function name="alog10()" kind="math" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
278
279
280
        <info_brief>Logarithm to the base 10</info_brief>
        <new_kernel>log10</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
281
    <function name="asin()" kind="math" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
282
283
284
        <info_brief>Arc-sine</info_brief>
        <new_kernel>asin</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
285
    <function name="atan()" kind="math" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
286
287
288
        <info_brief>Arc-tangent</info_brief>
        <new_kernel>atan</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
289
    <function name="atan2(,)" args="2" kind="math" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
290
        <info_brief>Arc-tangent</info_brief>
66aeb1bf   Benjamin Renard   First step to sup...
291
        <new_kernel>atan2</new_kernel>
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
292
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
293
    <function name="ceil()" kind="math" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
294
295
296
        <info_brief>Closest integer greater than or equal to its argument</info_brief>
        <new_kernel>Ceil</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
297
    <function name="cos()" kind="math" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
298
299
300
        <info_brief>cosine</info_brief>
        <new_kernel>cos</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
301
    <function name="cosh()" kind="math" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
302
303
304
        <info_brief>Hyperbolic cosine</info_brief>
        <new_kernel>cosh</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
305
    <function name="deriv_()" kind="math" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
306
307
308
        <info_brief>deriv() function with possibly unequal point spacing</info_brief>
        <new_kernel>#deriv</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
309
    <function name="exp()" kind="math" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
310
311
312
        <info_brief>Natural exponential function</info_brief>
        <new_kernel>exp</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
313
    <function name="fix()" kind="math" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
314
315
316
        <info_brief>Integer</info_brief>
        <new_kernel>Fix</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
317
    <function name="floor()" kind="math" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
318
319
320
        <info_brief>Closest integer less than or equal to its argument</info_brief>
        <new_kernel>Floor</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
321
    <function name="sign()" kind="math" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
322
323
324
        <info_brief>Sign</info_brief>
        <new_kernel>Sign</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
325
    <function name="sin()" kind="math" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
326
327
328
        <info_brief>Sine</info_brief>
        <new_kernel>sin</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
329
    <function name="sinh()" kind="math" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
330
331
332
        <info_brief>Hyperbolic sine</info_brief>
        <new_kernel>sinh</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
333
    <function name="tan()" kind="math" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
334
335
336
        <info_brief>Tangent</info_brief>
        <new_kernel>tan</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
337
    <function name="tanh()" kind="math" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
338
339
340
        <info_brief>Hyperbolic tangent</info_brief>
        <new_kernel>tanh</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
341
    <function name="sqrt()" kind="math" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
342
343
344
        <info_brief>Square root</info_brief>
        <new_kernel>sqrt</new_kernel>
    </function>
bf7793bf   Hacene SI HADJ MOHAND   correcting kendall
345

0d5a1aa5   Benjamin Renard   Parser: add a fun...
346
</functions>