source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/INIT/initncdf.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>initncdf.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=""><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="initncdfxxx.html"><img src="./../../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ToBeReviewed/INIT/</font></h1>
58    <h2>initncdf.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 Initfile for Netcdf file. define all the grid parameters through
65 an appropriate call to computegid
66
67
68   
69
70     
71      <a name="#_initncdf"></a>
72
73      <h2>initncdf  <font size="-1" color="#006633">
74 Grid
75 </font></h2>
76
77      <p><font face="Courier">initncdf<i>, <a href="#_initncdf_keyword_ncfilein">ncfilein</a></i>, <a href="#_initncdf_keyword_XAXISNAME">XAXISNAME</a>=<i>scalar string</i>, <a href="#_initncdf_keyword_YAXISNAME">YAXISNAME</a>=<i>scalar string</i>, <a href="#_initncdf_keyword_ZAXISNAME">ZAXISNAME</a>=<i>scalar string</i>, <a href="#_initncdf_keyword_MASKNAME">MASKNAME</a>=<i>string</i>, <a href="#_initncdf_keyword_INVMASK">INVMASK</a>=<i>scalar: 0 or 1</i>, <a href="#_initncdf_keyword_USEASMASK">USEASMASK</a>=<i>scalar string</i>, <a href="#_initncdf_keyword_MISSING_VALUE">MISSING_VALUE</a>=<i>scalar</i>, <a href="#_initncdf_keyword_START1">START1</a>=<i>scalar: 0 or 1</i>, <a href="#_initncdf_keyword_XYINDEX">XYINDEX</a>=<i>scalar: 0 or 1</i>, <a href="#_initncdf_keyword_ZINDEX">ZINDEX</a>=<i>scalar: 0 or 1</i>, <a href="#_initncdf_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i></font></p>
78
79   
80
81
82   
83
84   
85    <h3>Parameters</h3>
86   
87
88    <a name="#_initncdf_keyword_ncfilein"></a>
89    <h4>ncfilein&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
90      <font size="-1" color="#006633">in</font>
91     
92     
93      <font size="-1" color="#006633">required</font>
94     
95      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
96     
97     
98    </h4>
99
100   
101 A string giving the name of the NetCdf file
102
103   
104   
105
106   
107    <h3>Keywords</h3>
108
109   
110    <a name="#_initncdf_keyword_XAXISNAME"></a>
111    <h4>XAXISNAME&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>scalar string</i></font>
118      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>'x', 'longitude', 'nav_lon', 'lon', 'lon_rho' or 'NbLongitudes'</i></font>
119     
120    </h4>
121
122   
123 A string giving the name of the variable in the file
124 that contains the [xyz]axis.
125     
126   
127    <a name="#_initncdf_keyword_YAXISNAME"></a>
128    <h4>YAXISNAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
129     
130     
131     
132     
133     
134      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
135      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>'y', 'latitude', 'nav_lat','lat', 'lat_rho' or 'NbLatitudes'</i></font>
136     
137    </h4>
138
139   
140 A string giving the name of the variable in the file
141 that contains the [xyz]axis.
142
143   
144    <a name="#_initncdf_keyword_ZAXISNAME"></a>
145    <h4>ZAXISNAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
146     
147     
148     
149     
150     
151      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
152      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>'z', 'level', 'lev', 'depth...'</i></font>
153     
154    </h4>
155
156   
157 A string giving the name of the variable in the file
158 that contains the [xyz]axis.
159
160   
161    <a name="#_initncdf_keyword_MASKNAME"></a>
162    <h4>MASKNAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
163     
164     
165     
166     
167     
168      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font>
169     
170     
171    </h4>
172
173   
174 A string giving the name of the variable in the file
175 that contains the land/sea mask
176
177   
178    <a name="#_initncdf_keyword_INVMASK"></a>
179    <h4>INVMASK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
180     
181     
182     
183     
184     
185      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font>
186      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
187     
188    </h4>
189
190   
191 Inverse the land/sea mask (that should have 0/1 values for land/sea): mask = 1-mask
192
193   
194    <a name="#_initncdf_keyword_USEASMASK"></a>
195    <h4>USEASMASK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
196     
197     
198     
199     
200     
201      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
202     
203     
204    </h4>
205
206   
207 A string giving the name of the variable in the file
208 that will be used to build the land/sea mask. In this case the
209 mask is based on the first record (if record dimension
210 exists). The mask is build according to :
211    1 the keyword missing_value if existing
212    2 the attribute 'missing_value' if existing
213    3 NaN values if existing
214
215   
216    <a name="#_initncdf_keyword_MISSING_VALUE"></a>
217    <h4>MISSING_VALUE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
218     
219     
220     
221     
222     
223      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font>
224     
225     
226    </h4>
227
228   
229 To define (or redefine if the attribute is
230 already existing) the missing values used with USEASMASK
231 keyword
232
233   
234    <a name="#_initncdf_keyword_START1"></a>
235    <h4>START1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
236     
237     
238     
239     
240     
241      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font>
242      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
243     
244    </h4>
245
246   
247 Index the axis from 1 instead of 0 when using
248 /xyindex and/or zindex
249
250   
251    <a name="#_initncdf_keyword_XYINDEX"></a>
252    <h4>XYINDEX&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
253     
254     
255     
256     
257     
258      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font>
259      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
260     
261    </h4>
262
263   
264 To define the x/y axis with index instead of using
265 the values contained in X/YAXISNAME.
266 x/yaxis = keyword_set(start1) + findgen(jpi/jpj)
267 this forces key_onearth = 0
268
269   
270    <a name="#_initncdf_keyword_ZINDEX"></a>
271    <h4>ZINDEX&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
272     
273     
274     
275     
276     
277      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font>
278      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
279     
280    </h4>
281
282   
283 To define the z axis with index instead of using
284 the values contained in ZAXISNAME.
285 zaxis = keyword_set(start1) + findgen(jpk)
286 
287   
288    <a name="#_initncdf_keyword__EXTRA"></a>
289    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
290     
291     
292     
293     
294     
295     
296     
297     
298    </h4>
299
300   
301 Used to pass keywords to computegrid
302
303   
304   
305
306    <h3>Examples</h3>
307  IDL> initncdf,'toto.nc',glam=[-180,180]
308
309    <h3>Version history</h3>
310   
311    <h4>Version</h4>
312 $Id: initncdf.pro 172 2006-09-11 07:11:26Z smasson $
313
314    <h4>History</h4>
315 Sebastien Masson (smasson@lodyc.jussieu.fr)
316                      8 May 2002
317
318   
319
320    <h3>Known issues</h3>
321   
322   
323   
324    <h4>Restrictions</h4>
325 Change the grid parameters (see computegrid)
326
327
328 the file must contain an x and an y axis. (1 ou 2 dimentional array)
329
330
331    <h3>Other attributes</h3>
332   
333   
334    <h4>Uses routines</h4>
335 common.pro
336
337   
338   
339   
340
341    <font size="-3"><p>&nbsp;</p></font>
342    <hr size="1" color="#CCCCCC"/>
343     
344
345   
346
347    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Wed Sep 13 16:32:39 2006.</font></p>
348
349  </body>
350</html>
Note: See TracBrowser for help on using the repository browser.