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

Last change on this file since 234 was 234, checked in by pinsard, 17 years ago

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