Back to FabImage Library website

You are here: Start » Function Reference » System » Assertions » AssertImageEqualTo

AssertImageEqualTo


Header: FIL.h
Namespace: fil
Module: FoundationLite

Asserts that two images are equal or differ by a small given margin.

Syntax

C++
C#
 
void fil::AssertImageEqualTo
(
	const fil::Image& inImage,
	const fil::Image& inExpectedImage,
	const float inMaxDifference,
	const ftl::String& inDescription,
	const float inEpsilon = 1.0f,
	const int inEpsilonScale = -6
)

Parameters

Name Type Range Default Description
Input value inImage const Image& Input image
Input value inExpectedImage const Image&
Input value inMaxDifference const float 0.0 - 0.0f Maximum absolute difference between a specific pixel of the two images
Input value inDescription const String&
Input value inEpsilon const float 0.0 - 1.0f Maximum allowed difference, significant. InEpsilon will be multiplied by 10^inEpsilonScale before checking the difference
Input value inEpsilonScale const int -6

Errors

List of possible exceptions:

Error type Description
DomainError Input images have different pixel formats in AssertImageEqualTo.
DomainError Input images have different sizes in AssertImageEqualTo.