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

eofunc_ts_Wrap

Calculates the time series of the amplitudes associated with each eigenvalue in an EOF 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_ts_Wrap (
		data    : numeric,  
		evec    : numeric,  
		optETS  : logical   
	)

	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.

If your rightmost dimension is not time, then see eofunc_ts_n_Wrap.

evec

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

optETS

A logical variable to which various optional arguments may be assigned as attributes. These optional arguments alter the default behavior of the function. Must be set to True prior to setting the attributes which are assigned using the @ operator:

  • jopt - integer (default is 0)

    optETS      = True
    optETS@jopt = 1
    
    optETS@jopt = 1: Use the standardized data matrix to compute the time series. The default is to use data and evec.

Description

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