source: trunk/SRC/Documentation/idldoc_assistant_output/Interpolation/compute_fromreg_bilinear_weigaddr.html @ 210

Last change on this file since 210 was 210, checked in by smasson, 17 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_fromreg_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="compute_fromirr_bilinear_weigaddr.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_imoms3_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_fromreg_bilinear_weigaddr.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 compute the weight and address needed to interpolate data from a
65 "regular grid" to any grid using the bilinear method
66
67
68   
69
70     
71      <a name="#_compute_fromreg_bilinear_weigaddr"></a>
72
73      <h2>compute_fromreg_bilinear_weigaddr  <font size="-1" color="#006633"> 
74 Interpolation
75</font></h2>
76
77      <p><font face="Courier">compute_fromreg_bilinear_weigaddr<i>, <a href="#_compute_fromreg_bilinear_weigaddr_keyword_alonin">alonin</a>, <a href="#_compute_fromreg_bilinear_weigaddr_keyword_alatin">alatin</a>, <a href="#_compute_fromreg_bilinear_weigaddr_keyword_olonin">olonin</a>, <a href="#_compute_fromreg_bilinear_weigaddr_keyword_olat">olat</a>, <a href="#_compute_fromreg_bilinear_weigaddr_keyword_weig">weig</a>, <a href="#_compute_fromreg_bilinear_weigaddr_keyword_addr">addr</a></i>, <a href="#_compute_fromreg_bilinear_weigaddr_keyword_NONORTHERNLINE">NONORTHERNLINE</a>=<i>scalar 0 or 1</i>, <a href="#_compute_fromreg_bilinear_weigaddr_keyword_NOSOUTHERNLINE">NOSOUTHERNLINE</a>=<i>scalar 0 or 1</i></font></p>
78
79   
80
81   
82
83   
84    <h3>Parameters</h3>
85   
86
87    <a name="#_compute_fromreg_bilinear_weigaddr_keyword_alonin"></a>
88    <h4>alonin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
89      <font size="-1" color="#006633">in</font>
90     
91     
92      <font size="-1" color="#006633">required</font>
93     
94      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font>
95     
96     
97    </h4>
98
99   
100 longitude of the input data
101
102   
103
104    <a name="#_compute_fromreg_bilinear_weigaddr_keyword_alatin"></a>
105    <h4>alatin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
106      <font size="-1" color="#006633">in</font>
107     
108     
109      <font size="-1" color="#006633">required</font>
110     
111      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font>
112     
113     
114    </h4>
115
116   
117 latitude of the input data
118
119   
120
121    <a name="#_compute_fromreg_bilinear_weigaddr_keyword_olonin"></a>
122    <h4>olonin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
123      <font size="-1" color="#006633">in</font>
124     
125     
126      <font size="-1" color="#006633">required</font>
127     
128      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font>
129     
130     
131    </h4>
132
133   
134 longitude of the output data
135
136   
137
138    <a name="#_compute_fromreg_bilinear_weigaddr_keyword_olat"></a>
139    <h4>olat&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
140      <font size="-1" color="#006633">in</font>
141     
142     
143      <font size="-1" color="#006633">required</font>
144     
145      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font>
146     
147     
148    </h4>
149
150   
151 latitude of the output data
152
153   
154
155    <a name="#_compute_fromreg_bilinear_weigaddr_keyword_weig"></a>
156    <h4>weig&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
157     
158      <font size="-1" color="#006633">out</font>
159     
160     
161     
162      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font>
163     
164     
165    </h4>
166
167   
168 (see ADDR)
169
170   
171
172    <a name="#_compute_fromreg_bilinear_weigaddr_keyword_addr"></a>
173    <h4>addr&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
174     
175      <font size="-1" color="#006633">out</font>
176     
177     
178     
179      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font>
180     
181     
182    </h4>
183
184   
185 2D arrays, weig and addr are the weight and addresses used to
186 perform the interpolation:
187  dataout = total(weig*datain[addr], 1)
188  dataout = reform(dataout, jpio, jpjo, /over)
189
190   
191   
192
193   
194    <h3>Keywords</h3>
195
196   
197    <a name="#_compute_fromreg_bilinear_weigaddr_keyword_NONORTHERNLINE"></a>
198    <h4>NONORTHERNLINE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
199     
200     
201     
202     
203     
204      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar 0 or 1</i></font>
205      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
206     
207    </h4>
208
209   
210 put 1 if you don't want to take into
211 account the northen line of the input data when performing the interpolation.
212
213   
214    <a name="#_compute_fromreg_bilinear_weigaddr_keyword_NOSOUTHERNLINE"></a>
215    <h4>NOSOUTHERNLINE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
216     
217     
218     
219     
220     
221      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar 0 or 1</i></font>
222      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
223     
224    </h4>
225
226   
227 put 1 if you don't want to take into
228 account the southern line of the input data when performing the interpolation.
229
230   
231   
232
233   
234    <h3>Version history</h3>
235   
236    <h4>Version</h4> $Id: compute_fromreg_bilinear_weigaddr.pro 208 2007-02-02 11:23:09Z smasson $
237
238    <h4>History</h4>
239  November 2005: Sebastien Masson (smasson@lodyc.jussieu.fr)
240
241   
242
243    <h3>Known issues</h3>
244   
245   
246   
247    <h4>Restrictions</h4>
248  - the input grid must be a "regular grid", defined as a grid for which each
249  longitudes lines have the same latitude and each latitudes columns have the
250  same longitude.
251  - We supposed the data are located on a sphere, with a periodicity along
252  the longitude.
253  - points located out of the southern and northern boundaries are interpolated
254  using a linear interpolation only along the longitudinal direction.
255
256
257   
258   
259   
260   
261   
262   
263   
264
265    <font size="-3"><p>&nbsp;</p></font>
266    <hr size="1" color="#CCCCCC"/>
267     
268
269   
270
271    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
272
273  </body>
274</html>
Note: See TracBrowser for help on using the repository browser.