ImageCorrelationImage


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

Applications:This filter is used internally by the Gray-based Template Matching.

Syntax

C++
C#
Python
 
def ImageCorrelationImage(
	inImage: Image,
	inPatternImage: Image,
	outImage: Image,
	/,
	*,
	inRoi: Region | None = None,
	inPatternRoi: Region | None = None,
	inCorrelationMeasure: CorrelationMeasure = CorrelationMeasure.NormalizedCrossCorrelation
)
-> None

Parameters

Name Type Default Description
Input value inImage Image Input image
Input value inPatternImage Image Pattern to be compared with input image
Input value inRoi Region | None None Range of pixels to be processed
Input value inPatternRoi Region | None None Range of pixels in the pattern to be processed
Input value inCorrelationMeasure CorrelationMeasure CorrelationMeasure.NormalizedCrossCorrelation Measure of correlation
Output value outImage Image Output image

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).