Context Navigation

source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/INIT/initncdf.html @ 195

Last change on this file since 195 was 195, checked in by smasson, 18 years ago
update doc and rm old pages
File size: 10.0 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>initncdf.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="initncdf.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="../../../../ToBeReviewed/INIT//initncdf.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 documentation</td>
67	</tr>
68	</table>
69
70	</div>
71
72	<div id="secondary_navbar">
73
74	<< prev file \| <a href="initncdfxxx.html">next file >></a>    <a href="initncdf.html" target="_TOP">view single page</a> \| <a href="./../../index.html" target="_TOP">view frames</a>    summary: fields \| routine    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">ToBeReviewed/INIT/</a></h1>
82	<h2 class="pro_file">initncdf.pro</h2>
83
84	<div id="file_attr">
85	<dl>
86	</dl>
87	</div>
88
89	<div id="file_comments">
90	Initfile for Netcdf file. define all the grid parameters through
91	an appropriate call to computegid
92	</div>
93
94
95
96
97
98
99
100
101
102	<div id="routine_details">
103
104
105	<div class="routine_details" id="_initncdf">
106
107	<h2><a class="top" href="#container">top</a>initncdf <span class="categories">
108	Grid
109	</span></h2>
110
111	<p class="header">
112	initncdf<span class="result">, <a href="#_initncdf_param_ncfilein">ncfilein</a></span>, <a href="#_initncdf_keyword_XAXISNAME">XAXISNAME</a>=<span class="result">scalar string</span>, <a href="#_initncdf_keyword_YAXISNAME">YAXISNAME</a>=<span class="result">scalar string</span>, <a href="#_initncdf_keyword_ZAXISNAME">ZAXISNAME</a>=<span class="result">scalar string</span>, <a href="#_initncdf_keyword_MASKNAME">MASKNAME</a>=<span class="result">string</span>, <a href="#_initncdf_keyword_INVMASK">INVMASK</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_initncdf_keyword_USEASMASK">USEASMASK</a>=<span class="result">scalar string</span>, <a href="#_initncdf_keyword_MISSING_VALUE">MISSING_VALUE</a>=<span class="result">scalar</span>, <a href="#_initncdf_keyword_START1">START1</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_initncdf_keyword_XYINDEX">XYINDEX</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_initncdf_keyword_ZINDEX">ZINDEX</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_initncdf_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p>
113
114	<div class="comments">
115	</div>
116
117
118
119
120	<h3>Parameters</h3>
121
122
123	<h4 id="_initncdf_param_ncfilein">ncfilein
124	<span class="attr">in</span>
125
126
127	<span class="attr">required</span>
128
129	<span class="attr">type:</span> <span class="value">scalar string</span>
130
131
132	</h4>
133
134	<div class="comments">
135	A string giving the name of the NetCdf file
136	</div>
137
138
139
140
141
142
143	<h3>Keywords</h3>
144
145	<h4 id="_initncdf_keyword_XAXISNAME">XAXISNAME
146
147
148
149
150
151	<span class="attr">type:</span> <span class="value">scalar string</span>
152	<span class="attr">default:</span> <span class="value">'x', 'longitude', 'nav_lon', 'lon', 'lon_rho' or 'NbLongitudes'</span>
153
154	</h4>
155
156	<div class="comments">
157	A string giving the name of the variable in the file
158	that contains the [xyz]axis.
159	</div>
160
161	<h4 id="_initncdf_keyword_YAXISNAME">YAXISNAME
162
163
164
165
166
167	<span class="attr">type:</span> <span class="value">scalar string</span>
168	<span class="attr">default:</span> <span class="value">'y', 'latitude', 'nav_lat','lat', 'lat_rho' or 'NbLatitudes'</span>
169
170	</h4>
171
172	<div class="comments">
173	A string giving the name of the variable in the file
174	that contains the [xyz]axis.
175	</div>
176
177	<h4 id="_initncdf_keyword_ZAXISNAME">ZAXISNAME
178
179
180
181
182
183	<span class="attr">type:</span> <span class="value">scalar string</span>
184	<span class="attr">default:</span> <span class="value">'z', 'level', 'lev', 'depth...'</span>
185
186	</h4>
187
188	<div class="comments">
189	A string giving the name of the variable in the file
190	that contains the [xyz]axis.
191	</div>
192
193	<h4 id="_initncdf_keyword_MASKNAME">MASKNAME
194
195
196
197
198
199	<span class="attr">type:</span> <span class="value">string</span>
200
201
202	</h4>
203
204	<div class="comments">
205	A string giving the name of the variable in the file
206	that contains the land/sea mask
207	</div>
208
209	<h4 id="_initncdf_keyword_INVMASK">INVMASK
210
211
212
213
214
215	<span class="attr">type:</span> <span class="value">scalar: 0 or 1</span>
216	<span class="attr">default:</span> <span class="value">0</span>
217
218	</h4>
219
220	<div class="comments">
221	Inverse the land/sea mask (that should have 0/1 values for land/sea): mask = 1-mask
222	</div>
223
224	<h4 id="_initncdf_keyword_USEASMASK">USEASMASK
225
226
227
228
229
230	<span class="attr">type:</span> <span class="value">scalar string</span>
231
232
233	</h4>
234
235	<div class="comments">
236	A string giving the name of the variable in the file
237	that will be used to build the land/sea mask. In this case the
238	mask is based on the first record (if record dimension
239	exists). The mask is build according to :
240	1 the keyword missing_value if existing
241	2 the attribute 'missing_value' if existing
242	3 NaN values if existing
243	</div>
244
245	<h4 id="_initncdf_keyword_MISSING_VALUE">MISSING_VALUE
246
247
248
249
250
251	<span class="attr">type:</span> <span class="value">scalar</span>
252
253
254	</h4>
255
256	<div class="comments">
257	To define (or redefine if the attribute is
258	already existing) the missing values used with USEASMASK
259	keyword
260	</div>
261
262	<h4 id="_initncdf_keyword_START1">START1
263
264
265
266
267
268	<span class="attr">type:</span> <span class="value">scalar: 0 or 1</span>
269	<span class="attr">default:</span> <span class="value">0</span>
270
271	</h4>
272
273	<div class="comments">
274	Index the axis from 1 instead of 0 when using
275	/xyindex and/or zindex
276	</div>
277
278	<h4 id="_initncdf_keyword_XYINDEX">XYINDEX
279
280
281
282
283
284	<span class="attr">type:</span> <span class="value">scalar: 0 or 1</span>
285	<span class="attr">default:</span> <span class="value">0</span>
286
287	</h4>
288
289	<div class="comments">
290	To define the x/y axis with index instead of using
291	the values contained in X/YAXISNAME.
292	x/yaxis = keyword_set(start1) + findgen(jpi/jpj)
293	this forces key_onearth = 0
294	</div>
295
296	<h4 id="_initncdf_keyword_ZINDEX">ZINDEX
297
298
299
300
301
302	<span class="attr">type:</span> <span class="value">scalar: 0 or 1</span>
303	<span class="attr">default:</span> <span class="value">0</span>
304
305	</h4>
306
307	<div class="comments">
308	To define the z axis with index instead of using
309	the values contained in ZAXISNAME.
310	zaxis = keyword_set(start1) + findgen(jpk)
311	</div>
312
313	<h4 id="_initncdf_keyword__EXTRA">_EXTRA
314
315
316
317
318
319
320
321
322	</h4>
323
324	<div class="comments">
325	Used to pass keywords to computegrid
326	</div>
327
328
329
330	<h3>Examples</h3><div class="preformat">
331	IDL> initncdf,'toto.nc',glam=[-180,180]
332	</div>
333	<h3>Version history</h3>
334
335	<h4>Version</h4><div class="preformat">
336	$Id: initncdf.pro 192 2006-09-22 09:37:08Z smasson $
337	</div>
338	<h4>History</h4><div class="preformat">
339	Sebastien Masson (smasson@lodyc.jussieu.fr)
340	8 May 2002
341	</div>
342
343
344	<h3>Known issues</h3>
345
346
347
348	<h4>Restrictions</h4><div class="preformat">
349	Change the grid parameters (see computegrid)
350
351
352	the file must contain an x and an y axis. (1 ou 2 dimentional array)
353	</div>
354
355	<h3>Other attributes</h3>
356
357
358	<h4>Uses routines</h4><div class="preformat">
359	common.pro
360	</div>
361
362
363
364
365	<h3>Statistics</h3>
366	<table class="statistics">
367	<tr><td>McCabe cyclic</td><td> 64</td></tr>
368	<tr><td>McCabe essential</td><td> 1</td></tr>
369	<tr><td>McCabe modular design</td><td> 1</td></tr>
370	</table>
371
372
373	</div>
374
375	</div>
376
377
378
379	<div id="tagline">Produced by IDLdoc 2.0.</div>
380
381	</div>
382
383	</body>
384	</html>

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

Download in other formats: