Back to FabImage Library website

You are here: Start » Function Reference » Geometry 2D » Geometry 2D Features » PointsCaliperDiameter

PointsCaliperDiameter


Header: FIL.h
Namespace: fil
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 fil::PointsCaliperDiameter
(
	const ftl::Array<fil::Point2D>& inPoints,
	ftl::Optional<fil::Segment2D&> outMinDiameter = ftl::NIL,
	ftl::Optional<float&> outMinDiameterLength = ftl::NIL,
	ftl::Optional<fil::Segment2D&> outMaxDiameter = ftl::NIL,
	ftl::Optional<float&> outMaxDiameterLength = ftl::NIL
)

Parameters

Name Type Default Description
Input value inPoints const Array<Point2D>&
Output value outMinDiameter Optional<Segment2D&> NIL
Output value outMinDiameterLength Optional<float&> NIL
Output value outMaxDiameter Optional<Segment2D&> NIL
Output value outMaxDiameterLength Optional<float&> NIL

Optional Outputs

The computation of following outputs can be switched off by passing value ftl::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.