Admin Production ni-theme
Current Publication

AutoCorrelate2D

LabWindows/CVI

AutoCorrelate2D

Advanced Analysis Library Only

AnalysisLibErrType AutoCorrelate2D (void *inputArray, ssize_t rowsInArray, ssize_t columnsInArray, void *outputArray);

Purpose

Finds the 2D autocorrelation of the input array.

AutoCorrelate2D computes the two-dimensional autocorrelation using the following equation:

for i = -(M–1), ..., -1, 0, 1, ..., (M–1) and j = -(N–1), ..., -1, 0, 1, ..., (N–1)

where M is the number of rows of matrix inputArray, and N is the number of columns of matrix inputArray. The indexed elements of inputArray that lie outside its range are equal to zero, as shown in the following relationship:

x(m,n) = 0 when m < 0 or mM or n < 0 or nN

Note Note  This function temporarily allocates memory for use as a work area. If AutoCorrelate2D cannot allocate memory, the function returns an error code.

Parameters

Input
Name Type Description
inputArray void * The input array for which to compute the autocorrelation operation.
rowsInArray ssize_t Number of rows in inputArray.
columnsInArray ssize_t Number of columns in inputArray.
Output
Name Type Description
outputArray void The autocorrelation of inputArray. The size of outputArray is (2m - 1)-by-(2n - 1).

Return Value

Name Type Description
status AnalysisLibErrType A value that specifies the type of error that occurred. Refer to analysis.h for definitions of these constants.

Additional Information

Library: Advanced Analysis Library

Include file: analysis.h

LabWindows/CVI compatibility: LabWindows/CVI 2012 and later