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

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

update documentation

File size: 7.1 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>compute_fromirr_bilinear_weigaddr.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="clickincell.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="compute_fromreg_bilinear_weigaddr.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>compute_fromirr_bilinear_weigaddr.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 compute the weight and address needed to interpolate data from
65 an "irregular 2D grid" (defined as a grid made of quadrilateral cells)
66 to any grid using the bilinear method
67
68
69   
70
71     
72      <a name="#_compute_fromirr_bilinear_weigaddr"></a>
73
74      <h2>compute_fromirr_bilinear_weigaddr  <font size="-1" color="#006633">
75 Interpolation
76</font></h2>
77
78      <p><font face="Courier">compute_fromirr_bilinear_weigaddr<i>, <a href="#_compute_fromirr_bilinear_weigaddr_keyword_olonin">olonin</a>, <a href="#_compute_fromirr_bilinear_weigaddr_keyword_olat">olat</a>, <a href="#_compute_fromirr_bilinear_weigaddr_keyword_omsk">omsk</a>, <a href="#_compute_fromirr_bilinear_weigaddr_keyword_alonin">alonin</a>, <a href="#_compute_fromirr_bilinear_weigaddr_keyword_alat">alat</a>, <a href="#_compute_fromirr_bilinear_weigaddr_keyword_amsk">amsk</a>, <a href="#_compute_fromirr_bilinear_weigaddr_keyword_weig">weig</a>, <a href="#_compute_fromirr_bilinear_weigaddr_keyword_addr">addr</a></i></font></p>
79
80   
81
82
83   
84
85   
86    <h3>Parameters</h3>
87   
88
89    <a name="#_compute_fromirr_bilinear_weigaddr_keyword_olonin"></a>
90    <h4>olonin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
91      <font size="-1" color="#006633">in</font>
92     
93     
94      <font size="-1" color="#006633">required</font>
95     
96      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font>
97     
98     
99    </h4>
100
101   
102 longitude of the input data
103
104   
105
106    <a name="#_compute_fromirr_bilinear_weigaddr_keyword_olat"></a>
107    <h4>olat&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
108      <font size="-1" color="#006633">in</font>
109     
110     
111      <font size="-1" color="#006633">required</font>
112     
113      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font>
114     
115     
116    </h4>
117
118   
119 latitude of the input data
120
121   
122
123    <a name="#_compute_fromirr_bilinear_weigaddr_keyword_omsk"></a>
124    <h4>omsk&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
125      <font size="-1" color="#006633">in</font>
126     
127     
128      <font size="-1" color="#006633">required</font>
129     
130      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array or -1</i></font>
131     
132     
133    </h4>
134
135   
136 land/sea mask of the input data
137 put -1 if input data are not masked
138
139   
140
141    <a name="#_compute_fromirr_bilinear_weigaddr_keyword_alonin"></a>
142    <h4>alonin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
143      <font size="-1" color="#006633">in</font>
144     
145     
146      <font size="-1" color="#006633">required</font>
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 longitude of the output data
155
156   
157
158    <a name="#_compute_fromirr_bilinear_weigaddr_keyword_alat"></a>
159    <h4>alat&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
160      <font size="-1" color="#006633">in</font>
161     
162     
163      <font size="-1" color="#006633">required</font>
164     
165      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font>
166     
167     
168    </h4>
169
170   
171 latitude of the output data
172
173   
174
175    <a name="#_compute_fromirr_bilinear_weigaddr_keyword_amsk"></a>
176    <h4>amsk&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
177      <font size="-1" color="#006633">in</font>
178     
179     
180      <font size="-1" color="#006633">required</font>
181     
182      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array or -1</i></font>
183     
184     
185    </h4>
186
187   
188 land/sea mask of the output data
189 put -1 if output data are not masked
190
191   
192
193    <a name="#_compute_fromirr_bilinear_weigaddr_keyword_weig"></a>
194    <h4>weig&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
195     
196      <font size="-1" color="#006633">out</font>
197     
198     
199     
200      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font>
201     
202     
203    </h4>
204
205   
206 (see ADDR)
207
208   
209
210    <a name="#_compute_fromirr_bilinear_weigaddr_keyword_addr"></a>
211    <h4>addr&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
212     
213      <font size="-1" color="#006633">out</font>
214     
215     
216     
217      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font>
218     
219     
220    </h4>
221
222   
223 2D arrays, weig and addr are the weight and addresses used to
224 perform the interpolation:
225  dataout = total(weig*datain[addr], 1)
226  dataout = reform(dataout, jpia, jpja, /over)
227
228   
229   
230
231   
232
233   
234    </pre><h3>Version history</h3>
235   
236    <h4>Version</h4>
237 $Id: compute_fromirr_bilinear_weigaddr.pro 325 2007-12-06 10:04:53Z pinsard $
238
239    <h4>History</h4>
240  June 2006: Sebastien Masson (smasson@lodyc.jussieu.fr)
241
242   
243
244    <h3>Known issues</h3>
245   
246   
247   
248    <h4>Restrictions</h4>
249  -  the input grid must be an "irregular 2D grid", defined as a grid made
250  of quadrilateral cells
251  -  We supposed the data are located on a sphere, with a periodicity along
252  the longitude
253  -  to perform the bilinear interpolation within quadrilateral cells, we
254  first morph the cell into a square cell and then compute the bilinear
255  interpolation.
256  -  if some corners of the cell are land points, their weights are set to 0
257  and the weight is redistributed on the remaining "water" corners
258  -  points located out of the southern and northern boundaries or in cells
259  containing only land points are set the same value as their closest neighbors
260
261
262   
263   
264   
265   
266   
267   
268   
269
270    <font size="-3"><p>&nbsp;</p></font>
271    <hr size="1" color="#CCCCCC"/>
272     
273
274   
275
276    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
277
278  </body>
279</html>
Note: See TracBrowser for help on using the repository browser.