The Crosscorrelator
returns the crosscorrelation
sequence for two discretetime deterministic inputs. This object can
also return the crosscorrelation sequence estimate for two discretetime,
jointly widesense stationary (WSS), random processes.
To obtain the crosscorrelation for two discretetime deterministic inputs:
Define and set up your crosscorrelator. See Construction.
Call step
to compute the crosscorrelation
according to the properties of dsp.Crosscorrelator
.
The behavior of step
is specific to each object in
the toolbox.
Note:
Starting in R2016b, instead of using the 
H = dsp.Crosscorrelator
returns
a crosscorrelator object, H
, that computes the crosscorrelation
of two inputs. For ND arrays, the crosscorrelator computes the correlation
columnwise. The inputs must have an equal number of columns. If one
input is a vector and the other is an ND array, the crosscorrelator
computes the crosscorrelation of the vector with each column of the
ND array. Cross correlating inputs of length N and M results
in a crosscorrelation sequence of length N+M–1.
Cross correlating matrices of size MbyN and PbyN results
in a matrix of crosscorrelation sequences of size M+P–1byN.
H = dsp.Crosscorrelator('
returns a crosscorrelator, PropertyName
',PropertyValue
,
...)H
, with
each property set to the specified value.

Domain for computing correlations Specify the domain for computing correlation as 
clone  Create crosscorrelator object with same property values 
getNumInputs  Number of expected inputs to step method 
getNumOutputs  Number of outputs of step method 
isLocked  Locked status for input attributes and nontunable properties 
release  Allow property value and input characteristics changes 
step  Crosscorrelation sequence 
The crosscorrelation of two length N deterministic inputs, or realizations of jointly WSS random processes, x and y, is:
$$\begin{array}{l}{r}_{xy}(h)=\{\begin{array}{ll}{\displaystyle \sum _{n=0}^{Nh1}x}(n+h){y}^{*}(n)\hfill & 0\le h\le N1\hfill \\ {r}_{yx}^{*}(h)\hfill & (N1)\le h\le 0\hfill \end{array}\\ \end{array}$$
where h is the lag and * denotes the complex conjugate. If the inputs are realizations of jointly WSS stationary random processes, r_{xy}(h) is an unnormalized estimate of the theoretical crosscorrelation:
$${\rho}_{xy}(h)=E\{x(n+h){y}^{*}(n)\}$$
where E{ } is the expectation operator.
This object implements the algorithm, inputs, and outputs described on the Correlation block reference page. The object properties correspond to the block parameters.