<<prev file | next file >>    view single page | view frames    summary: fields | routine    details: routine

ToBeReviewed/CALCULS/

grossemoyenne.pro

averages a 3- or 4-d time series field over a selected geographical area or along the time axis. For one or more selected axes (x, y, z, t)

topgrossemoyenne

result = grossemoyenne(tab, direc, BOXZOOM=BOXZOOM, INTEGRATION=INTEGRATION, NAN=NAN, NODOMDEF=NODOMDEF, WDEPTH=WDEPTH, SPATIALFIRST=SPATIALFIRST, TEMPORALFIRST=TEMPORALFIRST, _EXTRA=_EXTRA)

Return value

an array

Parameters

tab        in required

3d or 4d field

direc        in required

'x' 'y' 'z' 't' 'xy' 'xz' 'yz' 'xyz' 'xt' 'yt' 'zt' 'xyt' 'xzt' 'yzt' or 'xyzt'

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')

SPATIALFIRST       

when performing at the same time spatial and temporal mean, grossemoyenne is assuming that the mask is not changing with the time. In consequence, grossemoyenne performs temporal mean first and then call moyenne. Activate /SPATIALFIRST if you want to perform the spatial mean before the temporal mean. Note that if NAN is activated, then SPATIALFIRST is activated automatically.

TEMPORALFIRST       

to force to perform first temporal mean even if NAN is activated (see SPATIALFIRST explanations...)

_EXTRA       

Version history

Version

$Id: grossemoyenne.pro 378 2008-08-12 12:35:46Z pinsard $

History

Jerome Vialard (jv@lodyc.jussieu.fr) 2/7/98 Sebastien Masson (smasson@lodyc.jussieu.fr) adaptation array containing a temporal dimension 14/8/98 15/1/98 12/3/99 adaptation for NAN and utilization of TEMPORARY

Known issues

Restrictions

Put values corresponding to land at 1.e20

Other attributes

Uses routines

common domdef

Statistics

McCabe cyclic 140
McCabe essential 1
McCabe modular design 1
Produced by IDLdoc 2.0.