You are here: Start » FIL.NET » Function Reference » Region » Region Features » FIL.RegionBoundingRectangle
Computes the smallest rectangle containing a region.
Namespace: | FilNet |
---|---|
Assembly: | FIL.NET.dll |
Syntax
C++
C#
public static void RegionBoundingRectangle ( FilNet.Region inRegion, FilNet.BoundingRectangleFeature inBoundingRectangleFeature, float inReferenceAngle, FilNet.RectangleOrientation inRectangleOrientation, out FilNet.Rectangle2D outBoundingRectangle, NullableValue<FilNet.Point2D> outCenter, NullableValue<float> outLongSide, NullableValue<float> outShortSide )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
![]() | inRegion | FilNet.Region | Input region. | ||
![]() | inBoundingRectangleFeature | FilNet.BoundingRectangleFeature | MinimalArea | Determines what kind of bounding rectangle will be computed. Default value: MinimalArea. | |
![]() | inReferenceAngle | float | 0.0f | The middle angle of the valid range of the output rectangle's angle. Default value: 0.0f. | |
![]() | inRectangleOrientation | FilNet.RectangleOrientation | Horizontal | Orientation of the output rectangle. Default value: Horizontal. | |
![]() | outBoundingRectangle | FilNet.Rectangle2D | The smallest bounding rectangle of the input region. | ||
![]() | outCenter | FilNet.NullableValue<FilNet.Point2D> | Center of the bounding rectangle. Can be null to skip this parameter calculation. | ||
![]() | outLongSide | FilNet.NullableValue<float> | Length of the bounding rectangle long side. Can be null to skip this parameter calculation. | ||
![]() | outShortSide | FilNet.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
- RegionBoundingRectangle(Region, BoundingRectangleFeature, Single, RectangleOrientation, Rectangle2D)
- RegionBoundingRectangle(Region, BoundingRectangleFeature, Single, RectangleOrientation, Rectangle2D, Point2D, Single, Single)