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

FIL.CreateEllipseRegion

Creates an elliptic region of given bounding rectangle.

Namespace:FilNet
Assembly:FIL.NET.dll

Syntax

C++
C#
 
public static void CreateEllipseRegion
(
	FilNet.Rectangle2D inEllipse,
	FilNet.CoordinateSystem2D? inEllipseAlignment,
	int inFrameWidth,
	int inFrameHeight,
	FilNet.Region outRegion,
	NullableValue<FilNet.Rectangle2D> outAlignedEllipse
)

Parameters

Name Type Range Default Description
inEllipseFilNet.Rectangle2D
inEllipseAlignmentFilNet.CoordinateSystem2D?Adjusts the ellipse 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 ellipse!).
inFrameHeightint<0, 65535>Height of the created region's frame (not to be confused with the height of the ellipse!).
outRegionFilNet.RegionOutput region.
outAlignedEllipseFilNet.NullableValue<FilNet.Rectangle2D>The input ellipse transformed to the absolute coordinate system. Can be null to skip this parameter calculation.

Description

The operation creates a region containing pixels lying inside an ellipse which is described by its bounding 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 ellipse exceeds these dimensions, the output region will be cropped.

Examples

CreateEllipseRegion run with a sample rectangle.

Function Overrides

See also