Functions
static Array< Array< int > >	oevislib_net.Region.GroupPointsByRegions (Array< Point2D > inPoints, Array< Region > inRegions, Optional< Array< Array< Point2D > > > outGroupedPoints)
	Splits all the points in different groups, based on the region in which they are contained.
static Array< Array< int > >	oevislib_net.Region.GroupPathsByRegions (Array< Path > inPaths, Array< Region > inRegions, MatchingCriterion inMatchingCriterion, Optional< Array< Array< Path > > > outGroupedPaths)
	Splits all the paths in different groups, based on the region in which they are contained.
static Array< Array< int > >	oevislib_net.Region.GroupRegionsByRegions (Array< Region > inRegions, Array< Region > inGroupRegions, MatchingCriterion inMatchingCriterion, Optional< Array< Array< Region > > > outGroupedRegions)
	Splits all the regions in different groups, based on the region in which they are contained.
static Array< Region >	oevislib_net.Region.ExtractRegions (Array< Region > inRegions, RegionFeature inFeature, Optional< float > inMinimum, Optional< float > inMaximum, Optional< Array< Region > > outRejected, Optional< Array< Region > > outBelow, Optional< Array< Region > > outAbove, Optional< Array< float > > outValues)
	Extracts regions whose feature value is in the provided range.
static Array< Region >	oevislib_net.Region.FilterRegions (Array< Region > inRegions, Region inReferenceRegion, RegionFeature inFeature, float inPercentageAbove, Optional< float > inPercentageBelow, Optional< Array< Region > > outRejected, Optional< Array< float > > outValues)
	Extracts regions whose feature value differs less than a percentage from the reference one.
static Array< Region >	oevislib_net.Region.SortRegions (Array< Region > inRegions, RegionFeature inFeature, SortingOrder inSortingOrder, Optional< Array< float > > outSortedValues)
	Sorts the input regions based on the provided feature values.
static Region	oevislib_net.Region.FindMinRegion (Array< Region > inRegions, RegionFeature inFeature, Optional< int > outIndex, Optional< float > outValue)
	Selects the region with the lowest value of the provided feature.
static int	oevislib_net.Region.MinimumRegionIndex (Array< Region > inRegions, RegionFeature inFeature, Optional< Region > outRegion, Optional< float > outValue)
	Returns the index of the region with the lowest value of the selected feature.
static Region	oevislib_net.Region.FindMaxRegion (Array< Region > inRegions, RegionFeature inFeature, Optional< int > outIndex, Optional< float > outValue)
	Selects the region with the highest value of the provided feature.
static int	oevislib_net.Region.MaximumRegionIndex (Array< Region > inRegions, RegionFeature inFeature, Optional< Region > outRegion, Optional< float > outValue)
	Returns the index of the region with the highest value of the selected feature.

Detailed Description

Function Documentation

◆ ExtractRegions()

Array< Region > oevislib_net.Region.ExtractRegions	(	Array< Region >	inRegions,
		RegionFeature	inFeature,
		Optional< float >	inMinimum,
		Optional< float >	inMaximum,
		Optional< Array< Region > >	outRejected,
		Optional< Array< Region > >	outBelow,
		Optional< Array< Region > >	outAbove,
		Optional< Array< float > >	outValues )

inlinestatic

Extracts regions whose feature value is in the provided range.

Parameters

inRegions	Input regions.
inFeature	Feature used to classify each region.
inMinimum	Regions with a feature value lower than this parameter will be discarded.
inMaximum	Regions with a feature higher lower than this parameter will be discarded.
outRejected	Array containing the regions whose feature value is not in the provided range.
outBelow	Array containing the regions whose feature value is below the provided range.
outAbove	Array containing the regions whose feature value is above the provided range.
outValues	Array containing the feature values for all the regions.

Returns: An array containing the regions whose feature value is in the provided range.

◆ FilterRegions()

Array< Region > oevislib_net.Region.FilterRegions	(	Array< Region >	inRegions,
		Region	inReferenceRegion,
		RegionFeature	inFeature,
		float	inPercentageAbove,
		Optional< float >	inPercentageBelow,
		Optional< Array< Region > >	outRejected,
		Optional< Array< float > >	outValues )

inlinestatic

Extracts regions whose feature value differs less than a percentage from the reference one.

Parameters

inRegions	Input regions.
inReferenceRegion	Region used to compute the reference value.
inFeature	Feature considered during the filtering process.
inPercentageAbove	Percentage used to calculate the range of accepted values above the reference. Range [0, +inf].
inPercentageBelow	Percentage used to calculate the range of accepted values below the reference. If Null, the value inPercentageDeltaAbove will be used. Range [0, +inf].
outRejected	Array containing the regions discarded by the filtering process.
outValues	Array containing the values computed for the input regions.

Returns: An array containing the regions accepted by the filtering process.

