Back to Adaptive Vision Library website
You are here: Start » Function Reference » Region Metrics » RegionToRegionDistance
RegionToRegionDistance
Computes minimal distance between one of the points of the first region with one of the points of the second region.
Syntax
C++
C#
void avl::RegionToRegionDistance ( const avl::Region& inRegion1, const avl::Region& inRegion2, float inResolution, float& outDistance, atl::Optional<avl::Segment2D&> outConnectingSegment = atl::NIL )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
inRegion1 | const Region& | First input region | |||
inRegion2 | const Region& | Second input region | |||
inResolution | float | 0.0 - | 1.0f | Number of real-world units per one pixel | |
outDistance | float& | ||||
outConnectingSegment | Optional<Segment2D&> | NIL |
Description
Operation computes length of the shortest segment that connects center of one of inRegion1's point which center of one of inRegion2's point.
Examples
Remarks
- inRegion1 and inRegion2 must not be empty, otherwise an error with appropriate description occurs.
Errors
Error type | Description |
---|---|
DomainError | One of input regions in RegionToRegionDistance is empty. |