wgt_areaave_Wrap

Calculates the area average of a quantity using weights 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 wgt_areaave_Wrap (
		q        : numeric,  
		wgty [*] : numeric,  
		wgtx [*] : numeric,  
		opt      : integer   
	)

	return_val  :  float or double

Arguments

An array of 2 or more dimensions containing the data to be averaged. The rightmost dimensions should correspond to "latitude" (lat) and "longitude" (lon) when dealing with quantities on a sphere ([...,],lat,lon), and "y" and "x" otherwise ([...,],y,x).

A scalar (typically 1.0) or singly dimensioned array of size "lat" (y) containing the weights.

A scalar (typically 1.0) or singly dimensioned array of size "lon" (x) containing the weights.

If opt = 0, the area average is calculated using available non-missing data. If opt = 1, then if any point in q is missing, the area average is not computed. In this case, it will be set to the missing value, which is indicated by q@_FillValue, or the default missing value if q@_FillValue is not set.

Description

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