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

ImageCorrelationImage

Header:	FIL.h
Namespace:	fil

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

Syntax

void fil::ImageCorrelationImage
(
	const fil::Image& inImage,
	const fil::Image& inPatternImage,
	ftl::Optional<const fil::Region&> inRoi,
	ftl::Optional<const fil::Region&> inPatternRoi,
	fil::CorrelationMeasure::Type inCorrelationMeasure,
	fil::Image& outImage
)

Parameters

Name	Type	Default	Description
inImage	const Image&		Input image
inPatternImage	const Image&		Pattern to be compared with input image
inRoi	Optional<const Region&>	NIL	Range of pixels to be processed
inPatternRoi	Optional<const Region&>	NIL	Range of pixels in the pattern to be processed
inCorrelationMeasure	CorrelationMeasure::Type		Measure of correlation
outImage	Image&		Output 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).

Errors

List of possible exceptions:

Error type	Description
DomainError	Not supported correlation measure in ImageCorrelationImage.