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

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

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