source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/LECTURE/read_ncdf.html

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

update documentation

File size: 13.8 KB
Line 
1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<!-- Generated by IDLdoc 2.0 -->
6
7<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8  <head>
9    <title>read_ncdf.pro (SAXO Documentation)</title>
10
11   
12    <link rel="stylesheet" type="text/css" media="all" href="./../../main_files.css" />
13    <link rel="stylesheet" type="text/css" media="print" href="./../../main_files_print.css" />
14   
15
16    <script type="text/javascript">
17      function setTitle() {
18        parent.document.title="read_ncdf.pro (SAXO Documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>SAXO Documentation</h1>
27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
35      <td><a href="./../../overview.html" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../../idldoc-categories.html" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../../search-page.html" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td><a href="../../../../ToBeReviewed/LECTURE//read_ncdf.pro" title="Source code of a file">Source</a></td>
58     
59
60     
61      <td><a href="./../../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
62     
63
64      <td >Etc</td>
65
66      <td id="flexible">Developer&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="read_ftp.html">&lt;&lt;prev file</a> | <a href="read_ncdf_varget.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="read_ncdf.html" target="_TOP">view single page</a> | <a href="./../../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html">ToBeReviewed/LECTURE/</a></h1>
82      <h2 class="pro_file">read_ncdf.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 Reading function for the file net_cdf.
91 This program is less universal than <a href="../..//ToBeReviewed/LECTURE/ncdf_lec.html">ncdf_lec</a> (it appeal to
92 declared variables in <a href="../..//Obsolete/common.html">common</a>) but it is very easier to be used.
93 It considerate
94 the declaration of the different zooms which have been defined
95 (ixminmesh...premierx...), the declaration of the variable key_shift...
96 To put it in a nutshell, the result of read_ncdf can be directly used in
97 <a href="../..//ToBeReviewed/PLOTS/DESSINE/plt.html">plt</a> ...
98
99 This is also this program which is used by default in our reading widgets.
100</div>
101
102     
103
104     
105
106     
107
108     
109
110      <div id="routine_details">
111       
112
113        <div class="routine_details" id="_read_ncdf">
114
115          <h2><a class="top" href="#container">top</a>read_ncdf <span class="categories">
116 Reading
117</span></h2>
118       
119          <p class="header">
120            <span class="result">result = </span>read_ncdf(<span class="result"><a href="#_read_ncdf_param_name">name</a>, <a href="#_read_ncdf_param_beginning">beginning</a>, <a href="#_read_ncdf_param_ending">ending</a>[, <a href="#_read_ncdf_param_compatibility">compatibility</a>]</span>, <a href="#_read_ncdf_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">BOXZOOM</span>, <a href="#_read_ncdf_keyword_FILENAME">FILENAME</a>=<span class="result">string</span>, <a href="#_read_ncdf_keyword_PARENTIN">PARENTIN</a>=<span class="result">PARENTIN</span>, <a href="#_read_ncdf_keyword_TIMESTEP">TIMESTEP</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_read_ncdf_keyword_ADDSCL_BEFORE">ADDSCL_BEFORE</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_read_ncdf_keyword_TOUT">TOUT</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_read_ncdf_keyword_NOSTRUCT">NOSTRUCT</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_read_ncdf_keyword_CONT_NOFILL">CONT_NOFILL</a>=<span class="result">CONT_NOFILL</span>, <a href="#_read_ncdf_keyword_INIT">INIT</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_read_ncdf_keyword_GRID">GRID</a>=<span class="result">GRID</span>, <a href="#_read_ncdf_keyword_CALLITSELF">CALLITSELF</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_read_ncdf_keyword_DIREC">DIREC</a>=<span class="result">DIREC</span>, <a href="#_read_ncdf_keyword_ZETAFILENAME">ZETAFILENAME</a>=<span class="result">string</span>, <a href="#_read_ncdf_keyword_ZETAZERO">ZETAZERO</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_read_ncdf_keyword_ZINVAR">ZINVAR</a>=<span class="result">named variable</span>, <a href="#_read_ncdf_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p>
121       
122          <div class="comments">
123</div>
124
125          <h3>Return value</h3><div class="preformat">
126 Structure readable by <a href="../..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a> or an array if NOSTRUCT is
127 activated.
128</div>
129
130         
131            <h3>Parameters</h3>
132       
133           
134            <h4 id="_read_ncdf_param_name">name&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
135              <span class="attr">in</span>
136             
137             
138              <span class="attr">required</span>
139             
140              <span class="attr">type:</span> <span class="value">string</span>
141             
142             
143            </h4>
144       
145          <div class="comments">
146 It define the field to be read.
147</div>
148           
149            <h4 id="_read_ncdf_param_beginning">beginning&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
150              <span class="attr">in</span>
151             
152             
153              <span class="attr">required</span>
154             
155             
156             
157             
158            </h4>
159       
160          <div class="comments">
161 Relative with the time axis.
162 These can be
163  - 2 dates of the type yyyymmdd and in this case, we select data
164  which are included between these two dates.
165  - 2 indexes which define between which and which time steps we have
166  to extract the temporal dimension.
167</div>
168           
169            <h4 id="_read_ncdf_param_ending">ending&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
170              <span class="attr">in</span>
171             
172             
173              <span class="attr">required</span>
174             
175             
176             
177             
178            </h4>
179       
180          <div class="comments">
181 Relative with the time axis.
182 See BEGINNING.
183</div>
184           
185            <h4 id="_read_ncdf_param_compatibility">compatibility&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
186              <span class="attr">in</span>
187             
188              <span class="attr">optional</span>
189             
190             
191             
192             
193             
194            </h4>
195       
196          <div class="comments">
197 Useless, defined for compatibility
198</div>
199           
200
201         
202
203         
204
205            <h3>Keywords</h3>
206           
207            <h4 id="_read_ncdf_keyword_BOXZOOM">BOXZOOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
208             
209             
210             
211             
212             
213             
214             
215             
216            </h4>
217       
218            <div class="comments">
219 Contain the boxzoom on which we have to do the reading
220</div>
221           
222            <h4 id="_read_ncdf_keyword_FILENAME">FILENAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
223             
224             
225             
226              <span class="attr">required</span>
227             
228              <span class="attr">type:</span> <span class="value">string</span>
229             
230             
231            </h4>
232       
233            <div class="comments">
234 It contains the file's name.
235</div>
236           
237            <h4 id="_read_ncdf_keyword_PARENTIN">PARENTIN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
238             
239             
240             
241             
242             
243             
244             
245             
246            </h4>
247       
248            <div class="comments"></div>
249           
250            <h4 id="_read_ncdf_keyword_TIMESTEP">TIMESTEP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
251             
252             
253             
254             
255             
256              <span class="attr">type:</span> <span class="value">scalar: 0 or 1</span>
257              <span class="attr">default:</span> <span class="value">0</span>
258             
259            </h4>
260       
261            <div class="comments">
262 Specify that BEGINNING and ENDING refer to indexes of the time axis and not
263 to dates
264</div>
265           
266            <h4 id="_read_ncdf_keyword_ADDSCL_BEFORE">ADDSCL_BEFORE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
267             
268             
269             
270             
271             
272              <span class="attr">type:</span> <span class="value">scalar: 0 or 1</span>
273              <span class="attr">default:</span> <span class="value">0</span>
274             
275            </h4>
276       
277            <div class="comments">
278 put 1 to apply add_offset and scale factor on data before looking for
279 missing values
280</div>
281           
282            <h4 id="_read_ncdf_keyword_TOUT">TOUT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
283             
284             
285             
286             
287             
288              <span class="attr">type:</span> <span class="value">scalar: 0 or 1</span>
289              <span class="attr">default:</span> <span class="value">0</span>
290             
291            </h4>
292       
293            <div class="comments">
294 We activate it if we want to read the file on the whole domain without
295 considerate the sub-domain defined by the boxzoom or
296 lon1,lon2,lat1,lat2,vert1,vert2.
297</div>
298           
299            <h4 id="_read_ncdf_keyword_NOSTRUCT">NOSTRUCT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
300             
301             
302             
303             
304             
305              <span class="attr">type:</span> <span class="value">scalar: 0 or 1</span>
306              <span class="attr">default:</span> <span class="value">0</span>
307             
308            </h4>
309       
310            <div class="comments">
311 We activate it if we do not want that read_ncdf send back a structure
312 but only the array referring to the field.
313</div>
314           
315            <h4 id="_read_ncdf_keyword_CONT_NOFILL">CONT_NOFILL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
316             
317             
318             
319             
320             
321             
322             
323             
324            </h4>
325       
326            <div class="comments"></div>
327           
328            <h4 id="_read_ncdf_keyword_INIT">INIT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
329             
330             
331             
332             
333             
334              <span class="attr">type:</span> <span class="value">scalar: 0 or 1</span>
335              <span class="attr">default:</span> <span class="value">0</span>
336             
337            </h4>
338       
339            <div class="comments">
340 To call automatically <a href="../..//ToBeReviewed/INIT/initncdf.html">initncdf</a> with filename as input argument
341 and thus redefine all the grid parameters
342</div>
343           
344            <h4 id="_read_ncdf_keyword_GRID">GRID&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
345             
346             
347             
348             
349             
350             
351             
352             
353            </h4>
354       
355            <div class="comments">
356 ='[UTVWF]' to specify the type of grid. Default is (1)
357 based on the name of the file if the file ends by
358 GRID[._][TUVFW].NC (not case sensible) or (2) T if case (1)
359 is not found.
360</div>
361           
362            <h4 id="_read_ncdf_keyword_CALLITSELF">CALLITSELF&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
363             
364             
365             
366             
367             
368              <span class="attr">type:</span> <span class="value">scalar: 0 or 1</span>
369              <span class="attr">default:</span> <span class="value">0</span>
370             
371            </h4>
372       
373            <div class="comments">
374 For ROMS outputs. Use by read_ncdf itself to access auxilliary data
375 (h and zeta).
376</div>
377           
378            <h4 id="_read_ncdf_keyword_DIREC">DIREC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
379             
380             
381             
382             
383             
384             
385             
386             
387            </h4>
388       
389            <div class="comments">
390 a string used to specify the direction along which we want to make
391 spatial and/or temporal mean. It could be: 'x' 'y' 'z' 't' 'xy' 'xz'
392 'yz' 'xyz' 'xt' 'yt' 'zt' 'xyt' 'xzt' 'yzt' or 'xyzt'
393</div>
394           
395            <h4 id="_read_ncdf_keyword_ZETAFILENAME">ZETAFILENAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
396             
397             
398             
399             
400             
401              <span class="attr">type:</span> <span class="value">string</span>
402              <span class="attr">default:</span> <span class="value">FILENAME</span>
403             
404            </h4>
405       
406            <div class="comments">
407 For ROMS outputs. The filename of the file where zeta variable should be read
408</div>
409           
410            <h4 id="_read_ncdf_keyword_ZETAZERO">ZETAZERO&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
411             
412             
413             
414             
415             
416              <span class="attr">type:</span> <span class="value">scalar: 0 or 1</span>
417              <span class="attr">default:</span> <span class="value">0</span>
418             
419            </h4>
420       
421            <div class="comments">
422 For ROMS outputs. To define zeta to 0. instead of reading it
423</div>
424           
425            <h4 id="_read_ncdf_keyword_ZINVAR">ZINVAR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
426             
427             
428             
429             
430             
431              <span class="attr">type:</span> <span class="value">named variable</span>
432             
433             
434            </h4>
435       
436            <div class="comments">
437 Set this keyword to a named variable in which 1 is returned if a
438 vertical dimension is found in the variable. Returns 0 otherwise
439</div>
440           
441            <h4 id="_read_ncdf_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
442             
443             
444             
445             
446             
447             
448             
449             
450            </h4>
451       
452            <div class="comments">
453 Used to pass keywords to <a href="../..//Utilities/isafile.html">isafile</a>, <a href="../..//ToBeReviewed/INIT/initncdf.html">initncdf</a>,
454 <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>
455</div>
456           
457         
458
459         
460          <h3>Version history</h3>
461         
462          <h4>Version</h4><div class="preformat">
463 $Id: read_ncdf.pro 399 2009-07-02 08:38:54Z smasson $
464</div>
465          <h4>History</h4><div class="preformat">
466 Sebastien Masson (smasson@lodyc.jussieu.fr)
467                      15/10/1999
468</div>
469         
470         
471          <h3>Known issues</h3>
472         
473         
474         
475          <h4>Restrictions</h4><div class="preformat">
476 The field must have a temporal dimension.
477</div>
478       
479          <h3>Other attributes</h3>
480         
481         
482          <h4>Uses routines</h4><div class="preformat">
483 <a href="../..//Obsolete/common.html">common</a>
484</div>
485         
486         
487         
488       
489          <h3>Statistics</h3>
490          <table class="statistics">
491            <tr><td>McCabe cyclic</td><td>         101</td></tr>
492            <tr><td>McCabe essential</td><td>           1</td></tr>
493            <tr><td>McCabe modular design</td><td>           1</td></tr>
494          </table>
495         
496       
497        </div>
498       
499      </div>
500
501     
502
503      <div id="tagline">Produced by IDLdoc 2.0.</div>
504
505    </div>
506
507  </body>
508</html>
Note: See TracBrowser for help on using the repository browser.