source: trunk/SRC/Documentation/idldoc_html_output/ReadWrite/ncdf_getaxis.html @ 402

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

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