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

GroupRegionsByRegions

Header:	FIL.h
Namespace:	fil
Module:	FoundationBasic

For each region returns which regions lie inside of it or intersect with it.

Syntax

void fil::GroupRegionsByRegions
(
	const ftl::Array<fil::Region>& inRegions,
	const ftl::Array<fil::Region>& inGroupRegions,
	fil::MatchingCriterion::Type inMatchingCriterion,
	ftl::Array<ftl::Array<int> >& outGroupedIndices,
	ftl::Optional<ftl::Array<ftl::Array<fil::Region> >&> outGroupedRegions = ftl::NIL
)

Parameters

Name	Type	Default	Description
inRegions	const Array<Region>&		Array of regions that will be classified into multiple groups
inGroupRegions	const Array<Region>&		Array of regions that define the groups
inMatchingCriterion	MatchingCriterion::Type		Specifies whether a region must fully belong to a group region or if it is enough that it intersects
outGroupedIndices	Array<Array<int> >&		Indices of input regions classified into multiple groups
outGroupedRegions	Optional<Array<Array<Region> >&>	NIL	Input regions classified into multiple groups

Optional Outputs

The computation of following outputs can be switched off by passing value ftl::NIL to these parameters: outGroupedRegions.