Context Navigation

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

Last change on this file since 163 was 163, checked in by navarro, 18 years ago
header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)
File size: 7.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="restoreboxparam.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>GLAMBOUNDARY</i>, <a href="#_ncdf_meshread_keyword_CHECKDAT">CHECKDAT</a>=<i>CHECKDAT</i>, <a href="#_ncdf_meshread_keyword_ONEARTH">ONEARTH</a>=<i>ONEARTH</i>, <a href="#_ncdf_meshread_keyword_GETDIMENSIONS">GETDIMENSIONS</a>=<i>GETDIMENSIONS</i>, <a href="#_ncdf_meshread_keyword_PERIODIC">PERIODIC</a>=<i>PERIODIC</i>, <a href="#_ncdf_meshread_keyword_SHIFT">SHIFT</a>=<i>SHIFT</i>, <a href="#_ncdf_meshread_keyword_STRIDE">STRIDE</a>=<i>STRIDE</i>, <a href="#_ncdf_meshread_keyword_STRCALLING">STRCALLING</a>=<i>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
88	<font size="-1" color="#006633">in</font>
89
90	<font size="-1" color="#006633">optional</font>
91
92
93
94	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>meshmask.nc</i></font>
95
96	</h4>
97
98
99	the name of the meshmask file to read.
100	if this name does not contain any "/" and if
101	iodirectory keyword is not specify, then the common variable
102	iodir will be use to define the mesh file path.
103
104
105
106
107
108	<h3>Keywords</h3>
109
110
111	<a name="#_ncdf_meshread_keyword_GLAMBOUNDARY"></a>
112	<h4>GLAMBOUNDARY
113
114
115
116
117
118
119
120
121	</h4>
122
123	a 2 elements vector, [lon1,lon2], the longitude
124	boundaries that should be used to visualize the data.
125	lon2 > lon1
126	lon2 - lon1 le 360
127	key_shift will be automatically defined according to GLAMBOUNDARY.
128
129
130	<a name="#_ncdf_meshread_keyword_CHECKDAT"></a>
131	<h4>CHECKDAT
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
148
149
150
151
152
153
154	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>key_onearth</i></font>
155
156	</h4>
157
158
159	= 0 or 1 to force the manual definition of
160	key_onearth (to specify if the data are on earth -> use longitude
161	/latitude etc...).
162	note that ONEARTH = 0 forces PERIODIC = 0, SHIFT = 0 and is
163	cancelling GLAMBOUNDARY
164
165
166	<a name="#_ncdf_meshread_keyword_GETDIMENSIONS"></a>
167	<h4>GETDIMENSIONS
168
169
170
171
172
173
174
175
176	</h4>
177
178
179	Activate this keywords if you only want to know the dimension
180	of the domain stored in the mesh file. This dimensions will be
181	defined in jpiglo, jpjglo, jpkglo (cm_4mesh common variables)
182
183
184	<a name="#_ncdf_meshread_keyword_PERIODIC"></a>
185	<h4>PERIODIC
186
187
188
189
190
191
192	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>key_periodic is automatically computed by using the first line of glamt</i></font>
193
194	</h4>
195
196
197	= 0 or 1 to force the manual definition of
198	key_periodic.
199
200
201	<a name="#_ncdf_meshread_keyword_SHIFT"></a>
202	<h4>SHIFT
203
204
205
206
207
208
209	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i> key_shift is automatically computed according to the glamboundary</i></font>
210
211	</h4>
212
213
214	to force the manual definition of key_shift. By
215	default, key_shift is automatically computed according to the
216	glamboundary (when defined) by using the first line of glamt. if
217	key_periodic=0 then in any case key_shift = 0.
218
219
220	<a name="#_ncdf_meshread_keyword_STRIDE"></a>
221	<h4>STRIDE
222
223
224
225
226
227
228	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>key_stride</i></font>
229
230	</h4>
231
232
233	a 3 elements vector to specify the stride in x, y, z direction.
234	The resulting value will be stored in the common (cm_4mesh) variable
235	key_stride
236
237
238	<a name="#_ncdf_meshread_keyword_STRCALLING"></a>
239	<h4>STRCALLING
240
241
242
243
244
245	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font>
246
247
248	</h4>
249
250
251	a string containing the calling command used to call
252	computegrid (this is used by xxx.pro)
253
254
255	<a name="#_ncdf_meshread_keyword__EXTRA"></a>
256	<h4>_EXTRA
257
258
259
260
261
262
263
264
265	</h4>
266
267	used to pass your keywords to the created function.
268
269
270
271
272	<h3>Examples</h3>
273	IDL> ncdf_meshread [,' filename']
274
275	<h3>Version history</h3>
276
277	<h4>Version</h4> $Id: ncdf_meshread.pro 157 2006-08-21 09:01:50Z navarro $
278
279	<h4>History</h4> Sebastien Masson (smasson@lodyc.jussieu.fr)
280	12/1999
281	July 2004, Sebastien Masson: Several modifications (micromeshmask,
282	clean partial steps, clean use of key_stride, automatic definition
283	of key_shift, ...)
284	Oct. 2004, Sebastien Masson: add PERIODIC and SHIFT
285	Aug. 2005, Sebastien Masson: some cleaning + english
286
287
288
289	<h3>Known issues</h3>
290
291
292
293	<h4>Restrictions</h4> define and/or use common variables from
294	cm_4mesh, cm_4data, cm_4cal
295
296
297
298	ixminmesh,ixmaxmesh,iyminmesh,iymaxmesh,izminmesh,izmaxmesh must
299	be defined before calling ncdf_meshread. if some of those value
300	are equal to -1 they will be automatically defined
301
302
303	<h3>Other attributes</h3>
304
305
306	<h4>Uses routines</h4> cm_4mesh cm_4data cm_4cal
307
308
309
310
311
312	<font size="-3"><p> </p></font>
313	<hr size="1" color="#CCCCCC"/>
314
315
316
317
318	<p><font color="gray" size="-3">  Produced by IDLdoc 2.0 on Tue Aug 29 14:49:13 2006.</font></p>
319
320	</body>
321	</html>

Note: See TracBrowser for help on using the repository browser.

Download in other formats: