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

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

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