Please note that the recommended version of Scilab is 2025.0.0. This page might be outdated.
See the recommended documentation of this function
xcov
Computes discrete auto or cross covariance
Syntax
[c, lagindex] = xcov(x) [c, lagindex] = xcov(x, y) [c, lagindex] = xcov(.., maxlags) [c, lagindex] = xcov(.., 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=xcov(x)
computes the un-normalized discrete covariance: and return inc
the sequence of covariance lags Ck=-n:n wheren
is the length ofx
xcov(x,y)
computes the un-normalized discrete cross covariance: and return inc
the sequence of cross covariance lags Ck=-n:n wheren
is the maximum ofx
andy
length's.
If the maxlags
argument is given
xcov
returns in c
the sequence of
covariance 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))
.
Remark
The corr function computes the "biased" covariance ofx
and y
and only return in c
the sequence of covariance lags Ck≥0
.Method
This function computes C usingxcorr(x-mean(x),y-mean(y),...)
.Examples
See also
History
Version | Description |
5.4.0 | xcov added. |
Report an issue | ||
<< sincd | Traitement du Signal | FFTW >> |