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

ImageDifferenceImage

Header:	FIL.h
Namespace:	fil
Module:	FoundationBasic

Computes an image of differences between a moving pattern and the input image.

Syntax

void fil::ImageDifferenceImage
(
	const fil::Image& inImage,
	const fil::Image& inPatternImage,
	ftl::Optional<const fil::Region&> inRoi,
	ftl::Optional<const fil::Region&> inPatternRoi,
	fil::DistanceMeasure::Type inDistanceMeasure,
	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
inDistanceMeasure	DistanceMeasure::Type		Measure of distance
outImage	Image&		Output image

Description

The operation computes the difference 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 inDifferenceMeasure as in ImageDifference 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.

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

Hardware Acceleration

This operation is optimized for SSE2 technology for pixels of types: UINT8 (for inDistanceMeasure = MeanError).

This operation is optimized for SSE3 technology for pixels of types: UINT16 (for inDistanceMeasure = MeanError), UINT8 (for inDistanceMeasure = MeanSquaredError), REAL.

This operation is optimized for SSE4 technology for pixels of types: INT16, UINT16 (for inDistanceMeasure = MeanSquaredError).

This operation is optimized for AVX2 technology for pixels of types: UINT8, INT16, UINT16, REAL.

This operation is optimized for NEON technology for pixels of types: UINT8, UINT16 (for inDistanceMeasure = MeanError), INT16 (for inDistanceMeasure = MeanError), REAL.

This operation supports automatic parallelization for multicore and multiprocessor systems.

Errors

List of possible exceptions:

Error type	Description
DomainError	Not supported distance measure in ImageDifferenceImage.