Back to FabImage Library website

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

CompareImages


Header: FIL.h
Namespace: fil
Module: FoundationPro

Compares two images tile by tile using one of several available methods.

Syntax

C++
C#
 
void fil::CompareImages
(
	const fil::Image& inImage1,
	const fil::Image& inImage2,
	fil::CompareMeasure::Type inMeasure,
	int inTileSize,
	int inDensity,
	fil::Image& outImage
)

Parameters

Name Type Range Default Description
Input value inImage1 const Image& First input image
Input value inImage2 const Image& Second input image
Input value inMeasure CompareMeasure::Type DSSIM
Input value inTileSize int 1 - 25
Input value inDensity int 1 -
Output value outImage Image& Output image

Description

The operation compares two images tile by tile using one of the following methods:

  • Value - Sum of absolute differences divided by tile area
  • NCC - Normalized cross-correlation
  • DSSIM - Structural dissimilarity

Errors

List of possible exceptions:

Error type Description
DomainError Formats of input images differ in CompareImages.
DomainError Images sizes are not equal in CompareImages.
DomainError Not supported measure type in CompareImages.

See Also

  • ColorDistanceImage – Compares each pixel with the specified color using chromatic and non-chromatic information.