source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/CALCULS/grossemoyenne.html @ 177

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

updates of html files...
File size: 7.0 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>grossemoyenne.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="fsfzpt.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="hdyn.html"><img src="./../../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ToBeReviewed/CALCULS/</font></h1>
58    <h2>grossemoyenne.pro</h2>
59
60    <dl>
61    </dl>
62
63     
64 averages a 3- or 4-d time series field over a selected
65 geographical area or along the time axis. For one ore more
66 selected axes (x, y, z, t)
67
68
69   
70
71     
72      <a name="#_grossemoyenne"></a>
73
74      <h2>grossemoyenne  <font size="-1" color="#006633">
75</font></h2>
76
77      <p><font face="Courier"><i>result = </i>grossemoyenne(<i><a href="#_grossemoyenne_keyword_tab">tab</a>, <a href="#_grossemoyenne_keyword_direc">direc</a></i>, <a href="#_grossemoyenne_keyword_BOXZOOM">BOXZOOM</a>=<i>BOXZOOM</i>, <a href="#_grossemoyenne_keyword_INTEGRATION">INTEGRATION</a>=<i>INTEGRATION</i>, <a href="#_grossemoyenne_keyword_NAN">NAN</a>=<i>NAN</i>, <a href="#_grossemoyenne_keyword_NODOMDEF">NODOMDEF</a>=<i>NODOMDEF</i>, <a href="#_grossemoyenne_keyword_WDEPTH">WDEPTH</a>=<i>WDEPTH</i>, <a href="#_grossemoyenne_keyword_SPATIALFIRST">SPATIALFIRST</a>=<i>SPATIALFIRST</i>, <a href="#_grossemoyenne_keyword_TEMPORALFIRST">TEMPORALFIRST</a>=<i>TEMPORALFIRST</i>, <a href="#_grossemoyenne_keyword__extra">_extra</a>=<i>_extra</i>)</font></p>
78
79   
80
81
82   
83
84   
85    <h3>Parameters</h3>
86   
87
88    <a name="#_grossemoyenne_keyword_tab"></a>
89    <h4>tab&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
90      <font size="-1" color="#006633">in</font>
91     
92     
93      <font size="-1" color="#006633">required</font>
94     
95     
96     
97     
98    </h4>
99
100   
101 3 or 4d field
102
103   
104
105    <a name="#_grossemoyenne_keyword_direc"></a>
106    <h4>direc&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
107      <font size="-1" color="#006633">in</font>
108     
109     
110      <font size="-1" color="#006633">required</font>
111     
112     
113     
114     
115    </h4>
116
117   
118 'x' 'y' 'z' 't' 'xy' 'xz' 'yz' 'xyz' 'xt' 'yt' 'zt'
119 'xyt' 'xzt' 'yzt' or 'xyzt'
120
121   
122   
123
124   
125    <h3>Keywords</h3>
126
127   
128    <a name="#_grossemoyenne_keyword_BOXZOOM"></a>
129    <h4>BOXZOOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
130     
131     
132     
133     
134     
135     
136     
137     
138    </h4>
139
140     
141 [xmin,xmax,ymin,ymax (,(zmin,)zmax)] to more details, see domdef
142 boxzoom can have 5 forms:
143 [vert2], [vert1, vert2],[lon1, lon2, lat1, lat2], 
144 [lon1, lon2, lat1, lat2, vert2],[lon1, lon2, lat1, lat2, vert1,vert2]
145             
146   
147    <a name="#_grossemoyenne_keyword_INTEGRATION"></a>
148    <h4>INTEGRATION&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
149     
150     
151     
152     
153     
154     
155     
156     
157    </h4>
158
159     
160 To make an integral rather than an average
161
162   
163    <a name="#_grossemoyenne_keyword_NAN"></a>
164    <h4>NAN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
165     
166     
167     
168     
169     
170     
171     
172     
173    </h4>
174
175     
176 not a number, we activate it if we want to average without considerate some masked values of TAB.
177 If masked values of TAB are values consecrated by IDL(!values.f_nan), wr just have to put NAN.
178 If masked values of TAB are valued a (a must be different of 1, corresponding to nan =
179 !values.f_nan and of 0, which desactivate nan). We have to put NAN=a.
180 Comment: In output, rsult points which are NAN will be valued a or !values.f_nan.
181           
182   
183    <a name="#_grossemoyenne_keyword_NODOMDEF"></a>
184    <h4>NODOMDEF&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
185     
186     
187     
188     
189     
190     
191     
192     
193    </h4>
194
195   
196 We activate it if we do not want to pass in domdef even if the keyword boxzoom
197 is present (like when grossemoyenne is called via checkfield)
198
199   
200    <a name="#_grossemoyenne_keyword_WDEPTH"></a>
201    <h4>WDEPTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
202     
203     
204     
205     
206     
207     
208     
209     
210    </h4>
211
212     
213 to specify that the field is at W depth instead of T
214 depth (automatically activated if vargrid eq 'W')
215
216   
217    <a name="#_grossemoyenne_keyword_SPATIALFIRST"></a>
218    <h4>SPATIALFIRST&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
219     
220     
221     
222     
223     
224     
225     
226     
227    </h4>
228
229     
230 when performing at the same time
231 spatial and temporal mean, grossemoyenne is assuming
232 that the mask is not changing with the time. In
233 consequence, grossemoyenne performs temporal mean
234 first and then call moyenne. Activate /SPATIALFIRST if
235 you want to perform the spatial mean before the
236 temporal mean. Note that if NAN is activated, then
237 SPATIALFIRST is activated automatically.
238
239   
240    <a name="#_grossemoyenne_keyword_TEMPORALFIRST"></a>
241    <h4>TEMPORALFIRST&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
242     
243     
244     
245     
246     
247     
248     
249     
250    </h4>
251
252     
253 to force to perform first temporal
254 mean even if nan is activated (see SPATIALFIRST
255 explanations...)
256
257 
258   
259    <a name="#_grossemoyenne_keyword__extra"></a>
260    <h4>_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
261     
262     
263     
264     
265     
266     
267     
268     
269    </h4>
270
271   
272   
273   
274
275   
276    <h3>Version history</h3>
277   
278    <h4>Version</h4>
279 $Id: grossemoyenne.pro 163 2006-08-29 12:59:46Z navarro $
280    <h4>History</h4> 
281 Jerome Vialard (jv@lodyc.jussieu.fr)
282                        2/7/98
283                       Sebastien Masson (smasson@lodyc.jussieu.fr)
284 adaptation array containing a temporal dimension
285                       14/8/98
286                       15/1/98
287                       12/3/99 adaptation for NAN and utilization of TEMPORARY
288
289   
290
291    <h3>Known issues</h3>
292   
293   
294   
295    <h4>Restrictions</h4> Put values corresponding to land at 1.e20
296
297
298    <h3>Other attributes</h3>
299   
300   
301    <h4>Uses routines</h4>
302 result:un tableau
303 common
304 domdef
305
306   
307   
308   
309
310    <font size="-3"><p>&nbsp;</p></font>
311    <hr size="1" color="#CCCCCC"/>
312     
313
314   
315
316    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Wed Sep 13 16:32:33 2006.</font></p>
317
318  </body>
319</html>
Note: See TracBrowser for help on using the repository browser.