source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/INIT/initncdf.html @ 338

Last change on this file since 338 was 338, checked in by smasson, 16 years ago

update documentation
File size: 5.8 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_ZAXISNAME">ZAXISNAME</a>=<i>scalar string</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_ZAXISNAME"></a>
111    <h4>ZAXISNAME&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>'z', 'level', 'lev', 'depth...'</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_START1"></a>
128    <h4>START1&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: 0 or 1</i></font>
135      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
136     
137    </h4>
138
139   
140 Index the axis from 1 instead of 0 when using
141 /xyindex and/or /zindex
142
143   
144    <a name="#_initncdf_keyword_XYINDEX"></a>
145    <h4>XYINDEX&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: 0 or 1</i></font>
152      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
153     
154    </h4>
155
156   
157 To define the x/y axis with index instead of using
158 the values contained in X/YAXISNAME.
159 x/yaxis = keyword_set(start1) + findgen(jpi/jpj)
160 this forces key_onearth = 0
161
162   
163    <a name="#_initncdf_keyword_ZINDEX"></a>
164    <h4>ZINDEX&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
165     
166     
167     
168     
169     
170      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font>
171      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
172     
173    </h4>
174
175   
176 To define the z axis with index instead of using
177 the values contained in ZAXISNAME.
178 zaxis = keyword_set(start1) + findgen(jpk)
179
180   
181    <a name="#_initncdf_keyword__EXTRA"></a>
182    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
183     
184     
185     
186     
187     
188     
189     
190     
191    </h4>
192
193   
194 Used to pass keywords to <a href="../..//Grid/computegrid.html">computegrid</a>,
195 <a href="../..//ReadWrite/ncdf_getaxis.html">ncdf_getaxis</a>, <a href="../..//ReadWrite/ncdf_getmask.html">ncdf_getmask</a> and <a href="../..//Utilities/isafile.html">isafile</a>
196
197   
198   
199
200    <h3>Examples</h3><pre>
201 IDL> initncdf,'toto.nc',glam=[-180,180]
202
203    </pre><h3>Version history</h3>
204   
205    <h4>Version</h4>
206 $Id: initncdf.pro 327 2007-12-13 16:22:35Z pinsard $
207
208    <h4>History</h4>
209 Sebastien Masson (smasson@lodyc.jussieu.fr)
210                      8 May 2002
211
212   
213
214    <h3>Known issues</h3>
215   
216   
217   
218    <h4>Restrictions</h4>
219 Change the grid parameters (see <a href="../..//Grid/computegrid.html">computegrid</a>)
220
221
222 the file must contain an x and an y axis. (1 ou 2 dimensional array)
223
224
225    <h3>Other attributes</h3>
226   
227   
228    <h4>Uses routines</h4>
229 common.pro
230
231   
232   
233   
234
235    <font size="-3"><p>&nbsp;</p></font>
236    <hr size="1" color="#CCCCCC"/>
237     
238
239   
240
241    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
242
243  </body>
244</html>
Note: See TracBrowser for help on using the repository browser.