source: trunk/SRC/Documentation/idldoc_html_output/Interpolation/compute_fromreg_bilinear_weigaddr.html @ 103

Last change on this file since 103 was 103, checked in by pinsard, 18 years ago

start to modify headers of Grid .pro files for better idldoc output
File size: 7.1 KB
Line 
1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<!-- Generated by IDLdoc 2.0 -->
6
7<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8  <head>
9    <title>compute_fromreg_bilinear_weigaddr.pro (IDLdoc API documentation)</title>
10
11   
12    <link rel="stylesheet" type="text/css" media="all" href="./../main_files.css" />
13    <link rel="stylesheet" type="text/css" media="print" href="./../main_files_print.css" />
14   
15
16    <script type="text/javascript">
17      function setTitle() {
18        parent.document.title="compute_fromreg_bilinear_weigaddr.pro (IDLdoc API documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>IDLdoc API documentation</h1>
27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
35      <td><a href="./../overview.html?format=raw" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../search-page.html?format=raw" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td >Source</td>
58     
59
60     
61      <td><a href="./../idldoc-help.html?format=raw" title="Help on IDLdoc">Help</a></td>
62     
63
64      <td >Etc</td>
65
66      <td id="flexible">Developer&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="clickincell.html">&lt;&lt;prev file</a> | <a href="compute_fromreg_imoms3_weigaddr.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="compute_fromreg_bilinear_weigaddr.html" target="_TOP">view single page</a> | <a href="./../index.html?format=raw" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html?format=raw">Interpolation/</a></h1>
82      <h2 class="pro_file">compute_fromreg_bilinear_weigaddr.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments"> compute the weight and address neede to interpolate data from a
90          "regular grid" to any grid using the bilinear method
91   </div>
92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
104        <div class="routine_details" id="_compute_fromreg_bilinear_weigaddr">
105
106          <h2><a class="top" href="#container">top</a>compute_fromreg_bilinear_weigaddr <span class="categories"> interpolation
107</span></h2>
108       
109          <p class="header">
110            compute_fromreg_bilinear_weigaddr<span class="result">, <a href="#_compute_fromreg_bilinear_weigaddr_param_alonin">alonin</a>, <a href="#_compute_fromreg_bilinear_weigaddr_param_alatin">alatin</a>, <a href="#_compute_fromreg_bilinear_weigaddr_param_olonin">olonin</a>, <a href="#_compute_fromreg_bilinear_weigaddr_param_olat">olat</a>, <a href="#_compute_fromreg_bilinear_weigaddr_param_weig">weig</a>, <a href="#_compute_fromreg_bilinear_weigaddr_param_addr">addr</a></span>, <a href="#_compute_fromreg_bilinear_weigaddr_keyword_NONORTHERNLINE">NONORTHERNLINE</a>=<span class="result">NONORTHERNLINE</span>, <a href="#_compute_fromreg_bilinear_weigaddr_keyword_NOSOUTHERNLINE">NOSOUTHERNLINE</a>=<span class="result">NOSOUTHERNLINE</span></p>
111       
112          <div class="comments"></div>
113
114          <h3>Return value</h3><div class="value"> 
115     weig, addr: 2D arrays, weig and addr are the weight and addresses used to
116     perform the interpolation:
117          dataout = total(weig*datain[addr], 1)
118          dataout = reform(dataout, jpio, jpjo, /over)
119</div>
120
121         
122            <h3>Parameters</h3>
123       
124           
125            <h4 id="_compute_fromreg_bilinear_weigaddr_param_alonin">alonin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
126              <span class="attr">in</span>
127             
128             
129              <span class="attr">required</span>
130             
131             
132             
133             
134            </h4>
135       
136          <div class="comments"> longitudeof the input data </div>
137           
138            <h4 id="_compute_fromreg_bilinear_weigaddr_param_alatin">alatin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
139              <span class="attr">in</span>
140             
141             
142              <span class="attr">required</span>
143             
144             
145             
146             
147            </h4>
148       
149          <div class="comments"> latitude of the input data </div>
150           
151            <h4 id="_compute_fromreg_bilinear_weigaddr_param_olonin">olonin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
152              <span class="attr">in</span>
153             
154             
155              <span class="attr">required</span>
156             
157             
158             
159             
160            </h4>
161       
162          <div class="comments"> longitude of the output data </div>
163           
164            <h4 id="_compute_fromreg_bilinear_weigaddr_param_olat">olat&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
165              <span class="attr">in</span>
166             
167             
168              <span class="attr">required</span>
169             
170             
171             
172             
173            </h4>
174       
175          <div class="comments"> latitude of the output data
176</div>
177           
178            <h4 id="_compute_fromreg_bilinear_weigaddr_param_weig">weig&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
179             
180             
181             
182             
183             
184             
185             
186             
187            </h4>
188       
189          <div class="comments"></div>
190           
191            <h4 id="_compute_fromreg_bilinear_weigaddr_param_addr">addr&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
192             
193             
194             
195             
196             
197             
198             
199             
200            </h4>
201       
202          <div class="comments"></div>
203           
204
205         
206
207         
208
209            <h3>Keywords</h3>
210           
211            <h4 id="_compute_fromreg_bilinear_weigaddr_keyword_NONORTHERNLINE">NONORTHERNLINE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
212             
213             
214             
215             
216             
217             
218             
219             
220            </h4>
221       
222            <div class="comments"> activate if you don't whant to take into
223          account the northen line of the input data when perfoming the</div>
224           
225            <h4 id="_compute_fromreg_bilinear_weigaddr_keyword_NOSOUTHERNLINE">NOSOUTHERNLINE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
226             
227             
228             
229             
230             
231             
232             
233             
234            </h4>
235       
236            <div class="comments"> activate if you don't whant to take into
237          account the southern line of the input data when perfoming the
238          interpolation.
239</div>
240           
241         
242
243         
244          <h3>Version history</h3>
245         
246         
247          <h4>History</h4><div class="value">
248  November 2005: Sebastien Masson (smasson@lodyc.jussieu.fr)
249 </div>
250         
251         
252          <h3>Known issues</h3>
253         
254         
255         
256          <h4>Restrictions</h4><div class="value">
257  -  the input grid must be a "regular grid", defined as a grid for which each
258     lontitudes lines have the same latitude and each latitudes columns have the
259     same longitude.
260  -  We supposed the data are located on a sphere, with a periodicity along
261     the longitude.
262  -  points located out of the southern and northern boundaries are interpolated
263     using a linear interpolation only along the longitudinal direction.
264 </div>
265       
266         
267         
268         
269         
270         
271         
272         
273       
274         
275       
276        </div>
277       
278      </div>
279
280     
281
282      <div id="tagline">Produced by IDLdoc 2.0.</div>
283
284    </div>
285
286  </body>
287</html>
Note: See TracBrowser for help on using the repository browser.