source: trunk/SRC/Documentation/idldoc_html_output/Interpolation/compute_fromirr_bilinear_weigaddr.html

Last change on this file 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_fromirr_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_fromirr_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_fromirr_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="clickincell.html">&lt;&lt;prev file</a> | <a href="compute_fromreg_bilinear_weigaddr.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="compute_fromirr_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_fromirr_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
91 an "irregular 2D grid" (defined as a grid made of quadrilateral cells)
92 to any grid using the bilinear method
93</div>
94
95     
96
97     
98
99     
100
101     
102
103      <div id="routine_details">
104       
105
106        <div class="routine_details" id="_compute_fromirr_bilinear_weigaddr">
107
108          <h2><a class="top" href="#container">top</a>compute_fromirr_bilinear_weigaddr <span class="categories">
109 Interpolation
110</span></h2>
111       
112          <p class="header">
113            compute_fromirr_bilinear_weigaddr<span class="result">, <a href="#_compute_fromirr_bilinear_weigaddr_param_olonin">olonin</a>, <a href="#_compute_fromirr_bilinear_weigaddr_param_olat">olat</a>, <a href="#_compute_fromirr_bilinear_weigaddr_param_omsk">omsk</a>, <a href="#_compute_fromirr_bilinear_weigaddr_param_alonin">alonin</a>, <a href="#_compute_fromirr_bilinear_weigaddr_param_alat">alat</a>, <a href="#_compute_fromirr_bilinear_weigaddr_param_amsk">amsk</a>, <a href="#_compute_fromirr_bilinear_weigaddr_param_weig">weig</a>, <a href="#_compute_fromirr_bilinear_weigaddr_param_addr">addr</a></span></p>
114       
115          <div class="comments">
116</div>
117
118         
119
120         
121            <h3>Parameters</h3>
122       
123           
124            <h4 id="_compute_fromirr_bilinear_weigaddr_param_olonin">olonin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
125              <span class="attr">in</span>
126             
127             
128              <span class="attr">required</span>
129             
130              <span class="attr">type:</span> <span class="value">2d array</span>
131             
132             
133            </h4>
134       
135          <div class="comments">
136 longitude of the input data
137</div>
138           
139            <h4 id="_compute_fromirr_bilinear_weigaddr_param_olat">olat&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
140              <span class="attr">in</span>
141             
142             
143              <span class="attr">required</span>
144             
145              <span class="attr">type:</span> <span class="value">2d array</span>
146             
147             
148            </h4>
149       
150          <div class="comments">
151 latitude of the input data
152</div>
153           
154            <h4 id="_compute_fromirr_bilinear_weigaddr_param_omsk">omsk&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
155              <span class="attr">in</span>
156             
157             
158              <span class="attr">required</span>
159             
160              <span class="attr">type:</span> <span class="value">2d array or -1</span>
161             
162             
163            </h4>
164       
165          <div class="comments">
166 land/sea mask of the input data
167 put -1 if input data are not masked
168</div>
169           
170            <h4 id="_compute_fromirr_bilinear_weigaddr_param_alonin">alonin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
171              <span class="attr">in</span>
172             
173             
174              <span class="attr">required</span>
175             
176              <span class="attr">type:</span> <span class="value">2d array</span>
177             
178             
179            </h4>
180       
181          <div class="comments">
182 longitude of the output data
183</div>
184           
185            <h4 id="_compute_fromirr_bilinear_weigaddr_param_alat">alat&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
186              <span class="attr">in</span>
187             
188             
189              <span class="attr">required</span>
190             
191              <span class="attr">type:</span> <span class="value">2d array</span>
192             
193             
194            </h4>
195       
196          <div class="comments">
197 latitude of the output data
198</div>
199           
200            <h4 id="_compute_fromirr_bilinear_weigaddr_param_amsk">amsk&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
201              <span class="attr">in</span>
202             
203             
204              <span class="attr">required</span>
205             
206              <span class="attr">type:</span> <span class="value">2d array or -1</span>
207             
208             
209            </h4>
210       
211          <div class="comments">
212 land/sea mask of the output data
213 put -1 if output data are not masked
214</div>
215           
216            <h4 id="_compute_fromirr_bilinear_weigaddr_param_weig">weig&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
217             
218              <span class="attr">out</span>
219             
220             
221             
222              <span class="attr">type:</span> <span class="value">2d array</span>
223             
224             
225            </h4>
226       
227          <div class="comments">
228 (see ADDR)
229</div>
230           
231            <h4 id="_compute_fromirr_bilinear_weigaddr_param_addr">addr&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
232             
233              <span class="attr">out</span>
234             
235             
236             
237              <span class="attr">type:</span> <span class="value">2d array</span>
238             
239             
240            </h4>
241       
242          <div class="comments">
243 2D arrays, weig and addr are the weight and addresses used to
244 perform the interpolation:
245  dataout = total(weig*datain[addr], 1)
246  dataout = reform(dataout, jpia, jpja, /over)
247</div>
248           
249
250         
251
252         
253
254         
255          <h3>Version history</h3>
256         
257          <h4>Version</h4><div class="preformat">
258 $Id: compute_fromirr_bilinear_weigaddr.pro 372 2008-08-08 12:31:53Z pinsard $
259</div>
260          <h4>History</h4><div class="preformat">
261 June 2006: Sebastien Masson (smasson@lodyc.jussieu.fr)
262</div>
263         
264         
265          <h3>Known issues</h3>
266         
267         
268         
269          <h4>Restrictions</h4><div class="preformat">
270  -  the input grid must be an "irregular 2D grid", defined as a grid made
271  of quadrilateral cells
272  -  We supposed the data are located on a sphere, with a periodicity along
273  the longitude
274  -  to perform the bilinear interpolation within quadrilateral cells, we
275  first morph the cell into a square cell and then compute the bilinear
276  interpolation.
277  -  if some corners of the cell are land points, their weights are set to 0
278  and the weight is redistributed on the remaining "water" corners
279  -  points located out of the southern and northern boundaries or in cells
280  containing only land points are set the same value as their closest neighbors
281</div>
282       
283         
284         
285         
286         
287         
288         
289         
290       
291          <h3>Statistics</h3>
292          <table class="statistics">
293            <tr><td>McCabe cyclic</td><td>          49</td></tr>
294            <tr><td>McCabe essential</td><td>           1</td></tr>
295            <tr><td>McCabe modular design</td><td>           1</td></tr>
296          </table>
297         
298       
299        </div>
300       
301      </div>
302
303     
304
305      <div id="tagline">Produced by IDLdoc 2.0.</div>
306
307    </div>
308
309  </body>
310</html>
Note: See TracBrowser for help on using the repository browser.