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

dim_standardize_Wrap

Calculates standardized anomalies of the rightmost dimension at all other dimensions 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 dim_standardize_Wrap (
		x    : numeric,  
		opt  : integer   
	)

	return_val [dimsizes(x)] :  float or double

Arguments

x

A variable of numeric type and any dimensionality.

opt

Setting opt=1 means to use the population standard deviation (i.e., divide by the number of non-missing values [N]). Otherwise, the sample standard deviation is used for normalization (i.e., divide by [N-1]).

Description

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