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

Last change on this file since 104 was 104, checked in by pinsard, 18 years ago

start to modify headers of Postscript *.pro files for better idldoc output + change the title of idldoc output in html to SAXO Documentation
File size: 8.3 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?format=raw" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../search-page.html?format=raw" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td >Source</td>
58     
59
60     
61      <td><a href="./../idldoc-help.html?format=raw" 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="restoreboxparam.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?format=raw" 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?format=raw">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"> read NetCDF meshmask file created by OPA
90</div>
91
92     
93
94     
95
96     
97
98     
99
100      <div id="routine_details">
101       
102
103        <div class="routine_details" id="_ncdf_meshread">
104
105          <h2><a class="top" href="#container">top</a>ncdf_meshread <span class="categories"> grid reading
106</span></h2>
107       
108          <p class="header">
109            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">GLAMBOUNDARY</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">ONEARTH</span>, <a href="#_ncdf_meshread_keyword_GETDIMENSIONS">GETDIMENSIONS</a>=<span class="result">GETDIMENSIONS</span>, <a href="#_ncdf_meshread_keyword_PERIODIC">PERIODIC</a>=<span class="result">PERIODIC</span>, <a href="#_ncdf_meshread_keyword_SHIFT">SHIFT</a>=<span class="result">SHIFT</span>, <a href="#_ncdf_meshread_keyword_STRIDE">STRIDE</a>=<span class="result">STRIDE</span>, <a href="#_ncdf_meshread_keyword_STRCALLING">STRCALLING</a>=<span class="result">STRCALLING</span>, <a href="#_ncdf_meshread_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p>
110       
111          <div class="comments">
112</div>
113
114         
115
116         
117            <h3>Parameters</h3>
118       
119           
120            <h4 id="_ncdf_meshread_param_filename">filename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
121              <span class="attr">in</span>
122             
123              <span class="attr">optional</span>
124             
125             
126             
127             
128             
129            </h4>
130       
131          <div class="comments"> the name of the meshmask file to read. Default is
132    meshmask.nc. if this name does not contain any / and if
133    iodirectory keyword is not specify, then the common variable
134    iodir will be use to define the mesh file path.
135</div>
136           
137
138         
139
140         
141
142            <h3>Keywords</h3>
143           
144            <h4 id="_ncdf_meshread_keyword_GLAMBOUNDARY">GLAMBOUNDARY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
145             
146             
147             
148             
149             
150             
151             
152             
153            </h4>
154       
155            <div class="comments"> a 2 elements vector, {lon1,lon2], the longitute
156    boundaries that should be used to visualize the data.
157      lon2 > lon1
158      lon2 - lon1 le 360
159    key_shift will be automaticaly defined according to GLAMBOUNDARY.
160</div>
161           
162            <h4 id="_ncdf_meshread_keyword_CHECKDAT">CHECKDAT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
163             
164             
165             
166             
167             
168             
169             
170             
171            </h4>
172       
173            <div class="comments"> Suppressed. Use micromeshmask.pro to create an
174    appropriate meshmask.
175</div>
176           
177            <h4 id="_ncdf_meshread_keyword_ONEARTH">ONEARTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
178             
179             
180             
181             
182             
183             
184             
185             
186            </h4>
187       
188            <div class="comments"> = 0 or 1 to force the manual definition of
189    key_onearth (to specify if the data are on earth -> use longitude
190    /latitude etc...). By default, key_onearth = 1.
191    note that ONEARTH = 0 forces PERIODIC = 0, SHIFT = 0 and is
192    cancelling GLAMBOUNDARY
193</div>
194           
195            <h4 id="_ncdf_meshread_keyword_GETDIMENSIONS">GETDIMENSIONS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
196             
197             
198             
199             
200             
201             
202             
203             
204            </h4>
205       
206            <div class="comments"></div>
207           
208            <h4 id="_ncdf_meshread_keyword_PERIODIC">PERIODIC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
209             
210             
211             
212             
213             
214             
215             
216             
217            </h4>
218       
219            <div class="comments"> = 0 or 1 to force the manual definition of
220    key_periodic. By default, key_periodic is automaticaly
221    computed by using the first line of glamt.
222</div>
223           
224            <h4 id="_ncdf_meshread_keyword_SHIFT">SHIFT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
225             
226             
227             
228             
229             
230             
231             
232             
233            </h4>
234       
235            <div class="comments">  to force the manual definition of key_shift. By
236    debault, key_shift is automaticaly computed according to the
237    glamboundary (when defined) by using the first line of glamt. if
238    key_periodic=0 then in any case key_shift = 0.
239</div>
240           
241            <h4 id="_ncdf_meshread_keyword_STRIDE">STRIDE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
242             
243             
244             
245             
246             
247             
248             
249             
250            </h4>
251       
252            <div class="comments"> a 3 elements vector to specify the stride in x, y, z
253    direction. Default definition is key_stride. The resulting value
254    will be stored in the common (cm_4mesh) variable key_stride
255</div>
256           
257            <h4 id="_ncdf_meshread_keyword_STRCALLING">STRCALLING&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
258             
259             
260             
261             
262             
263             
264             
265             
266            </h4>
267       
268            <div class="comments"> a string containing the calling command used to call
269    computegrid (this is used by xxx.pro)
270</div>
271           
272            <h4 id="_ncdf_meshread_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
273             
274             
275             
276             
277             
278             
279             
280             
281            </h4>
282       
283            <div class="comments"></div>
284           
285         
286
287          <h3>Examples</h3><div class="value">
288 IDL> ncdf_meshread [,' filename']
289 </div>
290          <h3>Version history</h3>
291         
292         
293          <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr)
294                      12/1999
295 July 2004, Sebastien Masson: Several modifications (micromeshmask,
296 clean partial steps, clean use of key_stride, automatic definition
297 of key_shift, ...)
298 Oct. 2004, Sebastien Masson: add PERIODIC and SHIFT
299 Aug. 2005, Sebastien Masson: some cleaning + english </div>
300         
301         
302          <h3>Known issues</h3>
303         
304         
305         
306          <h4>Restrictions</h4><div class="value"> define and/or use common variables from
307               cm_4mesh, cm_4data, cm_4cal
308
309
310
311  ixminmesh,ixmaxmesh,iyminmesh,iymaxmesh,izminmesh,izmaxmesh must
312  be defined febore calling ncdf_meshread. if some of those value
313  are equal to -1 they will be automatically defined
314</div>
315       
316          <h3>Other attributes</h3>
317         
318         
319          <h4>Uses routines</h4><div class="value"> cm_4mesh cm_4data cm_4cal
320</div>
321         
322         
323         
324       
325         
326       
327        </div>
328       
329      </div>
330
331     
332
333      <div id="tagline">Produced by IDLdoc 2.0.</div>
334
335    </div>
336
337  </body>
338</html>
Note: See TracBrowser for help on using the repository browser.