NCL Home > Documentation > Functions > CESM

mjo_xcor_lag_season

Calculates lagged correlations between a reference series and gridded data as specified by the US-CLIVAR MJO diagnostics website.

Available in version 5.1.0 and later.

Prototype

load "$NCARG_ROOT/lib/ncarg/nclscripts/csm/gsn_code.ncl"        ; These three libraries are automatically
load "$NCARG_ROOT/lib/ncarg/nclscripts/csm/gsn_csm.ncl"         ; loaded from NCL V6.2.0 onward.
load "$NCARG_ROOT/lib/ncarg/nclscripts/csm/contributed.ncl"     ; No need for user to explicitly load.

load "$NCARG_ROOT/lib/ncarg/nclscripts/csm/diagnostics_cam.ncl" ; Still need to load this library.

	function mjo_xcor_lag_season (
		ref   [*] : numeric,  
		x  [*][*] : numeric,  
		mxlag [1] : integer,  
		opt   [1] : logical   
	)

	return_val  :  array [mxlag , latitude or longitude]

Arguments

ref

Reference time series containing daily values. Nominally, ref(time).

A two-dimensional variable array. Nominally, (time,lat) or (time,lon).

mxlag

Maximum number of lags [mxlag=25 is suggested]

opt

If opt=False, the function will operate under default mode regardless of any attributes associated with the variable.

If opt=True, then the following attributes, associated with opt, may be used to alter the default behavior.

opt@smth9: If this attribute is present, it can have two values 0.25 or -0.25 for 'heavy' or 'light' local smoothing. Default: False

Return value

The return array will be a 2D variable (2*mxlag+1, nlat or mlon)

Description

Take a reference series and perform positive and negative cross-correlations.

Examples