source: trunk/SRC/Documentation/idldoc_assistant_output/Grid/ncdf_meshread.html @ 177

Last change on this file since 177 was 177, checked in by smasson, 18 years ago

updates of html files...
File size: 8.9 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>ncdf_meshread.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="n80gaussian.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="ncdf_meshroms.html"><img src="./../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">Grid/</font></h1>
58    <h2>ncdf_meshread.pro</h2>
59
60    <dl>
61    </dl>
62
63     read NetCDF meshmask file created by OPA
64
65
66   
67
68     
69      <a name="#_ncdf_meshread"></a>
70
71      <h2>ncdf_meshread  <font size="-1" color="#006633"> 
72 Grid
73</font></h2>
74
75      <p><font face="Courier">ncdf_meshread<i>[, <a href="#_ncdf_meshread_keyword_filename">filename</a>]</i>, <a href="#_ncdf_meshread_keyword_GLAMBOUNDARY">GLAMBOUNDARY</a>=<i>2 elements vector</i>, <a href="#_ncdf_meshread_keyword_CHECKDAT">CHECKDAT</a>=<i>CHECKDAT</i>, <a href="#_ncdf_meshread_keyword_ONEARTH">ONEARTH</a>=<i>scalar: 0 or 1</i>, <a href="#_ncdf_meshread_keyword_GETDIMENSIONS">GETDIMENSIONS</a>=<i>scalar: 0 or 1</i>, <a href="#_ncdf_meshread_keyword_PERIODIC">PERIODIC</a>=<i>scalar: 0 or 1</i>, <a href="#_ncdf_meshread_keyword_SHIFT">SHIFT</a>=<i>scalar</i>, <a href="#_ncdf_meshread_keyword_STRIDE">STRIDE</a>=<i>3 elements vector</i>, <a href="#_ncdf_meshread_keyword_STRCALLING">STRCALLING</a>=<i>scalar string</i>, <a href="#_ncdf_meshread_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i></font></p>
76
77   
78
79
80   
81
82   
83    <h3>Parameters</h3>
84   
85
86    <a name="#_ncdf_meshread_keyword_filename"></a>
87    <h4>filename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
88      <font size="-1" color="#006633">in</font>
89     
90      <font size="-1" color="#006633">optional</font>
91     
92     
93      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
94      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>'meshmask.nc'</i></font>
95     
96    </h4>
97
98   
99    Name of the meshmask file to read. If this name does not contain any "/"
100    and if iodirectory keyword is not specify, then the common variable
101    iodir will be use to define the mesh file path.
102
103   
104   
105
106   
107    <h3>Keywords</h3>
108
109   
110    <a name="#_ncdf_meshread_keyword_GLAMBOUNDARY"></a>
111    <h4>GLAMBOUNDARY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
112     
113     
114     
115     
116     
117      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2 elements vector</i></font>
118      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>those defined in the file</i></font>
119     
120    </h4>
121
122   
123    Longitude boundaries that should be used to visualize the data.
124      lon2 > lon1
125      lon2 - lon1 le 360
126    By default, the common (cm_4mesh) variable key_shift will be automatically
127    defined according to GLAMBOUNDARY.
128
129   
130    <a name="#_ncdf_meshread_keyword_CHECKDAT"></a>
131    <h4>CHECKDAT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
132     
133     
134     
135     
136     
137     
138     
139     
140    </h4>
141
142     Suppressed. Use micromeshmask.pro to create an
143    appropriate meshmask.
144
145   
146    <a name="#_ncdf_meshread_keyword_ONEARTH"></a>
147    <h4>ONEARTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
148     
149     
150     
151     
152     
153      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font>
154      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>1</i></font>
155     
156    </h4>
157
158   
159    Force the manual definition of data localization on the earth or not
160       0) if the data are not on the earth
161       1) if the data are on earth (in that case we can for example use
162          the labels 'longitude', 'latitude' in plots).
163    The resulting value will be stored in the common (cm_4mesh) variable key_onearth
164    ONEARTH = 0 forces PERIODIC = 0, SHIFT = 0 and is cancelling GLAMBOUNDARY
165
166   
167    <a name="#_ncdf_meshread_keyword_GETDIMENSIONS"></a>
168    <h4>GETDIMENSIONS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
169     
170     
171     
172     
173     
174      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font>
175      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
176     
177    </h4>
178
179   
180    Activate this keywords if you only want to know the dimension
181    of the domain stored in the mesh file. This dimensions will be
182    defined in jpiglo, jpjglo, jpkglo (cm_4mesh common variables)
183
184   
185    <a name="#_ncdf_meshread_keyword_PERIODIC"></a>
186    <h4>PERIODIC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
187     
188     
189     
190     
191     
192      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font>
193      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>computed by using the first line of glamt</i></font>
194     
195    </h4>
196
197   
198    Force the manual definition of the grid zonal periodicity.
199    The resulting value will be stored in the common (cm_4mesh) variable key_periodic
200    PERIODIC = 0 forces SHIFT = 0
201
202   
203    <a name="#_ncdf_meshread_keyword_SHIFT"></a>
204    <h4>SHIFT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
205     
206     
207     
208     
209     
210      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font>
211      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>computed according to glamboundary</i></font>
212     
213    </h4>
214
215   
216    Force the manual definition of the zonal shift that must be apply to the data.
217    The resulting value will be stored in the common (cm_4mesh) variable key_shift
218    Note that if key_periodic=0 then in any case key_shift = 0.
219
220   
221    <a name="#_ncdf_meshread_keyword_STRIDE"></a>
222    <h4>STRIDE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
223     
224     
225     
226     
227     
228      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>3 elements vector</i></font>
229      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>[1, 1, 1]</i></font>
230     
231    </h4>
232
233   
234    Specify the stride in x, y and z direction. The resulting
235    value will be stored in the common (cm_4mesh) variable key_stride
236
237   
238    <a name="#_ncdf_meshread_keyword_STRCALLING"></a>
239    <h4>STRCALLING&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
240     
241     
242     
243     
244     
245      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
246     
247     
248    </h4>
249
250   
251    the calling command used to call computegrid (this is used by xxx.pro)
252
253   
254    <a name="#_ncdf_meshread_keyword__EXTRA"></a>
255    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
256     
257     
258     
259     
260     
261     
262     
263     
264    </h4>
265
266     used to pass isafile keywords
267
268   
269   
270
271    <h3>Examples</h3>
272 IDL> ncdf_meshread [,' filename']
273
274    <h3>Version history</h3>
275   
276    <h4>Version</h4> $Id: ncdf_meshread.pro 172 2006-09-11 07:11:26Z smasson $
277
278    <h4>History</h4> Sebastien Masson (smasson@lodyc.jussieu.fr)
279                      12/1999
280 July 2004, Sebastien Masson: Several modifications (micromeshmask,
281 clean partial steps, clean use of key_stride, automatic definition
282 of key_shift, ...)
283 Oct. 2004, Sebastien Masson: add PERIODIC and SHIFT
284 Aug. 2005, Sebastien Masson: some cleaning + english
285
286   
287
288    <h3>Known issues</h3>
289   
290   
291   
292    <h4>Restrictions</h4>
293
294  ixminmesh,ixmaxmesh,iyminmesh,iymaxmesh,izminmesh,izmaxmesh must
295  be defined before calling ncdf_meshread. if some of those value
296  are equal to -1 they will be automatically defined
297
298
299    <h3>Other attributes</h3>
300   
301   
302    <h4>Uses routines</h4> cm_4mesh cm_4data cm_4cal
303
304   
305   
306   
307
308    <font size="-3"><p>&nbsp;</p></font>
309    <hr size="1" color="#CCCCCC"/>
310     
311
312   
313
314    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Wed Sep 13 16:32:11 2006.</font></p>
315
316  </body>
317</html>
Note: See TracBrowser for help on using the repository browser.