Home / Classic / Circle
Classic

Circle

Circle finder and circle geometry tool for holes, rings, and round part features.

2 public methods

Import

from Xenonix.Classic import Circle

Search this API

Filter methods, arguments, and configuration keys on this page.

Configuration

Use Config(...) with these keys where the class exposes configuration.

This object does not expose a public Config table.

Public methods

Create

Creates a new Circle instance.

Create()

Arguments

No arguments.

Output

Creates a new Circle object.

Find

Runs the main operation and returns the detected/calculated result.

Find(Frame, Region=None, Type='Dark', Min_Area=20.0, Radius_Min=8.0, Radius_Max=4096.0, Image_Size=None, Circularity_Min=0.65, Aspect_Tol=0.35, Area_Ratio_Min=0.55, Area_Ratio_Max=1.45, Fit_Rms_Max=None, Mask_Erode=1, Reject_Border_Touch=True, Min_Points=20, Inlier_Dist=2.5, Ransac_Iters=20, Pair_Max_Dist=None, Radius_Mode='Fit', Contour_Mode='External', Pick='All', Index=None, Score=None, Fast_Mode=True, Contour_Points=1000, **KArgs)

Arguments

Argument Default Accepted values What it does
Frame Required Any valid value Input image/frame data. Can be an image object, array, or frame accepted by this tool.
Region None Any valid value Region of interest used to limit where the operation runs.
Type 'Dark' DARK, LIGHT Mode/value selector for type.
Min_Area 20.0 Any valid value Minimum area required by the operation.
Radius_Min 8.0 Any valid value Radius Min value used by the operation.
Radius_Max 4096.0 Any valid value Radius Max value used by the operation.
Image_Size None Any valid value Input image size used by the model/tool.
Circularity_Min 0.65 Any valid value Circularity Min value used by the operation.
Aspect_Tol 0.35 Any valid value Aspect Tol value used by the operation.
Area_Ratio_Min 0.55 Any valid value Area Ratio Min value used by the operation.
Area_Ratio_Max 1.45 Any valid value Area Ratio Max value used by the operation.
Fit_Rms_Max None Any valid value Fit Rms Max value used by the operation.
Mask_Erode 1 Any valid value Mask Erode value used by the operation.
Reject_Border_Touch True Any valid value Turns reject border touch on or off.
Min_Points 20 Any valid value Minimum points required by the operation.
Inlier_Dist 2.5 Any valid value Maximum distance for a candidate point to count as an inlier.
Ransac_Iters 20 Any valid value Number of random fitting attempts used by RANSAC.
Pair_Max_Dist None Any valid value Maximum distance allowed between paired points/features.
Radius_Mode 'Fit' FIT, INNER, OUTER, BOTH, MIN, MAX, MIN_MAX Mode/value selector for radius mode.
Contour_Mode 'External' EXTERNAL, INTERNAL, BOTH Mode/value selector for contour mode.
Pick 'All' ALL, FIRST, BEST, BEST_FIRST, BEST_TWO, INDEX Selects which candidate/result should be returned.
Index None Any valid value Index value used by the operation.
Score None Any valid value Score value used by the operation.
Fast_Mode True Any valid value When True, uses faster approximations or reduced processing where supported.
Contour_Points 1000 Any valid value Contour Points value used by the operation.
KArgs **kwargs Any valid value KArgs value used by the operation.

Output

Returns structured data such as a list or dictionary.