source: trunk/SRC/Documentation/idldoc_assistant_output/Interpolation/get_gridparams.html @ 338

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

update documentation
File size: 6.7 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>get_gridparams.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="fromreg.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="imoms3.html"><img src="./../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">Interpolation/</font></h1>
58    <h2>get_gridparams.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 Case 1: extract from a NetCDF file longitude and latitude arrays, their dimensions
65 and make sure it is 1D or 2D arrays
66
67 Case 2: given longitude and latitude arrays, get their dimensions and make
68 sure they are 1D or 2D arrays
69
70
71   
72
73     
74      <a name="#_get_gridparams"></a>
75
76      <h2>get_gridparams  <font size="-1" color="#006633"> 
77 Interpolation
78</font></h2>
79
80      <p><font face="Courier">get_gridparams<i>, <a href="#_get_gridparams_keyword_in1">in1</a>, <a href="#_get_gridparams_keyword_in2">in2</a>, <a href="#_get_gridparams_keyword_in3">in3</a>, <a href="#_get_gridparams_keyword_in4">in4</a>, <a href="#_get_gridparams_keyword_in5">in5</a>, <a href="#_get_gridparams_keyword_in6">in6</a>, <a href="#_get_gridparams_keyword_in7">in7</a>, <a href="#_get_gridparams_keyword_in8">in8</a></i>, <a href="#_get_gridparams_keyword_DOUBLE">DOUBLE</a>=<i>scalar: 0 or 1</i></font></p>
81
82   
83
84
85   
86
87   
88    <h3>Parameters</h3>
89   
90
91    <a name="#_get_gridparams_keyword_in1"></a>
92    <h4>in1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
93      <font size="-1" color="#006633">in</font>
94     
95     
96      <font size="-1" color="#006633">required</font>
97     
98     
99     
100     
101    </h4>
102
103   
104 Case 1: name or the id (returned by ncdf_open) of the netcdf file
105 Case 2: 1D or 2D arrays defining longitudes, will be forced to have
106         n_dimensions dimensions when returned
107
108   
109
110    <a name="#_get_gridparams_keyword_in2"></a>
111    <h4>in2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
112      <font size="-1" color="#006633">in</font>
113     
114     
115      <font size="-1" color="#006633">required</font>
116     
117     
118     
119     
120    </h4>
121
122   
123 Case 1: name of the variable containing the longitude in the NetCDF file
124 Case 2: 1D or 2D arrays defining latitudes, will be forced to have
125         n_dimensions dimensions when returned
126
127   
128
129    <a name="#_get_gridparams_keyword_in3"></a>
130    <h4>in3&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
131     
132     
133     
134     
135     
136     
137     
138     
139    </h4>
140
141     
142 Case 1: name of the variable containing the latitude in the NetCDF file
143 Case 2: returned number of points in longitudinal direction.
144
145   
146
147    <a name="#_get_gridparams_keyword_in4"></a>
148    <h4>in4&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
149     
150      <font size="-1" color="#006633">out</font>
151     
152     
153     
154     
155     
156     
157    </h4>
158
159   
160 Case 1: returned longitudes array, with n_dimensions dimensions
161 Case 2: returned number of points in latitudinal direction
162
163   
164
165    <a name="#_get_gridparams_keyword_in5"></a>
166    <h4>in5&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
167     
168     
169     
170     
171     
172     
173     
174     
175    </h4>
176
177   
178 Case 1: returned latitudes array, with n_dimensions dimensions
179 Case 2: input scalar (1 or 2) to specify if lon and lat should be returned
180         as 1D or 2D arrays. Note that if n_dimensions = 1, the grid must be
181         regular (longitude and latitudes can be described as 1D arrays).
182
183   
184
185    <a name="#_get_gridparams_keyword_in6"></a>
186    <h4>in6&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
187     
188      <font size="-1" color="#006633">out</font>
189     
190     
191     
192     
193     
194     
195    </h4>
196
197   
198 Case 1: returned number of points in longitudinal direction.
199
200   
201
202    <a name="#_get_gridparams_keyword_in7"></a>
203    <h4>in7&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
204     
205      <font size="-1" color="#006633">out</font>
206     
207     
208     
209     
210     
211     
212    </h4>
213
214   
215 Case 1: returned number of points in latitudinal direction
216
217   
218
219    <a name="#_get_gridparams_keyword_in8"></a>
220    <h4>in8&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
221      <font size="-1" color="#006633">in</font>
222     
223     
224     
225     
226     
227     
228     
229    </h4>
230
231   
232 Case 1: input scalar (1 or 2) to specify if lon and lat should be returned
233         as 1D or 2D arrays. Note that if n_dimensions = 1, the grid must be
234         regular (longitude and latitudes can be described as 1D arrays).
235
236   
237   
238
239   
240    <h3>Keywords</h3>
241
242   
243    <a name="#_get_gridparams_keyword_DOUBLE"></a>
244    <h4>DOUBLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
245     
246     
247     
248     
249     
250      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font>
251      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
252     
253    </h4>
254
255   
256 activate to force double precision for lon/lat arrays
257
258   
259   
260
261    <h3>Examples</h3><pre>
262
263 Case 1:
264 IDL> get_gridparams, file name/id, lonname, latname, lon, lat, jpi, jpj, n_dimensions
265
266 Case 2:
267 IDL> get_gridparams, lon, lat, jpi, jpj, n_dimensions
268
269
270
271 1) IDL> ncdf_get_gridparams, 'coordinates_ORCA_R05.nc', 'glamt', 'gphit' $
272            , olon, olat, jpio, jpjo, 2
273
274 2) IDL> ncdf_get_gridparams, olon, olat, jpio, jpjo, 2
275
276    </pre><h3>Version history</h3>
277   
278    <h4>Version</h4>
279 $Id: get_gridparams.pro 327 2007-12-13 16:22:35Z pinsard $
280
281    <h4>History</h4>
282  November 2005: Sebastien Masson (smasson@lodyc.jussieu.fr)
283
284   
285
286   
287   
288   
289   
290   
291
292   
293   
294   
295   
296   
297   
298   
299
300    <font size="-3"><p>&nbsp;</p></font>
301    <hr size="1" color="#CCCCCC"/>
302     
303
304   
305
306    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
307
308  </body>
309</html>
Note: See TracBrowser for help on using the repository browser.