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

wgt_arearmse

Calculates a weighted area root-mean-square-difference between two variables.

Prototype

	function wgt_arearmse (
		q        : numeric,  
		r        : numeric,  
		wgty [*] : numeric,  
		wgtx [*] : numeric,  
		opt      : integer   
	)

	return_val  :  float or double

Arguments

q

An array of 2 or more dimensions containing the data to be differenced. 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).

r

An array of 2 or more dimensions containing the data to be differenced. 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).

wgty

A scalar (typically 1.0) or 1-dimensional array of size "lat" (y) containing the weights. A scalar value of 1.0 means no weighting.

wgtx

A scalar (typically 1.0) or 1-dimensional array of size "lon" (x) containing the weights. A scalar value of 1.0 means no weighting.

opt

If opt = 0, the area root-mean-square-difference is calculated using available non-missing data. If opt = 1, then if any point in q or r is missing, the area root-mean-square-difference 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.

Return value

Returns an array of the same dimensionality as the leftmost dimensions of q.

The return type is float if the input is float, and double if the input is of type double.

Description

This function computes the area root-mean-square-difference [rmse] between two variables using weights.

See Also

wgt_areaave, wgt_areaave2, wgt_arearmse2, wgt_areasum2, wgt_runave, wgt_volave, wgt_volave_ccm, wgt_volrmse, wgt_volrmse_ccm

Examples

Example 1

Let q and r be (time, lev, lat, lon) global arrays with dimension sizes ktime = 120, nlev = 28, nlat = 64, mlon = 128; wgty(nlat) be a 1D array containing gaussian or cosine weights; assume that no special weighting is applied in the longitude (x) direction. Then:

   glRmse = wgt_arearmse(q,r, wgty, 1.0, 0)   ; glRmse(ktime, nlev)
will calculate the area (global) rmse for each time and level. "glRmse" will be a 2D array with dimensions (ktime, nlev) [= (120, 28)]. If a missing value is encountered at any of the two rightmost dimensions of q or r it is ignored (equivalent to a weight of 0.0) and the average is calculated using available non-missing data (opt = 1).

Example 2

   nhRmse = wgt_arearmse (q(:, :, 33:nlat - 1, :), r(:, :, 33:nlat - 1, :), \
                          wgty(33:nlat), 1.0, 1) 
will calculate the area (northern hemisphere ) rmse for each time and level. Standard subscripting is used to subset the input global array. nhRmse will be a 2D array with dimensions (ktime, nlev) [ = (120, 28)]. If a missing value is encountered at any of the two rightmost dimensions of q or r then the result will be set to _FillValue (opt = 0) for that particular time and level.

Example 3

   shRmse = wgt_arearmse(q(:, 5:7, {lat | -90:0}, :), r(:, 5:7, {lat | -90:0}, :), \
                          wgty({lat | -90:0}), 1.0,0) 
will calculate the area (southern hemisphere) rmse for each time and only at levels 5, 6, 7. Named subscripting and standard subscripting are used to subset the input global array. shRmse will have dimensions (ktime).