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="file_interp.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 <a href="..//Interpolation/extrapolate.html">extrapolate</a> but could to the job in a better way |
---|
65 | because the extrapolated values are smoothed... |
---|
66 | takes more time than <a href="..//Interpolation/extrapolate.html">extrapolate</a>. |
---|
67 | extrapolate data where mskin is equal 0 by filling |
---|
68 | step by step the coastline points with the mean value of the 8 neighbors. |
---|
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>, <a href="#_extrapsmooth_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p> |
---|
81 | |
---|
82 | |
---|
83 | |
---|
84 | |
---|
85 | <h3>Return value</h3> |
---|
86 | the extrapolated array with no more masked values |
---|
87 | |
---|
88 | |
---|
89 | |
---|
90 | <h3>Parameters</h3> |
---|
91 | |
---|
92 | |
---|
93 | <a name="#_extrapsmooth_keyword_in"></a> |
---|
94 | <h4>in |
---|
95 | <font size="-1" color="#006633">in</font> |
---|
96 | |
---|
97 | |
---|
98 | <font size="-1" color="#006633">required</font> |
---|
99 | |
---|
100 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font> |
---|
101 | |
---|
102 | |
---|
103 | </h4> |
---|
104 | |
---|
105 | |
---|
106 | data to be extrapolate |
---|
107 | |
---|
108 | |
---|
109 | |
---|
110 | <a name="#_extrapsmooth_keyword_mskin"></a> |
---|
111 | <h4>mskin |
---|
112 | <font size="-1" color="#006633">in</font> |
---|
113 | |
---|
114 | |
---|
115 | <font size="-1" color="#006633">required</font> |
---|
116 | |
---|
117 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array or -1</i></font> |
---|
118 | |
---|
119 | |
---|
120 | </h4> |
---|
121 | |
---|
122 | |
---|
123 | a 2D array, the land-sea mask of the output data (1 on ocean, 0 on land) |
---|
124 | put -1 if input data are not masked |
---|
125 | |
---|
126 | |
---|
127 | |
---|
128 | |
---|
129 | |
---|
130 | <h3>Keywords</h3> |
---|
131 | |
---|
132 | |
---|
133 | <a name="#_extrapsmooth_keyword_X_PERIODIC"></a> |
---|
134 | <h4>X_PERIODIC |
---|
135 | |
---|
136 | |
---|
137 | |
---|
138 | |
---|
139 | |
---|
140 | |
---|
141 | |
---|
142 | |
---|
143 | </h4> |
---|
144 | |
---|
145 | |
---|
146 | |
---|
147 | <a name="#_extrapsmooth_keyword_MINVAL"></a> |
---|
148 | <h4>MINVAL |
---|
149 | |
---|
150 | |
---|
151 | |
---|
152 | |
---|
153 | |
---|
154 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font> |
---|
155 | <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>not used</i></font> |
---|
156 | |
---|
157 | </h4> |
---|
158 | |
---|
159 | |
---|
160 | to specify a minimum value to the extrapolated values |
---|
161 | |
---|
162 | |
---|
163 | <a name="#_extrapsmooth_keyword_MAXVAL"></a> |
---|
164 | <h4>MAXVAL |
---|
165 | |
---|
166 | |
---|
167 | |
---|
168 | |
---|
169 | |
---|
170 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font> |
---|
171 | <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>not used</i></font> |
---|
172 | |
---|
173 | </h4> |
---|
174 | |
---|
175 | |
---|
176 | to specify a maximum value to the extrapolated values |
---|
177 | |
---|
178 | |
---|
179 | <a name="#_extrapsmooth_keyword_GE0"></a> |
---|
180 | <h4>GE0 |
---|
181 | |
---|
182 | |
---|
183 | |
---|
184 | |
---|
185 | |
---|
186 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar 0 or 1</i></font> |
---|
187 | <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font> |
---|
188 | |
---|
189 | </h4> |
---|
190 | |
---|
191 | |
---|
192 | put 1 to force the extrapolated values to be larger than 0, same as using minval=0. |
---|
193 | |
---|
194 | |
---|
195 | <a name="#_extrapsmooth_keyword__EXTRA"></a> |
---|
196 | <h4>_EXTRA |
---|
197 | |
---|
198 | |
---|
199 | |
---|
200 | |
---|
201 | |
---|
202 | |
---|
203 | |
---|
204 | |
---|
205 | </h4> |
---|
206 | |
---|
207 | to be able to call extrapsmooth with _extra keyword |
---|
208 | |
---|
209 | |
---|
210 | |
---|
211 | |
---|
212 | <h3>Examples</h3><pre> |
---|
213 | |
---|
214 | IDL> a=extrapsmooth(dist(jpi,jpj),tmask[*,*,0],/x_periodic) |
---|
215 | IDL> tvplus, a |
---|
216 | |
---|
217 | compare to extrapolate result: |
---|
218 | |
---|
219 | IDL> b=extrapolate(dist(jpi,jpj),tmask[*,*,0],/x_periodic) |
---|
220 | IDL> tvplus, b, window = 1 |
---|
221 | |
---|
222 | </pre><h3>Version history</h3> |
---|
223 | |
---|
224 | <h4>Version</h4> |
---|
225 | $Id: extrapsmooth.pro 371 2008-08-07 09:32:02Z pinsard $ |
---|
226 | <h4>History</h4> |
---|
227 | January 2007: Sebastien Masson (smasson@lodyc.jussieu.fr) |
---|
228 | |
---|
229 | |
---|
230 | |
---|
231 | <h3>Known issues</h3> |
---|
232 | |
---|
233 | |
---|
234 | |
---|
235 | <h4>Restrictions</h4> |
---|
236 | You cannot specify the number of iterations done in the extrapolation process |
---|
237 | |
---|
238 | |
---|
239 | |
---|
240 | |
---|
241 | |
---|
242 | |
---|
243 | |
---|
244 | |
---|
245 | |
---|
246 | |
---|
247 | <font size="-3"><p> </p></font> |
---|
248 | <hr size="1" color="#CCCCCC"/> |
---|
249 | |
---|
250 | |
---|
251 | |
---|
252 | |
---|
253 | <p><font color="gray" size="-3"> Produced by IDLdoc 2.0.</font></p> |
---|
254 | |
---|
255 | </body> |
---|
256 | </html> |
---|