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

Last change on this file since 191 was 191, checked in by pinsard, 18 years ago

remove format=raw in all html files 2+ : correction for all_plots; suppression of css and correction of Source links in idldoc html output
File size: 7.7 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" 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="../../../Interpolation//get_gridparams.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="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" 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">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, latitude, and their dimensions
91 and make sure it is 1D or 2D arrays
92
93 or
94 2) given longitude and latitude arrays get their dimensions and make
95 sure they are 1D or 2D arrays
96</div>
97
98     
99
100     
101
102     
103
104     
105
106      <div id="routine_details">
107       
108
109        <div class="routine_details" id="_get_gridparams">
110
111          <h2><a class="top" href="#container">top</a>get_gridparams <span class="categories"> 
112 Interpolation
113</span></h2>
114       
115          <p class="header">
116            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>
117       
118          <div class="comments">
119</div>
120
121         
122
123         
124            <h3>Parameters</h3>
125       
126           
127            <h4 id="_get_gridparams_param_in1">in1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
128              <span class="attr">in</span>
129             
130             
131              <span class="attr">required</span>
132             
133             
134             
135             
136            </h4>
137       
138          <div class="comments">
139 Case 1: the name of the netcdf file
140 Case 2: 1d or 2D arrays defining longitudes and latitudes.
141 Out: the variable that will contain the longitudes
142</div>
143           
144            <h4 id="_get_gridparams_param_in2">in2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
145              <span class="attr">in</span>
146             
147             
148              <span class="attr">required</span>
149             
150             
151             
152             
153            </h4>
154       
155          <div class="comments">
156 Case 1: the name of the variable that contains the longitude in the NetCDF file
157 Case 2: 1d or 2D arrays defining longitudes and latitudes.
158         Note that these arrays are also outputs and can therefore be modified.
159 Out: the variable that will contain the latitudes
160</div>
161           
162            <h4 id="_get_gridparams_param_in3">in3&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
163              <span class="attr">in</span>
164             
165             
166              <span class="attr">required</span>
167             
168             
169             
170             
171            </h4>
172       
173          <div class="comments">
174 Case 1: the name of the variable that contains the latitude in the NetCDF file
175 Case 2: the number of points in the longitudinal direction.
176</div>
177           
178            <h4 id="_get_gridparams_param_in4">in4&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
179             
180              <span class="attr">out</span>
181             
182             
183             
184             
185             
186             
187            </h4>
188       
189          <div class="comments">
190 Case 1: the number of points in the longitudinal direction
191 Case 2: the number of points in the latitudinal direction
192</div>
193           
194            <h4 id="_get_gridparams_param_in5">in5&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
195             
196              <span class="attr">out</span>
197             
198             
199             
200             
201             
202             
203            </h4>
204       
205          <div class="comments">
206 Case 1: the number of points in the latitudinal direction
207 Case 2: 1 or 2 to specify if lon and lat should be 1D (jpi or jpj)
208 arrays or 2D arrays (jpi,jpj). Note that of  n_dimensions = 1, then the
209 grid must be regular (each longitudes must be the same for all latitudes
210 and each latitudes should be the same for all longitudes).
211</div>
212           
213            <h4 id="_get_gridparams_param_in6">in6&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
214             
215              <span class="attr">out</span>
216             
217             
218             
219             
220             
221             
222            </h4>
223       
224          <div class="comments">
225 the variable that will contain the longitudes
226</div>
227           
228            <h4 id="_get_gridparams_param_in7">in7&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
229             
230              <span class="attr">out</span>
231             
232             
233             
234             
235             
236             
237            </h4>
238       
239          <div class="comments">
240 the variable that will contain the latitudes
241</div>
242           
243            <h4 id="_get_gridparams_param_in8">in8&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
244             
245              <span class="attr">out</span>
246             
247             
248             
249             
250             
251             
252            </h4>
253       
254          <div class="comments">
255 1 or 2 to specify if lon and lat should be 1D (jpi or jpj)
256</div>
257           
258
259         
260
261         
262
263            <h3>Keywords</h3>
264           
265            <h4 id="_get_gridparams_keyword_DOUBLE">DOUBLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
266             
267             
268             
269             
270             
271             
272             
273             
274            </h4>
275       
276            <div class="comments">
277 use double precision to perform the computation
278</div>
279           
280         
281
282          <h3>Examples</h3><div class="preformat">
283
284 1)
285 IDL> get_gridparams, file, lonname, latname, lon, lat, jpi, jpj, n_dimensions
286
287 or
288
289 2)
290 IDL> get_gridparams, lon, lat, jpi, jpj, n_dimensions
291
292 1)
293
294
295 1) IDL> ncdf_get_gridparams, 'coordinates_ORCA_R05.nc', 'glamt', 'gphit' $
296            , olon, olat, jpio, jpjo, 2
297
298 2) IDL> ncdf_get_gridparams, olon, olat, jpio, jpjo, 2
299</div>
300          <h3>Version history</h3>
301         
302          <h4>Version</h4><div class="preformat"> $Id: get_gridparams.pro 163 2006-08-29 12:59:46Z navarro $
303</div>
304          <h4>History</h4><div class="preformat">
305  November 2005: Sebastien Masson (smasson@lodyc.jussieu.fr)
306</div>
307         
308         
309         
310         
311         
312         
313         
314       
315         
316         
317         
318         
319         
320         
321         
322       
323          <h3>Statistics</h3>
324          <table class="statistics">
325            <tr><td>McCabe cyclic</td><td>          32</td></tr>
326            <tr><td>McCabe essential</td><td>           1</td></tr>
327            <tr><td>McCabe modular design</td><td>           1</td></tr>
328          </table>
329         
330       
331        </div>
332       
333      </div>
334
335     
336
337      <div id="tagline">Produced by IDLdoc 2.0.</div>
338
339    </div>
340
341  </body>
342</html>
Note: See TracBrowser for help on using the repository browser.