source: trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/ncdf_getaxis.html @ 412

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

update documentation
File size: 11.3 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>ncdf_getaxis.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="ncdf_getatt.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="ncdf_getmask.html"><img src="./../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ReadWrite/</font></h1>
58    <h2>ncdf_getaxis.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 get the x/y dimension Id and x/y axes from a netcdf file
65
66
67   
68
69     
70      <a name="#_ncdf_getaxis"></a>
71
72      <h2>ncdf_getaxis  <font size="-1" color="#006633">
73 Read NetCDF file
74</font></h2>
75
76      <p><font face="Courier">ncdf_getaxis<i>, <a href="#_ncdf_getaxis_keyword_fileid">fileid</a>, <a href="#_ncdf_getaxis_keyword_dimidx">dimidx</a>, <a href="#_ncdf_getaxis_keyword_dimidy">dimidy</a>, <a href="#_ncdf_getaxis_keyword_xaxis">xaxis</a>, <a href="#_ncdf_getaxis_keyword_yaxis">yaxis</a></i>, <a href="#_ncdf_getaxis_keyword_XAXISNAME">XAXISNAME</a>=<i>scalar string</i>, <a href="#_ncdf_getaxis_keyword_YAXISNAME">YAXISNAME</a>=<i>scalar string</i>, <a href="#_ncdf_getaxis_keyword_XDIMNAME">XDIMNAME</a>=<i>scalar string</i>, <a href="#_ncdf_getaxis_keyword_YDIMNAME">YDIMNAME</a>=<i>scalar string</i>, <a href="#_ncdf_getaxis_keyword_XYINDEX">XYINDEX</a>=<i>scalar: 0 or 1</i>, <a href="#_ncdf_getaxis_keyword_START1">START1</a>=<i>scalar: 0 or 1</i>, <a href="#_ncdf_getaxis_keyword_XMINMESH">XMINMESH</a>=<i>scalar</i>, <a href="#_ncdf_getaxis_keyword_XMAXMESH">XMAXMESH</a>=<i>scalar</i>, <a href="#_ncdf_getaxis_keyword_YMINMESH">YMINMESH</a>=<i>scalar</i>, <a href="#_ncdf_getaxis_keyword_YMAXMESH">YMAXMESH</a>=<i>scalar</i>, <a href="#_ncdf_getaxis_keyword_ROMSGRID">ROMSGRID</a>=<i>variable</i>, <a href="#_ncdf_getaxis_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i></font></p>
77
78   
79
80
81   
82
83   
84    <h3>Parameters</h3>
85   
86
87    <a name="#_ncdf_getaxis_keyword_fileid"></a>
88    <h4>fileid&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
89      <font size="-1" color="#006633">in</font>
90     
91     
92      <font size="-1" color="#006633">required</font>
93     
94      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font>
95     
96     
97    </h4>
98
99   
100 the id of the netcdf file
101
102   
103
104    <a name="#_ncdf_getaxis_keyword_dimidx"></a>
105    <h4>dimidx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
106     
107      <font size="-1" color="#006633">out</font>
108     
109     
110     
111      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar (long)</i></font>
112     
113     
114    </h4>
115
116   
117 id of the x dimension
118
119   
120
121    <a name="#_ncdf_getaxis_keyword_dimidy"></a>
122    <h4>dimidy&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
123     
124      <font size="-1" color="#006633">out</font>
125     
126     
127     
128      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar (long)</i></font>
129     
130     
131    </h4>
132
133   
134 id of the y dimension
135
136   
137
138    <a name="#_ncdf_getaxis_keyword_xaxis"></a>
139    <h4>xaxis&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
140     
141      <font size="-1" color="#006633">out</font>
142     
143     
144     
145      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>1D or 2D array</i></font>
146     
147     
148    </h4>
149
150   
151 the x axis
152
153   
154
155    <a name="#_ncdf_getaxis_keyword_yaxis"></a>
156    <h4>yaxis&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
157     
158      <font size="-1" color="#006633">out</font>
159     
160     
161     
162      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>1D or 2D array</i></font>
163     
164     
165    </h4>
166
167   
168 the y axis
169
170   
171   
172
173   
174    <h3>Keywords</h3>
175
176   
177    <a name="#_ncdf_getaxis_keyword_XAXISNAME"></a>
178    <h4>XAXISNAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
179     
180     
181     
182     
183     
184      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
185      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>'x', 'longitude', 'nav_lon', 'lon', 'lon_rho' or 'NbLongitudes'</i></font>
186     
187    </h4>
188
189   
190 A string giving the name of the variable in the file
191 that contains the x axis or/and a named variable
192 in which this variable name is returned.
193
194   
195    <a name="#_ncdf_getaxis_keyword_YAXISNAME"></a>
196    <h4>YAXISNAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
197     
198     
199     
200     
201     
202      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
203      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>'y', 'latitude', 'nav_lat','lat', 'lat_rho' or 'NbLatitudes'</i></font>
204     
205    </h4>
206
207   
208 A string giving the name of the variable in the file
209 that contains the y axis or/and a named variable
210 in which this variable name is returned.
211
212   
213    <a name="#_ncdf_getaxis_keyword_XDIMNAME"></a>
214    <h4>XDIMNAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
215     
216     
217     
218     
219     
220      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
221      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>'longitude', 'lon', 'x', 'longitude*', 'lon*', 'x*', '*longitude*', '*lon*' or '*x*'</i></font>
222     
223    </h4>
224
225   
226 A string giving the name of the x dimension or/and a named variable
227 in which x dimension name is returned.
228
229   
230    <a name="#_ncdf_getaxis_keyword_YDIMNAME"></a>
231    <h4>YDIMNAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
232     
233     
234     
235     
236     
237      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
238      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>'latitude', 'lat', 'y', 'latitude*', 'lat*', 'y*', 'eta_*', '*latitude*', '*lat*', '*y*'</i></font>
239     
240    </h4>
241
242   
243 A string giving the name of the y dimension or/and a named variable
244 in which y dimension name is returned.
245
246   
247    <a name="#_ncdf_getaxis_keyword_XYINDEX"></a>
248    <h4>XYINDEX&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
249     
250     
251     
252     
253     
254      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font>
255      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
256     
257    </h4>
258
259   
260 To define the x/y axis with index instead of using
261 the values contained in X/YAXISNAME.
262 x/yaxis = keyword_set(start1) + findgen(jpi/jpj)
263
264   
265    <a name="#_ncdf_getaxis_keyword_START1"></a>
266    <h4>START1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
267     
268     
269     
270     
271     
272      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font>
273      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
274     
275    </h4>
276
277   
278 Index the axis from 1 instead of 0 when using /xyindex
279
280   
281    <a name="#_ncdf_getaxis_keyword_XMINMESH"></a>
282    <h4>XMINMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
283     
284     
285     
286     
287     
288      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font>
289      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0L</i></font>
290     
291    </h4>
292
293   
294 Define common (cm_4mesh) variables ixminmesh used to define the localization
295 of the first point of the grid along the x direction in a zoom of the original grid
296
297   
298    <a name="#_ncdf_getaxis_keyword_XMAXMESH"></a>
299    <h4>XMAXMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
300     
301     
302     
303     
304     
305      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font>
306      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>jpiglo-1</i></font>
307     
308    </h4>
309
310   
311 Define common (cm_4mesh) variables ixmaxmesh used to define the localization
312 of the last point of the grid along the x direction in a zoom of the original grid
313 Note that if XMAXMESH < 0 then ixmaxmesh is defined as ixmaxmesh = jpiglo -1 + xmaxmesh
314
315   
316    <a name="#_ncdf_getaxis_keyword_YMINMESH"></a>
317    <h4>YMINMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
318     
319     
320     
321     
322     
323      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font>
324      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0L</i></font>
325     
326    </h4>
327
328   
329 Define common (cm_4mesh) variables iyminmesh used to define the localization
330 of the first point of the grid along the y direction in a zoom of the original grid
331
332   
333    <a name="#_ncdf_getaxis_keyword_YMAXMESH"></a>
334    <h4>YMAXMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
335     
336     
337     
338     
339     
340      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font>
341      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>jpjglo-1</i></font>
342     
343    </h4>
344
345   
346 Define common (cm_4mesh) variables iymaxmesh used to define the localization
347 of the last point of the grid along the y direction in a zoom of the original grid
348 Note that if YMAXMESH < 0 then iymaxmesh is defined as iymaxmesh = jpjglo -1 + ymaxmesh
349
350   
351    <a name="#_ncdf_getaxis_keyword_ROMSGRID"></a>
352    <h4>ROMSGRID&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
353     
354      <font size="-1" color="#006633">out</font>
355     
356     
357     
358      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font>
359     
360     
361    </h4>
362
363   
364 gives back if we are using a ROMS grid (1) or not (0)
365
366   
367    <a name="#_ncdf_getaxis_keyword__EXTRA"></a>
368    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
369     
370     
371     
372     
373     
374     
375     
376     
377    </h4>
378
379   
380 Used to be able to call ncdf_getaxis with _extra
381
382   
383   
384
385   
386    </pre><h3>Version history</h3>
387   
388    <h4>Version</h4>
389 $Id: ncdf_getaxis.pro 399 2009-07-02 08:38:54Z smasson $
390    <h4>History</h4>
391 March 2007: Sebastien Masson (smasson@locean-ipsl.upmc.fr)
392
393
394   
395
396   
397   
398   
399   
400   
401
402   
403   
404   
405   
406   
407   
408   
409
410    <font size="-3"><p>&nbsp;</p></font>
411    <hr size="1" color="#CCCCCC"/>
412     
413
414   
415
416    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
417
418  </body>
419</html>
Note: See TracBrowser for help on using the repository browser.