Back to Adaptive Vision Library website

You are here: Start » Function Reference » Region Features » RegionCaliperDiameter

RegionCaliperDiameter


Header:AVL.h
Namespace:avl

Computes the longest and the shortest width of the input region measured as distance between parallel lines containing the whole region.

Syntax

C++
C#
 
void avl::RegionCaliperDiameter
(
	const avl::Region& inRegion,
	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
inRegion const Region& Input region
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 region in RegionCaliperDiameter.