Blame view

generic_data/Functions/functions.xml 11 KB
16035364   Benjamin Renard   First commit
1
<?xml version="1.0"?>
3cedc95c   Benjamin Renard   Fix functions def...
2
<functions xml:id="functions">
9521cade   Elena.Budnik   rm 8441
3
    <function name="mean_(,)" args="1" kind="time" group="stat">
23f569c3   Benjamin Renard   Give the possibil...
4
5
6
	<prompts>
        	<prompt>input averaging time in secs</prompt>
	</prompts>
e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
7
8
9
        <info_brief>average</info_brief>
        <new_kernel>#sampling_classic</new_kernel>
    </function> 
9521cade   Elena.Budnik   rm 8441
10
    <function name="median_(,)" args="1" kind="time" group="stat">
23f569c3   Benjamin Renard   Give the possibil...
11
12
13
	<prompts>
        	<prompt>input averaging time in secs</prompt>
	</prompts>
e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
14
15
16
        <info_brief>median average</info_brief>
        <new_kernel>#median</new_kernel>
    </function>
9521cade   Elena.Budnik   rm 8441
17
    <function name="rms_(,)" args="1" kind="time" group="stat">
23f569c3   Benjamin Renard   Give the possibil...
18
19
20
	<prompts>
        	<prompt>input averaging time in secs</prompt>
	</prompts>
e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
21
22
23
        <info_brief>root mean square</info_brief>
        <new_kernel>#rms</new_kernel>
    </function>  
9521cade   Elena.Budnik   rm 8441
24
    <function name="min_(,)" args="1" kind="time"  group="stat">
23f569c3   Benjamin Renard   Give the possibil...
25
26
27
	<prompts>
        	<prompt>input window time in secs</prompt>
	</prompts>
e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
28
29
30
        <info_brief>min() function</info_brief>
        <new_kernel>#min</new_kernel>
    </function> 
9521cade   Elena.Budnik   rm 8441
31
    <function name="max_(,)" args="1" kind="time" group="stat">
23f569c3   Benjamin Renard   Give the possibil...
32
33
34
	<prompts>
        	<prompt>input window time in secs</prompt>
	</prompts>
e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
35
36
37
        <info_brief>max() function</info_brief>
        <new_kernel>#max</new_kernel>
    </function>
9521cade   Elena.Budnik   rm 8441
38
    <function name="var_(,)" args="1" kind="time" group="stat">
23f569c3   Benjamin Renard   Give the possibil...
39
40
41
	<prompts>
        	<prompt>input window time in secs</prompt>
	</prompts>
e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
42
43
44
        <info_brief>variance() function</info_brief>
        <new_kernel>#var</new_kernel>
    </function>
9521cade   Elena.Budnik   rm 8441
45
    <function name="skew_(,)" args="1" kind="time" group="stat">
23f569c3   Benjamin Renard   Give the possibil...
46
47
48
	<prompts>
        	<prompt>input window time in secs</prompt>
	</prompts>
e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
49
50
51
        <info_brief>skewness() function</info_brief>
        <new_kernel>#skew</new_kernel>
    </function>
9521cade   Elena.Budnik   rm 8441
52
    <function name="mean_sm_(,)" args="1" kind="sliding" group="stat">
23f569c3   Benjamin Renard   Give the possibil...
53
54
55
	<prompts>
        	<prompt>input averaging time in secs</prompt>
	</prompts>
e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
56
57
58
        <info_brief>average</info_brief>
        <new_kernel>#sliding_average</new_kernel>
    </function> 
9521cade   Elena.Budnik   rm 8441
59
    <function name="rms_sm_(,)" args="1" kind="sliding" group="stat">
23f569c3   Benjamin Renard   Give the possibil...
60
61
62
	<prompts>
        	<prompt>input averaging time in secs</prompt>
	</prompts>
e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
63
64
65
        <info_brief>root mean square</info_brief>
        <new_kernel>#rms_sm</new_kernel>
    </function>
9521cade   Elena.Budnik   rm 8441
66
    <function name="min_sm_(,)" args="1" kind="sliding" group="stat">
23f569c3   Benjamin Renard   Give the possibil...
67
68
69
	<prompts>
        	<prompt>input window time in secs</prompt>
	</prompts>
e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
70
71
72
        <info_brief>min() function</info_brief>
        <new_kernel>#min_sm</new_kernel>
    </function> 
9521cade   Elena.Budnik   rm 8441
73
    <function name="max_sm_(,)" args="1" kind="sliding" group="stat">
