You are here: Start » FIL.NET » FIL.RegionCircularity
FIL.RegionCircularity
Computes the area of a region divided by the area of a circular region having the same feature.
| Namespace: | FilNet |
|---|---|
| Assembly: | FIL.NET.dll |
Syntax
public static void RegionCircularity ( FilNet.Region inRegion, FilNet.CircularityMeasure inCircularityMeasure, out float outCircularity )
Parameters
| Name | Type | Range | Default | Description | |
|---|---|---|---|---|---|
 | inRegion | FilNet.Region | Input region. | ||
| inCircularityMeasure | FilNet.CircularityMeasure | RadiusPreserving | Which algorithm should be used to compute a circle. Default value: RadiusPreserving. | |
 | outCircularity | float |
Description
Circularity is a measure of similarity of a region shape to the perfect circle. Circular regions have circularity close to 1.0, while the more elongated the region is (or contains more holes), the closer to 0.0 is its circularity.
Mathematically, the circularity is calculated as follows:
Where c denotes a
circular region having the same feature as input region r. The feature being considered depends on the inCircularityMeasure chosen and it is:
- the minimal bounding circle in case of BoundingCirclePreserving
- the perimeter in case of PerimeterPreserving
- the radius (maximal distance from mass center to any of the region pixels) in case of RadiusPreserving
Examples
Circularity with RadiusPreserving of the sample region equals to 0.667. |
Circularity with PerimeterPreserving of the sample region equals to 1.000. |
Errors
List of possible exceptions:
| Error type | Description |
|---|---|
| DomainError | Empty region on input in RegionCircularity. |
| DomainError | Not supported circularity measure in RegionCircularity. |
