Please note that the recommended version of Scilab is 2025.0.0. This page might be outdated.
See the recommended documentation of this function
xcorr
Computes discrete auto or cross correlation
Syntax
[c, lagindex] = xcorr(x) [c, lagindex] = xcorr(x, y) [c, lagindex] = xcorr(.., maxlags) [c, lagindex] = xcorr(.., maxlags, scaling)
Parameters
- x
a vector of real or complex floating point numbers.
- y
a vector of real or complex floating point numbers. The default value is
x
.- maxlags
a scalar with integer value greater than 1. The default value is
n
. Wheren
is the maximum of thex
andy
vector length.- scaling
a character string with possible value:
"biased"
,"unbiased"
,"coeff"
,"none"
. The default value is"none"
.- c
a vector of real or complex floating point numbers with same orientation as
x
.- lagindex
a row vector, containing the lags index corresponding to the
c
values.
Description
c=xcorr(x)
computes the un-normalized discrete auto correlation:and return in
c
the sequence of auto correlation lags Ck=-n:n wheren
is the length ofx
xcorr(x,y)
computes the un-normalized discrete cross correlation:and return in
c
the sequence of auto correlation lags Ck=-n:n wheren
is the maximum ofx
andy
lengths.
If the maxlags
argument is given
xcorr
returns in c
the sequence of
auto correlation lags Ck=-maxlags:maxlags. If
maxlags
is greater than length(x)
,
the first and last values of c
are zero.
The scaling
argument describes how
C(k) is normalized before being returned in
c
:
- "biased":
c=
C/n
. - "unbiased":
c=
C./(n-(-maxlags:maxlags))
. - "coeff":
c=
C/(norm(x)*norm(y))
.
The corr function computes the "biased" covariance of
Method: This function computes C using
|
Examples
See also
History
Version | Description |
5.4.0 | xcorr added. |
Report an issue | ||
<< hank | correlation_convolution | transforms >> |