You are here: Start » FIL.NET » Function Reference » Region » Region Basics » FIL.CreateRectangleRegion

FIL.CreateRectangleRegion

Creates a region corresponding to a given rectangle.

Namespace:FilNet
Assembly:FIL.NET.dll

Syntax

C++
C#
 
public static void CreateRectangleRegion
(
	FilNet.Rectangle2D inRectangle,
	FilNet.CoordinateSystem2D? inRectangleAlignment,
	int inFrameWidth,
	int inFrameHeight,
	FilNet.Region outRegion,
	out FilNet.Rectangle2D outAlignedRectangle
)

Parameters

Name Type Range Default Description
inRectangleFilNet.Rectangle2D
inRectangleAlignmentFilNet.CoordinateSystem2D?Adjusts the rectangle to the position of the inspected object. Default value: ftl::NIL.
inFrameWidthint<0, 65535>Width of the created region's frame (not to be confused with the width of the rectangle!).
inFrameHeightint<0, 65535>Height of the created region's frame (not to be confused with the height of the rectangle!).
outRegionFilNet.RegionOutput region.
outAlignedRectangleFilNet.Rectangle2DThe input rectangle transformed to the absolute coordinate system.

Description

The operation creates a region containing pixels lying inside the specified rectangle.

The inFrameWidth and inFrameHeight parameters most often should be set equal to the dimensions of the image this region will be used with. If the input rectangle exceeds these dimensions, the output region will be cropped.

Examples

Function Overrides

See also