Context Navigation

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

Note: See TracBrowser for help on using the repository browser.

Download in other formats: