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.

Available in version 5.1.1 and later.

Prototype

load "$NCARG_ROOT/lib/ncarg/nclscripts/csm/contributed.ncl"

	function dim_rmvmean_n_Wrap (
		x        : numeric,  
		dims [*] : integer   
	)

	return_val [dimsizes(x)] :  float or double

Arguments

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.

Return value

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

The dimensionality is the same as the input dimensionality.

Description

The dim_rmvmean_n_Wrap function calculates and removes the mean from all elements of the dimensions indicated by dims for each index of the remaining dimensions and retains metadata. A wrapper function. Missing values are ignored.

Examples

Example 1:

Let x be a 1-dimensional array: (a) Create a new variable, xNew, that contains just the deviations from the mean; (b) replace the variable x with the deviations.

  xNew = dim_rmvmean_n_Wrap(x,0)      ; new variable
  x    = dim_rmvmean_n_Wrap(x,0)      ; overwrite with deviations

Example 2:

Let x be a 3-dimensional array with dimension sizes (ntim, nlat, nlon). To remove the means of the "nlon" dimension:

   xRmvLon = dim_rmvmean_n (x,2)         ; new variable containing deviations (no metadata)
   xRmvLon = dim_rmvmean_n_Wrap(x,2)     ; with metadata
   x       = dim_rmvmean_n (x,2)         ; overwrite with deviations

Note: when operating across the rightmost dimension, it is simpler to use dim_rmvmean_Wrap.

Example 3:

Let x be a 3-dimensional array with named dimensions (time, lat, lon) and dimension sizes (ntim, nlat, nlon). Remove the mean of the time dimension from all lat/lon indices:

   xRmvTime = dim_rmvmean_n(x,0)
   xRmvTime = dim_rmvmean_n_Wrap(x,0)

Example 4:

Let x be a 3-dimensional array with named dimensions (time, level, lat, lon) and dimension sizes (ntim, nlev, nlat, nlon). Remove the mean of the lat/lon dimension at all time/lev indices:

   xRmv = dim_rmvmean_n(x,(/2,3/)/)
   xRmv = dim_rmvmean_n_Wrap(x,(/2,3/))

Example 5:

Let x be as in Example 3 and let x contain monthly means for (say) 10 years of data (ntim=120). Monthly anomalies for each month could be calculated using array subscripting: