source: trunk/SRC/Documentation/idldoc_html_output/Interpolation/fromreg.html @ 191

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

remove format=raw in all html files 2+ : correction for all_plots; suppression of css and correction of Source links in idldoc html output
File size: 8.8 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>fromreg.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="fromreg.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//fromreg.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="fromirr.html">&lt;&lt;prev file</a> | <a href="get_gridparams.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="fromreg.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">fromreg.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 interpolate data from a "regular/rectangular grid" to any grid.
91   2 methods available: bilinear and imoms3
92   A "regular/rectangular grid" is defined as a grid for which each longitudes lines have
93   the same latitude and each latitudes columns have the same longitude.
94</div>
95
96     
97
98     
99
100     
101
102     
103
104      <div id="routine_details">
105       
106
107        <div class="routine_details" id="_fromreg">
108
109          <h2><a class="top" href="#container">top</a>fromreg <span class="categories"> 
110 Interpolation
111</span></h2>
112       
113          <p class="header">
114            <span class="result">result = </span>fromreg(<span class="result"><a href="#_fromreg_param_method">method</a>, <a href="#_fromreg_param_datain">datain</a>[, <a href="#_fromreg_param_lonin">lonin</a>][, <a href="#_fromreg_param_latin">latin</a>][, <a href="#_fromreg_param_lonout">lonout</a>], <a href="#_fromreg_param_latout">latout</a></span>, <a href="#_fromreg_keyword_WEIG">WEIG</a>=<span class="result">2d array</span>, <a href="#_fromreg_keyword_ADDR">ADDR</a>=<span class="result">2d array</span>, <a href="#_fromreg_keyword_NONORTHERNLINE">NONORTHERNLINE</a>=<span class="result">NONORTHERNLINE</span>, <a href="#_fromreg_keyword_NOSOUTHERNLINE">NOSOUTHERNLINE</a>=<span class="result">NOSOUTHERNLINE</span>)</p>
115       
116          <div class="comments">
117</div>
118
119          <h3>Return value</h3><div class="preformat">
120 2D array the interpolated data
121</div>
122
123         
124            <h3>Parameters</h3>
125       
126           
127            <h4 id="_fromreg_param_method">method&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
128              <span class="attr">in</span>
129             
130             
131              <span class="attr">required</span>
132             
133              <span class="attr">type:</span> <span class="value">string</span>
134             
135             
136            </h4>
137       
138          <div class="comments">
139 a string defining the interpolation method.
140 must be 'bilinear' or 'imoms3'
141</div>
142           
143            <h4 id="_fromreg_param_datain">datain&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
144              <span class="attr">in</span>
145             
146             
147              <span class="attr">required</span>
148             
149              <span class="attr">type:</span> <span class="value">2d array</span>
150             
151             
152            </h4>
153       
154          <div class="comments">
155 a 2D array the input data to interpolate
156</div>
157           
158            <h4 id="_fromreg_param_lonin">lonin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
159              <span class="attr">in</span>
160             
161              <span class="attr">optional</span>
162             
163             
164              <span class="attr">type:</span> <span class="value">1d or 2d array</span>
165             
166             
167            </h4>
168       
169          <div class="comments">
170 1D or 2D array defining the longitude of the input data
171</div>
172           
173            <h4 id="_fromreg_param_latin">latin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
174              <span class="attr">in</span>
175             
176              <span class="attr">optional</span>
177             
178             
179              <span class="attr">type:</span> <span class="value">1d or 2d array</span>
180             
181             
182            </h4>
183       
184          <div class="comments">
185 1D or 2D array defining the latitude of the input data
186</div>
187           
188            <h4 id="_fromreg_param_lonout">lonout&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
189              <span class="attr">in</span>
190             
191              <span class="attr">optional</span>
192             
193             
194              <span class="attr">type:</span> <span class="value">1d or 2d array</span>
195             
196             
197            </h4>
198       
199          <div class="comments">
200 1D or 2D array defining the longitude of the output data
201</div>
202           
203            <h4 id="_fromreg_param_latout">latout&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
204              <span class="attr">in</span>
205             
206             
207              <span class="attr">required</span>
208             
209              <span class="attr">type:</span> <span class="value">1d or 2d array</span>
210             
211             
212            </h4>
213       
214          <div class="comments">
215 1D or 2D array defining the latitude of the output data
216</div>
217           
218
219         
220
221         
222
223            <h3>Keywords</h3>
224           
225            <h4 id="_fromreg_keyword_WEIG">WEIG&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
226             
227             
228             
229             
230             
231              <span class="attr">type:</span> <span class="value">2d array</span>
232             
233             
234            </h4>
235       
236            <div class="comments">
237 (see ADDR)
238</div>
239           
240            <h4 id="_fromreg_keyword_ADDR">ADDR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
241             
242             
243             
244             
245             
246              <span class="attr">type:</span> <span class="value">2d array</span>
247             
248             
249            </h4>
250       
251            <div class="comments">
252 2D arrays, weig and addr are the weight and addresses used to
253 perform the interpolation:
254          dataout = total(weig*datain[addr], 1)
255          dataout = reform(dataout, jpio, jpjo, /over)
256 Those keywords can be set to named variables (that are undefined or equal to 0) into which the
257 values will be copied when the current routine exits. Next, they can be used to perform
258 the interpolation without computing again those 2 parameters. In that
259 case, lonin, latin, lonout and latout are not necessary.
260</div>
261           
262            <h4 id="_fromreg_keyword_NONORTHERNLINE">NONORTHERNLINE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
263             
264             
265             
266             
267             
268             
269             
270             
271            </h4>
272       
273            <div class="comments">
274 activate if you don't want to take into account the northern line
275 of the input data when performing the interpolation.
276</div>
277           
278            <h4 id="_fromreg_keyword_NOSOUTHERNLINE">NOSOUTHERNLINE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
279             
280             
281             
282             
283             
284             
285             
286             
287            </h4>
288       
289            <div class="comments">
290 activate if you don't want to take into account the southern line
291 of the input data when performing the interpolation.
292</div>
293           
294         
295
296          <h3>Examples</h3><div class="preformat">
297
298 IDL> topa = fromreg('bilinear', tncep, xncep, yncep, glamt, gphit)
299
300  or
301
302 IDL> t1opa = fromreg('bilinear', t1ncep, xncep, yncep, glamt, gphit, WEIG = a, ADDR = b)
303 IDL> help, a, b
304 IDL> t2opa = fromreg('bilinear', t2ncep, xncep, WEIG = a, ADDR = b)
305</div>
306          <h3>Version history</h3>
307         
308          <h4>Version</h4><div class="preformat"> $Id: fromreg.pro 163 2006-08-29 12:59:46Z navarro $
309</div>
310          <h4>History</h4><div class="preformat">
311  November 2005: Sebastien Masson (smasson@lodyc.jussieu.fr)
312</div>
313         
314         
315          <h3>Known issues</h3>
316         
317         
318         
319          <h4>Restrictions</h4><div class="preformat">
320 We supposed the data are located on a sphere, with a periodicity along the
321 longitude.
322</div>
323       
324         
325         
326         
327         
328         
329         
330         
331       
332          <h3>Statistics</h3>
333          <table class="statistics">
334            <tr><td>McCabe cyclic</td><td>           5</td></tr>
335            <tr><td>McCabe essential</td><td>           1</td></tr>
336            <tr><td>McCabe modular design</td><td>           1</td></tr>
337          </table>
338         
339       
340        </div>
341       
342      </div>
343
344     
345
346      <div id="tagline">Produced by IDLdoc 2.0.</div>
347
348    </div>
349
350  </body>
351</html>
Note: See TracBrowser for help on using the repository browser.