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

Last change on this file since 363 was 363, checked in by smasson, 16 years ago

update documentation

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