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

dim_sum_n_Wrap

Computes the arithmetic sum of a variable's given dimensions at all other dimensions and retains metadata.

Prototype

load "$NCARG_ROOT/lib/ncarg/nclscripts/csm/contributed.ncl"  ; not needed from 6.2.0 onward
                                                           ; contributed.ncl is automatically loaded

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

	return_val  :  float or double

Arguments

x

A variable of numeric type and any dimensionality.

dims

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

Description

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