Blame view

test/data/functions.xml 11.4 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>
66aeb1bf   Benjamin Renard   First step to sup...
52
53
54
55
    <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
56
57
58
        <info_brief>average</info_brief>
        <new_kernel>#sliding_average</new_kernel>
    </function> 
66aeb1bf   Benjamin Renard   First step to sup...
59
60
61
62
    <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
63
64
65
        <info_brief>root mean square</info_brief>
        <new_kernel>#rms_sm</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
66
67
68
69
    <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
70
71
72
        <info_brief>min() function</info_brief>
        <new_kernel>#min_sm</new_kernel>
    </function> 
66aeb1bf   Benjamin Renard   First step to sup...
73
74
75
76
    <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
77
78
79
        <info_brief>max() function</info_brief>
        <new_kernel>#max_sm</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
80
81
82
83
    <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
84
85
86
        <info_brief>variance() function</info_brief>
        <new_kernel>#var_sm</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
87
88
89
90
    <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
91
92
93
        <info_brief>skewness() function</info_brief>
        <new_kernel>#skew_sm</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
94
95
96
97
    <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
98
99
100
101
102
103
104
        <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...
105
106
107
108
109
    <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
110
111
        <new_kernel>#timeShift</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
112
113
114
115
116
    
    <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
117
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
118
119
120
121

     <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
122
    </function>
68af7c4e   Hacene SI HADJ MOHAND   nOk 7528
123

66aeb1bf   Benjamin Renard   First step to sup...
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
    <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>
 
    <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>
    <function name="framesTransformation(,,,)" args="1" kind="frames" group="space">
	<prompts>
ea6be348   Benjamin Renard   Support arguments...
157
158
        	<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...
159
                <prompt type="boolean">The vector represent a position in space?</prompt>
66aeb1bf   Benjamin Renard   First step to sup...
160
161
162
163
	</prompts>
        <info_brief>Frames transformation</info_brief>
        <new_kernel>#framesTransformation</new_kernel>
    </function>
0ee1c50f   Benjamin Renard   Remove isPosition...
164
    <function name="GSE2GSM()" kind="frames" group="space">
86dc0e65   Benjamin Renard   Add GSE2GSM & GSM...
165
166
167
        <info_brief>GSE to GSM frame transformation</info_brief>
        <new_kernel>#GSE2GSM</new_kernel>
    </function>
0ee1c50f   Benjamin Renard   Remove isPosition...
168
    <function name="GSM2GSE()" kind="frames" group="space">
86dc0e65   Benjamin Renard   Add GSE2GSM & GSM...
169
170
171
        <info_brief>GSM to GSE frame transformation</info_brief>
        <new_kernel>#GSM2GSE</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
172
    <function name="angle(,)" args="2" kind="vectors" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
173
174
175
        <info_brief>Angle between two vectors</info_brief>
        <new_kernel>angle</new_kernel>
    </function>
68af7c4e   Hacene SI HADJ MOHAND   nOk 7528
176

66aeb1bf   Benjamin Renard   First step to sup...
177
178
179
180
    <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
181

66aeb1bf   Benjamin Renard   First step to sup...
182
    <function name="dot(,)" args="2" kind="vectors" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
183
184
185
        <info_brief>Dot product</info_brief>
        <new_kernel>dot</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
186
187
188
189
190
191
192

    <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
193
194
195
        <info_brief>Magnitude</info_brief>
        <new_kernel>magnitude</new_kernel>
    </function>
ed087564   Hacene SI HADJ MOHAND   function fairfiel...
196
    
66aeb1bf   Benjamin Renard   First step to sup...
197
    <function name="abs()" kind="math" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
198
199
200
        <info_brief>Absolute value</info_brief>
        <new_kernel>abs</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
201
    <function name="acos()" kind="math" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
202
203
204
        <info_brief>Arc-cosine</info_brief>
        <new_kernel>acos</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
205
    <function name="alog()" kind="math" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
206
207
208
        <info_brief>Natural logarithm</info_brief>
        <new_kernel>log</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
209
    <function name="alog10()" kind="math" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
210
211
212
        <info_brief>Logarithm to the base 10</info_brief>
        <new_kernel>log10</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
213
    <function name="asin()" kind="math" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
214
215
216
        <info_brief>Arc-sine</info_brief>
        <new_kernel>asin</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
217
    <function name="atan()" kind="math" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
218
219
220
        <info_brief>Arc-tangent</info_brief>
        <new_kernel>atan</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
221
    <function name="atan2(,)" args="2" kind="math" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
222
        <info_brief>Arc-tangent</info_brief>
66aeb1bf   Benjamin Renard   First step to sup...
223
        <new_kernel>atan2</new_kernel>
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
224
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
225
    <function name="ceil()" kind="math" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
226
227
228
        <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...
229
    <function name="cos()" kind="math" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
230
231
232
        <info_brief>cosine</info_brief>
        <new_kernel>cos</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
233
    <function name="cosh()" kind="math" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
234
235
236
        <info_brief>Hyperbolic cosine</info_brief>
        <new_kernel>cosh</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
237
    <function name="deriv_()" kind="math" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
238
239
240
        <info_brief>deriv() function with possibly unequal point spacing</info_brief>
        <new_kernel>#deriv</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
241
    <function name="exp()" kind="math" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
242
243
244
        <info_brief>Natural exponential function</info_brief>
        <new_kernel>exp</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
245
    <function name="fix()" kind="math" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
246
247
248
        <info_brief>Integer</info_brief>
        <new_kernel>Fix</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
249
    <function name="floor()" kind="math" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
250
251
252
        <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...
253
    <function name="sign()" kind="math" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
254
255
256
        <info_brief>Sign</info_brief>
        <new_kernel>Sign</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
257
    <function name="sin()" kind="math" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
258
259
260
        <info_brief>Sine</info_brief>
        <new_kernel>sin</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
261
    <function name="sinh()" kind="math" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
262
263
264
        <info_brief>Hyperbolic sine</info_brief>
        <new_kernel>sinh</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
265
    <function name="tan()" kind="math" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
266
267
268
        <info_brief>Tangent</info_brief>
        <new_kernel>tan</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
269
    <function name="tanh()" kind="math" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
270
271
272
        <info_brief>Hyperbolic tangent</info_brief>
        <new_kernel>tanh</new_kernel>
    </function>
66aeb1bf   Benjamin Renard   First step to sup...
273
    <function name="sqrt()" kind="math" group="math">
f02d93eb   Hacene SI HADJ MOHAND   alfven ok
274
275
276
        <info_brief>Square root</info_brief>
        <new_kernel>sqrt</new_kernel>
    </function>
0d5a1aa5   Benjamin Renard   Parser: add a fun...
277
</functions>