]> Creatis software - CreaPhase.git/blob - octave_packages/optiminterp-0.3.3/doc-cache
Add a useful package (from Source forge) for octave
[CreaPhase.git] / octave_packages / optiminterp-0.3.3 / doc-cache
1 # Created by Octave 3.6.1, Fri Mar 30 22:42:15 2012 UTC <root@t61>
2 # name: cache
3 # type: cell
4 # rows: 3
5 # columns: 8
6 # name: <cell-element>
7 # type: sq_string
8 # elements: 1
9 # length: 19
10 example_optiminterp
11
12
13 # name: <cell-element>
14 # type: sq_string
15 # elements: 1
16 # length: 54
17  Example program of the optimal interpolation toolbox
18
19
20
21 # name: <cell-element>
22 # type: sq_string
23 # elements: 1
24 # length: 54
25  Example program of the optimal interpolation toolbox
26
27
28
29
30 # name: <cell-element>
31 # type: sq_string
32 # elements: 1
33 # length: 12
34 optiminterp1
35
36
37 # name: <cell-element>
38 # type: sq_string
39 # elements: 1
40 # length: 790
41  -- Loadable Function: [FI,VARI] = optiminterp1(X,F,VAR,LENX,M,XI)
42      Performs a local 1D-optimal interpolation (objective analysis).
43
44      Every elements in F corresponds to a data point (observation) at
45      location X,Y with the error variance VAR.
46
47      LENX is correlation length in x-direction.  M represents the
48      number of influential points.
49
50      XI is the data points where the field is interpolated. FI is the
51      interpolated field and VARI is its error variance.
52
53      The background field of the optimal interpolation is zero.  For a
54      different background field, the background field must be
55      subtracted from the observation, the difference is mapped by OI
56      onto the background grid and finally the background is added back
57      to the interpolated field.
58
59
60
61
62 # name: <cell-element>
63 # type: sq_string
64 # elements: 1
65 # length: 63
66 Performs a local 1D-optimal interpolation (objective analysis).
67
68
69
70 # name: <cell-element>
71 # type: sq_string
72 # elements: 1
73 # length: 12
74 optiminterp2
75
76
77 # name: <cell-element>
78 # type: sq_string
79 # elements: 1
80 # length: 955
81  -- Loadable Function: [FI,VARI] =
82           optiminterp2(X,Y,F,VAR,LENX,LENY,M,XI,YI)
83      Performs a local 2D-optimal interpolation (objective analysis).
84
85      Every elements in F corresponds to a data point (observation) at
86      location X,Y with the error variance VAR.
87
88      LENX and LENY are correlation length in x-direction and
89      y-direction respectively.  M represents the number of influential
90      points.
91
92      XI and YI are the data points where the field is interpolated. FI
93      is the interpolated field and VARI is its error variance.
94
95      The background field of the optimal interpolation is zero.  For a
96      different background field, the background field must be
97      subtracted from the observation, the difference is mapped by OI
98      onto the background grid and finally the background is added back
99      to the interpolated field.  The error variance of the background
100      field is assumed to have a error variance of one.
101
102
103
104
105 # name: <cell-element>
106 # type: sq_string
107 # elements: 1
108 # length: 63
109 Performs a local 2D-optimal interpolation (objective analysis).
110
111
112
113 # name: <cell-element>
114 # type: sq_string
115 # elements: 1
116 # length: 12
117 optiminterp3
118
119
120 # name: <cell-element>
121 # type: sq_string
122 # elements: 1
123 # length: 971
124  -- Loadable Function: [FI,VARI] =
125           optiminterp3(X,Y,Z,F,VAR,LENX,LENY,LENZ,M,XI,YI,ZI)
126      Performs a local 3D-optimal interpolation (objective analysis).
127
128      Every elements in F corresponds to a data point (observation) at
129      location  X, Y, Z with the error variance var
130
131      LENX,LENY and LENZ are correlation length in x-,y- and z-direction
132      respectively.  M represents the number of influential points.
133
134      XI,YI and ZI are the data points where the field is interpolated.
135      FI is the interpolated field and VARI is its error variance.
136
137      The background field of the optimal interpolation is zero.  For a
138      different background field, the background field must be
139      subtracted from the observation, the difference is mapped by OI
140      onto the background grid and finally the background is added back
141      to the interpolated field.
142
143      The error variance of the background field is assumed to have a
144      error variance of one.
145
146
147
148
149 # name: <cell-element>
150 # type: sq_string
151 # elements: 1
152 # length: 63
153 Performs a local 3D-optimal interpolation (objective analysis).
154
155
156
157 # name: <cell-element>
158 # type: sq_string
159 # elements: 1
160 # length: 12
161 optiminterp4
162
163
164 # name: <cell-element>
165 # type: sq_string
166 # elements: 1
167 # length: 1008
168  -- Loadable Function: [FI,VARI] =
169           optiminterp4(X,Y,Z,T,F,VAR,LENX,LENY,LENZ,LENT,M,XI,YI,ZI,TI)
170      Performs a local 4D-optimal interpolation (objective analysis).
171
172      Every elements in F corresponds to a data point (observation) at
173      location  X, Y, Z, T with the error variance var
174
175      LENX,LENY,LENZ and LENT are correlation length in
176      x-,y-,z-direction and time, respectively.  M represents the number
177      of influential points.
178
179      XI,YI,ZI and TI are the data points where the field is
180      interpolated. FI is the interpolated field and VARI is its error
181      variance.
182
183      The background field of the optimal interpolation is zero.  For a
184      different background field, the background field must be
185      subtracted from the observation, the difference is mapped by OI
186      onto the background grid and finally the background is added back
187      to the interpolated field.
188
189      The error variance of the background field is assumed to have a
190      error variance of one.
191
192
193
194
195 # name: <cell-element>
196 # type: sq_string
197 # elements: 1
198 # length: 63
199 Performs a local 4D-optimal interpolation (objective analysis).
200
201
202
203 # name: <cell-element>
204 # type: sq_string
205 # elements: 1
206 # length: 12
207 optiminterpn
208
209
210 # name: <cell-element>
211 # type: sq_string
212 # elements: 1
213 # length: 971
214  -- Loadable Function: [FI,VARI] =
215           optiminterpn(X,Y,...,F,VAR,LENX,LENY,...,M,XI,YI,...)
216      Performs a local nD-optimal interpolation (objective analysis).
217
218      Every elements in F corresponds to a data point (observation) at
219      location X,Y,... with the error variance VAR.
220
221      LENX,LENY,... are correlation length in x-direction
222      y-direction,... respectively.  M represents the number of
223      influential points.
224
225      XI,YI,... are the data points where the field is interpolated. FI
226      is the interpolated field and VARI is its error variance.
227
228      The background field of the optimal interpolation is zero.  For a
229      different background field, the background field must be
230      subtracted from the observation, the difference is mapped by OI
231      onto the background grid and finally the background is added back
232      to the interpolated field.  The error variance of the background
233      field is assumed to have a error variance of one.
234
235
236
237
238 # name: <cell-element>
239 # type: sq_string
240 # elements: 1
241 # length: 63
242 Performs a local nD-optimal interpolation (objective analysis).
243
244
245
246 # name: <cell-element>
247 # type: sq_string
248 # elements: 1
249 # length: 16
250 test_optiminterp
251
252
253 # name: <cell-element>
254 # type: sq_string
255 # elements: 1
256 # length: 194
257  Tests 1D, 2D and 3D optimal interpolation.
258  All tests should pass; any error indicates that either 
259  there is a bug in the optimal interpolation package or 
260  that it is incrorrectly installed.
261
262
263
264 # name: <cell-element>
265 # type: sq_string
266 # elements: 1
267 # length: 43
268  Tests 1D, 2D and 3D optimal interpolation.
269
270
271
272 # name: <cell-element>
273 # type: sq_string
274 # elements: 1
275 # length: 21
276 test_optiminterp_mult
277
278
279 # name: <cell-element>
280 # type: sq_string
281 # elements: 1
282 # length: 194
283  Tests 1D, 2D and 3D optimal interpolation.
284  All tests should pass; any error indicates that either 
285  there is a bug in the optimal interpolation package or 
286  that it is incrorrectly installed.
287
288
289
290 # name: <cell-element>
291 # type: sq_string
292 # elements: 1
293 # length: 43
294  Tests 1D, 2D and 3D optimal interpolation.
295
296
297
298
299