Back to Aurora Vision Library website
You are here: Start » Function Reference » Geometry 2D » Geometry 2D Features » PointsCaliperDiameter
PointsCaliperDiameter
Header: | AVL.h |
---|---|
Namespace: | avl |
Module: | FoundationBasic |
Computes the longest and the shortest width of the input points measured as distance between parallel lines containing all of them.
Syntax
C++
C#
void avl::PointsCaliperDiameter ( const atl::Array<avl::Point2D>& inPoints, atl::Optional<avl::Segment2D&> outMinDiameter = atl::NIL, atl::Optional<float&> outMinDiameterLength = atl::NIL, atl::Optional<avl::Segment2D&> outMaxDiameter = atl::NIL, atl::Optional<float&> outMaxDiameterLength = atl::NIL )
Parameters
Name | Type | Default | Description | |
---|---|---|---|---|
inPoints | const Array<Point2D>& | |||
outMinDiameter | Optional<Segment2D&> | NIL | ||
outMinDiameterLength | Optional<float&> | NIL | ||
outMaxDiameter | Optional<Segment2D&> | NIL | ||
outMaxDiameterLength | Optional<float&> | NIL |
Optional Outputs
The computation of following outputs can be switched off by passing value atl::NIL
to these parameters: outMinDiameter, outMinDiameterLength, outMaxDiameter, outMaxDiameterLength.
Read more about Optional Outputs.
Errors
List of possible exceptions:
Error type | Description |
---|---|
DomainError | Empty point array on input in PointsCaliperDiameter. |