Back to FabImage Library website

You are here: Start » Function Reference » Path » Path Features » PathCaliperDiameter

PathCaliperDiameter


Header: FIL.h
Namespace: fil
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 fil::PathCaliperDiameter
(
	const fil::Path& inPath,
	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
inPath const Path& Input path
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 path on input in PathCaliperDiameter.