Back to Adaptive Vision Library website
You are here: Start » Function Reference » Path » Path Features » PathCaliperDiameter
PathCaliperDiameter
Header: | AVL.h |
---|---|
Namespace: | avl |
Module: | FoundationBasic |
Computes the longest and the shortest width of the input path measured as distance between parallel lines containing the whole path.
Syntax
C++
C#
void avl::PathCaliperDiameter ( const avl::Path& inPath, 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 | |
---|---|---|---|---|
inPath | const Path& | Input path | ||
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 path on input in PathCaliperDiameter. |