23f569c3   Benjamin Renard   Give the possibil...
74
75
76
	<prompts>
        	<prompt>input window time in secs</prompt>
	</prompts>
e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
77
78
79
        <info_brief>max() function</info_brief>
        <new_kernel>#max_sm</new_kernel>
    </function>
9521cade   Elena.Budnik   rm 8441
80
    <function name="var_sm_(,)" args="1" kind="sliding" group="stat">
23f569c3   Benjamin Renard   Give the possibil...
81
82
83
	<prompts>
	        <prompt>input window time in secs</prompt>
	</prompts>
e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
84
85
86
        <info_brief>variance() function</info_brief>
        <new_kernel>#var_sm</new_kernel>
    </function>
9521cade   Elena.Budnik   rm 8441
87
    <function name="skew_sm_(,)" args="1" kind="sliding" group="stat">
23f569c3   Benjamin Renard   Give the possibil...
88
89
90
	<prompts>
        	<prompt>input window time in secs</prompt>
	</prompts>
e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
91
92
93
        <info_brief>skewness() function</info_brief>
        <new_kernel>#skew_sm</new_kernel>
    </function>
9521cade   Elena.Budnik   rm 8441
94
    <function name="smooth_(,)" args="1" kind="sliding" group="stat">
23f569c3   Benjamin Renard   Give the possibil...
95
96
97
	<prompts>
        	<prompt>input averaging time in secs</prompt>
	</prompts>
e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
98
99
100
        <info_brief>smooths with a boxcar average</info_brief>
        <new_kernel>#boxcar</new_kernel>
    </function> 
e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
101
102
103
104
    <!--  <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>-->
9521cade   Elena.Budnik   rm 8441
105
    <function name="shiftT_(,)" args="1" kind="amda" group="space">
23f569c3   Benjamin Renard   Give the possibil...
106
107
108
	<prompts>
        	<prompt>input time interval T in secs to delay by</prompt>
	</prompts>
078e7658   Elena.Budnik   functions.xml fai...
109
        <info_brief>Shifts parameter by T secs back (T &lt; 0) and forth (T &gt; 0))</info_brief>
e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
110
111
        <new_kernel>#timeShift</new_kernel>
    </function>
2d2852a1   Elena.Budnik   function prompt, ...
112
    
9521cade   Elena.Budnik   rm 8441
113
    <function name="vAlfven(,)" args="2" kind="physics" group="space">
2d2852a1   Elena.Budnik   function prompt, ...
114
115
        <prompt_param>density[cm^⁻3], b_magnitude[nT]</prompt_param>
        <info_brief>Alfven velocity Valfven(density[cm^⁻3], b_magnitude[nT])</info_brief>
2af1d21e   Hacene SI HADJ MOHAND   alfven ok
116
117
        <new_kernel>alfvenVelocity</new_kernel>
    </function>
2deb6154   Hacene SI HADJ MOHAND   function fairfiel...
118

9521cade   Elena.Budnik   rm 8441
119
     <function name="perreault78(,,)" args="3" kind="model" group="space">
cf6992b3   Hacene SI HADJ MOHAND   fairfield70 et fa...
120
121
122
        <info_brief>Perreault and Akasofu 1978 model u = perreault78(E_mag, B_mag, theta_p)</info_brief>
        <new_kernel>perreault78</new_kernel>
    </function>
2deb6154   Hacene SI HADJ MOHAND   function fairfiel...
123

9521cade   Elena.Budnik   rm 8441
124
    <function name="newell2007(,)" args="3" kind="model" group="space">
cf6992b3   Hacene SI HADJ MOHAND   fairfield70 et fa...
125
126
127
        <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>
078e7658   Elena.Budnik   functions.xml fai...
128
 
9521cade   Elena.Budnik   rm 8441
129
    <function name="fairfield70(,tilt_angle_60)" args="2" kind="model" group="space">
4dadc8ac   Elena.Budnik   rm 8444 +
130
131
        <prompt_param>xyz_sm (Re), dipole tilt angle (deg)</prompt_param>
        <default_args>,tilt_angle_60</default_args>
078e7658   Elena.Budnik   functions.xml fai...
132
133
        <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>
4dadc8ac   Elena.Budnik   rm 8444 +
134
        <new_kernel>fairfield70</new_kernel>        
2deb6154   Hacene SI HADJ MOHAND   function fairfiel...
135
136
    </function>

