source: trunk/SRC/Documentation/idldoc_html_output/Interpolation/get_gridparams.html @ 107

Last change on this file since 107 was 107, checked in by smasson, 18 years ago

bugfix in ead/write_oasis
File size: 7.3 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>get_gridparams.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="get_gridparams.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?format=raw" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../search-page.html?format=raw" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td >Source</td>
58     
59
60     
61      <td><a href="./../idldoc-help.html?format=raw" 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="fromreg.html">&lt;&lt;prev file</a> | <a href="imoms3.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="get_gridparams.html?format=raw" target="_TOP">view single page</a> | <a href="./../index.html?format=raw" 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?format=raw">Interpolation/</a></h1>
82      <h2 class="pro_file">get_gridparams.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments"> 
90   1) extract from a NetCDF file the longitude, latidude, and their dimensions
91      and make sure it is 1D or 2D arrays
92   
93   or 2) given longitude and latitude arrays get their dimensions and make sure
94      they are 1D or 2D arrays
95</div>
96
97     
98
99     
100
101     
102
103     
104
105      <div id="routine_details">
106       
107
108        <div class="routine_details" id="_get_gridparams">
109
110          <h2><a class="top" href="#container">top</a>get_gridparams <span class="categories"> interpolation
111</span></h2>
112       
113          <p class="header">
114            get_gridparams<span class="result">, <a href="#_get_gridparams_param_in1">in1</a>, <a href="#_get_gridparams_param_in2">in2</a>, <a href="#_get_gridparams_param_in3">in3</a>, <a href="#_get_gridparams_param_in4">in4</a>, <a href="#_get_gridparams_param_in5">in5</a>, <a href="#_get_gridparams_param_in6">in6</a>, <a href="#_get_gridparams_param_in7">in7</a>, <a href="#_get_gridparams_param_in8">in8</a></span>, <a href="#_get_gridparams_keyword_DOUBLE">DOUBLE</a>=<span class="result">DOUBLE</span></p>
115       
116          <div class="comments">
117</div>
118
119         
120
121         
122            <h3>Parameters</h3>
123       
124           
125            <h4 id="_get_gridparams_param_in1">in1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
126              <span class="attr">in</span>
127              <span class="attr">out</span>
128             
129              <span class="attr">required</span>
130             
131             
132             
133             
134            </h4>
135       
136          <div class="comments">  the name of the netcdf file
137  1d or 2D arrays defining longitudes and latitudes.
138 the variable that will contain the longitudes</div>
139           
140            <h4 id="_get_gridparams_param_in2">in2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
141              <span class="attr">in</span>
142              <span class="attr">out</span>
143             
144              <span class="attr">required</span>
145             
146             
147             
148             
149            </h4>
150       
151          <div class="comments">  the name of the variable that contains the longitude in the NetCDF file
152  1d or 2D arrays defining longitudes and latitudes.
153    Note that these arrays are also outputs and can therefore be modified.
154
155 the variable that will contain the latitudes</div>
156           
157            <h4 id="_get_gridparams_param_in3">in3&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
158              <span class="attr">in</span>
159             
160             
161              <span class="attr">required</span>
162             
163             
164             
165             
166            </h4>
167       
168          <div class="comments">  the name of the variable that contains the latitude in the NetCDF file
169 the number of points in the longitudinal direction</div>
170           
171            <h4 id="_get_gridparams_param_in4">in4&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
172              <span class="attr">in</span>
173              <span class="attr">out</span>
174             
175             
176             
177             
178             
179             
180            </h4>
181       
182          <div class="comments"> the number of points in the longitudinal direction
183 the number of points in the latitudinal direction</div>
184           
185            <h4 id="_get_gridparams_param_in5">in5&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
186              <span class="attr">in</span>
187              <span class="attr">out</span>
188             
189             
190             
191             
192             
193             
194            </h4>
195       
196          <div class="comments"> the number of points in the latitudinal direction
197 1 or 2 to specify if lon and lat should be 1D (jpi or jpj)
198    arrays or 2D arrays (jpi,jpj). Note that of  n_dimensions = 1, then the
199    grid must be regular (each longitudes must be the same for all latitudes
200    and each latitudes should be the sae for all longitudes).
201</div>
202           
203            <h4 id="_get_gridparams_param_in6">in6&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
204             
205              <span class="attr">out</span>
206             
207             
208             
209             
210             
211             
212            </h4>
213       
214          <div class="comments"> the variable that will contain the longitudes</div>
215           
216            <h4 id="_get_gridparams_param_in7">in7&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
217             
218              <span class="attr">out</span>
219             
220             
221             
222             
223             
224             
225            </h4>
226       
227          <div class="comments"> the variable that will contain the latitudes</div>
228           
229            <h4 id="_get_gridparams_param_in8">in8&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
230             
231              <span class="attr">out</span>
232             
233             
234             
235             
236             
237             
238            </h4>
239       
240          <div class="comments"> 1 or 2 to specify if lon and lat should be 1D (jpi or jpj)
241
242 or
243
244 2) </div>
245           
246
247         
248
249         
250
251            <h3>Keywords</h3>
252           
253            <h4 id="_get_gridparams_keyword_DOUBLE">DOUBLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
254             
255             
256             
257             
258             
259             
260             
261             
262            </h4>
263       
264            <div class="comments"></div>
265           
266         
267
268          <h3>Examples</h3><div class="value"> 
269 
270 1) get_gridparams, file, lonname, latname, lon, lat, jpi, jpj, n_dimensions
271
272 or
273
274 2) get_gridparams, lon, lat, jpi, jpj, n_dimensions
275
276 1)
277 
278 
279 1) ncdf_get_gridparams, 'coordinates_ORCA_R05.nc', 'glamt', 'gphit' $
280            , olon, olat, jpio, jpjo, 2
281
282 2) ncdf_get_gridparams, olon, olat, jpio, jpjo, 2
283</div>
284          <h3>Version history</h3>
285         
286         
287          <h4>History</h4><div class="value">
288  November 2005: Sebastien Masson (smasson@lodyc.jussieu.fr)
289 </div>
290         
291         
292         
293         
294         
295         
296         
297       
298         
299         
300         
301         
302         
303         
304         
305       
306         
307       
308        </div>
309       
310      </div>
311
312     
313
314      <div id="tagline">Produced by IDLdoc 2.0.</div>
315
316    </div>
317
318  </body>
319</html>
Note: See TracBrowser for help on using the repository browser.