ToBeReviewed/CALCULS/
moyenne.pro
averages a 2- or 3-d field over a selected
geographical area and along one or more
selected axes (x, y or z)
moyenne
result = moyenne(tab, direc, BOXZOOM=BOXZOOM, INTEGRATION=INTEGRATION, NAN=NAN, NODOMDEF=NODOMDEF, WDEPTH=WDEPTH, _EXTRA=_EXTRA)
Return value
An array
Parameters
tab
in
required
2 or 3d field
direc
in
required
'x' 'y' 'z' 'xy' 'xz' 'yz' or 'xyz'
Keywords
BOXZOOM
[xmin,xmax,ymin,ymax (,(zmin,)zmax)] to more details, see domdef
boxzoom can have 5 forms:
[vert2],
[vert1, vert2],
[lon1, lon2, lat1, lat2],
[lon1, lon2, lat1, lat2, vert2],
[lon1, lon2, lat1, lat2, vert1,vert2]
INTEGRATION
To make an integral rather than an average
NAN
not a number, we activate it if we want to average without considerate some masked values of TAB.
If masked values of TAB are values consecrated by IDL(!values.f_nan), we just have to put NAN.
If masked values of TAB are valued a (a must be different of 1, corresponding to nan =
!values.f_nan and of 0, which desactivate nan). We have to put NAN=a.
Comment: In output, result points which are NAN will be valued a or !values.f_nan.
NODOMDEF
We activate it if we do not want to pass in domdef even if the
keyword boxzoom is present (like when grossemoyenne is called
via checkfield)
WDEPTH
to specify that the field is at W depth instead of T
depth (automatically activated if vargrid eq 'W')
_EXTRA
Version history
Version
$Id: moyenne.pro 370 2008-08-07 07:59:15Z pinsard $
History
Jerome Vialard (jv@lodyc.jussieu.fr)
2/7/98
Sebastien Masson (smasson@lodyc.jussieu.fr)
14/8/98
15/1/98
11/3/99 adaptation for NAN
28/7/99 Averages 1d arrays
Known issues
Restrictions
Put values corresponding to land at 1.e20
Other attributes
Uses routines
common
domdef
Produced by IDLdoc 2.0.