NCL Website header
NCL Home > Documentation > Functions > Empirical orthogonal functions

eofcov_Wrap

Calculates empirical orthogonal functions and retains metadata. (NCL's original EOF function).

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 eofcov_Wrap (
		data   : numeric,  
		neval  : integer   
	)

	return_val  :  numeric

Arguments

data

A multi-dimensional array in which the rightmost dimension is the number of observations. Generally, this is the time dimension.

neval

A scalar integer that specifies the number of eigenvalues and eigenvectors to be returned. This is usually less than or equal to the minimum number of observations or number of variables, and is typically 3 to 5.

Description

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