source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/CALCULS/moyenne.html @ 234

Last change on this file since 234 was 234, checked in by pinsard, 17 years ago

new idldoc html and assistant outputs
File size: 5.7 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>moyenne.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="level2mask.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="norme.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>moyenne.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 averages a 2- or 3-d field over a selected
65           geographical area and along one ore more
66            selected axes (x, y or z)
67
68
69   
70
71     
72      <a name="#_moyenne"></a>
73
74      <h2>moyenne  <font size="-1" color="#006633">
75</font></h2>
76
77      <p><font face="Courier"><i>result = </i>moyenne(<i><a href="#_moyenne_keyword_tab">tab</a>, <a href="#_moyenne_keyword_direc">direc</a></i>, <a href="#_moyenne_keyword_BOXZOOM">BOXZOOM</a>=<i>BOXZOOM</i>, <a href="#_moyenne_keyword_INTEGRATION">INTEGRATION</a>=<i>INTEGRATION</i>, <a href="#_moyenne_keyword_NAN">NAN</a>=<i>NAN</i>, <a href="#_moyenne_keyword_NODOMDEF">NODOMDEF</a>=<i>NODOMDEF</i>, <a href="#_moyenne_keyword_WDEPTH">WDEPTH</a>=<i>WDEPTH</i>, <a href="#_moyenne_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="#_moyenne_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 2 or 3d field
104
105   
106
107    <a name="#_moyenne_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' 'xy' 'xz' 'yz' or 'xyz'
121
122   
123   
124
125   
126    <h3>Keywords</h3>
127
128   
129    <a name="#_moyenne_keyword_BOXZOOM"></a>
130    <h4>BOXZOOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
131     
132     
133     
134     
135     
136     
137     
138     
139    </h4>
140
141   
142 [xmin,xmax,ymin,ymax (,(zmin,)zmax)] to more details, see domdef
143 boxzoom can have 5 forms:
144  [vert2],
145  [vert1, vert2],
146  [lon1, lon2, lat1, lat2],
147  [lon1, lon2, lat1, lat2, vert2],
148  [lon1, lon2, lat1, lat2, vert1,vert2]
149
150   
151    <a name="#_moyenne_keyword_INTEGRATION"></a>
152    <h4>INTEGRATION&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
153     
154     
155     
156     
157     
158     
159     
160     
161    </h4>
162
163   
164 To make an integral rather than an average
165
166   
167    <a name="#_moyenne_keyword_NAN"></a>
168    <h4>NAN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
169     
170     
171     
172     
173     
174     
175     
176     
177    </h4>
178
179   
180 not a number, we activate it if we want to average without considerate some masked values of TAB.
181 If masked values of TAB are values consecrated by IDL(!values.f_nan), we just have to put NAN.
182 If masked values of TAB are valued a (a must be different of 1, corresponding to nan =
183 !values.f_nan and of 0, which desactivate nan). We have to put NAN=a.
184 Comment: In output, result points which are NAN will be valued a or !values.f_nan.
185
186   
187    <a name="#_moyenne_keyword_NODOMDEF"></a>
188    <h4>NODOMDEF&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
189     
190     
191     
192     
193     
194     
195     
196     
197    </h4>
198
199   
200 We activate it if we do not want to pass in domdef even if the keyword boxzoom
201 is present (like when grossemoyenne is called via checkfield)
202
203   
204    <a name="#_moyenne_keyword_WDEPTH"></a>
205    <h4>WDEPTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
206     
207     
208     
209     
210     
211     
212     
213     
214    </h4>
215
216   
217 to specify that the field is at W depth instead of T
218 depth (automatically activated if vargrid eq 'W')
219
220   
221    <a name="#_moyenne_keyword__EXTRA"></a>
222    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
223     
224     
225     
226     
227     
228     
229     
230     
231    </h4>
232
233   
234   
235   
236
237   
238    </pre><h3>Version history</h3>
239   
240    <h4>Version</h4>
241 $Id: moyenne.pro 232 2007-03-20 16:59:36Z pinsard $
242
243    <h4>History</h4>
244  Jerome Vialard (jv@lodyc.jussieu.fr)
245                        2/7/98
246                       Sebastien Masson (smasson@lodyc.jussieu.fr)
247                       14/8/98
248                       15/1/98
249                       11/3/99 adaptation for NAN
250                       28/7/99 Averages 1d arrays
251
252   
253
254    <h3>Known issues</h3>
255   
256   
257   
258    <h4>Restrictions</h4>
259 Put values corresponding to land at 1.e20
260
261
262    <h3>Other attributes</h3>
263   
264   
265    <h4>Uses routines</h4>
266 common
267 domdef
268
269   
270   
271   
272
273    <font size="-3"><p>&nbsp;</p></font>
274    <hr size="1" color="#CCCCCC"/>
275     
276
277   
278
279    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
280
281  </body>
282</html>
Note: See TracBrowser for help on using the repository browser.