Back to Adaptive Vision Library Lite websiteYou are here:
Start »
Geometry 2D »
Geometry 2D Distance Metrics »
PointToLineDistance
Header: |
AVL.h
|
Namespace: |
avl |
Measures the distance between a point and a line.
Syntax
void avl::PointToLineDistance
(
const avl::Point2D& inPoint,
const avl::Line2D& inLine,
float inResolution,
float& outDistance,
atl::Optional<avl::Segment2D&> outConnectingSegment = atl::NIL,
atl::Optional<float&> outSignedDistance = atl::NIL
)
Parameters
|
Name |
Type |
Range |
Default |
Description |
|
inPoint |
const Point2D& |
|
|
|
|
inLine |
const Line2D& |
|
|
|
|
inResolution |
float |
0.0 - |
1.0f |
Number of real-world units per one pixel |
|
outDistance |
float& |
|
|
|
|
outConnectingSegment |
Optional<Segment2D&> |
|
NIL |
|
|
outSignedDistance |
Optional<float&> |
|
NIL |
|
Optional Outputs
The computation of following outputs can be switched off by passing value atl::NIL
to these parameters: outConnectingSegment, outSignedDistance.
Read more about Optional Outputs.
Examples
PointToLineDistance performed on a sample point and a sample line. The green segment is the value of outConnectingSegment output.
Errors
List of possible exceptions:
Error type |
Description |
DomainError |
Indefinite line on input in PointToLineDistance. |