Back to FabImage Library website

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

TestRegionInRegion


Header: FIL.h
Namespace: fil
Module: FoundationBasic

Tests whether a region is contained in another one.

Syntax

C++
C#
 
void fil::TestRegionInRegion
(
	const fil::Region& inSubregion,
	const fil::Region& inRegion,
	bool& outIsContained
)

Parameters

Name Type Default Description
Input value
 inSubregion const Region&
Input value
 inRegion const Region& Input region
Output value
 outIsContained bool&

Description

The operation tests whether the inSubregion is contained inside the inRegion. The resulting outIsContained is set to 'true' if and only if each pixel of inSubregion is also included in inRegion.

Examples

TestRegionInRegion run with inSubregion set to the left region and inRegion set to the right, computes the outIsContained = true.

TestRegionInRegion run with inSubregion set to the left region and inRegion set to the right, computes the outIsContained = false.

See Also