Blame view

generic_data/Functions/functions.xml 9.03 KB
16035364   Benjamin Renard   First commit
1
2
<?xml version="1.0"?>
<functions>
e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
    <function name="mean_(,)" args="1" kind="time">
        <prompt>input averaging time in secs</prompt>
        <info_brief>average</info_brief>
        <new_kernel>#sampling_classic</new_kernel>
    </function> 
    <function name="median_(,)" args="1" kind="time">
        <prompt>input averaging time in secs</prompt>
        <info_brief>median average</info_brief>
        <new_kernel>#median</new_kernel>
    </function>
    <function name="rms_(,)" args="1" kind="time">
        <prompt>input averaging time in secs</prompt>
        <info_brief>root mean square</info_brief>
        <new_kernel>#rms</new_kernel>
    </function>  
    <function name="min_(,)" args="1" kind="time">
        <prompt>input window time in secs</prompt>
        <info_brief>min() function</info_brief>
        <new_kernel>#min</new_kernel>
    </function> 
    <function name="max_(,)" args="1" kind="time">
        <prompt>input window time in secs</prompt>
        <info_brief>max() function</info_brief>
        <new_kernel>#max</new_kernel>
    </function>
    <function name="var_(,)" args="1" kind="time">
        <prompt>input window time in secs</prompt>
        <info_brief>variance() function</info_brief>
        <new_kernel>#var</new_kernel>
    </function>
    <function name="skew_(,)" args="1" kind="time">
        <prompt>input window time in secs</prompt>
        <info_brief>skewness() function</info_brief>
        <new_kernel>#skew</new_kernel>
    </function>
    <function name="mean_sm_(,)" args="1" kind="sliding">
        <prompt>input averaging time in secs</prompt>
        <info_brief>average</info_brief>
        <new_kernel>#sliding_average</new_kernel>
    </function> 
    <function name="rms_sm_(,)" args="1" kind="sliding">
        <prompt>input averaging time in secs</prompt>
        <info_brief>root mean square</info_brief>
        <new_kernel>#rms_sm</new_kernel>
    </function>
    <function name="min_sm_(,)" args="1" kind="sliding">
        <prompt>input window time in secs</prompt>
        <info_brief>min() function</info_brief>
        <new_kernel>#min_sm</new_kernel>
    </function> 
    <function name="max_sm_(,)" args="1" kind="sliding">
        <prompt>input window time in secs</prompt>
        <info_brief>max() function</info_brief>
        <new_kernel>#max_sm</new_kernel>
    </function>
    <function name="var_sm_(,)" args="1" kind="sliding">
        <prompt>input window time in secs</prompt>
        <info_brief>variance() function</info_brief>
        <new_kernel>#var_sm</new_kernel>
    </function>
2deb6154   Hacene SI HADJ MOHAND   function fairfiel...
63

e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
64
65
66
67
68
69
70
71
72
73
    <function name="skew_sm_(,)" args="1" kind="sliding">
        <prompt>input window time in secs</prompt>
        <info_brief>skewness() function</info_brief>
        <new_kernel>#skew_sm</new_kernel>
    </function>
    <function name="smooth_(,)" args="1" kind="sliding">
        <prompt>input averaging time in secs</prompt>
        <info_brief>smooths with a boxcar average</info_brief>
        <new_kernel>#boxcar</new_kernel>
    </function> 
2deb6154   Hacene SI HADJ MOHAND   function fairfiel...
74

e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
75
76
77
78
    <!--  <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>-->
2deb6154   Hacene SI HADJ MOHAND   function fairfiel...
79

e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
80
81
82
83
84
    <function name="shiftT_(,)" args="1" kind="amda">
        <prompt>input time interval T in secs to delay by</prompt>
        <info_brief>Delays array by T secs back (T &lt; 0) and forth (T &gt; 0))</info_brief>
        <new_kernel>#timeShift</new_kernel>
    </function>
2deb6154   Hacene SI HADJ MOHAND   function fairfiel...
85

2af1d21e   Hacene SI HADJ MOHAND   alfven ok
86
87
88
89
90
    <function name="Valfven(,)" params="2" kind="physics">
        <prompt>Alfven velocity Valfven(density[cm^⁻3], mag[nT])</prompt>
        <info_brief>Alfven velocity Valfven(density[cm^⁻3], mag[nT])</info_brief>
        <new_kernel>alfvenVelocity</new_kernel>
    </function>
2deb6154   Hacene SI HADJ MOHAND   function fairfiel...
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

    <function name="fairfield70(,)" params="3" kind="physics">
        <prompt>FAIRFIELD 1970 model of neutral sheet position Z = fairfield70(y_sm, z_sm, x_ss) 
               where y_sm and z_sm  are the solar magnetospheric coordinates of the spacecraft 
               and x_ss is geomagnetic latitude of the sun</prompt>

        <info_brief>FAIRFIELD 1970 model of neutral sheet position Z = fairfield70(y_sm, z_sm, x_ss) 
               where y_sm and z_sm  are the solar magnetospheric coordinates of the spacecraft 
               and x_ss is geomagnetic latitude of the sun</info_brief>
        <new_kernel>fairfield70</new_kernel>
    </function>

    <function name="lopez90(,)" params="4" kind="physics">
        <prompt>
            Lopez 1990 model of magnetic latitude of the neutral sheet  MLAT = lopez90(Kp, phi, R, DTA)
            where Kp is the 3-hour magnetic index, phi the magnetic local time in degrees (phi = 0° at midnight)
            R is the radial distance in RE and DTA is the dipole tilt angle 
        </prompt>
        <info_brief>
            Lopez 1990 model of magnetic latitude of the neutral sheet  MLAT = lopez90(Kp, phi, R, DTA)
            where Kp is the 3-hour magnetic index, phi the magnetic local time in degrees (phi = 0° at midnight)
            R is the radial distance in RE and DTA is the dipole tilt angle 
        </info_brief>
        <new_kernel>lopez90</new_kernel>
    </function>

