NCL Home >
Documentation >
Functions >
General applied math,
Statistics
dim_standardize_n_Wrap
Calculates standardized anomalies of the given dimensions 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_n_Wrap (
x : numeric,
opt : integer,
dims [*] : integer
)
return_val [dimsizes(x)] : float or double
Arguments
xA variable of numeric type and any dimensionality.
optSetting 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]).
dimsThe dimension(s) of x on which to calculate the standardized anomalies. Must be consecutive and monotonically increasing.
Description
This function is identical to dim_standardize_n, except the return value will have metadata added based on metadata attached to x. See the dim_standardize_n page for full documentation and examples.