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

RegionBoundingRectangle

Header:	FIL.h
Namespace:	fil
Module:	FoundationBasic

Computes the smallest rectangle containing a region.

Syntax

void fil::RegionBoundingRectangle
(
	const fil::Region& inRegion,
	fil::BoundingRectangleFeature::Type inBoundingRectangleFeature,
	float inReferenceAngle,
	fil::RectangleOrientation::Type inRectangleOrientation,
	fil::Rectangle2D& outBoundingRectangle,
	ftl::Optional<fil::Point2D&> outCenter = ftl::NIL,
	ftl::Optional<float&> outLongSide = ftl::NIL,
	ftl::Optional<float&> outShortSide = ftl::NIL
)

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

Optional Outputs

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

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

List of possible exceptions:

Error type	Description
DomainError	Empty region on input in RegionBoundingRectangle.