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

Last change on this file since 203 was 203, checked in by smasson, 18 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"></div>
116
117         
118
119         
120            <h3>Parameters</h3>
121       
122           
123            <h4 id="_compute_fromirr_bilinear_weigaddr_param_olonin">olonin&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_fromirr_bilinear_weigaddr_param_olat">olat&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_fromirr_bilinear_weigaddr_param_omsk">omsk&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 or -1</span>
160             
161             
162            </h4>
163       
164          <div class="comments">
165 land/sea mask of the input data
166 put -1 if input data are not masked
167</div>
168           
169            <h4 id="_compute_fromirr_bilinear_weigaddr_param_alonin">alonin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
170              <span class="attr">in</span>
171             
172             
173              <span class="attr">required</span>
174             
175              <span class="attr">type:</span> <span class="value">2d array</span>
176             
177             
178            </h4>
179       
180          <div class="comments">
181 longitude of the output data
182</div>
183           
184            <h4 id="_compute_fromirr_bilinear_weigaddr_param_alat">alat&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
185              <span class="attr">in</span>
186             
187             
188              <span class="attr">required</span>
189             
190              <span class="attr">type:</span> <span class="value">2d array</span>
191             
192             
193            </h4>
194       
195          <div class="comments">
196 latitude of the output data
197</div>
198           
199            <h4 id="_compute_fromirr_bilinear_weigaddr_param_amsk">amsk&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
200              <span class="attr">in</span>
201             
202             
203              <span class="attr">required</span>
204             
205              <span class="attr">type:</span> <span class="value">2d array or -1</span>
206             
207             
208            </h4>
209       
210          <div class="comments">
211 land/sea mask of the output data
212 put -1 if output data are not masked
213</div>
214           
215            <h4 id="_compute_fromirr_bilinear_weigaddr_param_weig">weig&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
216             
217              <span class="attr">out</span>
218             
219             
220             
221              <span class="attr">type:</span> <span class="value">2d array</span>
222             
223             
224            </h4>
225       
226          <div class="comments">
227 (see ADDR)
228</div>
229           
230            <h4 id="_compute_fromirr_bilinear_weigaddr_param_addr">addr&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
231             
232              <span class="attr">out</span>
233             
234             
235             
236              <span class="attr">type:</span> <span class="value">2d array</span>
237             
238             
239            </h4>
240       
241          <div class="comments">
242 2D arrays, weig and addr are the weight and addresses used to
243 perform the interpolation:
244  dataout = total(weig*datain[addr], 1)
245  dataout = reform(dataout, jpia, jpja, /over)
246</div>
247           
248
249         
250
251         
252
253         
254          <h3>Version history</h3>
255         
256          <h4>Version</h4><div class="preformat"> $Id: compute_fromirr_bilinear_weigaddr.pro 202 2007-01-12 11:00:06Z smasson $
257</div>
258          <h4>History</h4><div class="preformat">
259  June 2006: Sebastien Masson (smasson@lodyc.jussieu.fr)
260</div>
261         
262         
263          <h3>Known issues</h3>
264         
265         
266         
267          <h4>Restrictions</h4><div class="preformat">
268  -  the input grid must be an "irregular 2D grid", defined as a grid made
269  of quadrilateral cells which corners positions are defined with olonin and olat
270  -  We supposed the data are located on a sphere, with a periodicity along
271  the longitude
272  -  to perform the bilinear interpolation within quadrilateral cells, we
273  first morph the cell into a square cell and then compute the bilinear
274  interpolation.
275  -  if some corners of the cell are land points, their weight is set to 0
276  and the weight is redistributed on the remaining "water" corners
277  -  points located out of the southern and northern boundaries or in cells
278  containing only land points are set the the same value as their closest neighbor
279</div>
280       
281         
282         
283         
284         
285         
286         
287         
288       
289          <h3>Statistics</h3>
290          <table class="statistics">
291            <tr><td>McCabe cyclic</td><td>          37</td></tr>
292            <tr><td>McCabe essential</td><td>           1</td></tr>
293            <tr><td>McCabe modular design</td><td>           1</td></tr>
294          </table>
295         
296       
297        </div>
298       
299      </div>
300
301     
302
303      <div id="tagline">Produced by IDLdoc 2.0.</div>
304
305    </div>
306
307  </body>
308</html>
Note: See TracBrowser for help on using the repository browser.