You are here: Start » AVL.NET » Function Reference » Region » Region Features » AVL.RegionBoundingRectangle

AVL.RegionBoundingRectangle

Computes the smallest rectangle containing a region.

Namespace:AvlNet
Assembly:AVL.NET.dll

Syntax

C++
C#
 
public static void RegionBoundingRectangle
(
	AvlNet.Region inRegion,
	AvlNet.BoundingRectangleFeature inBoundingRectangleFeature,
	float inReferenceAngle,
	AvlNet.RectangleOrientation inRectangleOrientation,
	out AvlNet.Rectangle2D outBoundingRectangle,
	NullableValue<AvlNet.Point2D> outCenter,
	NullableValue<float> outLongSide,
	NullableValue<float> outShortSide
)

Parameters

Name Type Range Default Description
inRegionAvlNet.RegionInput region.
inBoundingRectangleFeatureAvlNet.BoundingRectangleFeatureMinimalAreaDetermines what kind of bounding rectangle will be computed. Default value: MinimalArea.
inReferenceAnglefloat0.0fThe middle angle of the valid range of the output rectangle's angle. Default value: 0.0f.
inRectangleOrientationAvlNet.RectangleOrientationHorizontalOrientation of the output rectangle. Default value: Horizontal.
outBoundingRectangleAvlNet.Rectangle2DThe smallest bounding rectangle of the input region.
outCenterAvlNet.NullableValue<AvlNet.Point2D>Center of the bounding rectangle. Can be null to skip this parameter calculation.
outLongSideAvlNet.NullableValue<float>Length of the bounding rectangle long side. Can be null to skip this parameter calculation.
outShortSideAvlNet.NullableValue<float>Length of the bounding rectangle short side. Can be null to skip this parameter calculation.

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.

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.

Function Overrides

See also