◆ FindMaxRegion()

Region oevislib_net.Region.FindMaxRegion	(	Array< Region >	inRegions,
		RegionFeature	inFeature,
		Optional< int >	outIndex,
		Optional< float >	outValue )

inlinestatic

Selects the region with the highest value of the provided feature.

Parameters

inRegions	Input regions.
inFeature	Feature used to find the maximum.
outIndex	Index of the selected region.
outValue	Feature value of the selected region.

Returns: The selected region.

◆ FindMinRegion()

Region oevislib_net.Region.FindMinRegion	(	Array< Region >	inRegions,
		RegionFeature	inFeature,
		Optional< int >	outIndex,
		Optional< float >	outValue )

inlinestatic

Selects the region with the lowest value of the provided feature.

Parameters

inRegions	Input regions.
inFeature	Feature used to find the minimum.
outIndex	Index of the selected region.
outValue	Feature value of the selected region.

Returns: The selected region.

◆ GroupPathsByRegions()

Array< Array< int > > oevislib_net.Region.GroupPathsByRegions	(	Array< Path >	inPaths,
		Array< Region >	inRegions,
		MatchingCriterion	inMatchingCriterion,
		Optional< Array< Array< Path > > >	outGroupedPaths )

inlinestatic

Splits all the paths in different groups, based on the region in which they are contained.

Parameters

inPaths	Input paths.
inRegions	Input regions.
inMatchingCriterion	Method used by the algorithm to group objects.
outGroupedPaths	Array containing the paths grouped by regions. The first index match the index of the respective region.

Returns: An array containing the indices of each path, grouped by regions. The first index match the index of the respective region.

◆ GroupPointsByRegions()

Array< Array< int > > oevislib_net.Region.GroupPointsByRegions	(	Array< Point2D >	inPoints,
		Array< Region >	inRegions,
		Optional< Array< Array< Point2D > > >	outGroupedPoints )

inlinestatic

Splits all the points in different groups, based on the region in which they are contained.

Parameters

inPoints	Input points.
inRegions	Input regions.
outGroupedPoints	Array containing the points grouped by regions. The first index match the index of the respective region.

Returns: An array containing the indices of each point, grouped by regions. The first index match the index of the respective region.

◆ GroupRegionsByRegions()

Array< Array< int > > oevislib_net.Region.GroupRegionsByRegions	(	Array< Region >	inRegions,
		Array< Region >	inGroupRegions,
		MatchingCriterion	inMatchingCriterion,
		Optional< Array< Array< Region > > >	outGroupedRegions )

inlinestatic

Splits all the regions in different groups, based on the region in which they are contained.

Parameters

inRegions	Input regions.
inGroupRegions	Region array used to group input objects.
inMatchingCriterion	Method used by the algorithm to group objects.
outGroupedRegions	Array containing the grouped regions.

Returns: An array containing the indices of each region, divided in respective groups.

◆ MaximumRegionIndex()

int oevislib_net.Region.MaximumRegionIndex	(	Array< Region >	inRegions,
		RegionFeature	inFeature,
		Optional< Region >	outRegion,
		Optional< float >	outValue )

inlinestatic

Returns the index of the region with the highest value of the selected feature.

Parameters

inRegions	Input regions.
inFeature	Feature used to find the minimum.
outRegion	Region with the highest feature value.
outValue	Feature value of the selected region.

Returns: Index of the region with the highest feature value.

◆ MinimumRegionIndex()

int oevislib_net.Region.MinimumRegionIndex	(	Array< Region >	inRegions,
		RegionFeature	inFeature,
		Optional< Region >	outRegion,
		Optional< float >	outValue )

inlinestatic

Returns the index of the region with the lowest value of the selected feature.

Parameters

inRegions	Input regions.
inFeature	Feature used to find the minimum.
outRegion	Region with the lowest feature value.
outValue	Feature value of the selected region.

Returns: Index of the region with the lowest feature value.

◆ SortRegions()

Array< Region > oevislib_net.Region.SortRegions	(	Array< Region >	inRegions,
		RegionFeature	inFeature,
		SortingOrder	inSortingOrder,
		Optional< Array< float > >	outSortedValues )

inlinestatic

Sorts the input regions based on the provided feature values.

Parameters

inRegions	Input regions.
inFeature	Feature used to sort regions.
inSortingOrder	Sorting order.
outSortedValues	All the feature values, sorted accordingly.

Returns: An array containing the sorted regions.

Functions

Detailed Description

Function Documentation

◆ ExtractRegions()

◆ FilterRegions()

◆ FindMaxRegion()

◆ FindMinRegion()

◆ GroupPathsByRegions()

◆ GroupPointsByRegions()

◆ GroupRegionsByRegions()

◆ MaximumRegionIndex()

◆ MinimumRegionIndex()

◆ SortRegions()