Back to Aurora Vision Library Lite website

You are here: Start » System » Assertions » AssertImageEqualTo

AssertImageEqualTo


Header: AVL.h
Namespace: avl

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

Syntax

void avl::AssertImageEqualTo
(
	const avl::Image& inImage,
	const avl::Image& inExpectedImage,
	const float inMaxDifference,
	const atl::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.