Back to FabImage Library website

You are here: Start » Function Reference » Path » Path Features » PathBoundingRectangle

PathBoundingRectangle


Header: FIL.h
Namespace: fil
Module: FoundationBasic

Computes the smallest rectangle containing a path.

Syntax

C++
C#
 
void fil::PathBoundingRectangle
(
	const fil::Path& inPath,
	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
Input value inPath const Path& Input path
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& The smallest bounding rectangle of the input path
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 ftl::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 points of the given path. The angle of the resulting rectangle is then normalized as in the NormalizeRectangleOrientation filter.

Errors

List of possible exceptions:

Error type Description
DomainError Empty path on input in PathBoundingRectangle.

See Also