Main Content

(To be removed) Autocorrelation sequence

`dsp.Autocorrelator`

will be removed in a future release. Use `xcorr`

instead.
For more information, see Compatibility Considerations.

The `Autocorrelator`

object returns the autocorrelation
sequence for a discrete-time, deterministic input, or the autocorrelation sequence estimate
for a discrete-time, wide-sense stationary (WSS) random process at positive lags.

To obtain the autocorrelation sequence:

Create the

`dsp.Autocorrelator`

object and set its properties.Call the object with arguments, as if it were a function.

To learn more about how System objects work, see What Are System Objects?.

returns an
autocorrelator, `ac`

= dsp.Autocorrelator`ac`

, that computes the autocorrelation along the first
dimension of an *N*-D array. By default, the autocorrelator computes the
autocorrelation at lags from zero to *N* – 1, where *N*
is the length of the input vector or the row dimension of the input matrix. Inputting a
row vector results in a row of zero-lag autocorrelation sequence values, one for each
column of the row vector. The default autocorrelator returns the unscaled autocorrelation
and performs the computation in the time domain.

returns an autocorrelator, `ac`

= dsp.Autocorrelator(`Name,Value`

)`ac`

, with each property set to the
specified value.

To use an object function, specify the
System object™ as the first input argument. For
example, to release system resources of a System object named `obj`

, use
this syntax:

release(obj)