source: trunk/SRC/Documentation/idldoc_assistant_output/Interpolation/extrapolate.html @ 338

Last change on this file since 338 was 338, checked in by smasson, 16 years ago

update documentation
File size: 6.7 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>extrapolate.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="cutsegment.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="extrapsmooth.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>extrapolate.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 extrapolate data (zinput) where maskinput equal 0 by filling step by
65 step the coastline points with the mean value of the 8 neighbors
66 (weighted by their mask values).
67
68
69   
70
71     
72      <a name="#_extrapolate"></a>
73
74      <h2>extrapolate  <font size="-1" color="#006633">
75 Interpolation
76</font></h2>
77
78      <p><font face="Courier"><i>result = </i>extrapolate(<i><a href="#_extrapolate_keyword_zinput">zinput</a>, <a href="#_extrapolate_keyword_maskinput">maskinput</a>[, <a href="#_extrapolate_keyword_nb_iteration">nb_iteration</a>]</i>, <a href="#_extrapolate_keyword_X_PERIODIC">X_PERIODIC</a>=<i>scalar, 0 or 1</i>, <a href="#_extrapolate_keyword_MINVAL">MINVAL</a>=<i>scalar</i>, <a href="#_extrapolate_keyword_MAXVAL">MAXVAL</a>=<i>scalar</i>, <a href="#_extrapolate_keyword_GE0">GE0</a>=<i>scalar 0 or 1</i>, <a href="#_extrapolate_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p>
79
80   
81
82
83    <h3>Return value</h3>
84 the extrapolated 2d array
85
86
87   
88    <h3>Parameters</h3>
89   
90
91    <a name="#_extrapolate_keyword_zinput"></a>
92    <h4>zinput&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
93      <font size="-1" color="#006633">in</font>
94     
95     
96      <font size="-1" color="#006633">required</font>
97     
98      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font>
99     
100     
101    </h4>
102
103   
104 data to be extrapolate
105
106   
107
108    <a name="#_extrapolate_keyword_maskinput"></a>
109    <h4>maskinput&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
110      <font size="-1" color="#006633">in</font>
111     
112     
113      <font size="-1" color="#006633">required</font>
114     
115      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array or -1</i></font>
116     
117     
118    </h4>
119
120   
121 a 2D array, the land-sea mask of the output data (1 on ocean, 0 on land)
122 put -1 if input data are not masked
123
124   
125
126    <a name="#_extrapolate_keyword_nb_iteration"></a>
127    <h4>nb_iteration&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
128      <font size="-1" color="#006633">in</font>
129     
130      <font size="-1" color="#006633">optional</font>
131     
132     
133      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>integer</i></font>
134      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>large enough to fill everything</i></font>
135     
136    </h4>
137
138   
139 Maximum number of iterations done in the extrapolation process. If there
140 is no more masked values we exit extrapolate before reaching nb_iteration
141
142   
143   
144
145   
146    <h3>Keywords</h3>
147
148   
149    <a name="#_extrapolate_keyword_X_PERIODIC"></a>
150    <h4>X_PERIODIC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
151     
152     
153     
154     
155     
156      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar, 0 or 1</i></font>
157      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
158     
159    </h4>
160
161   
162 put 1 to specify that the data are periodic along x axis
163
164   
165    <a name="#_extrapolate_keyword_MINVAL"></a>
166    <h4>MINVAL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
167     
168     
169     
170     
171     
172      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font>
173      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>not used</i></font>
174     
175    </h4>
176
177   
178 to specify a minimum value to the extrapolated values
179
180   
181    <a name="#_extrapolate_keyword_MAXVAL"></a>
182    <h4>MAXVAL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
183     
184     
185     
186     
187     
188      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font>
189      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>not used</i></font>
190     
191    </h4>
192
193   
194 to specify a maximum value to the extrapolated values
195
196   
197    <a name="#_extrapolate_keyword_GE0"></a>
198    <h4>GE0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
199     
200     
201     
202     
203     
204      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar 0 or 1</i></font>
205      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
206     
207    </h4>
208
209   
210 put 1 to force the extrapolated values to be larger than 0, same as using minval=0.
211
212   
213    <a name="#_extrapolate_keyword__EXTRA"></a>
214    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
215     
216     
217     
218     
219     
220     
221     
222     
223    </h4>
224
225     to be able to call extrapolate with _extra keyword
226
227   
228   
229
230    <h3>Examples</h3><pre>
231 IDL> a=extrapolate(dist(jpi,jpj),tmask[*,*,0],/x_periodic)
232 IDL> tvplus, a
233 IDL> tvplus, a*(1-tmask[*,*,0])
234 get the coastline:
235 IDL> a=extrapolate(tmask[*,*,0],tmask[*,*,0],1,/x_periodic)
236 IDL> tvplus, a-tmask[*,*,0]
237
238    </pre><h3>Version history</h3>
239   
240    <h4>Version</h4>
241 $Id: extrapolate.pro 327 2007-12-13 16:22:35Z pinsard $
242
243    <h4>History</h4>
244  Originaly written by G. Roullet
245  Sebastien Masson (smasson@lodyc.jussieu.fr)
246
247   
248
249   
250   
251   
252   
253   
254
255   
256   
257   
258   
259   
260   
261   
262
263    <font size="-3"><p>&nbsp;</p></font>
264    <hr size="1" color="#CCCCCC"/>
265     
266
267   
268
269    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
270
271  </body>
272</html>
Note: See TracBrowser for help on using the repository browser.