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

Last change on this file since 402 was 402, checked in by smasson, 15 years ago

update documentation
File size: 8.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 (SAXO 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 (SAXO Documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>SAXO 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" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../idldoc-categories.html" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../search-page.html" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td><a href="../../../Interpolation//compute_fromreg_bilinear_weigaddr.pro" title="Source code of a file">Source</a></td>
58     
59
60     
61      <td><a href="./../idldoc-help.html" 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="compute_fromirr_bilinear_weigaddr.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" 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">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">
90 compute the weight and address needed to interpolate data from a
91 "regular grid" to any grid using the bilinear method
92</div>
93
94     
95
96     
97
98     
99
100     
101
102      <div id="routine_details">
103       
104
105        <div class="routine_details" id="_compute_fromreg_bilinear_weigaddr">
106
107          <h2><a class="top" href="#container">top</a>compute_fromreg_bilinear_weigaddr <span class="categories">
108 Interpolation
109</span></h2>
110       
111          <p class="header">
112            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">scalar 0 or 1</span>, <a href="#_compute_fromreg_bilinear_weigaddr_keyword_NOSOUTHERNLINE">NOSOUTHERNLINE</a>=<span class="result">scalar 0 or 1</span></p>
113       
114          <div class="comments">
115</div>
116
117         
118
119         
120            <h3>Parameters</h3>
121       
122           
123            <h4 id="_compute_fromreg_bilinear_weigaddr_param_alonin">alonin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
124              <span class="attr">in</span>
125             
126             
127              <span class="attr">required</span>
128             
129              <span class="attr">type:</span> <span class="value">2d array</span>
130             
131             
132            </h4>
133       
134          <div class="comments">
135 longitude of the input data
136</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              <span class="attr">type:</span> <span class="value">2d array</span>
145             
146             
147            </h4>
148       
149          <div class="comments">
150 latitude of the input data
151</div>
152           
153            <h4 id="_compute_fromreg_bilinear_weigaddr_param_olonin">olonin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
154              <span class="attr">in</span>
155             
156             
157              <span class="attr">required</span>
158             
159              <span class="attr">type:</span> <span class="value">2d array</span>
160             
161             
162            </h4>
163       
164          <div class="comments">
165 longitude of the output data
166</div>
167           
168            <h4 id="_compute_fromreg_bilinear_weigaddr_param_olat">olat&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
169              <span class="attr">in</span>
170             
171             
172              <span class="attr">required</span>
173             
174              <span class="attr">type:</span> <span class="value">2d array</span>
175             
176             
177            </h4>
178       
179          <div class="comments">
180 latitude of the output data
181</div>
182           
183            <h4 id="_compute_fromreg_bilinear_weigaddr_param_weig">weig&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
184             
185              <span class="attr">out</span>
186             
187             
188             
189              <span class="attr">type:</span> <span class="value">2d array</span>
190             
191             
192            </h4>
193       
194          <div class="comments">
195 (see ADDR)
196</div>
197           
198            <h4 id="_compute_fromreg_bilinear_weigaddr_param_addr">addr&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
199             
200              <span class="attr">out</span>
201             
202             
203             
204              <span class="attr">type:</span> <span class="value">2d array</span>
205             
206             
207            </h4>
208       
209          <div class="comments">
210 2D arrays, weig and addr are the weight and addresses used to
211 perform the interpolation:
212  dataout = total(weig*datain[addr], 1)
213  dataout = reform(dataout, jpio, jpjo, /over)
214</div>
215           
216
217         
218
219         
220
221            <h3>Keywords</h3>
222           
223            <h4 id="_compute_fromreg_bilinear_weigaddr_keyword_NONORTHERNLINE">NONORTHERNLINE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
224             
225             
226             
227             
228             
229              <span class="attr">type:</span> <span class="value">scalar 0 or 1</span>
230              <span class="attr">default:</span> <span class="value">0</span>
231             
232            </h4>
233       
234            <div class="comments">
235 put 1 if you don't want to take into
236 account the northern line of the input data when performing the interpolation.
237</div>
238           
239            <h4 id="_compute_fromreg_bilinear_weigaddr_keyword_NOSOUTHERNLINE">NOSOUTHERNLINE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
240             
241             
242             
243             
244             
245              <span class="attr">type:</span> <span class="value">scalar 0 or 1</span>
246              <span class="attr">default:</span> <span class="value">0</span>
247             
248            </h4>
249       
250            <div class="comments">
251 put 1 if you don't want to take into
252 account the southern line of the input data when performing the interpolation.
253</div>
254           
255         
256
257         
258          <h3>Version history</h3>
259         
260          <h4>Version</h4><div class="preformat">
261 $Id: compute_fromreg_bilinear_weigaddr.pro 372 2008-08-08 12:31:53Z pinsard $
262</div>
263          <h4>History</h4><div class="preformat">
264 November 2005: Sebastien Masson (smasson@lodyc.jussieu.fr)
265</div>
266         
267         
268          <h3>Known issues</h3>
269         
270         
271         
272          <h4>Restrictions</h4><div class="preformat">
273  - the input grid must be a "regular grid", defined as a grid for which each
274  longitude lines have the same latitude and each latitude columns have the
275  same longitude.
276  - We supposed the data are located on a sphere, with a periodicity along
277  the longitude.
278  - points located out of the southern and northern boundaries are interpolated
279  using a linear interpolation only along the longitudinal direction.
280</div>
281       
282         
283         
284         
285         
286         
287         
288         
289       
290          <h3>Statistics</h3>
291          <table class="statistics">
292            <tr><td>McCabe cyclic</td><td>          30</td></tr>
293            <tr><td>McCabe essential</td><td>           1</td></tr>
294            <tr><td>McCabe modular design</td><td>           1</td></tr>
295          </table>
296         
297       
298        </div>
299       
300      </div>
301
302     
303
304      <div id="tagline">Produced by IDLdoc 2.0.</div>
305
306    </div>
307
308  </body>
309</html>
Note: See TracBrowser for help on using the repository browser.