source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/CALCULS/grossemoyenne.html @ 402

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

update documentation
File size: 8.9 KB
Line 
1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<!-- Generated by IDLdoc 2.0 -->
6
7<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8  <head>
9    <title>grossemoyenne.pro (SAXO Documentation)</title>
10
11   
12    <link rel="stylesheet" type="text/css" media="all" href="./../../main_files.css" />
13    <link rel="stylesheet" type="text/css" media="print" href="./../../main_files_print.css" />
14   
15
16    <script type="text/javascript">
17      function setTitle() {
18        parent.document.title="grossemoyenne.pro (SAXO Documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>SAXO Documentation</h1>
27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
35      <td><a href="./../../overview.html" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../../idldoc-categories.html" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../../search-page.html" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td><a href="../../../../ToBeReviewed/CALCULS//grossemoyenne.pro" title="Source code of a file">Source</a></td>
58     
59
60     
61      <td><a href="./../../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
62     
63
64      <td >Etc</td>
65
66      <td id="flexible">Developer&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="fsfzpt.html">&lt;&lt;prev file</a> | <a href="hdyn.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="grossemoyenne.html" target="_TOP">view single page</a> | <a href="./../../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html">ToBeReviewed/CALCULS/</a></h1>
82      <h2 class="pro_file">grossemoyenne.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 averages a 3- or 4-d time series field over a selected
91 geographical area or along the time axis. For one or more
92 selected axes (x, y, z, t)
93</div>
94
95     
96
97     
98
99     
100
101     
102
103      <div id="routine_details">
104       
105
106        <div class="routine_details" id="_grossemoyenne">
107
108          <h2><a class="top" href="#container">top</a>grossemoyenne <span class="categories">
109</span></h2>
110       
111          <p class="header">
112            <span class="result">result = </span>grossemoyenne(<span class="result"><a href="#_grossemoyenne_param_tab">tab</a>, <a href="#_grossemoyenne_param_direc">direc</a></span>, <a href="#_grossemoyenne_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">BOXZOOM</span>, <a href="#_grossemoyenne_keyword_INTEGRATION">INTEGRATION</a>=<span class="result">INTEGRATION</span>, <a href="#_grossemoyenne_keyword_NAN">NAN</a>=<span class="result">NAN</span>, <a href="#_grossemoyenne_keyword_NODOMDEF">NODOMDEF</a>=<span class="result">NODOMDEF</span>, <a href="#_grossemoyenne_keyword_WDEPTH">WDEPTH</a>=<span class="result">WDEPTH</span>, <a href="#_grossemoyenne_keyword_SPATIALFIRST">SPATIALFIRST</a>=<span class="result">SPATIALFIRST</span>, <a href="#_grossemoyenne_keyword_TEMPORALFIRST">TEMPORALFIRST</a>=<span class="result">TEMPORALFIRST</span>, <a href="#_grossemoyenne_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p>
113       
114          <div class="comments">
115</div>
116
117          <h3>Return value</h3><div class="preformat">
118 an array
119</div>
120
121         
122            <h3>Parameters</h3>
123       
124           
125            <h4 id="_grossemoyenne_param_tab">tab&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
126              <span class="attr">in</span>
127             
128             
129              <span class="attr">required</span>
130             
131             
132             
133             
134            </h4>
135       
136          <div class="comments">
137 3d or 4d field
138</div>
139           
140            <h4 id="_grossemoyenne_param_direc">direc&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
141              <span class="attr">in</span>
142             
143             
144              <span class="attr">required</span>
145             
146             
147             
148             
149            </h4>
150       
151          <div class="comments">
152 'x' 'y' 'z' 't' 'xy' 'xz' 'yz' 'xyz' 'xt' 'yt' 'zt'
153 'xyt' 'xzt' 'yzt' or 'xyzt'
154</div>
155           
156
157         
158
159         
160
161            <h3>Keywords</h3>
162           
163            <h4 id="_grossemoyenne_keyword_BOXZOOM">BOXZOOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
164             
165             
166             
167             
168             
169             
170             
171             
172            </h4>
173       
174            <div class="comments">
175 [xmin,xmax,ymin,ymax (,(zmin,)zmax)] to more details, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a>
176 boxzoom can have 5 forms :
177 [vert2], [vert1, vert2],[lon1, lon2, lat1, lat2],
178 [lon1, lon2, lat1, lat2, vert2],[lon1, lon2, lat1, lat2, vert1,vert2]
179</div>
180           
181            <h4 id="_grossemoyenne_keyword_INTEGRATION">INTEGRATION&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
182             
183             
184             
185             
186             
187             
188             
189             
190            </h4>
191       
192            <div class="comments">
193 To make an integral rather than an average
194</div>
195           
196            <h4 id="_grossemoyenne_keyword_NAN">NAN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
197             
198             
199             
200             
201             
202             
203             
204             
205            </h4>
206       
207            <div class="comments">
208 not a number, we activate it if we want to average without considerate some
209 masked values of TAB.
210 If masked values of TAB are values consecrated by IDL(!values.f_nan), we
211 just have to put NAN.
212 If masked values of TAB are valued a (a must be different of 1,
213 corresponding to nan = !values.f_nan and of 0, which desactivate nan).
214 We have to put NAN=a.
215 Comment: In output, result points which are NAN will be valued a or
216 !values.f_nan.
217</div>
218           
219            <h4 id="_grossemoyenne_keyword_NODOMDEF">NODOMDEF&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
220             
221             
222             
223             
224             
225             
226             
227             
228            </h4>
229       
230            <div class="comments">
231 We activate it if we do not want to pass in <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> even if the
232 keyword boxzoom is present (like when <a href="../..//ToBeReviewed/CALCULS/grossemoyenne.html">grossemoyenne</a> is called via
233 <a href="../..//ToBeReviewed/PLOTS/DIVERS/checkfield.html">checkfield</a>)
234</div>
235           
236            <h4 id="_grossemoyenne_keyword_WDEPTH">WDEPTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
237             
238             
239             
240             
241             
242             
243             
244             
245            </h4>
246       
247            <div class="comments">
248 to specify that the field is at W depth instead of T
249 depth (automatically activated if vargrid eq 'W')
250</div>
251           
252            <h4 id="_grossemoyenne_keyword_SPATIALFIRST">SPATIALFIRST&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
253             
254             
255             
256             
257             
258             
259             
260             
261            </h4>
262       
263            <div class="comments">
264 when performing at the same time
265 spatial and temporal mean, grossemoyenne is assuming
266 that the mask is not changing with the time. In
267 consequence, grossemoyenne performs temporal mean
268 first and then call moyenne. Activate /SPATIALFIRST if
269 you want to perform the spatial mean before the
270 temporal mean. Note that if NAN is activated, then
271 SPATIALFIRST is activated automatically.
272</div>
273           
274            <h4 id="_grossemoyenne_keyword_TEMPORALFIRST">TEMPORALFIRST&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
275             
276             
277             
278             
279             
280             
281             
282             
283            </h4>
284       
285            <div class="comments">
286 to force to perform first temporal
287 mean even if NAN is activated (see SPATIALFIRST explanations...)
288</div>
289           
290            <h4 id="_grossemoyenne_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
291             
292             
293             
294             
295             
296             
297             
298             
299            </h4>
300       
301            <div class="comments"></div>
302           
303         
304
305         
306          <h3>Version history</h3>
307         
308          <h4>Version</h4><div class="preformat">
309 $Id: grossemoyenne.pro 378 2008-08-12 12:35:46Z pinsard $
310</div>
311          <h4>History</h4><div class="preformat">
312 Jerome Vialard (jv@lodyc.jussieu.fr)
313                        2/7/98
314                       Sebastien Masson (smasson@lodyc.jussieu.fr)
315 adaptation array containing a temporal dimension
316                       14/8/98
317                       15/1/98
318                       12/3/99 adaptation for NAN and utilization of TEMPORARY
319</div>
320         
321         
322          <h3>Known issues</h3>
323         
324         
325         
326          <h4>Restrictions</h4><div class="preformat">
327 Put values corresponding to land at 1.e20
328</div>
329       
330          <h3>Other attributes</h3>
331         
332         
333          <h4>Uses routines</h4><div class="preformat">
334 <a href="../..//Obsolete/common.html">common</a>
335 <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a>
336</div>
337         
338         
339         
340       
341          <h3>Statistics</h3>
342          <table class="statistics">
343            <tr><td>McCabe cyclic</td><td>         140</td></tr>
344            <tr><td>McCabe essential</td><td>           1</td></tr>
345            <tr><td>McCabe modular design</td><td>           1</td></tr>
346          </table>
347         
348       
349        </div>
350       
351      </div>
352
353     
354
355      <div id="tagline">Produced by IDLdoc 2.0.</div>
356
357    </div>
358
359  </body>
360</html>
Note: See TracBrowser for help on using the repository browser.