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

RegionBoundingRectangle

Computes the smallest rectangle containing a region.

Syntax

void avl::RegionBoundingRectangle
(
	const avl::Region& inRegion,
	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
)

void RegionBoundingRectangle
(
	Region inRegion,
	BoundingRectangleFeature inBoundingRectangleFeature,
	float inReferenceAngle,
	RectangleOrientation inRectangleOrientation,
	out Rectangle2D outBoundingRectangle,
	out Point2D? outCenter,
	out float? outLongSide,
	out float? outShortSide
)

Parameters

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

Description

The filter computes a rectangle with the smallest possible selected feature that contains all pixels belonging to the input region. The angle of the resulting rectangle is then normalized as in the NormalizeRectangleOrientation filter.

Hints

If the input region is not guaranteed to be non-empty, precede this filter with SkipEmptyRegion.

Examples

RegionBoundingRectangle performed on a sample region with inRectangleOrientation set on Vertical.

Errors

Error type	Description
DomainError	Empty region on input in RegionBoundingRectangle.