source: trunk/SRC/Documentation/idldoc_html_output/Interpolation/extrapsmooth.html

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

update documentation
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>extrapsmooth.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="extrapsmooth.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//extrapsmooth.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="file_interp.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="extrapsmooth.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">extrapsmooth.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 similar to <a href="..//Interpolation/extrapolate.html">extrapolate</a> but could to the job in a better way
91 because the extrapolated values are smoothed...
92 takes more time than <a href="..//Interpolation/extrapolate.html">extrapolate</a>.
93 extrapolate data where mskin is equal 0 by filling
94 step by step the coastline points with the mean value of the 8 neighbors.
95</div>
96
97     
98
99     
100
101     
102
103     
104
105      <div id="routine_details">
106       
107
108        <div class="routine_details" id="_extrapsmooth">
109
110          <h2><a class="top" href="#container">top</a>extrapsmooth <span class="categories">
111 Interpolation
112</span></h2>
113       
114          <p class="header">
115            <span class="result">result = </span>extrapsmooth(<span class="result"><a href="#_extrapsmooth_param_in">in</a>, <a href="#_extrapsmooth_param_mskin">mskin</a></span>, <a href="#_extrapsmooth_keyword_X_PERIODIC">X_PERIODIC</a>=<span class="result">X_PERIODIC</span>, <a href="#_extrapsmooth_keyword_MINVAL">MINVAL</a>=<span class="result">scalar</span>, <a href="#_extrapsmooth_keyword_MAXVAL">MAXVAL</a>=<span class="result">scalar</span>, <a href="#_extrapsmooth_keyword_GE0">GE0</a>=<span class="result">scalar 0 or 1</span>, <a href="#_extrapsmooth_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p>
116       
117          <div class="comments">
118</div>
119
120          <h3>Return value</h3><div class="preformat">
121 the extrapolated array with no more masked values
122</div>
123
124         
125            <h3>Parameters</h3>
126       
127           
128            <h4 id="_extrapsmooth_param_in">in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
129              <span class="attr">in</span>
130             
131             
132              <span class="attr">required</span>
133             
134              <span class="attr">type:</span> <span class="value">2d array</span>
135             
136             
137            </h4>
138       
139          <div class="comments">
140 data to be extrapolate
141</div>
142           
143            <h4 id="_extrapsmooth_param_mskin">mskin&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 or -1</span>
150             
151             
152            </h4>
153       
154          <div class="comments">
155 a 2D array, the land-sea mask of the output data (1 on ocean, 0 on land)
156 put -1 if input data are not masked
157</div>
158           
159
160         
161
162         
163
164            <h3>Keywords</h3>
165           
166            <h4 id="_extrapsmooth_keyword_X_PERIODIC">X_PERIODIC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
167             
168             
169             
170             
171             
172             
173             
174             
175            </h4>
176       
177            <div class="comments"></div>
178           
179            <h4 id="_extrapsmooth_keyword_MINVAL">MINVAL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
180             
181             
182             
183             
184             
185              <span class="attr">type:</span> <span class="value">scalar</span>
186              <span class="attr">default:</span> <span class="value">not used</span>
187             
188            </h4>
189       
190            <div class="comments">
191 to specify a minimum value to the extrapolated values
192</div>
193           
194            <h4 id="_extrapsmooth_keyword_MAXVAL">MAXVAL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
195             
196             
197             
198             
199             
200              <span class="attr">type:</span> <span class="value">scalar</span>
201              <span class="attr">default:</span> <span class="value">not used</span>
202             
203            </h4>
204       
205            <div class="comments">
206 to specify a maximum value to the extrapolated values
207</div>
208           
209            <h4 id="_extrapsmooth_keyword_GE0">GE0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
210             
211             
212             
213             
214             
215              <span class="attr">type:</span> <span class="value">scalar 0 or 1</span>
216              <span class="attr">default:</span> <span class="value">0</span>
217             
218            </h4>
219       
220            <div class="comments">
221 put 1 to force the extrapolated values to be larger than 0, same as using minval=0.
222</div>
223           
224            <h4 id="_extrapsmooth_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
225             
226             
227             
228             
229             
230             
231             
232             
233            </h4>
234       
235            <div class="comments"> to be able to call extrapsmooth with _extra keyword
236</div>
237           
238         
239
240          <h3>Examples</h3><div class="preformat">
241
242   IDL> a=extrapsmooth(dist(jpi,jpj),tmask[*,*,0],/x_periodic)
243   IDL> tvplus, a
244
245 compare to extrapolate result:
246
247   IDL> b=extrapolate(dist(jpi,jpj),tmask[*,*,0],/x_periodic)
248   IDL> tvplus, b, window = 1
249</div>
250          <h3>Version history</h3>
251         
252          <h4>Version</h4><div class="preformat">
253 $Id: extrapsmooth.pro 371 2008-08-07 09:32:02Z pinsard $</div>
254          <h4>History</h4><div class="preformat">
255  January 2007: Sebastien Masson (smasson@lodyc.jussieu.fr)
256</div>
257         
258         
259          <h3>Known issues</h3>
260         
261         
262         
263          <h4>Restrictions</h4><div class="preformat">
264 You cannot specify the number of iterations done in the extrapolation process
265</div>
266       
267         
268         
269         
270         
271         
272         
273         
274       
275          <h3>Statistics</h3>
276          <table class="statistics">
277            <tr><td>McCabe cyclic</td><td>          14</td></tr>
278            <tr><td>McCabe essential</td><td>           1</td></tr>
279            <tr><td>McCabe modular design</td><td>           1</td></tr>
280          </table>
281         
282       
283        </div>
284       
285      </div>
286
287     
288
289      <div id="tagline">Produced by IDLdoc 2.0.</div>
290
291    </div>
292
293  </body>
294</html>
Note: See TracBrowser for help on using the repository browser.