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

eofunc_varimax_Wrap

Rotates EOFs using the using Kaiser row normalization and the varimax criterion 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 eofunc_varimax_Wrap (
		evec    : numeric,  
		optEVX  : integer   
	)

	return_val [dimsizes(evec)] :  numeric

Arguments

evec

A multi-dimensional array containing the EOFs calculated using eofunc.

optEVX

An integer which specifies options.

  1. 0 => do nothing; use the normalized eigenvectors directly.
  2. 1 => scale the normalized eigenvectors by the square root of the associated eigenvalue and return normalized eigenvectors.
  3. -1 => same as optEVX=1 but returns the scaled rotated eigenvectors.
The most common options are optEVX=1 and -1.

For versions through 4.2.0.a034, the optEVX argument had been of type logical. For backward compatibility, NCL will continue to accept the logical argument. If used, optEVX=False with default to 0 and optEVX=False with default to 1.

Description

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