Back to FabImage Library website

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

GroupPathsByRegions


Header: FIL.h
Namespace: fil
Module: FoundationBasic

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

Syntax

C++
C#
 
void fil::GroupPathsByRegions
(
	const ftl::Array<fil::Path>& inPaths,
	const ftl::Array<fil::Region>& inRegions,
	fil::MatchingCriterion::Type inMatchingCriterion,
	ftl::Array<ftl::Array<int> >& outGroupedIndices,
	ftl::Optional<ftl::Array<ftl::Array<fil::Path> >&> outGroupedPaths = ftl::NIL
)

Parameters

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

Optional Outputs

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

Read more about Optional Outputs.

See Also