e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
117
118
119
120
121
122
123
124
125
    <!-- <function name="gsegsm_()" argv="vector" kind="amda">
      <prompt/>
      <info_brief>GSE to GSM transformation</info_brief>
           <new_kernel>#framesTransformation</new_kernel>
    </function>
    <function name="gsesm_()"  argv="vector" kind="amda">
      <prompt/>
      <info_brief>GSE to SM transformation</info_brief>
    </function>-->
2deb6154   Hacene SI HADJ MOHAND   function fairfiel...
126

e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
127
128
129
130
    <function name="angle(,)" params="2" kind="vectors">
        <info_brief>Angle between two vectors</info_brief>
        <new_kernel>angle</new_kernel>
    </function>
2deb6154   Hacene SI HADJ MOHAND   function fairfiel...
131

e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
    <function name="cross(,)" params="2" kind="vectors">
        <info_brief>Cross product</info_brief>
        <new_kernel>cross</new_kernel>
    </function>

    <function name="dot(,)" params="2" kind="vectors">
        <info_brief>Dot product</info_brief>
        <new_kernel>dot</new_kernel>
    </function>

    <function name="module()" kind="vectors">
        <info_brief>Magnitude</info_brief>
        <new_kernel>magnitude</new_kernel>
    </function>
    
    <function name="abs()" kind="math">
        <info_brief>Absolute value</info_brief>
        <new_kernel>abs</new_kernel>
    </function>
    <function name="acos()" kind="math">
        <info_brief>Arc-cosine</info_brief>
        <new_kernel>acos</new_kernel>
    </function>
    <function name="alog()" kind="math">
        <info_brief>Natural logarithm</info_brief>
        <new_kernel>log</new_kernel>
    </function>
    <function name="alog10()" kind="math">
        <info_brief>Logarithm to the base 10</info_brief>
        <new_kernel>log10</new_kernel>
    </function>
    <function name="asin()" kind="math">
        <info_brief>Arc-sine</info_brief>
        <new_kernel>asin</new_kernel>
    </function>
    <function name="atan()" kind="math">
        <info_brief>Arc-tangent</info_brief>
        <new_kernel>atan</new_kernel>
    </function>
c88da604   Benjamin Renard   Fix atan2
171
    <function name="atan2(,)" params="2" kind="math">
e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
172
        <info_brief>Arc-tangent</info_brief>
c88da604   Benjamin Renard   Fix atan2
173
        <new_kernel>atan2</new_kernel>
e9cb80e5   Hacene SI HADJ MOHAND   angle between two...
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
    </function>
    <function name="ceil()" kind="math">
        <info_brief>Closest integer greater than or equal to its argument</info_brief>
        <new_kernel>Ceil</new_kernel>
    </function>
    <function name="cos()" kind="math">
        <info_brief>cosine</info_brief>
        <new_kernel>cos</new_kernel>
    </function>
    <function name="cosh()" kind="math">
        <info_brief>Hyperbolic cosine</info_brief>
        <new_kernel>cosh</new_kernel>
    </function>
    <function name="deriv_()" kind="math">
        <info_brief>deriv() function with possibly unequal point spacing</info_brief>
        <new_kernel>#deriv</new_kernel>
    </function>
    <function name="exp()" kind="math">
        <info_brief>Natural exponential function</info_brief>
        <new_kernel>exp</new_kernel>
    </function>
    <function name="fix()" kind="math">
        <info_brief>Integer</info_brief>
        <new_kernel>Fix</new_kernel>
    </function>
    <function name="floor()" kind="math">
        <info_brief>Closest integer less than or equal to its argument</info_brief>
        <new_kernel>Floor</new_kernel>
    </function>
    <function name="sign()" kind="math">
        <info_brief>Sign</info_brief>
        <new_kernel>Sign</new_kernel>
    </function>
    <function name="sin()" kind="math">
        <info_brief>Sine</info_brief>
        <new_kernel>sin</new_kernel>
    </function>
    <function name="sinh()" kind="math">
        <info_brief>Hyperbolic sine</info_brief>
        <new_kernel>sinh</new_kernel>
    </function>
    <function name="tan()" kind="math">
        <info_brief>Tangent</info_brief>
        <new_kernel>tan</new_kernel>
    </function>
    <function name="tanh()" kind="math">
        <info_brief>Hyperbolic tangent</info_brief>
        <new_kernel>tanh</new_kernel>
    </function>
    <function name="sqrt()" kind="math">
        <info_brief>Square root</info_brief>
        <new_kernel>sqrt</new_kernel>
    </function>
16035364   Benjamin Renard   First commit
227
</functions>