Context Navigation

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

Last change on this file since 321 was 321, checked in by smasson, 17 years ago
update documentation
File size: 7.5 KB

Rev	Line
[89]	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>
[104]	9	<title>moyenne.pro (SAXO Documentation)</title>
[89]	10
	11
[191]	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" />
[89]	14
	15
	16	<script type="text/javascript">
	17	function setTitle() {
[104]	18	parent.document.title="moyenne.pro (SAXO Documentation)";
[89]	19	}
	20	</script>
	21	</head>
	22
	23	<body onload="setTitle();">
	24
	25	<div id="navbar_title">
[104]	26	<h1>SAXO Documentation</h1>
[89]	27	</div>
	28
	29
	30	<div id="main_navbar">
	31
	32	<table cellspacing="0">
	33	<tr>
	34
[189]	35	<td><a href="./../../overview.html" title="Overview of library">Overview</a></td>
[89]	36
	37
	38
	39	<td >Directory</td>
	40
	41
	42
[189]	43	<td><a href="./../../idldoc-categories.html" title="Browse library by category">Categories</a></td>
[89]	44
	45
	46
[189]	47	<td><a href="./../../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
[89]	48
	49
	50
[189]	51	<td><a href="./../../search-page.html" title="Search library">Search</a></td>
[89]	52
	53
	54	<td id="selected">File</td>
	55
	56
[189]	57	<td><a href="../../../../ToBeReviewed/CALCULS//moyenne.pro" title="Source code of a file">Source</a></td>
[89]	58
	59
	60
[189]	61	<td><a href="./../../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
[89]	62
	63
	64	<td >Etc</td>
	65
	66	<td id="flexible">Developer documentation</td>
	67	</tr>
	68	</table>
	69
	70	</div>
	71
	72	<div id="secondary_navbar">
	73
[321]	74	<a href="level2mask.html"><<prev file</a> \| <a href="projectondepth.html">next file >></a>    <a href="moyenne.html" target="_TOP">view single page</a> \| <a href="./../../index.html" target="_TOP">view frames</a>    summary: fields \| routine    details: <a href="#routine_details">routine</a>
[89]	75
	76	</div>
	77
	78
	79	<div id="container">
	80
[189]	81	<h1 class="directory"><a href="directory-overview.html">ToBeReviewed/CALCULS/</a></h1>
[89]	82	<h2 class="pro_file">moyenne.pro</h2>
	83
	84	<div id="file_attr">
	85	<dl>
	86	</dl>
	87	</div>
	88
[234]	89	<div id="file_comments">
[142]	90	averages a 2- or 3-d field over a selected
[290]	91	geographical area and along one or more
[142]	92	selected axes (x, y or z)
	93	</div>
[89]	94
	95
	96
	97
	98
	99
	100
	101
	102
	103	<div id="routine_details">
	104
	105
	106	<div class="routine_details" id="_moyenne">
	107
[142]	108	<h2><a class="top" href="#container">top</a>moyenne <span class="categories">
	109	</span></h2>
[89]	110
	111	<p class="header">
[234]	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>
[89]	113
	114	<div class="comments">
[142]	115	</div>
[89]	116
[142]	117	<h3>Return value</h3><div class="preformat">
[234]	118	An array
[89]	119	</div>
	120
	121
	122	<h3>Parameters</h3>
	123
	124
	125	<h4 id="_moyenne_param_tab">tab
[142]	126	<span class="attr">in</span>
[89]	127
	128
[142]	129	<span class="attr">required</span>
[89]	130
	131
	132
	133
	134	</h4>
	135
[142]	136	<div class="comments">
	137	2 or 3d field
	138	</div>
[89]	139
	140	<h4 id="_moyenne_param_direc">direc
[142]	141	<span class="attr">in</span>
[89]	142
	143
[142]	144	<span class="attr">required</span>
[89]	145
	146
	147
	148
	149	</h4>
	150
[142]	151	<div class="comments">
	152	'x' 'y' 'z' 'xy' 'xz' 'yz' or 'xyz'
	153	</div>
[89]	154
	155
	156
	157
	158
	159
	160	<h3>Keywords</h3>
	161
	162	<h4 id="_moyenne_keyword_BOXZOOM">BOXZOOM
	163
	164
	165
	166
	167
	168
	169
	170
	171	</h4>
	172
[234]	173	<div class="comments">
[290]	174	[xmin,xmax,ymin,ymax (,(zmin,)zmax)] to more details, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a>
[234]	175	boxzoom can have 5 forms:
[163]	176	[vert2],
	177	[vert1, vert2],
[234]	178	[lon1, lon2, lat1, lat2],
[163]	179	[lon1, lon2, lat1, lat2, vert2],
	180	[lon1, lon2, lat1, lat2, vert1,vert2]
[142]	181	</div>
[89]	182
	183	<h4 id="_moyenne_keyword_INTEGRATION">INTEGRATION
	184
	185
	186
	187
	188
	189
	190
	191
	192	</h4>
	193
[234]	194	<div class="comments">
[142]	195	To make an integral rather than an average
[234]	196	</div>
[89]	197
	198	<h4 id="_moyenne_keyword_NAN">NAN
	199
	200
	201
	202
	203
	204
	205
	206
	207	</h4>
	208
[234]	209	<div class="comments">
[142]	210	not a number, we activate it if we want to average without considerate some masked values of TAB.
[163]	211	If masked values of TAB are values consecrated by IDL(!values.f_nan), we just have to put NAN.
[142]	212	If masked values of TAB are valued a (a must be different of 1, corresponding to nan =
[234]	213	!values.f_nan and of 0, which desactivate nan). We have to put NAN=a.
[163]	214	Comment: In output, result points which are NAN will be valued a or !values.f_nan.
[234]	215	</div>
[89]	216
	217	<h4 id="_moyenne_keyword_NODOMDEF">NODOMDEF
	218
	219
	220
	221
	222
	223
	224
	225
	226	</h4>
	227
[142]	228	<div class="comments">
[242]	229	We activate it if we do not want to pass in <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> even if the
[290]	230	keyword boxzoom is present (like when <a href="../..//ToBeReviewed/CALCULS/grossemoyenne.html">grossemoyenne</a> is called
[242]	231	via <a href="../..//ToBeReviewed/PLOTS/DIVERS/checkfield.html">checkfield</a>)
[142]	232	</div>
[89]	233
	234	<h4 id="_moyenne_keyword_WDEPTH">WDEPTH
	235
	236
	237
	238
	239
	240
	241
	242
	243	</h4>
	244
[234]	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>
[89]	249
[234]	250	<h4 id="_moyenne_keyword__EXTRA">_EXTRA
[89]	251
	252
	253
	254
	255
	256
	257
	258
	259	</h4>
	260
	261	<div class="comments"></div>
	262
	263
	264
	265
[142]	266	<h3>Version history</h3>
[89]	267
[142]	268	<h4>Version</h4><div class="preformat">
[290]	269	$Id: moyenne.pro 268 2007-08-24 14:07:01Z pinsard $
[142]	270	</div>
[157]	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>
[89]	280
	281
[142]	282	<h3>Known issues</h3>
[89]	283
	284
	285
[234]	286	<h4>Restrictions</h4><div class="preformat">
	287	Put values corresponding to land at 1.e20
[142]	288	</div>
[89]	289
[142]	290	<h3>Other attributes</h3>
[89]	291
	292
[142]	293	<h4>Uses routines</h4><div class="preformat">
	294	common
[290]	295	<a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a>
[142]	296	</div>
[89]	297
	298
	299
	300
[163]	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>
[89]	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>
[249]	320	</html>

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

Download in other formats: