Start » Filter Reference » Region » Region Basics » CreateEllipseRegion

CreateEllipseRegion

Basic

Module: FoundationLite

Creates an elliptic region of given bounding rectangle.

Name Type Range Description
Input value
 inEllipse Rectangle2D
Input value
 inEllipseAlignment CoordinateSystem2D* Adjusts the ellipse to the position of the inspected object
Input value
 inFrameWidth Integer 0 - 65535 Width of the created region's frame (not to be confused with the width of the ellipse!)
Input value
 inFrameHeight Integer 0 - 65535 Height of the created region's frame (not to be confused with the height of the ellipse!)
Output value
 outRegion Region Output region
Output value
 outAlignedEllipse Rectangle2D The input ellipse transformed to the absolute coordinate system

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.

Hints

  • Remember to set inFrameWidth and inFrameHeight inputs to specify the region frame.

Examples

CreateEllipseRegion run with a sample rectangle.

Complexity Level

This filter is available on Basic Complexity Level.

See Also