Back to Aurora Vision Library website

You are here: Start » Function Reference » Path » Polygon Features » PolygonRectangularity

PolygonRectangularity


Header: AVL.h
Namespace: avl
Module: FoundationBasic

Computes the area of a polygon divided by the area of its bounding rectangle.

Syntax

C++
C#
 
void avl::PolygonRectangularity
(
	const avl::Path& inPolygon,
	float& outRectangularity
)

Parameters

Name Type Default Description
Input value inPolygon const Path&
Output value outRectangularity float&

Description

Note that if the input path is not a valid polygon (i.e. it has at least one self-intersection), the computation may lead to results that are not intuitive.

Errors

List of possible exceptions:

Error type Description
DomainError Degenerate polygon on input in PolygonRectangularity.
DomainError Open path on input in PolygonRectangularity.