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

dim_rmvmean_n_Wrap

Calculates and removes the mean 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_rmvmean_n_Wrap (
		x        : numeric,  
		dims [*] : integer   
	)

	return_val [dimsizes(x)] :  float or double

Arguments

x

A variable of numeric type and any dimensionality.

dims

The dimension(s) of x on which to calculate and remove the mean. Must be consecutive and monotonically increasing.

Description

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