NCL Website header
NCL Home > Documentation > Functions > General applied math

runave_Wrap

Calculates an unweighted running average on the rightmost dimension and retains metadata.

Prototype

load "$NCARG_ROOT/lib/ncarg/nclscripts/csm/contributed.ncl"  ; This library is automatically loaded
                                                             ; from NCL V6.2.0 onward.
                                                             ; No need for user to explicitly load.

	function runave_Wrap (
		x     : numeric,  
		nave  : integer,  
		opt   : integer   
	)

	return_val [dimsizes(x)] :  float or double

Arguments

x

An array with one or more dimensions. The fastest varying (i.e. rightmost) dimension will be the dimension on which the unweighted running average is performed. Missing values should be indicated by x@_FillValue. If x@_FillValue is not set, then the NCL default (appropriate to the type of x) will be assumed.

nave

Number of points to be included in the running average.

opt

End-point option (opt = 0 is the most common option)

See runave for a detailed description on opt.

Description

This function is identical to runave, except the return value will have metadata added based on metadata attached to x. See the runave page for full documentation and examples.