The Crosscorrelator object computes 2-D cross-correlation
of two input matrices.

Construction

H = vision.Crosscorrelator returns
a System object, H, that performs two-dimensional
cross-correlation between two inputs.

H = vision.Crosscorrelator(Name,Value) returns
a 2-D cross correlation System object, H, with each
specified property set to the specified value. You can specify additional
name-value pair arguments in any order as (Name1, Value1,...,NameN,ValueN).

This property controls the size of the output scalar, vector,
or matrix produced as a result of the cross-correlation between the
two inputs. This property can be set to one of Full, Same as first input, Valid.
If this property is set to Full,
the output is the full two-dimensional cross-correlation with dimensions
(Ma+Mb-1, Na+Nb-1).
if this property is set to same as first
input, the output is the central part of the cross-correlation
with the same dimensions as the first input. if this property is set
to valid, the output is only those
parts of the cross-correlation that are computed without the zero-padded
edges of any input. this output has dimensions (Ma-Mb+1, Na-Nb+1).
(Ma, Na) is the size of the
first input matrix and (Mb, Nb)
is the size of the second input matrix. The default is Full.

Normalize

Normalize output

Set this property to true to normalize the
output. If you set this property to true, the object
divides the output by $$\sqrt{{\displaystyle \sum \left({I}_{1p}\u2022{I}_{1p}\right)}\times {\displaystyle \sum \left({I}_{2}\u2022{I}_{2}\right)}}$$,
where $${I}_{1p}$$ is
the portion of the input matrix, $${I}_{1}$$that
aligns with the input matrix, $${I}_{2}$$.
This property must be set to false for fixed-point
inputs. The default is false.

Specify the rounding method as one of Ceiling | Convergent | Floor | Nearest | Round | Simplest | Zero.
The default is Floor.

OverflowAction

Overflow action for fixed-point operations

Specify the overflow action as Wrap or Saturate. The default is Wrap.

ProductDataType

Product word and fraction lengths

Specify the product fixed-point data type as Same as first input, Custom.
The default is Same as first input.

CustomProductDataType

Product word and fraction lengths

Specify the product fixed-point type as a scaled numerictype object with a Signedness of Auto.
This property applies when you set the ProductDataType property
to Custom. The default is numerictype([],32,30).

AccumulatorDataType

Accumulator word and fraction lengths

Specify the accumulator fixed-point data type as Same as product, Same
as first input, Custom.The
default is Same as product.

CustomAccumulatorDataType

Accumulator word and fraction lengths

Specify the accumulator fixed-point type as a scaled numerictype object with a Signedness of Auto.
This property applies when you set the AccumulatorDataType property
to Custom. The default is numerictype([],32,30).

OutputDataType

Output word and fraction lengths

Specify the output fixed-point data type as Same as first input, Custom.
The default is Same as first input.

CustomOutputDataType

Output word and fraction lengths

Specify the output fixed-point type as a scaled numerictype object with a Signedness of Auto.
This property applies when you set the OutputDataType property
to Custom. The default is numerictype([],16,15).

This object implements the algorithm, inputs, and outputs described
on the 2-D Correlation block
reference page. The object properties correspond to the block parameters.