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

Last change on this file since 203 was 203, checked in by smasson, 18 years ago

update documentation
File size: 7.4 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 eq 0 by filling step by
91 step the coastline points with the mean value of the 8 neighbourgs
92 (weighted by their mask value).
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_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>)</p>
114       
115          <div class="comments"></div>
116
117          <h3>Return value</h3><div class="preformat"> {type=2d array}
118 the extrapolated array
119</div>
120
121         
122            <h3>Parameters</h3>
123       
124           
125            <h4 id="_extrapolate_param_zinput">zinput&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">2d array</span>
132             
133             
134            </h4>
135       
136          <div class="comments">
137 data to be extrapolate
138</div>
139           
140            <h4 id="_extrapolate_param_maskinput">maskinput&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 or -1</span>
147             
148             
149            </h4>
150       
151          <div class="comments">
152 a 2D array, the land-sea mask of the output data (1 on ocean, 0 on land)
153 put -1 if input data are not masked
154</div>
155           
156            <h4 id="_extrapolate_param_nb_iteration">nb_iteration&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
157              <span class="attr">in</span>
158             
159              <span class="attr">optional</span>
160             
161             
162              <span class="attr">type:</span> <span class="value">integer scalar</span>
163              <span class="attr">default:</span> <span class="value">10.E20</span>
164             
165            </h4>
166       
167          <div class="comments">
168 Maximum number if iterations done in the extrapolation process. If there
169 is no more masked values we exit extrapolate before reaching nb_iteration
170 (to be sure to fill everything, you can use a very large value)
171</div>
172           
173
174         
175
176         
177
178            <h3>Keywords</h3>
179           
180            <h4 id="_extrapolate_keyword_x_periodic">x_periodic&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 the data are periodic along x axis
193</div>
194           
195            <h4 id="_extrapolate_keyword_MINVAL">MINVAL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
196             
197             
198             
199             
200             
201              <span class="attr">type:</span> <span class="value">scalar</span>
202              <span class="attr">default:</span> <span class="value">not used</span>
203             
204            </h4>
205       
206            <div class="comments">
207 to specify a minimum value to the extrapolated values
208</div>
209           
210            <h4 id="_extrapolate_keyword_MAXVAL">MAXVAL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
211             
212             
213             
214             
215             
216              <span class="attr">type:</span> <span class="value">scalar</span>
217              <span class="attr">default:</span> <span class="value">not used</span>
218             
219            </h4>
220       
221            <div class="comments">
222 to specify a maximum value to the extrapolated values
223</div>
224           
225            <h4 id="_extrapolate_keyword_GE0">GE0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
226             
227             
228             
229             
230             
231              <span class="attr">type:</span> <span class="value">scalar 0 or 1</span>
232              <span class="attr">default:</span> <span class="value">0</span>
233             
234            </h4>
235       
236            <div class="comments">
237 put 1 to force the extrapolated values to be larger than 0, same as using minval=0.
238</div>
239           
240         
241
242          <h3>Examples</h3><div class="preformat">
243 IDL> a=extrapolate(dist(jpi,jpj),tmask[*,*,0],/x_periodic)
244 IDL> tvplus, a
245 IDL> tvplus, a*(1-tmask[*,*,0])
246 get the coastline:
247 IDL> a=extrapolate(tmask[*,*,0],tmask[*,*,0],1,/x_periodic)
248 IDL> tvplus, a-tmask[*,*,0]
249</div>
250          <h3>Version history</h3>
251         
252          <h4>Version</h4><div class="preformat"> $Id: extrapolate.pro 202 2007-01-12 11:00:06Z smasson $
253</div>
254          <h4>History</h4><div class="preformat">
255  Originaly written by G. Roulet
256  Sebastien Masson (smasson@lodyc.jussieu.fr)
257</div>
258         
259         
260         
261         
262         
263         
264         
265       
266         
267         
268         
269         
270         
271         
272         
273       
274          <h3>Statistics</h3>
275          <table class="statistics">
276            <tr><td>McCabe cyclic</td><td>          13</td></tr>
277            <tr><td>McCabe essential</td><td>           1</td></tr>
278            <tr><td>McCabe modular design</td><td>           1</td></tr>
279          </table>
280         
281       
282        </div>
283       
284      </div>
285
286     
287
288      <div id="tagline">Produced by IDLdoc 2.0.</div>
289
290    </div>
291
292  </body>
293</html>
Note: See TracBrowser for help on using the repository browser.