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

runave_n_Wrap

Calculates an unweighted running average on the given 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_n_Wrap (
		x       : numeric,  
		nave    : integer,  
		opt     : integer,  
		dim [1] : integer   
	)

	return_val [dimsizes(x)] :  float or double

Arguments

x

An array with one or more dimensions. The dim-th dimension 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_n for a detailed description on opt.

dim

A scalar integer indicating which dimension of x to do the calculation on. Dimension numbering starts at 0.

Description

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