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