Back to FabImage Library website

You are here: Start » Function Reference » Region » Region Combinators » RegionDifference

RegionDifference


Header: FIL.h
Namespace: fil
Module: FoundationLite

Computes a region containing pixels from the first input region but not from the second input region.

Syntax

C++
C#
 
void fil::RegionDifference
(
	const fil::Region& inRegion1,
	const fil::Region& inRegion2,
	fil::Region& outRegion
)

Parameters

Name Type Default Description
Input value
 inRegion1 const Region& First input region
Input value
 inRegion2 const Region& Second input region
Output value
 outRegion Region& Output region

Description

The operation computes the logical difference of two given regions. That is, the resulting region contains pixel locations that belong to the first input region but do not belong to the second one. Both dimensions (width and height) of the resulting region are set to the corresponding dimensions of the first input region.

Examples

Sample region inRegion1

Sample region inRegion2

RegionDifference(inRegion1, inRegion2)

RegionDifference(inRegion2, inRegion1)

Errors

List of possible exceptions:

Error type Description
DomainError Input and output regions are not distinct in RegionDifference.

See Also