source: trunk/SRC/Documentation/idldoc_html_output/Interpolation/extrapolate.html @ 402

Last change on this file since 402 was 402, checked in by smasson, 15 years ago

update documentation
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>extrapolate.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="extrapolate.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//extrapolate.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="cutsegment.html">&lt;&lt;prev file</a> | <a href="extrapsmooth.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="extrapolate.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">extrapolate.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 extrapolate data (zinput) where maskinput equal 0 by filling step by
91 step the coastline points with the mean value of the 8 neighbors
92 (weighted by their mask values).
93</div>
94
95     
96
97     
98
99     
100
101     
102
103      <div id="routine_details">
104       
105
106        <div class="routine_details" id="_extrapolate">
107
108          <h2><a class="top" href="#container">top</a>extrapolate <span class="categories">
109 Interpolation
110</span></h2>
111       
112          <p class="header">
113            <span class="result">result = </span>extrapolate(<span class="result"><a href="#_extrapolate_param_zinput">zinput</a>, <a href="#_extrapolate_param_maskinput">maskinput</a>[, <a href="#_extrapolate_param_nb_iteration">nb_iteration</a>]</span>, <a href="#_extrapolate_keyword_FILLXDIR">FILLXDIR</a>=<span class="result">scalar, 0 or 1</span>, <a href="#_extrapolate_keyword_FILLYDIR">FILLYDIR</a>=<span class="result">scalar, 0 or 1</span>, <a href="#_extrapolate_keyword_X_PERIODIC">X_PERIODIC</a>=<span class="result">scalar, 0 or 1</span>, <a href="#_extrapolate_keyword_MINVAL">MINVAL</a>=<span class="result">scalar</span>, <a href="#_extrapolate_keyword_MAXVAL">MAXVAL</a>=<span class="result">scalar</span>, <a href="#_extrapolate_keyword_GE0">GE0</a>=<span class="result">scalar 0 or 1</span>, <a href="#_extrapolate_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p>
114       
115          <div class="comments">
116</div>
117
118          <h3>Return value</h3><div class="preformat">
119 the extrapolated 2d array
120</div>
121
122         
123            <h3>Parameters</h3>
124       
125           
126            <h4 id="_extrapolate_param_zinput">zinput&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
127              <span class="attr">in</span>
128             
129             
130              <span class="attr">required</span>
131             
132              <span class="attr">type:</span> <span class="value">2d array</span>
133             
134             
135            </h4>
136       
137          <div class="comments">
138 data to be extrapolate
139</div>
140           
141            <h4 id="_extrapolate_param_maskinput">maskinput&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
142              <span class="attr">in</span>
143             
144             
145              <span class="attr">required</span>
146             
147              <span class="attr">type:</span> <span class="value">2d array or -1</span>
148             
149             
150            </h4>
151       
152          <div class="comments">
153 a 2D array, the land-sea mask of the output data (1 on ocean, 0 on land)
154 put -1 if input data are not masked
155</div>
156           
157            <h4 id="_extrapolate_param_nb_iteration">nb_iteration&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
158              <span class="attr">in</span>
159             
160              <span class="attr">optional</span>
161             
162             
163              <span class="attr">type:</span> <span class="value">integer</span>
164              <span class="attr">default:</span> <span class="value">large enough to fill everything</span>
165             
166            </h4>
167       
168          <div class="comments">
169 Maximum number of iterations done in the extrapolation process. If there
170 is no more masked values we exit extrapolate before reaching nb_iteration
171</div>
172           
173
174         
175
176         
177
178            <h3>Keywords</h3>
179           
180            <h4 id="_extrapolate_keyword_FILLXDIR">FILLXDIR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
181             
182             
183             
184             
185             
186              <span class="attr">type:</span> <span class="value">scalar, 0 or 1</span>
187              <span class="attr">default:</span> <span class="value">0</span>
188             
189            </h4>
190       
191            <div class="comments">
192 put 1 to specify that filling of the data must be done only along x direction
193</div>
194           
195            <h4 id="_extrapolate_keyword_FILLYDIR">FILLYDIR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
196             
197             
198             
199             
200             
201              <span class="attr">type:</span> <span class="value">scalar, 0 or 1</span>
202              <span class="attr">default:</span> <span class="value">0</span>
203             
204            </h4>
205       
206            <div class="comments">
207 put 1 to specify that filling of the data must be done only along y direction
208</div>
209           
210            <h4 id="_extrapolate_keyword_X_PERIODIC">X_PERIODIC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
211             
212             
213             
214             
215             
216              <span class="attr">type:</span> <span class="value">scalar, 0 or 1</span>
217              <span class="attr">default:</span> <span class="value">0</span>
218             
219            </h4>
220       
221            <div class="comments">
222 put 1 to specify that the data are periodic along x axis
223</div>
224           
225            <h4 id="_extrapolate_keyword_MINVAL">MINVAL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
226             
227             
228             
229             
230             
231              <span class="attr">type:</span> <span class="value">scalar</span>
232              <span class="attr">default:</span> <span class="value">not used</span>
233             
234            </h4>
235       
236            <div class="comments">
237 to specify a minimum value to the extrapolated values
238</div>
239           
240            <h4 id="_extrapolate_keyword_MAXVAL">MAXVAL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
241             
242             
243             
244             
245             
246              <span class="attr">type:</span> <span class="value">scalar</span>
247              <span class="attr">default:</span> <span class="value">not used</span>
248             
249            </h4>
250       
251            <div class="comments">
252 to specify a maximum value to the extrapolated values
253</div>
254           
255            <h4 id="_extrapolate_keyword_GE0">GE0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
256             
257             
258             
259             
260             
261              <span class="attr">type:</span> <span class="value">scalar 0 or 1</span>
262              <span class="attr">default:</span> <span class="value">0</span>
263             
264            </h4>
265       
266            <div class="comments">
267 put 1 to force the extrapolated values to be larger than 0, same as using minval=0.
268</div>
269           
270            <h4 id="_extrapolate_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
271             
272             
273             
274             
275             
276             
277             
278             
279            </h4>
280       
281            <div class="comments"> to be able to call extrapolate with _extra keyword
282</div>
283           
284         
285
286          <h3>Examples</h3><div class="preformat">
287
288   IDL> a=extrapolate(dist(jpi,jpj),tmask[*,*,0],/x_periodic)
289   IDL> tvplus, a
290   IDL> tvplus, a*(1-tmask[*,*,0])
291
292 get the coastline:
293
294   IDL> a=extrapolate(tmask[*,*,0],tmask[*,*,0],1,/x_periodic)
295   IDL> tvplus, a-tmask[*,*,0]
296</div>
297          <h3>Version history</h3>
298         
299          <h4>Version</h4><div class="preformat">
300 $Id: extrapolate.pro 384 2008-11-06 02:32:33Z smasson $
301</div>
302          <h4>History</h4><div class="preformat">
303  Originaly written by G. Roullet
304  Sebastien Masson (smasson@lodyc.jussieu.fr)
305</div>
306         
307         
308         
309         
310         
311         
312         
313       
314         
315         
316         
317         
318         
319         
320         
321       
322          <h3>Statistics</h3>
323          <table class="statistics">
324            <tr><td>McCabe cyclic</td><td>          24</td></tr>
325            <tr><td>McCabe essential</td><td>           1</td></tr>
326            <tr><td>McCabe modular design</td><td>           1</td></tr>
327          </table>
328         
329       
330        </div>
331       
332      </div>
333
334     
335
336      <div id="tagline">Produced by IDLdoc 2.0.</div>
337
338    </div>
339
340  </body>
341</html>
Note: See TracBrowser for help on using the repository browser.