Back to Aurora Vision Studio website

You are here: Start » Filter Reference » Image » Image Metrics » ImageCorrelationImage


Module: FoundationPro

Computes an image of correlation between a pattern and the input image at each possible location.


This filter is used internally by the Gray-based Template Matching.
Name Type Description
Input value
inImage Image Input image
Input value
inPatternImage Image Pattern to be compared with input image
Input value
inRoi Region* Range of pixels to be processed
Input value
inPatternRoi Region* Range of pixels in the pattern to be processed
Input value
inCorrelationMeasure CorrelationMeasure Measure of correlation
Output value
outImage Image Output image


The operation computes the correlation between inImage and inPatternImage. The inPatternImage is aligned at each location of the inImage and the similarity between the inPatternImage and the corresponding part of the inImage is estimated using the inCorrelationMeasure as in ImageCorrelation filter. The result is stored in the pixel of the outImage that corresponds to the location at which the center of inPatternImage was aligned to the inImage.


A sample inImage.

A sample inPatternImage.

The resulting outImage multiplied by 255.

The locations in the inImage corresponding to the brightest points of the outImage.

Hardware Acceleration

This operation supports automatic parallelization for multicore and multiprocessor systems.

This operation supports processing on OpenCL compatible device (when inRoi=NIL, inPatternRoi=NIL and pixel type is uint8).


This filter can throw an exception to report error. Read how to deal with errors in Error Handling.

List of possible exceptions:

Error type Description
DomainError Not supported correlation measure in ImageCorrelationImage.

Complexity Level

This filter is available on Advanced Complexity Level.

See Also

  • LocateMultipleObjects_NCC – Finds all occurrences of a predefined template on an image by analysing the normalized correlation between pixel values.