source: trunk/SRC/Documentation/idldoc_assistant_output/Interpolation/extrapsmooth.html @ 203

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

update documentation
File size: 5.3 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>extrapsmooth.pro (SAXO Documentation Assistant)</title>
6  </head>
7
8  <body text="#000000" bgcolor="#FFFFFF">
9
10   
11<!-- Navbar template takes a structure with the following fields:
12       overview_href :
13       overview_selected :
14       dir_overview_href :
15       dir_overview_selected :
16       categories_href :
17       categories_selected :
18       index_href :
19       index_selected :
20       search_href :
21       search_selected :
22       file_selected :
23       source_href :
24       source_selected :
25       help_href :
26       help_selected :
27       etc_selected :
28
29       prev_file_href :
30       next_file_href :
31
32       view_single_page_href :
33       view_frames_href :
34
35       summary_fields_href :
36       summary_routine_href :
37       details_routine_href :
38
39       title :
40       subtitle :
41       user :
42-->
43
44
45<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46  <tr>
47    <td width="10%">
48<a href="extrapolate.html"><img src="./../prev.gif" border="0" alt="Previous"></a></td>
49    <td width="80%" align="center" valign="center">
50<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../home.html">Overview</a></font></td>
51    <td width="10%" align="right">
52<a href="fromirr.html"><img src="./../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">Interpolation/</font></h1>
58    <h2>extrapsmooth.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 similar to extrapolate but could to the job in a better way because the
65 extrapolated values are smoothed... takes more time than extrapolate.
66 extrapolate data where maskinput eq 0 by filling
67 step by step the coastline points with the mean value of the 8 neighbourgs.
68
69
70
71   
72
73     
74      <a name="#_extrapsmooth"></a>
75
76      <h2>extrapsmooth  <font size="-1" color="#006633">
77 Interpolation
78</font></h2>
79
80      <p><font face="Courier"><i>result = </i>extrapsmooth(<i><a href="#_extrapsmooth_keyword_in">in</a>, <a href="#_extrapsmooth_keyword_mskin">mskin</a></i>, <a href="#_extrapsmooth_keyword_x_periodic">x_periodic</a>=<i>x_periodic</i>, <a href="#_extrapsmooth_keyword_MINVAL">MINVAL</a>=<i>scalar</i>, <a href="#_extrapsmooth_keyword_MAXVAL">MAXVAL</a>=<i>scalar</i>, <a href="#_extrapsmooth_keyword_GE0">GE0</a>=<i>scalar 0 or 1</i>)</font></p>
81
82   
83
84    <h3>Return value</h3>
85 the extrapolated array with no more masked values
86
87
88   
89    <h3>Parameters</h3>
90   
91
92    <a name="#_extrapsmooth_keyword_in"></a>
93    <h4>in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
94      <font size="-1" color="#006633">in</font>
95     
96     
97      <font size="-1" color="#006633">required</font>
98     
99      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font>
100     
101     
102    </h4>
103
104   
105 data to be extrapolate
106
107   
108
109    <a name="#_extrapsmooth_keyword_mskin"></a>
110    <h4>mskin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
111     
112     
113     
114     
115     
116     
117     
118     
119    </h4>
120
121   
122   
123   
124
125   
126    <h3>Keywords</h3>
127
128   
129    <a name="#_extrapsmooth_keyword_x_periodic"></a>
130    <h4>x_periodic&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
131     
132     
133     
134     
135     
136     
137     
138     
139    </h4>
140
141   
142   
143    <a name="#_extrapsmooth_keyword_MINVAL"></a>
144    <h4>MINVAL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
145     
146     
147     
148     
149     
150      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font>
151      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>not used</i></font>
152     
153    </h4>
154
155   
156 to specify a minimum value to the extrapolated values
157
158   
159    <a name="#_extrapsmooth_keyword_MAXVAL"></a>
160    <h4>MAXVAL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
161     
162     
163     
164     
165     
166      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font>
167      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>not used</i></font>
168     
169    </h4>
170
171   
172 to specify a maximum value to the extrapolated values
173
174   
175    <a name="#_extrapsmooth_keyword_GE0"></a>
176    <h4>GE0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
177     
178     
179     
180     
181     
182      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar 0 or 1</i></font>
183      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
184     
185    </h4>
186
187   
188 put 1 to force the extrapolated values to be larger than 0, same as using minval=0.
189
190   
191   
192
193    <h3>Examples</h3>
194 IDL> a=extrapsmooth(dist(jpi,jpj),tmask[*,*,0],/x_periodic)
195 IDL> tvplus, a
196 compare to extrapolate result:
197 IDL> b=extrapolate(dist(jpi,jpj),tmask[*,*,0],/x_periodic)
198 IDL> tvplus, b, window = 1
199
200    <h3>Version history</h3>
201   
202    <h4>Version</h4>
203 $Id: extrapsmooth.pro 202 2007-01-12 11:00:06Z smasson $
204    <h4>History</h4>
205  January 2007: Sebastien Masson (smasson@lodyc.jussieu.fr)
206
207   
208
209    <h3>Known issues</h3>
210   
211   
212   
213    <h4>Restrictions</h4>
214 You cannot specify the number of iterations done in the extrapolation process
215
216
217   
218   
219   
220   
221   
222   
223   
224
225    <font size="-3"><p>&nbsp;</p></font>
226    <hr size="1" color="#CCCCCC"/>
227     
228
229   
230
231    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
232
233  </body>
234</html>
Note: See TracBrowser for help on using the repository browser.