Back to FabImage Library website

You are here: Start » Function Reference » Region » Region Relations » TestRegionEqualTo

TestRegionEqualTo


Header: FIL.h
Namespace: fil
Module: FoundationBasic

Tests whether given regions are equal.

Syntax

C++
C#
 
void fil::TestRegionEqualTo
(
	const fil::Region& inRegion,
	const fil::Region& inReferenceRegion,
	bool& outIsEqual
)

Parameters

Name Type Default Description
Input value
 inRegion const Region& Input region
Input value
 inReferenceRegion const Region&
Output value
 outIsEqual bool&

Description

The operation tests whether the inRegion is the same region as contained inside inReferenceRegion. It means that the resulting outIsEqual is set to 'true' if and only if both of the conditions are met:

  • inRegion and inReferenceRegion have the same dimensions
  • inRegion and inReferenceRegion contain the same set of pixels

Examples

TestRegionEqualTo run with inRegion set to the right region and inReferenceRegion set to the left, computes the outIsEqual = true.

TestRegionEqualTo run with inRegion set to the right region and inReferenceRegion set to the left, computes the outIsEqual = false, as dimensions of the regions differ.

See Also