Context Navigation

source: trunk/SRC/Documentation/idldoc_assistant_output/Interpolation/file_interp.html @ 338

Last change on this file since 338 was 338, checked in by smasson, 16 years ago
update documentation
File size: 21.3 KB

Line
1
2
3	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4	<head>
5	<title>file_interp.pro (SAXO Documentation Assistant)</title>
6	</head>
7
8	<body text="#000000" bgcolor="#FFFFFF">
9
10
11	<!-- Navbar template takes a structure with the following fields:
12	overview_href :
13	overview_selected :
14	dir_overview_href :
15	dir_overview_selected :
16	categories_href :
17	categories_selected :
18	index_href :
19	index_selected :
20	search_href :
21	search_selected :
22	file_selected :
23	source_href :
24	source_selected :
25	help_href :
26	help_selected :
27	etc_selected :
28
29	prev_file_href :
30	next_file_href :
31
32	view_single_page_href :
33	view_frames_href :
34
35	summary_fields_href :
36	summary_routine_href :
37	details_routine_href :
38
39	title :
40	subtitle :
41	user :
42	-->
43
44
45	<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46	<tr>
47	<td width="10%">
48	<a href="extrapsmooth.html"><img src="./../prev.gif" border="0" alt="Previous"></a></td>
49	<td width="80%" align="center" valign="center">
50	<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../home.html">Overview</a></font></td>
51	<td width="10%" align="right">
52	<a href="fromirr.html"><img src="./../next.gif" border="0" alt="Next"></a></td>
53	</tr>
54	</table>
55
56
57	<h1><font size="-2">Interpolation/</font></h1>
58	<h2>file_interp.pro</h2>
59
60	<dl>
61	</dl>
62
63
64	interpolate a NetCDF file from a grid to another (both regular or not)
65
66
67
68
69
70	<a name="#_file_interp"></a>
71
72	<h2>file_interp <font size="-1" color="#006633">
73	Interpolation, NetCDF
74	</font></h2>
75
76	<p><font face="Courier">file_interp<i>, <a href="#_file_interp_keyword_filein">filein</a>, <a href="#_file_interp_keyword_fileout">fileout</a>, <a href="#_file_interp_keyword_gridout">gridout</a></i>, <a href="#_file_interp_keyword_GRIDIN">GRIDIN</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_MASKIN">MASKIN</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_MASKOUT">MASKOUT</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_KEEP">KEEP</a>=<i>string array</i>, <a href="#_file_interp_keyword_REMOVE">REMOVE</a>=<i>string array</i>, <a href="#_file_interp_keyword_METHOD">METHOD</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_SMOOTH">SMOOTH</a>=<i>scalar 0 or 1</i>, <a href="#_file_interp_keyword_SET_XDIMNAME">SET_XDIMNAME</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_SET_YDIMNAME">SET_YDIMNAME</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_SET_XAXISNAME">SET_XAXISNAME</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_SET_YAXISNAME">SET_YAXISNAME</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_INMASKNAME">INMASKNAME</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_ININVMASK">ININVMASK</a>=<i>scalar: 0 or 1</i>, <a href="#_file_interp_keyword_INUSEASMASK">INUSEASMASK</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_INMISSING_VALUE">INMISSING_VALUE</a>=<i>scalar</i>, <a href="#_file_interp_keyword_INADDSCL_BEFORE">INADDSCL_BEFORE</a>=<i>scalar: 0 or 1</i>, <a href="#_file_interp_keyword_OUTMASKNAME">OUTMASKNAME</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_OUTINVMASK">OUTINVMASK</a>=<i>scalar: 0 or 1</i>, <a href="#_file_interp_keyword_OUTUSEASMASK">OUTUSEASMASK</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_OUTMISSING_VALUE">OUTMISSING_VALUE</a>=<i>scalar</i>, <a href="#_file_interp_keyword_OUTADDSCL_BEFORE">OUTADDSCL_BEFORE</a>=<i>scalar: 0 or 1</i>, <a href="#_file_interp_keyword_NAN_VALUE">NAN_VALUE</a>=<i>scalar</i>, <a href="#_file_interp_keyword_WEIG">WEIG</a>=<i>2d array or variable name</i>, <a href="#_file_interp_keyword_ADDR">ADDR</a>=<i>2d array or variable name</i>, <a href="#_file_interp_keyword_INXAXISNAME">INXAXISNAME</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_INYAXISNAME">INYAXISNAME</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_OUTXAXISNAME">OUTXAXISNAME</a>=<i>scalar string</i>, <a href="#_file_interp_keyword_OUTYAXISNAME">OUTYAXISNAME</a>=<i>scalar string</i>, <a href="#_file_interp_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i></font></p>
77
78
79
80
81
82
83
84	<h3>Parameters</h3>
85
86
87	<a name="#_file_interp_keyword_filein"></a>
88	<h4>filein
89	<font size="-1" color="#006633">in</font>
90
91
92
93
94	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
95
96
97	</h4>
98
99
100	input file name (must exist)
101
102
103
104	<a name="#_file_interp_keyword_fileout"></a>
105	<h4>fileout
106	<font size="-1" color="#006633">in</font>
107
108
109
110
111	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
112
113
114	</h4>
115
116
117	output file name (will be overwritten if already exist)
118
119
120
121	<a name="#_file_interp_keyword_gridout"></a>
122	<h4>gridout
123	<font size="-1" color="#006633">in</font>
124
125
126
127
128	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
129
130
131	</h4>
132
133
134	output grid file name (must exist and must contain the
135	longitude and latitude axis as 1D or 2D arrays)
136
137
138
139
140
141	<h3>Keywords</h3>
142
143
144	<a name="#_file_interp_keyword_GRIDIN"></a>
145	<h4>GRIDIN
146
147
148
149
150
151	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
152	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>set to filein</i></font>
153
154	</h4>
155
156
157	define the input grid file name. It must exist and must contain the
158	longitude and latitude axis as 1D or 2D arrays. Useful if
159	filein file doesn't contain longitude and latitude axis
160
161
162	<a name="#_file_interp_keyword_MASKIN"></a>
163	<h4>MASKIN
164
165
166
167
168
169	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
170	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>set to gridin</i></font>
171
172	</h4>
173
174
175	define the input mask file name. It must exist. The mask will be
176	determined through <a href="..//ReadWrite/ncdf_getmask.html">ncdf_getmask</a> according to the keywords
177	inmaskname, ininvmask, inuseasmask, inmissing_value, inaddscl_before
178	(see below)
179
180
181	<a name="#_file_interp_keyword_MASKOUT"></a>
182	<h4>MASKOUT
183
184
185
186
187
188	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
189	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>set to gridout</i></font>
190
191	</h4>
192
193
194	define the output mask file name. It must exist. The mask will be
195	determined through <a href="..//ReadWrite/ncdf_getmask.html">ncdf_getmask</a> according to the keywords
196	outmaskname, outinvmask, outuseasmask, outmissing_value,
197	outaddscl_before (see bellow)
198
199
200	<a name="#_file_interp_keyword_KEEP"></a>
201	<h4>KEEP
202
203
204
205
206
207	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string array</i></font>
208	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>all variables</i></font>
209
210	</h4>
211
212
213	array defining the name of the variables that must be kept in the
214	output file
215
216
217	<a name="#_file_interp_keyword_REMOVE"></a>
218	<h4>REMOVE
219
220
221
222
223
224	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string array</i></font>
225	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>empty</i></font>
226
227	</h4>
228
229
230	array defining the name of the variables that will be removed in the
231	output file
232
233
234	<a name="#_file_interp_keyword_METHOD"></a>
235	<h4>METHOD
236
237
238
239
240
241	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
242	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>'bilinear'</i></font>
243
244	</h4>
245
246
247	interpolation method: can be only 'bilinear' (or 'imoms3' if the input grid
248	is a "regular" grid). A "regular/rectangular grid" is defined as a
249	grid for which each longitude lines have the same latitude and each
250	latitude columns have the same longitude.
251
252
253	<a name="#_file_interp_keyword_SMOOTH"></a>
254	<h4>SMOOTH
255
256
257
258
259
260	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar 0 or 1</i></font>
261	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
262
263	</h4>
264
265
266	activate to use <a href="..//Interpolation/extrapsmooth.html">extrapsmooth</a> instead of
267	<a href="..//Interpolation/extrapolate.html">extrapolate</a> when extrapolating input data over masked
268	points.
269
270
271	<a name="#_file_interp_keyword_SET_XDIMNAME"></a>
272	<h4>SET_XDIMNAME
273
274
275
276
277
278	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
279	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>not used</i></font>
280
281	</h4>
282
283
284	used to defined the name of x dimension in filein input file when
285	gridin keyword is used and when the x dimension name is not the same
286	in filein and gridin files. By default, we assume both file have the
287	same x dimension name.
288
289
290	<a name="#_file_interp_keyword_SET_YDIMNAME"></a>
291	<h4>SET_YDIMNAME
292
293
294
295
296
297	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
298	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>not used</i></font>
299
300	</h4>
301
302
303	same as set_xdimname but for y dimension
304
305
306	<a name="#_file_interp_keyword_SET_XAXISNAME"></a>
307	<h4>SET_XAXISNAME
308
309
310
311
312
313	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
314	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>not used</i></font>
315
316	</h4>
317
318
319	used to defined the name of the variable containing the x axis in
320	filein input file when gridin keyword is used and when its variable
321	containing the x axis name is not the same. By default, we assume
322	both file have the same x axis name. Not that if filein includes x
323	axis there is no point to use gridin
324
325
326	<a name="#_file_interp_keyword_SET_YAXISNAME"></a>
327	<h4>SET_YAXISNAME
328
329
330
331
332
333	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
334	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>not used</i></font>
335
336	</h4>
337
338
339	same as set_xaxisname but for y dimension
340
341
342	<a name="#_file_interp_keyword_INMASKNAME"></a>
343	<h4>INMASKNAME
344
345
346
347
348
349	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
350	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>not used</i></font>
351
352	</h4>
353
354
355	A string giving the name of the variable in the file maskin that
356	contains the land/sea mask
357
358
359	<a name="#_file_interp_keyword_ININVMASK"></a>
360	<h4>ININVMASK
361
362
363
364
365
366	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font>
367	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
368
369	</h4>
370
371
372	Inverse the land/sea mask of the input mask file maskin (that should
373	have 0/1 values for land/sea)
374
375
376	<a name="#_file_interp_keyword_INUSEASMASK"></a>
377	<h4>INUSEASMASK
378
379
380
381
382
383	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
384
385
386	</h4>
387
388
389	A string giving the name of the variable in the input mask file maskin
390	that will be used to build the land/sea mask. In this case the
391	mask is based on the first record (if record dimension
392	exists). The mask is build according to :
393	1 the keyword missing_value if existing
394	2 the attribute 'missing_value' if existing
395	3 NaN values if existing
396
397
398	<a name="#_file_interp_keyword_INMISSING_VALUE"></a>
399	<h4>INMISSING_VALUE
400
401
402
403
404
405	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font>
406
407
408	</h4>
409
410
411	To define (or redefine if the attribute is already existing) the
412	missing values used by INUSEASMASK keyword
413
414
415	<a name="#_file_interp_keyword_INADDSCL_BEFORE"></a>
416	<h4>INADDSCL_BEFORE
417
418
419
420
421
422	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font>
423	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
424
425	</h4>
426
427
428	put 1 to apply add_offset and scale factor on data before looking for
429	missing values when using INUSEASMASK keyword
430
431
432	<a name="#_file_interp_keyword_OUTMASKNAME"></a>
433	<h4>OUTMASKNAME
434
435
436
437
438
439	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
440	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>not used</i></font>
441
442	</h4>
443
444
445	same as inmaskname but for output mask file maskout
446
447
448	<a name="#_file_interp_keyword_OUTINVMASK"></a>
449	<h4>OUTINVMASK
450
451
452
453
454
455	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font>
456	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
457
458	</h4>
459
460
461	same as ininvmask but for output mask file maskout
462
463
464	<a name="#_file_interp_keyword_OUTUSEASMASK"></a>
465	<h4>OUTUSEASMASK
466
467
468
469
470
471	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
472
473
474	</h4>
475
476
477	same as inuseasmask but for output mask file maskout
478
479
480	<a name="#_file_interp_keyword_OUTMISSING_VALUE"></a>
481	<h4>OUTMISSING_VALUE
482
483
484
485
486
487	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font>
488
489
490	</h4>
491
492
493	same as inmissing_value but for output mask file maskout
494
495
496	<a name="#_file_interp_keyword_OUTADDSCL_BEFORE"></a>
497	<h4>OUTADDSCL_BEFORE
498
499
500
501
502
503	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font>
504	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
505
506	</h4>
507
508
509	same as inaddscl_before but for output mask file maskout
510
511
512	<a name="#_file_interp_keyword_NAN_VALUE"></a>
513	<h4>NAN_VALUE
514
515
516
517
518
519	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font>
520	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>not used</i></font>
521
522	</h4>
523
524
525	define the missing value in input data (missing values are treated
526	like masked values and will be filled with extrapolation before
527	interpolation).
528
529
530	<a name="#_file_interp_keyword_WEIG"></a>
531	<h4>WEIG
532
533
534
535
536
537	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array or variable name</i></font>
538
539
540	</h4>
541
542
543	(see ADDR)
544
545
546	<a name="#_file_interp_keyword_ADDR"></a>
547	<h4>ADDR
548
549
550
551
552
553	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array or variable name</i></font>
554
555
556	</h4>
557
558
559	1) at the first call of file_interp:
560	This keyword can be set to a named variable (undefined or equal to
561	0) into which the addresses used to perform the interpolation will
562	be copied when the current routine exits.
563	2) Next, once this keyword is set to a defined 2d array, it is used
564	to bypass the computation of the weights and addresses used to
565	perform the interpolation. In this case, interpolation is much
566	faster
567
568
569	<a name="#_file_interp_keyword_INXAXISNAME"></a>
570	<h4>INXAXISNAME
571
572
573
574
575
576	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
577	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>'x', 'longitude', 'nav_lon', 'lon', 'lon_rho' or 'NbLongitudes'</i></font>
578
579	</h4>
580
581
582	A string giving the name of the variable containing the x axis in
583	the input grid file gridin
584
585
586	<a name="#_file_interp_keyword_INYAXISNAME"></a>
587	<h4>INYAXISNAME
588
589
590
591
592
593	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
594	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>'y', 'latitude', 'nav_lat','lat', 'lat_rho' or 'NbLatitudes'</i></font>
595
596	</h4>
597
598
599	same as inxaxisname but for the y axis in the input grid file gridin
600
601
602	<a name="#_file_interp_keyword_OUTXAXISNAME"></a>
603	<h4>OUTXAXISNAME
604
605
606
607
608
609	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
610	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>'x', 'longitude', 'nav_lon', 'lon', 'lon_rho' or 'NbLongitudes'</i></font>
611
612	</h4>
613
614
615	same as inxaxisname but for output grid file gridout
616
617
618	<a name="#_file_interp_keyword_OUTYAXISNAME"></a>
619	<h4>OUTYAXISNAME
620
621
622
623
624
625	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
626	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>'y', 'latitude', 'nav_lat','lat', 'lat_rho' or 'NbLatitudes'</i></font>
627
628	</h4>
629
630
631	same as inyaxisname but for output grid file gridout
632
633
634	<a name="#_file_interp_keyword__EXTRA"></a>
635	<h4>_EXTRA
636
637
638
639
640
641
642
643
644	</h4>
645
646
647	to use <a href="..//Interpolation/extrapolate.html">extrapolate</a>, <a href="..//Interpolation/extrapsmooth.html">extrapsmooth</a> and <a href="..//Interpolation/fromreg.html">fromreg</a> keywords
648
649
650
651
652	<h3>Examples</h3><pre>
653
654	IDL> file_interp, filein, fileout, gridout, inxaxisname = 'lo', inyaxisname = 'la', keep = ['lo', 'la', 'cond_sed']
655
656	IDL> file_interp, in, out, gdout, inuseasmask = 'sst', inmissing_value = -1.00000e+30, nan_value = -1000.00
657
658	</pre><h3>Version history</h3>
659
660	<h4>Version</h4>
661	$Id: file_interp.pro 330 2008-02-01 16:28:24Z smasson $
662
663	<h4>History</h4>
664	September 2007: Sebastien Masson (smasson@locean-ipsl.upmc.fr)
665
666
667
668	<h3>Known issues</h3>
669
670
671
672	<h4>Restrictions</h4>
673
674	- perform only horizontal interpolations on scalar fields
675	- will fill all masked and missing values before interpolation
676	- attributes (like valid_min...) are not updated
677	- see restrictions of <a href="..//Interpolation/fromreg.html">fromreg</a> and <a href="..//Interpolation/fromirr.html">fromirr</a>
678
679
680	<h3>Other attributes</h3>
681
682
683	<h4>Uses routines</h4>
684	<a href="..//Interpolation/extrapsmooth.html">extrapsmooth</a>, <a href="..//Interpolation/extrapolate.html">extrapolate</a>, <a href="..//Interpolation/fromreg.html">fromreg</a> and <a href="..//Interpolation/fromirr.html">fromirr</a>
685
686
687
688
689
690	<font size="-3"><p> </p></font>
691	<hr size="1" color="#CCCCCC"/>
692
693
694
695
696	<p><font color="gray" size="-3">  Produced by IDLdoc 2.0.</font></p>
697
698	</body>
699	</html>

Note: See TracBrowser for help on using the repository browser.

Download in other formats: