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

Last change on this file since 402 was 402, checked in by smasson, 15 years ago

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