source: trunk/SRC/Documentation/idldoc_assistant_output/Interpolation/fromirr.html @ 203

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

update documentation
File size: 7.9 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>fromirr.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="extrapsmooth.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="fromreg.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>fromirr.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 interpolate data from an irregular 2D grid to any 2D grid.
65   Only 1 method available = bilinear
66
67
68   
69
70     
71      <a name="#_fromirr"></a>
72
73      <h2>fromirr  <font size="-1" color="#006633"> 
74 Interpolation
75</font></h2>
76
77      <p><font face="Courier"><i>result = </i>fromirr(<i><a href="#_fromirr_keyword_method">method</a>, <a href="#_fromirr_keyword_datain">datain</a>[, <a href="#_fromirr_keyword_lonin">lonin</a>][, <a href="#_fromirr_keyword_latin">latin</a>][, <a href="#_fromirr_keyword_mskin">mskin</a>][, <a href="#_fromirr_keyword_lonout">lonout</a>][, <a href="#_fromirr_keyword_latout">latout</a>], <a href="#_fromirr_keyword_mskout">mskout</a></i>, <a href="#_fromirr_keyword_WEIG">WEIG</a>=<i>2d array</i>, <a href="#_fromirr_keyword_ADDR">ADDR</a>=<i>2d array</i>)</font></p>
78
79   
80
81
82    <h3>Return value</h3>
83 2D array the interpolated data
84
85
86   
87    <h3>Parameters</h3>
88   
89
90    <a name="#_fromirr_keyword_method"></a>
91    <h4>method&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
92      <font size="-1" color="#006633">in</font>
93     
94     
95      <font size="-1" color="#006633">required</font>
96     
97      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font>
98     
99     
100    </h4>
101
102   
103 a string defining the interpolation method. must be 'bilinear'
104
105   
106
107    <a name="#_fromirr_keyword_datain"></a>
108    <h4>datain&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
109      <font size="-1" color="#006633">in</font>
110     
111     
112      <font size="-1" color="#006633">required</font>
113     
114      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font>
115     
116     
117    </h4>
118
119   
120 a 2D array the input data to interpolate
121
122   
123
124    <a name="#_fromirr_keyword_lonin"></a>
125    <h4>lonin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
126      <font size="-1" color="#006633">in</font>
127     
128      <font size="-1" color="#006633">optional</font>
129     
130     
131      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font>
132     
133     
134    </h4>
135
136   
137 a 2D array defining the longitude of the input data
138
139   
140
141    <a name="#_fromirr_keyword_latin"></a>
142    <h4>latin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
143      <font size="-1" color="#006633">in</font>
144     
145      <font size="-1" color="#006633">optional</font>
146     
147     
148      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font>
149     
150     
151    </h4>
152
153   
154 a 2D array defining the latitude of the input data.
155
156   
157
158    <a name="#_fromirr_keyword_mskin"></a>
159    <h4>mskin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
160      <font size="-1" color="#006633">in</font>
161     
162      <font size="-1" color="#006633">optional</font>
163     
164     
165      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array or -1</i></font>
166     
167     
168    </h4>
169
170   
171 a 2D array, the land-sea mask of the input data (1 on ocean, 0 on land)
172 put -1 if input data are not masked
173
174   
175
176    <a name="#_fromirr_keyword_lonout"></a>
177    <h4>lonout&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
178      <font size="-1" color="#006633">in</font>
179     
180      <font size="-1" color="#006633">optional</font>
181     
182     
183      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>1d or 2d array</i></font>
184     
185     
186    </h4>
187
188   
189 1D or 2D array defining the longitude of the output data.
190
191   
192
193    <a name="#_fromirr_keyword_latout"></a>
194    <h4>latout&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
195      <font size="-1" color="#006633">in</font>
196     
197      <font size="-1" color="#006633">optional</font>
198     
199     
200      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>1d or 2d array</i></font>
201     
202     
203    </h4>
204
205   
206 1D or 2D array defining the latitude of the output data.
207
208   
209
210    <a name="#_fromirr_keyword_mskout"></a>
211    <h4>mskout&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
212      <font size="-1" color="#006633">in</font>
213     
214     
215      <font size="-1" color="#006633">required</font>
216     
217      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array or -1</i></font>
218     
219     
220    </h4>
221
222   
223 a 2D array, the land-sea mask of the output data (1 on ocean, 0 on land)
224 put -1 if output data are not masked
225
226   
227   
228
229   
230    <h3>Keywords</h3>
231
232   
233    <a name="#_fromirr_keyword_WEIG"></a>
234    <h4>WEIG&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
235     
236     
237     
238     
239     
240      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font>
241     
242     
243    </h4>
244
245   
246 (see ADDR)
247
248   
249    <a name="#_fromirr_keyword_ADDR"></a>
250    <h4>ADDR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
251     
252     
253     
254     
255     
256      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font>
257     
258     
259    </h4>
260
261   
262 2D arrays, weig and addr are the weight and addresses used to
263 perform the interpolation:
264          dataout = total(weig*datain[addr], 1)
265          dataout = reform(dataout, jpio, jpjo, /over)
266 Those keywords can be set to named variables (that are undefined or equal to 0) into which the
267 values will be copied when the current routine exits. Next, they can be used to perform
268 the interpolation without computing again those 2 parameters. This greatly
269 speed-up the interpolation! In that case, lonin, latin, lonout and latout are not necessary.
270
271   
272   
273
274    <h3>Examples</h3>
275
276 IDL> tncep = fromirr('bilinear', topa, glamt, gphit, tmask[*,*,0], lonout, latout, mskout)
277
278  or
279
280 IDL> t1ncep = fromirr('bilinear', topa, glamt, gphit, tmask[*,*,0], lonout, latout, mskout $
281                            , WEIG = a, ADDR = b)
282 IDL> help, a, b
283 IDL> t2ncep = fromirr('bilinear', topa, WEIG = a, ADDR = b)
284
285    <h3>Version history</h3>
286   
287    <h4>Version</h4> $Id: fromirr.pro 202 2007-01-12 11:00:06Z smasson $
288
289    <h4>History</h4>
290  June 2006: Sebastien Masson (smasson@lodyc.jussieu.fr)
291
292   
293
294    <h3>Known issues</h3>
295   
296   
297   
298    <h4>Restrictions</h4>
299 We supposed the data are located on a sphere, with a periodicity along
300 the longitude.
301 Note that the input data can contain the same cells several times
302 (like ORCA grid near the north pole boundary)
303
304
305   
306   
307   
308   
309   
310   
311   
312
313    <font size="-3"><p>&nbsp;</p></font>
314    <hr size="1" color="#CCCCCC"/>
315     
316
317   
318
319    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
320
321  </body>
322</html>
Note: See TracBrowser for help on using the repository browser.