You are here: Start » AVL.NET » Function Reference » Image » Image Metrics » AVL.ImageCorrelationImage

AVL.ImageCorrelationImage

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

Namespace:AvlNet
Assembly:AVL.NET.dll

Syntax

C++
C#
 
public static void ImageCorrelationImage
(
	AvlNet.Image inImage,
	AvlNet.Image inPatternImage,
	NullableRef<AvlNet.Region> inRoi,
	NullableRef<AvlNet.Region> inPatternRoi,
	AvlNet.CorrelationMeasure inCorrelationMeasure,
	AvlNet.Image outImage
)

Parameters

Name Type Range Default Description
inImageAvlNet.ImageInput image.
inPatternImageAvlNet.ImagePattern to be compared with input image.
inRoiAvlNet.NullableRef<AvlNet.Region>Range of pixels to be processed. Default value: atl::NIL.
inPatternRoiAvlNet.NullableRef<AvlNet.Region>Range of pixels in the pattern to be processed. Default value: atl::NIL.
inCorrelationMeasureAvlNet.CorrelationMeasureMeasure of correlation.
outImageAvlNet.ImageOutput image.

Description

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.

Examples

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

Hardware acceleration settings may be manipulated with Settings class.

Errors

List of possible exceptions:

Error type Description
DomainError Not supported correlation measure in ImageCorrelationImage.

Function Overrides

See also