source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/CALCULS/moyenne.html

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

update documentation
File size: 7.6 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>moyenne.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="moyenne.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//moyenne.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="level2mask.html">&lt;&lt;prev file</a> | <a href="projectondepth.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="moyenne.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">moyenne.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 averages a 2- or 3-d field over a selected
91           geographical area and along one or more
92            selected axes (x, y or z)
93</div>
94
95     
96
97     
98
99     
100
101     
102
103      <div id="routine_details">
104       
105
106        <div class="routine_details" id="_moyenne">
107
108          <h2><a class="top" href="#container">top</a>moyenne <span class="categories">
109</span></h2>
110       
111          <p class="header">
112            <span class="result">result = </span>moyenne(<span class="result"><a href="#_moyenne_param_tab">tab</a>, <a href="#_moyenne_param_direc">direc</a></span>, <a href="#_moyenne_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">BOXZOOM</span>, <a href="#_moyenne_keyword_INTEGRATION">INTEGRATION</a>=<span class="result">INTEGRATION</span>, <a href="#_moyenne_keyword_NAN">NAN</a>=<span class="result">NAN</span>, <a href="#_moyenne_keyword_NODOMDEF">NODOMDEF</a>=<span class="result">NODOMDEF</span>, <a href="#_moyenne_keyword_WDEPTH">WDEPTH</a>=<span class="result">WDEPTH</span>, <a href="#_moyenne_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="_moyenne_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 2 or 3d field
138</div>
139           
140            <h4 id="_moyenne_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' 'xy' 'xz' 'yz' or 'xyz'
153</div>
154           
155
156         
157
158         
159
160            <h3>Keywords</h3>
161           
162            <h4 id="_moyenne_keyword_BOXZOOM">BOXZOOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
163             
164             
165             
166             
167             
168             
169             
170             
171            </h4>
172       
173            <div class="comments">
174 [xmin,xmax,ymin,ymax (,(zmin,)zmax)] to more details, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a>
175 boxzoom can have 5 forms:
176  [vert2],
177  [vert1, vert2],
178  [lon1, lon2, lat1, lat2],
179  [lon1, lon2, lat1, lat2, vert2],
180  [lon1, lon2, lat1, lat2, vert1,vert2]
181</div>
182           
183            <h4 id="_moyenne_keyword_INTEGRATION">INTEGRATION&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
184             
185             
186             
187             
188             
189             
190             
191             
192            </h4>
193       
194            <div class="comments">
195 To make an integral rather than an average
196</div>
197           
198            <h4 id="_moyenne_keyword_NAN">NAN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
199             
200             
201             
202             
203             
204             
205             
206             
207            </h4>
208       
209            <div class="comments">
210 not a number, we activate it if we want to average without considerate some masked values of TAB.
211 If masked values of TAB are values consecrated by IDL(!values.f_nan), we just have to put NAN.
212 If masked values of TAB are valued a (a must be different of 1, corresponding to nan =
213 !values.f_nan and of 0, which desactivate nan). We have to put NAN=a.
214 Comment: In output, result points which are NAN will be valued a or !values.f_nan.
215</div>
216           
217            <h4 id="_moyenne_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
231 via <a href="../..//ToBeReviewed/PLOTS/DIVERS/checkfield.html">checkfield</a>)
232</div>
233           
234            <h4 id="_moyenne_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="_moyenne_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
251             
252             
253             
254             
255             
256             
257             
258             
259            </h4>
260       
261            <div class="comments"></div>
262           
263         
264
265         
266          <h3>Version history</h3>
267         
268          <h4>Version</h4><div class="preformat">
269 $Id: moyenne.pro 370 2008-08-07 07:59:15Z pinsard $
270</div>
271          <h4>History</h4><div class="preformat">
272  Jerome Vialard (jv@lodyc.jussieu.fr)
273                        2/7/98
274                       Sebastien Masson (smasson@lodyc.jussieu.fr)
275                       14/8/98
276                       15/1/98
277                       11/3/99 adaptation for NAN
278                       28/7/99 Averages 1d arrays
279</div>
280         
281         
282          <h3>Known issues</h3>
283         
284         
285         
286          <h4>Restrictions</h4><div class="preformat">
287 Put values corresponding to land at 1.e20
288</div>
289       
290          <h3>Other attributes</h3>
291         
292         
293          <h4>Uses routines</h4><div class="preformat">
294 <a href="../..//Obsolete/common.html">common</a>
295 <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a>
296</div>
297         
298         
299         
300       
301          <h3>Statistics</h3>
302          <table class="statistics">
303            <tr><td>McCabe cyclic</td><td>         160</td></tr>
304            <tr><td>McCabe essential</td><td>           1</td></tr>
305            <tr><td>McCabe modular design</td><td>           1</td></tr>
306          </table>
307         
308       
309        </div>
310       
311      </div>
312
313     
314
315      <div id="tagline">Produced by IDLdoc 2.0.</div>
316
317    </div>
318
319  </body>
320</html>
Note: See TracBrowser for help on using the repository browser.