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

eofunc_ts_n_Wrap

Calculates the time series of the amplitudes associated with each eigenvalue in an EOF, given an index that specifies the time dimension, and retains metadata.

Available in version 6.4.0 and later.

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_n_Wrap (
		data    : numeric,  
		evec    : numeric,  
		optETS  : logical,  
		dim [1] : integer   
	)

	return_val  :  numeric

Arguments

data

A multi-dimensional array in which the dim index specifies the dimension that contains the number of observations. Generally, this is the time dimension.

evec

A multi-dimensional array containing the EOFs calculated using eofunc_n or eofunc_n_Wrap.

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.

dim

The dimension index of data that represents the dimension containing the number of observations. Generally, this is the time dimension.

Description

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