9521cade   Elena.Budnik   rm 8441
137
   <function name="fairfield80(,tilt_angle_60)" args="2" kind="model" group="space">
2d2852a1   Elena.Budnik   function prompt, ...
138
139
        <prompt_param>xyz_sm (Re), dipole tilt angle (deg)</prompt_param> 
        <default_args>,tilt_angle_60</default_args>
078e7658   Elena.Budnik   functions.xml fai...
140
141
        <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>
cf6992b3   Hacene SI HADJ MOHAND   fairfield70 et fa...
142
143
        <new_kernel>fairfield80</new_kernel>
    </function>
9521cade   Elena.Budnik   rm 8441
144
    <function name="lopez90(omni_kp,,,tilt_angle_60)" args="4" kind="model" group="space">
2d2852a1   Elena.Budnik   function prompt, ...
145
146
        <prompt_param>Kp, MLT (deg), R (Re), dipole tilt angle (deg)</prompt_param>
        <default_args>omni_kp,,,tilt_angle_60</default_args>
2deb6154   Hacene SI HADJ MOHAND   function fairfiel...
147
        <info_brief>
1bb6d620   Elena.Budnik   help homogene pou...
148
149
            Magnetic latitude of the neutral sheet (Lopez1990 model) &lt;br/&gt;   
            MLAT = lopez90(Kp, MLT, R, tilt_angle) &lt;br/&gt;
03ff71b2   Elena.Budnik   typo
150
            Kp is the 3-hour magnetic index, MLT the magnetic local time in degrees (MLT = 0° at midnight)
1bb6d620   Elena.Budnik   help homogene pou...
151
            R is the radial distance in RE and  dipole tilt angle in degrees
2deb6154   Hacene SI HADJ MOHAND   function fairfiel...
152
153
        </info_brief>
        <new_kernel>lopez90</new_kernel>
cf6992b3   Hacene SI HADJ MOHAND   fairfield70 et fa...
154
    </function>
23f569c3   Benjamin Renard   Give the possibil...
155
156
157
158
159
160
161
    <function name="framesTransformation(,,,)" args="1" kind="frames" group="space">
	<prompts>
        	<prompt type="list" subtype="frames">Input frame:</prompt>
        	<prompt type="list" subtype="frames">Output frame:</prompt>
                <prompt type="boolean">Transform a position?</prompt>
	</prompts>
        <info_brief>Frames transformation</info_brief>
078e7658   Elena.Budnik   functions.xml fai...
162
        <new_kernel>#framesTransformation</new_kernel>
23f569c3   Benjamin Renard   Give the possibil...
163
    </function>
9521cade   Elena.Budnik   rm 8441
164
    <function name="angle(,)" args="2" kind="vectors" group="math">
e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
165
166
167
        <info_brief>Angle between two vectors</info_brief>
        <new_kernel>angle</new_kernel>
    </function>
2deb6154   Hacene SI HADJ MOHAND   function fairfiel...
168

9521cade   Elena.Budnik   rm 8441
169
    <function name="cross(,)" args="2" kind="vectors" group="math">
e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
170
171
172
173
        <info_brief>Cross product</info_brief>
        <new_kernel>cross</new_kernel>
    </function>

9521cade   Elena.Budnik   rm 8441
174
    <function name="dot(,)" args="2" kind="vectors" group="math">
e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
175
176
177
178
        <info_brief>Dot product</info_brief>
        <new_kernel>dot</new_kernel>
    </function>

9521cade   Elena.Budnik   rm 8441
179
    <function name="vector(,,)" args="3" kind="vectors" group="math">
33164824   Benjamin Renard   Add vector functi...
180
181
182
183
        <info_brief>Build vector from components</info_brief>
        <new_kernel>vector_</new_kernel>
    </function>

9521cade   Elena.Budnik   rm 8441
184
    <function name="module()" kind="vectors" group="math">
e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
185
186
187
188
        <info_brief>Magnitude</info_brief>
        <new_kernel>magnitude</new_kernel>
    </function>
    
9521cade   Elena.Budnik   rm 8441
189
    <function name="abs()" kind="math" group="math">
e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
190
191
192
        <info_brief>Absolute value</info_brief>
        <new_kernel>abs</new_kernel>
    </function>
9521cade   Elena.Budnik   rm 8441
193
    <function name="acos()" kind="math" group="math">
e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
194
195
196
        <info_brief>Arc-cosine</info_brief>
        <new_kernel>acos</new_kernel>
    </function>
