Context Navigation

source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/LECTURE/read_ncdf.html @ 338

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

Line
1
2
3	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4	<head>
5	<title>read_ncdf.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="read_ftp.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="read_ncdf_varget.html"><img src="./../../next.gif" border="0" alt="Next"></a></td>
53	</tr>
54	</table>
55
56
57	<h1><font size="-2">ToBeReviewed/LECTURE/</font></h1>
58	<h2>read_ncdf.pro</h2>
59
60	<dl>
61	</dl>
62
63
64	Reading function for the file net_cdf.
65	This program is less universal than ncdf_lec (it appeal to declared
66	variables in common.pro) but it is very easier to be used. It considerate
67	the declaration of the different zooms which have been defined
68	(ixminmesh...premierx...), the declaration of the variable key_shift...
69	To put it in a nutshell, the result of read_ncdf can be directly used in plt...
70	This is also this program which is used by default in our reading widgets.
71
72
73
74
75
76	<a name="#_read_ncdf"></a>
77
78	<h2>read_ncdf <font size="-1" color="#006633">
79	Reading
80	</font></h2>
81
82	<p><font face="Courier"><i>result = </i>read_ncdf(<i><a href="#_read_ncdf_keyword_name">name</a>, <a href="#_read_ncdf_keyword_beginning">beginning</a>, <a href="#_read_ncdf_keyword_ending">ending</a>[, <a href="#_read_ncdf_keyword_compatibility">compatibility</a>]</i>, <a href="#_read_ncdf_keyword_BOXZOOM">BOXZOOM</a>=<i>BOXZOOM</i>, <a href="#_read_ncdf_keyword_FILENAME">FILENAME</a>=<i>string</i>, <a href="#_read_ncdf_keyword_PARENTIN">PARENTIN</a>=<i>PARENTIN</i>, <a href="#_read_ncdf_keyword_TIMESTEP">TIMESTEP</a>=<i>scalar: 0 or 1</i>, <a href="#_read_ncdf_keyword_ADDSCL_BEFORE">ADDSCL_BEFORE</a>=<i>scalar: 0 or 1</i>, <a href="#_read_ncdf_keyword_TOUT">TOUT</a>=<i>scalar: 0 or 1</i>, <a href="#_read_ncdf_keyword_NOSTRUCT">NOSTRUCT</a>=<i>scalar: 0 or 1</i>, <a href="#_read_ncdf_keyword_CONT_NOFILL">CONT_NOFILL</a>=<i>CONT_NOFILL</i>, <a href="#_read_ncdf_keyword_INIT">INIT</a>=<i>scalar: 0 or 1</i>, <a href="#_read_ncdf_keyword_GRID">GRID</a>=<i>GRID</i>, <a href="#_read_ncdf_keyword_CALLITSELF">CALLITSELF</a>=<i>scalar: 0 or 1</i>, <a href="#_read_ncdf_keyword_DIREC">DIREC</a>=<i>DIREC</i>, <a href="#_read_ncdf_keyword_ZETAFILENAME">ZETAFILENAME</a>=<i>string</i>, <a href="#_read_ncdf_keyword_ZETAZERO">ZETAZERO</a>=<i>scalar: 0 or 1</i>, <a href="#_read_ncdf_keyword_ZINVAR">ZINVAR</a>=<i>named variable</i>, <a href="#_read_ncdf_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p>
83
84
85
86
87	<h3>Return value</h3>
88	Structure readable by <a href="../..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a> or an array if NOSTRUCT is activated.
89
90
91	<h3>Parameters</h3>
92
93
94	<a name="#_read_ncdf_keyword_name"></a>
95	<h4>name
96	<font size="-1" color="#006633">in</font>
97
98
99	<font size="-1" color="#006633">required</font>
100
101	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font>
102
103
104	</h4>
105
106
107	It define the field to be read.
108
109
110
111	<a name="#_read_ncdf_keyword_beginning"></a>
112	<h4>beginning
113	<font size="-1" color="#006633">in</font>
114
115
116	<font size="-1" color="#006633">required</font>
117
118
119
120
121	</h4>
122
123
124	Relative with the time axis.
125	These can be
126	- 2 date of the type yyyymmdd and in this case, we select dates
127	which are included between these two dates.
128	- 2 indexes which define between which and which time step we have
129	to extract the temporal dimension.
130
131
132
133	<a name="#_read_ncdf_keyword_ending"></a>
134	<h4>ending
135	<font size="-1" color="#006633">in</font>
136
137
138	<font size="-1" color="#006633">required</font>
139
140
141
142
143	</h4>
144
145
146	Relative with the time axis.
147	See BEGINNING.
148
149
150
151	<a name="#_read_ncdf_keyword_compatibility"></a>
152	<h4>compatibility
153	<font size="-1" color="#006633">in</font>
154
155	<font size="-1" color="#006633">optional</font>
156
157
158
159
160
161	</h4>
162
163
164	Useless, defined for compatibility
165
166
167
168
169
170	<h3>Keywords</h3>
171
172
173	<a name="#_read_ncdf_keyword_BOXZOOM"></a>
174	<h4>BOXZOOM
175
176
177
178
179
180
181
182
183	</h4>
184
185
186	Contain the boxzoom on which we have to do the reading
187
188
189	<a name="#_read_ncdf_keyword_FILENAME"></a>
190	<h4>FILENAME
191
192
193
194	<font size="-1" color="#006633">required</font>
195
196	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font>
197
198
199	</h4>
200
201
202	It contains the file's name.
203
204
205	<a name="#_read_ncdf_keyword_PARENTIN"></a>
206	<h4>PARENTIN
207
208
209
210
211
212
213
214
215	</h4>
216
217
218
219	<a name="#_read_ncdf_keyword_TIMESTEP"></a>
220	<h4>TIMESTEP
221
222
223
224
225
226	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font>
227	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
228
229	</h4>
230
231
232	Specify that BEGINNING and ENDING refer to indexes of the time axis and not to dates
233
234
235	<a name="#_read_ncdf_keyword_ADDSCL_BEFORE"></a>
236	<h4>ADDSCL_BEFORE
237
238
239
240
241
242	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font>
243	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
244
245	</h4>
246
247
248	put 1 to apply add_offset ad scale factor on data before looking for
249	missing values
250
251
252	<a name="#_read_ncdf_keyword_TOUT"></a>
253	<h4>TOUT
254
255
256
257
258
259	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font>
260	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
261
262	</h4>
263
264
265	We activate it if we want to read the file on the whole domain without
266	considerate the sub-domain defined by the boxzoom or
267	lon1,lon2,lat1,lat2,vert1,vert2.
268
269
270	<a name="#_read_ncdf_keyword_NOSTRUCT"></a>
271	<h4>NOSTRUCT
272
273
274
275
276
277	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font>
278	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
279
280	</h4>
281
282
283	We activate it if we do not want that read_ncdf send back a structure
284	but only the array referring to the field.
285
286
287	<a name="#_read_ncdf_keyword_CONT_NOFILL"></a>
288	<h4>CONT_NOFILL
289
290
291
292
293
294
295
296
297	</h4>
298
299
300
301	<a name="#_read_ncdf_keyword_INIT"></a>
302	<h4>INIT
303
304
305
306
307
308	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font>
309	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
310
311	</h4>
312
313
314	To call automatically <a href="../..//ToBeReviewed/INIT/initncdf.html">initncdf</a> with filename as input argument
315	and thus ; redefine all the grid parameters
316
317
318	<a name="#_read_ncdf_keyword_GRID"></a>
319	<h4>GRID
320
321
322
323
324
325
326
327
328	</h4>
329
330
331	='[UTVWF]' to specify the type of grid. Default is (1)
332	based on the name of the file if the file ends by
333	GRID[._][TUVFW].NC (not case sensible) or (2) T if case (1)
334	is not found.
335
336
337	<a name="#_read_ncdf_keyword_CALLITSELF"></a>
338	<h4>CALLITSELF
339
340
341
342
343
344	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font>
345	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
346
347	</h4>
348
349
350	For ROMS outputs. Use by read_ncdf itself to access auxilliary data (h and zeta).
351
352
353	<a name="#_read_ncdf_keyword_DIREC"></a>
354	<h4>DIREC
355
356
357
358
359
360
361
362
363	</h4>
364
365
366	a string used to specify the direction along which we want to make
367	spatial and/or temporal mean. It could be: 'x' 'y' 'z' 't' 'xy' 'xz'
368	'yz' 'xyz' 'xt' 'yt' 'zt' 'xyt' 'xzt' 'yzt' or 'xyzt'
369
370
371	<a name="#_read_ncdf_keyword_ZETAFILENAME"></a>
372	<h4>ZETAFILENAME
373
374
375
376
377
378	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font>
379	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>FILENAME</i></font>
380
381	</h4>
382
383
384	For ROMS outputs. The filename of the file where zeta variable should be read
385
386
387	<a name="#_read_ncdf_keyword_ZETAZERO"></a>
388	<h4>ZETAZERO
389
390
391
392
393
394	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font>
395	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
396
397	</h4>
398
399
400	For ROMS outputs. To define zeta to 0. instead of reading it
401
402
403	<a name="#_read_ncdf_keyword_ZINVAR"></a>
404	<h4>ZINVAR
405
406
407
408
409
410	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>named variable</i></font>
411
412
413	</h4>
414
415
416	Set this keyword to a named variable in which 1 is returned if a
417	vertical dimension is found in the variable. Returns 0 otherwise
418
419
420	<a name="#_read_ncdf_keyword__EXTRA"></a>
421	<h4>_EXTRA
422
423
424
425
426
427
428
429
430	</h4>
431
432
433	Used to pass keywords to <a href="../..//Utilities/isafile.html">isafile</a>, <a href="../..//ToBeReviewed/INIT/initncdf.html">initncdf</a>,
434	<a href="../..//ReadWrite/ncdf_gettime.html">ncdf_gettime</a>, <a href="../..//ReadWrite/ncdf_getatt.html">ncdf_getatt</a> and <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a>
435
436
437
438
439
440	</pre><h3>Version history</h3>
441
442	<h4>Version</h4>
443	$Id: read_ncdf.pro 336 2008-03-20 21:36:46Z smasson $
444
445	<h4>History</h4>
446	Sebastien Masson (smasson@lodyc.jussieu.fr)
447	15/10/1999
448
449
450
451	<h3>Known issues</h3>
452
453
454
455	<h4>Restrictions</h4>
456	The field must have a temporal dimension.
457
458
459	<h3>Other attributes</h3>
460
461
462	<h4>Uses routines</h4>
463	common.pro
464
465
466
467
468
469	<font size="-3"><p> </p></font>
470	<hr size="1" color="#CCCCCC"/>
471
472
473
474
475	<p><font color="gray" size="-3">  Produced by IDLdoc 2.0.</font></p>
476
477	</body>
478	</html>

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

Download in other formats: