Home / Classic / Edge
Classic

Edge

Edge detection and edge grouping tool for lines, contours, and feature extraction.

2 public methods

Import

from Xenonix.Classic import Edge

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 Edge instance.

Create()

Arguments

No arguments.

Output

Creates a new Edge object.

Find

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

Find(Frame, Region=None, Angle=None, Width=3, Length=None, Merge=None, Percentile=None, Pick='All', Index=None, Score=None, Inlier_Dist=4.0, Ransac_Iters=20, Min_Inliers=20, Batch_Size=16, Pair_Max_Dist=100.0, Max_Gap=5.0, Min_Contig_Frac=0.6, Max_Perp_Rms=2.0, Min_Proj_Len=120.0, Nms_Dist=20.0, Nms_Ang=3.0, Image_Size=None, Use_Edge_Points=True, Grid_Step=None, Max_Points=5000, Max_Per_Label=3000, Fast_Mode=True, Denoise=False, **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.
Angle None Any valid value Angle in degrees unless the method says otherwise.
Width 3 Any valid value Width in pixels, world units, or widget units depending on the class.
Length None Any valid value Length value used by the operation.
Merge None Any valid value Merge value used by the operation.
Percentile None Any valid value Percentile value used by the operation.
Pick 'All' BEST, BEST_LAST, BEST_FIRST, FIRST, BIGGEST_GAP, ALL, BEST_TWO, SHORTEST_GAP, LAST 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.
Inlier_Dist 4.0 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.
Min_Inliers 20 Any valid value Minimum inlier count required to accept a fitted result.
Batch_Size 16 Any valid value Number of items processed per batch.
Pair_Max_Dist 100.0 Any valid value Maximum distance allowed between paired points/features.
Max_Gap 5.0 Any valid value Maximum allowed gap before a continuous feature is split.
Min_Contig_Frac 0.6 Any valid value Minimum contiguous fraction required to keep a detected feature.
Max_Perp_Rms 2.0 Any valid value Maximum perpendicular RMS error allowed for a fitted line/edge.
Min_Proj_Len 120.0 Any valid value Minimum projected feature length required to keep a result.
Nms_Dist 20.0 Any valid value Distance threshold used when removing duplicate detections.
Nms_Ang 3.0 Any valid value Angle threshold used when removing duplicate detections.
Image_Size None Any valid value Input image size used by the model/tool.
Use_Edge_Points True Any valid value When True, uses detected edge points directly instead of broader image samples.
Grid_Step None Any valid value Spacing used when sampling a grid of candidate points.
Max_Points 5000 Any valid value Maximum number of points to keep/use.
Max_Per_Label 3000 Any valid value Maximum number of points/features kept per label/group.
Fast_Mode True Any valid value When True, uses faster approximations or reduced processing where supported.
Denoise False Any valid value When True, applies denoising before the main operation.
KArgs **kwargs Any valid value KArgs value used by the operation.

Output

Returns structured data such as a list or dictionary.