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

Last change on this file was 402, checked in by smasson, 15 years ago

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