Crosscor: Difference between revisions

From Eigenvector Research Documentation Wiki
Jump to navigation Jump to search
imported>Jeremy
(Importing text file)
imported>Neal
No edit summary
 
Line 1: Line 1:
===Purpose===
===Purpose===


Line 10: Line 9:
===Description===
===Description===


crcor = crosscor(x,y,n) returns the crosscorrelation function crcor of two time series x and y for a maximum time shift of n sample periods.
crcor = crosscor(x,y,n) returns the cross-correlation function (crcor) of two time series (x) and (y) for a maximum time shift of (n) sample periods.


crcor = crosscor(x,y,n,''period'') uses the sampling period period to scale the x-axis on the output plot.
crcor = crosscor(x,y,n,''period'') uses the sampling period (period) to scale the x-axis on the output plot.


crcor = crosscor(x,y,n,''period'',''flag'') with flag set to 1 changes the routine from cross correlation to cross covariance.
crcor = crosscor(x,y,n,''period'',''flag'') with (flag) set to 1 changes the routine from cross-correlation to cross-covariance.


Optional input ''plots'' suppresses plotting when set to 0.
Optional input ''plots'' suppresses plotting when set to 0.

Latest revision as of 15:18, 7 October 2008

Purpose

Calculates the crosscorrelation function of two time series.

Synopsis

crcor = crosscor(x,y,n,period,flag,plots)

Description

crcor = crosscor(x,y,n) returns the cross-correlation function (crcor) of two time series (x) and (y) for a maximum time shift of (n) sample periods.

crcor = crosscor(x,y,n,period) uses the sampling period (period) to scale the x-axis on the output plot.

crcor = crosscor(x,y,n,period,flag) with (flag) set to 1 changes the routine from cross-correlation to cross-covariance.

Optional input plots suppresses plotting when set to 0.

See Also

autocor, corrmap, wrtpulse