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