source: trunk/SRC/Documentation/idldoc_html_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: 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"></div>
115
116         
117
118         
119            <h3>Parameters</h3>
120       
121           
122            <h4 id="_compute_fromreg_bilinear_weigaddr_param_alonin">alonin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
123              <span class="attr">in</span>
124             
125             
126              <span class="attr">required</span>
127             
128              <span class="attr">type:</span> <span class="value">2d array</span>
129             
130             
131            </h4>
132       
133          <div class="comments">
134 longitude of the input data
135</div>
136           
137            <h4 id="_compute_fromreg_bilinear_weigaddr_param_alatin">alatin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
138              <span class="attr">in</span>
139             
140             
141              <span class="attr">required</span>
142             
143              <span class="attr">type:</span> <span class="value">2d array</span>
144             
145             
146            </h4>
147       
148          <div class="comments">
149 latitude of the input data
150</div>
151           
152            <h4 id="_compute_fromreg_bilinear_weigaddr_param_olonin">olonin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
153              <span class="attr">in</span>
154             
155             
156              <span class="attr">required</span>
157             
158              <span class="attr">type:</span> <span class="value">2d array</span>
159             
160             
161            </h4>
162       
163          <div class="comments">
164 longitude of the output data
165</div>
166           
167            <h4 id="_compute_fromreg_bilinear_weigaddr_param_olat">olat&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
168              <span class="attr">in</span>
169             
170             
171              <span class="attr">required</span>
172             
173              <span class="attr">type:</span> <span class="value">2d array</span>
174             
175             
176            </h4>
177       
178          <div class="comments">
179 latitude of the output data
180</div>
181           
182            <h4 id="_compute_fromreg_bilinear_weigaddr_param_weig">weig&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
183             
184              <span class="attr">out</span>
185             
186             
187             
188              <span class="attr">type:</span> <span class="value">2d array</span>
189             
190             
191            </h4>
192       
193          <div class="comments">
194 (see ADDR)
195</div>
196           
197            <h4 id="_compute_fromreg_bilinear_weigaddr_param_addr">addr&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
198             
199              <span class="attr">out</span>
200             
201             
202             
203              <span class="attr">type:</span> <span class="value">2d array</span>
204             
205             
206            </h4>
207       
208          <div class="comments">
209 2D arrays, weig and addr are the weight and addresses used to
210 perform the interpolation:
211  dataout = total(weig*datain[addr], 1)
212  dataout = reform(dataout, jpio, jpjo, /over)
213</div>
214           
215
216         
217
218         
219
220            <h3>Keywords</h3>
221           
222            <h4 id="_compute_fromreg_bilinear_weigaddr_keyword_NONORTHERNLINE">NONORTHERNLINE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
223             
224             
225             
226             
227             
228              <span class="attr">type:</span> <span class="value">scalar 0 or 1</span>
229              <span class="attr">default:</span> <span class="value">0</span>
230             
231            </h4>
232       
233            <div class="comments">
234 put 1 if you don't want to take into
235 account the northen line of the input data when performing the interpolation.
236</div>
237           
238            <h4 id="_compute_fromreg_bilinear_weigaddr_keyword_NOSOUTHERNLINE">NOSOUTHERNLINE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
239             
240             
241             
242             
243             
244              <span class="attr">type:</span> <span class="value">scalar 0 or 1</span>
245              <span class="attr">default:</span> <span class="value">0</span>
246             
247            </h4>
248       
249            <div class="comments">
250 put 1 if you don't want to take into
251 account the southern line of the input data when performing the interpolation.
252</div>
253           
254         
255
256         
257          <h3>Version history</h3>
258         
259          <h4>Version</h4><div class="preformat"> $Id: compute_fromreg_bilinear_weigaddr.pro 208 2007-02-02 11:23:09Z smasson $
260</div>
261          <h4>History</h4><div class="preformat">
262  November 2005: Sebastien Masson (smasson@lodyc.jussieu.fr)
263</div>
264         
265         
266          <h3>Known issues</h3>
267         
268         
269         
270          <h4>Restrictions</h4><div class="preformat">
271  - the input grid must be a "regular grid", defined as a grid for which each
272  longitudes lines have the same latitude and each latitudes columns have the
273  same longitude.
274  - We supposed the data are located on a sphere, with a periodicity along
275  the longitude.
276  - points located out of the southern and northern boundaries are interpolated
277  using a linear interpolation only along the longitudinal direction.
278</div>
279       
280         
281         
282         
283         
284         
285         
286         
287       
288          <h3>Statistics</h3>
289          <table class="statistics">
290            <tr><td>McCabe cyclic</td><td>          30</td></tr>
291            <tr><td>McCabe essential</td><td>           1</td></tr>
292            <tr><td>McCabe modular design</td><td>           1</td></tr>
293          </table>
294         
295       
296        </div>
297       
298      </div>
299
300     
301
302      <div id="tagline">Produced by IDLdoc 2.0.</div>
303
304    </div>
305
306  </body>
307</html>
Note: See TracBrowser for help on using the repository browser.