source: trunk/SRC/Documentation/idldoc_html_output/Interpolation/compute_fromreg_imoms3_weigaddr.html @ 106

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

start to modify headers of ReadWrite? *.pro files for better idldoc output
File size: 7.2 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_imoms3_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_imoms3_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?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="compute_fromreg_bilinear_weigaddr.html">&lt;&lt;prev file</a> | <a href="cutpar.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="compute_fromreg_imoms3_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_imoms3_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 imoms3 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_imoms3_weigaddr">
105
106          <h2><a class="top" href="#container">top</a>compute_fromreg_imoms3_weigaddr <span class="categories"> interpolation
107</span></h2>
108       
109          <p class="header">
110            compute_fromreg_imoms3_weigaddr<span class="result">, <a href="#_compute_fromreg_imoms3_weigaddr_param_alonin">alonin</a>, <a href="#_compute_fromreg_imoms3_weigaddr_param_alatin">alatin</a>, <a href="#_compute_fromreg_imoms3_weigaddr_param_olonin">olonin</a>, <a href="#_compute_fromreg_imoms3_weigaddr_param_olat">olat</a>, <a href="#_compute_fromreg_imoms3_weigaddr_param_weig">weig</a>, <a href="#_compute_fromreg_imoms3_weigaddr_param_addr">addr</a></span>, <a href="#_compute_fromreg_imoms3_weigaddr_keyword_NONORTHERNLINE">NONORTHERNLINE</a>=<span class="result">NONORTHERNLINE</span>, <a href="#_compute_fromreg_imoms3_weigaddr_keyword_NOSOUTHERNLINE">NOSOUTHERNLINE</a>=<span class="result">NOSOUTHERNLINE</span></p>
111       
112          <div class="comments">
113</div>
114
115          <h3>Return value</h3><div class="value"> 
116     weig, addr: 2D arrays, weig and addr are the weight and addresses used to
117     perform the interpolation:
118          dataout = total(weig*datain[addr], 1)
119          dataout = reform(dataout, jpio, jpjo, /over)
120</div>
121
122         
123            <h3>Parameters</h3>
124       
125           
126            <h4 id="_compute_fromreg_imoms3_weigaddr_param_alonin">alonin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
127              <span class="attr">in</span>
128             
129             
130              <span class="attr">required</span>
131             
132             
133             
134             
135            </h4>
136       
137          <div class="comments"> longitude of the input data </div>
138           
139            <h4 id="_compute_fromreg_imoms3_weigaddr_param_alatin">alatin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
140              <span class="attr">in</span>
141             
142             
143              <span class="attr">required</span>
144             
145             
146             
147             
148            </h4>
149       
150          <div class="comments"> latitude of the input data </div>
151           
152            <h4 id="_compute_fromreg_imoms3_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             
159             
160             
161            </h4>
162       
163          <div class="comments"> longitude of the output data </div>
164           
165            <h4 id="_compute_fromreg_imoms3_weigaddr_param_olat">olat&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
166              <span class="attr">in</span>
167             
168             
169              <span class="attr">required</span>
170             
171             
172             
173             
174            </h4>
175       
176          <div class="comments"> latitude of the output data
177</div>
178           
179            <h4 id="_compute_fromreg_imoms3_weigaddr_param_weig">weig&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
180             
181             
182             
183             
184             
185             
186             
187             
188            </h4>
189       
190          <div class="comments"></div>
191           
192            <h4 id="_compute_fromreg_imoms3_weigaddr_param_addr">addr&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
193             
194             
195             
196             
197             
198             
199             
200             
201            </h4>
202       
203          <div class="comments"></div>
204           
205
206         
207
208         
209
210            <h3>Keywords</h3>
211           
212            <h4 id="_compute_fromreg_imoms3_weigaddr_keyword_NONORTHERNLINE">NONORTHERNLINE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
213             
214             
215             
216             
217             
218             
219             
220             
221            </h4>
222       
223            <div class="comments"> and /NOSOUTHERNLINE activate if you don't whant to take into
224          account the northen/southern line of the input data when perfoming the
225          interpolation.
226</div>
227           
228            <h4 id="_compute_fromreg_imoms3_weigaddr_keyword_NOSOUTHERNLINE">NOSOUTHERNLINE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
229             
230             
231             
232             
233             
234             
235             
236             
237            </h4>
238       
239            <div class="comments"></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  March 2006: works for rectangular grids</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/rectangular grid", defined as a grid for
258     which each lontitudes lines have the same latitude and each latitudes columns
259     have the same longitude.
260  -  We supposed the data are located on a sphere, with a periodicity along
261     the longitude.
262  -  points located between the first/last 2 lines are interpolated
263     using a imoms3 interpolation along the longitudinal direction and linear
264     interpolation along the latitudinal direction
265  -  points located out of the southern and northern boundaries are interpolated
266     using a imoms3 interpolation only along the longitudinal direction.
267 </div>
268       
269         
270         
271         
272         
273         
274         
275         
276       
277         
278       
279        </div>
280       
281      </div>
282
283     
284
285      <div id="tagline">Produced by IDLdoc 2.0.</div>
286
287    </div>
288
289  </body>
290</html>
Note: See TracBrowser for help on using the repository browser.