source: trunk/SRC/Documentation/idldoc_html_output/Grid/ncdf_meshread.html @ 338

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

update documentation
File size: 10.2 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>ncdf_meshread.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="ncdf_meshread.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="../../../Grid//ncdf_meshread.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="n80gaussian.html">&lt;&lt;prev file</a> | <a href="ncdf_meshroms.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="ncdf_meshread.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">Grid/</a></h1>
82      <h2 class="pro_file">ncdf_meshread.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 read NetCDF meshmask file created by OPA
91</div>
92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
104        <div class="routine_details" id="_ncdf_meshread">
105
106          <h2><a class="top" href="#container">top</a>ncdf_meshread <span class="categories">
107 Grid
108</span></h2>
109       
110          <p class="header">
111            ncdf_meshread<span class="result">[, <a href="#_ncdf_meshread_param_filename">filename</a>]</span>, <a href="#_ncdf_meshread_keyword_GLAMBOUNDARY">GLAMBOUNDARY</a>=<span class="result">2 elements vector</span>, <a href="#_ncdf_meshread_keyword_CHECKDAT">CHECKDAT</a>=<span class="result">CHECKDAT</span>, <a href="#_ncdf_meshread_keyword_ONEARTH">ONEARTH</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_ncdf_meshread_keyword_GETDIMENSIONS">GETDIMENSIONS</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_ncdf_meshread_keyword_PERIODIC">PERIODIC</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_ncdf_meshread_keyword_SHIFT">SHIFT</a>=<span class="result">scalar</span>, <a href="#_ncdf_meshread_keyword_STRIDE">STRIDE</a>=<span class="result">3 elements vector</span>, <a href="#_ncdf_meshread_keyword_STRCALLING">STRCALLING</a>=<span class="result">scalar string</span>, <a href="#_ncdf_meshread_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p>
112       
113          <div class="comments">
114</div>
115
116         
117
118         
119            <h3>Parameters</h3>
120       
121           
122            <h4 id="_ncdf_meshread_param_filename">filename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
123              <span class="attr">in</span>
124             
125              <span class="attr">optional</span>
126             
127             
128              <span class="attr">type:</span> <span class="value">scalar string</span>
129              <span class="attr">default:</span> <span class="value">'meshmask.nc'</span>
130             
131            </h4>
132       
133          <div class="comments">
134    Name of the meshmask file to read. If this name does not contain any "/"
135    and if iodirectory keyword is not specified, then the common variable
136    iodir will be used to define the mesh file path.
137</div>
138           
139
140         
141
142         
143
144            <h3>Keywords</h3>
145           
146            <h4 id="_ncdf_meshread_keyword_GLAMBOUNDARY">GLAMBOUNDARY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
147             
148             
149             
150             
151             
152              <span class="attr">type:</span> <span class="value">2 elements vector</span>
153              <span class="attr">default:</span> <span class="value">those defined in the file</span>
154             
155            </h4>
156       
157            <div class="comments">
158    Longitude boundaries that should be used to visualize the data.
159      lon2 > lon1
160      lon2 - lon1 le 360
161    By default, the common (cm_4mesh) variable key_shift will be automatically
162    defined according to GLAMBOUNDARY.
163</div>
164           
165            <h4 id="_ncdf_meshread_keyword_CHECKDAT">CHECKDAT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
166             
167             
168             
169             
170             
171             
172             
173             
174            </h4>
175       
176            <div class="comments">
177 Suppressed. Use <a href="..//Grid/micromeshmask.html">micromeshmask</a> to create an appropriate meshmask.
178</div>
179           
180            <h4 id="_ncdf_meshread_keyword_ONEARTH">ONEARTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
181             
182             
183             
184             
185             
186              <span class="attr">type:</span> <span class="value">scalar: 0 or 1</span>
187              <span class="attr">default:</span> <span class="value">1</span>
188             
189            </h4>
190       
191            <div class="comments">
192    Force the manual definition of data localization on the earth or not
193       0) if the data are not on the earth
194       1) if the data are on earth (in that case we can for example use
195          the labels 'longitude', 'latitude' in plots).
196    The resulting value will be stored in the common (cm_4mesh) variable key_onearth
197    ONEARTH=0 forces PERIODIC=0, SHIFT=0 and is cancelling GLAMBOUNDARY
198</div>
199           
200            <h4 id="_ncdf_meshread_keyword_GETDIMENSIONS">GETDIMENSIONS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
201             
202             
203             
204             
205             
206              <span class="attr">type:</span> <span class="value">scalar: 0 or 1</span>
207              <span class="attr">default:</span> <span class="value">0</span>
208             
209            </h4>
210       
211            <div class="comments">
212    Activate this keywords if you only want to know the dimension
213    of the domain stored in the mesh file. This dimension will be
214    defined in jpiglo, jpjglo, jpkglo (cm_4mesh common variables)
215</div>
216           
217            <h4 id="_ncdf_meshread_keyword_PERIODIC">PERIODIC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
218             
219             
220             
221             
222             
223              <span class="attr">type:</span> <span class="value">scalar: 0 or 1</span>
224              <span class="attr">default:</span> <span class="value">computed by using the first line of glamt</span>
225             
226            </h4>
227       
228            <div class="comments">
229    Force the manual definition of the grid zonal periodicity.
230    The resulting value will be stored in the common (cm_4mesh) variable key_periodic
231    PERIODIC=0 forces SHIFT=0
232</div>
233           
234            <h4 id="_ncdf_meshread_keyword_SHIFT">SHIFT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
235             
236             
237             
238             
239             
240              <span class="attr">type:</span> <span class="value">scalar</span>
241              <span class="attr">default:</span> <span class="value">computed according to glamboundary</span>
242             
243            </h4>
244       
245            <div class="comments">
246    Force the manual definition of the zonal shift that must be apply to the data.
247    The resulting value will be stored in the common (cm_4mesh) variable key_shift
248    Note that if key_periodic=0 then in any case key_shift = 0.
249</div>
250           
251            <h4 id="_ncdf_meshread_keyword_STRIDE">STRIDE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
252             
253             
254             
255             
256             
257              <span class="attr">type:</span> <span class="value">3 elements vector</span>
258              <span class="attr">default:</span> <span class="value">[1, 1, 1]</span>
259             
260            </h4>
261       
262            <div class="comments">
263    Specify the stride in x, y and z direction. The resulting
264    value will be stored in the common (cm_4mesh) variable key_stride
265</div>
266           
267            <h4 id="_ncdf_meshread_keyword_STRCALLING">STRCALLING&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
268             
269             
270             
271             
272             
273              <span class="attr">type:</span> <span class="value">scalar string</span>
274             
275             
276            </h4>
277       
278            <div class="comments">
279    the calling command used to call <a href="..//Grid/computegrid.html">computegrid</a> (this is used by <a href="..//ToBeReviewed/WIDGET/xxx.html">xxx</a>)
280</div>
281           
282            <h4 id="_ncdf_meshread_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
283             
284             
285             
286             
287             
288             
289             
290             
291            </h4>
292       
293            <div class="comments">
294 Used to pass keywords to <a href="..//Utilities/isafile.html">isafile</a>
295</div>
296           
297         
298
299          <h3>Examples</h3><div class="preformat">
300 IDL> ncdf_meshread [,' filename']
301</div>
302          <h3>Version history</h3>
303         
304          <h4>Version</h4><div class="preformat">
305 $Id: ncdf_meshread.pro 327 2007-12-13 16:22:35Z pinsard $
306</div>
307          <h4>History</h4><div class="preformat">
308 Sebastien Masson (smasson@lodyc.jussieu.fr)
309                      12/1999
310 July 2004, Sebastien Masson: Several modifications (micromeshmask,
311 clean partial steps, clean use of key_stride, automatic definition
312 of key_shift, ...)
313 Oct. 2004, Sebastien Masson: add PERIODIC and SHIFT
314 Aug. 2005, Sebastien Masson: some cleaning + english
315</div>
316         
317         
318          <h3>Known issues</h3>
319         
320         
321         
322          <h4>Restrictions</h4><div class="preformat">
323 ixminmesh, ixmaxmesh, iyminmesh, iymaxmesh, izminmesh, izmaxmesh must
324 be defined before calling ncdf_meshread. If some of those values
325 are equal to -1 they will be automatically defined
326</div>
327       
328          <h3>Other attributes</h3>
329         
330         
331          <h4>Uses routines</h4><div class="preformat">
332 cm_4mesh
333 cm_4data
334 cm_4cal
335</div>
336         
337         
338         
339       
340          <h3>Statistics</h3>
341          <table class="statistics">
342            <tr><td>McCabe cyclic</td><td>          95</td></tr>
343            <tr><td>McCabe essential</td><td>           1</td></tr>
344            <tr><td>McCabe modular design</td><td>           1</td></tr>
345          </table>
346         
347       
348        </div>
349       
350      </div>
351
352     
353
354      <div id="tagline">Produced by IDLdoc 2.0.</div>
355
356    </div>
357
358  </body>
359</html>
Note: See TracBrowser for help on using the repository browser.