Back to FabImage Studio website

You are here: Start » Filter Reference » Region » Region Basics » CreateRingRegion

CreateRingRegion

Basic

Module: FoundationLite

Creates a ring-shaped region with given parameters.

Name Type Range Description
Input value
 inCircle Circle2D Input circle
Input value
 inCircleAlignment CoordinateSystem2D* Adjusts the circle to the position of the inspected object
Input value
 inRingWidth Real 0.0 -
Input value
 inBorderPosition BorderPosition
Input value
 inFrameWidth Integer 0 - 65535 Width of the created region's frame
Input value
 inFrameHeight Integer 0 - 65535 Height of the created region's frame
Output value
 outRegion Region Output region
Output value
 outAlignedCircle Circle2D The input circle transformed to the absolute coordinate system

Errors

This filter can throw an exception to report error. Read how to deal with errors in Error Handling.

List of possible exceptions:

Error type Description
DomainError Incorrect BorderPosition in CreateRingRegion.

Complexity Level

This filter is available on Basic Complexity Level.