9521cade   Elena.Budnik   rm 8441
197
    <function name="alog()" kind="math" group="math">
e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
198
199
200
        <info_brief>Natural logarithm</info_brief>
        <new_kernel>log</new_kernel>
    </function>
9521cade   Elena.Budnik   rm 8441
201
    <function name="alog10()" kind="math" group="math">
e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
202
203
204
        <info_brief>Logarithm to the base 10</info_brief>
        <new_kernel>log10</new_kernel>
    </function>
9521cade   Elena.Budnik   rm 8441
205
    <function name="asin()" kind="math" group="math">
e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
206
207
208
        <info_brief>Arc-sine</info_brief>
        <new_kernel>asin</new_kernel>
    </function>
9521cade   Elena.Budnik   rm 8441
209
    <function name="atan()" kind="math" group="math">
e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
210
211
212
        <info_brief>Arc-tangent</info_brief>
        <new_kernel>atan</new_kernel>
    </function>
9521cade   Elena.Budnik   rm 8441
213
    <function name="atan2(,)" args="2" kind="math" group="math">
e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
214
        <info_brief>Arc-tangent</info_brief>
c88da604   Benjamin Renard   Fix atan2
215
        <new_kernel>atan2</new_kernel>
e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
216
    </function>
9521cade   Elena.Budnik   rm 8441
217
    <function name="ceil()" kind="math" group="math">
e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
218
219
220
        <info_brief>Closest integer greater than or equal to its argument</info_brief>
        <new_kernel>Ceil</new_kernel>
    </function>
9521cade   Elena.Budnik   rm 8441
221
    <function name="cos()" kind="math" group="math">
e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
222
223
224
        <info_brief>cosine</info_brief>
        <new_kernel>cos</new_kernel>
    </function>
9521cade   Elena.Budnik   rm 8441
225
    <function name="cosh()" kind="math" group="math">
e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
226
227
228
        <info_brief>Hyperbolic cosine</info_brief>
        <new_kernel>cosh</new_kernel>
    </function>
9521cade   Elena.Budnik   rm 8441
229
    <function name="deriv_()" kind="math" group="math">
e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
230
231
232
        <info_brief>deriv() function with possibly unequal point spacing</info_brief>
        <new_kernel>#deriv</new_kernel>
    </function>
9521cade   Elena.Budnik   rm 8441
233
    <function name="exp()" kind="math" group="math">
e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
234
235
236
        <info_brief>Natural exponential function</info_brief>
        <new_kernel>exp</new_kernel>
    </function>
9521cade   Elena.Budnik   rm 8441
237
    <function name="fix()" kind="math" group="math">
e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
238
239
240
        <info_brief>Integer</info_brief>
        <new_kernel>Fix</new_kernel>
    </function>
9521cade   Elena.Budnik   rm 8441
241
    <function name="floor()" kind="math" group="math">
e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
242
243
244
        <info_brief>Closest integer less than or equal to its argument</info_brief>
        <new_kernel>Floor</new_kernel>
    </function>
9521cade   Elena.Budnik   rm 8441
245
    <function name="sign()" kind="math" group="math">
e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
246
247
248
        <info_brief>Sign</info_brief>
        <new_kernel>Sign</new_kernel>
    </function>
9521cade   Elena.Budnik   rm 8441
249
    <function name="sin()" kind="math" group="math">
e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
250
251
252
        <info_brief>Sine</info_brief>
        <new_kernel>sin</new_kernel>
    </function>
9521cade   Elena.Budnik   rm 8441
253
    <function name="sinh()" kind="math" group="math">
e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
254
255
256
        <info_brief>Hyperbolic sine</info_brief>
        <new_kernel>sinh</new_kernel>
    </function>
9521cade   Elena.Budnik   rm 8441
257
    <function name="tan()" kind="math" group="math">
e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
258
259
260
        <info_brief>Tangent</info_brief>
        <new_kernel>tan</new_kernel>
    </function>
9521cade   Elena.Budnik   rm 8441
261
    <function name="tanh()" kind="math" group="math">
e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
262
263
264
        <info_brief>Hyperbolic tangent</info_brief>
        <new_kernel>tanh</new_kernel>
    </function>
9521cade   Elena.Budnik   rm 8441
265
    <function name="sqrt()" kind="math" group="math">
e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
266
267
268
        <info_brief>Square root</info_brief>
        <new_kernel>sqrt</new_kernel>
    </function>
16035364   Benjamin Renard   First commit
269
</functions>