Back to Aurora Vision Library website

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

PointsBoundingRectangle


Header: AVL.h
Namespace: avl
Module: FoundationLite

Computes the smallest rectangle containing an array of points.

Syntax

C++
C#
 
void avl::PointsBoundingRectangle
(
	const atl::Array<avl::Point2D>& inPoints,
	avl::BoundingRectangleFeature::Type inBoundingRectangleFeature,
	float inReferenceAngle,
	avl::RectangleOrientation::Type inRectangleOrientation,
	avl::Rectangle2D& outBoundingRectangle,
	atl::Optional<avl::Point2D&> outCenter = atl::NIL,
	atl::Optional<float&> outLongSide = atl::NIL,
	atl::Optional<float&> outShortSide = atl::NIL
)

Parameters

Name Type Default Description
Input value inPoints const Array<Point2D>& Input array of points
Input value inBoundingRectangleFeature BoundingRectangleFeature::Type MinimalArea Determines what kind of bounding rectangle will be computed
Input value inReferenceAngle float 0.0f The middle angle of the valid range of the output rectangle's angle
Input value inRectangleOrientation RectangleOrientation::Type Horizontal Orientation of the output rectangle
Output value outBoundingRectangle Rectangle2D& Smallest bounding rectangle of the input points
Output value outCenter Optional<Point2D&> NIL Center of the bounding rectangle
Output value outLongSide Optional<float&> NIL Length of the bounding rectangle long side
Output value outShortSide Optional<float&> NIL Length of the bounding rectangle short side

Optional Outputs

The computation of following outputs can be switched off by passing value atl::NIL to these parameters: outCenter, outLongSide, outShortSide.

Read more about Optional Outputs.

Description

The filter computes a rectangle with the smallest possible selected feature that contains all given points. The angle of the resulting rectangle is then normalized as in the NormalizeRectangleOrientation filter.

Examples

The resulting outBoundingRectangle drawn with the input points and with inRectangleOrientation set on Horizontal

Errors

List of possible exceptions:

Error type Description
DomainError Incorrect BoundingRectangleFeature in PointsBoundingRectangle.
DomainError No points on input in PointsBoundingRectangle.

See Also