Home / Classic / Region
Classic

Region

Region/ROI toolkit for points, rectangles, circles, polygons, masks, and coordinate conversions.

13 nested API groups

Import

from Xenonix.Classic import Region

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.

Nested APIs

These are public helper types grouped under the main class.

Point

Point API available from the Classic library.

Configuration

This object does not expose a public Config table.

Methods

Create

Creates a new Point instance.

Create(X=0.0, Y=0.0, Score=0.0, ID=0, Label=0, Class=None)

Arguments

Argument Default Accepted values What it does
X 0.0 Any valid value X coordinate or horizontal value.
Y 0.0 Any valid value Y coordinate or vertical value.
Score 0.0 Any valid value Score value used by the operation.
ID 0 Any valid value ID value used by the operation.
Label 0 Any valid value Label value used by the operation.
Class None Any valid value Class value used by the operation.

Output

Creates a new Point object.

Type

Runs the Type operation for Point.

Type()

Arguments

No arguments.

Output

Returns the calculated result.

Graphics

Runs the Graphics operation for Point.

Graphics(Color=None, Thickness=None, Shift=None, Size=None)

Arguments

Argument Default Accepted values What it does
Color None Any valid value Color used for drawing or display.
Thickness None Any valid value Line/outline thickness used for drawing.
Shift None Any valid value Shift value used by the operation.
Size None Any valid value Size value used by the operation or widget.

Output

Returns structured data such as a list or dictionary.

Score

Runs the Score operation for Point.

Score(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

ID

Runs the ID operation for Point.

ID(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Label

Runs the Label operation for Point.

Label(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Class

Runs the Class operation for Point.

Class(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

X

Runs the X operation for Point.

X(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Y

Runs the Y operation for Point.

Y(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Translate

Runs the Translate operation for Point.

Translate(X=None, Y=None)

Arguments

Argument Default Accepted values What it does
X None Any valid value X coordinate or horizontal value.
Y None Any valid value Y coordinate or vertical value.

Output

Runs the operation. Some methods update the object in place.

Transpose

Runs the Transpose operation for Point.

Transpose(Point, Angle)

Arguments

Argument Default Accepted values What it does
Point Required Any valid value Point value used by the operation.
Angle Required Any valid value Angle in degrees unless the method says otherwise.

Output

Runs the operation. Some methods update the object in place.

Resize

Runs the Resize operation for Point.

Resize(Percentage=None)

Arguments

Argument Default Accepted values What it does
Percentage None Any valid value Percentage value used by the operation.

Output

Returns the object, so the call can be chained.

Locate

Runs the Locate operation for Point.

Locate(Cross, Reference)

Arguments

Argument Default Accepted values What it does
Cross Required Any valid value Cross value used by the operation.
Reference Required Any valid value Reference value used by the operation.

Output

Returns the object, so the call can be chained.

Copy

Creates a copy of the object, optionally with supplied data.

Copy()

Arguments

No arguments.

Output

Returns a copy of the object.

To_Tuple

Runs the To_Tuple operation for Point.

To_Tuple()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

Distance

Calculates distance between features or points.

Distance(P)

Arguments

Argument Default Accepted values What it does
P Required Any valid value P value used by the operation.

Output

Returns a numeric distance.

Cross

Cross API available from the Classic library.

Configuration

This object does not expose a public Config table.

Methods

Create

Creates a new Cross instance.

Create(X=0.0, Y=0.0, Angle=0.0, Scale=0.0, Score=0.0, ID=0, Label=0, Class=None)

Arguments

Argument Default Accepted values What it does
X 0.0 Any valid value X coordinate or horizontal value.
Y 0.0 Any valid value Y coordinate or vertical value.
Angle 0.0 Any valid value Angle in degrees unless the method says otherwise.
Scale 0.0 Any valid value Scale value used by the operation.
Score 0.0 Any valid value Score value used by the operation.
ID 0 Any valid value ID value used by the operation.
Label 0 Any valid value Label value used by the operation.
Class None Any valid value Class value used by the operation.

Output

Creates a new Cross object.

Type

Runs the Type operation for Cross.

Type()

Arguments

No arguments.

Output

Returns the calculated result.

Graphics

Runs the Graphics operation for Cross.

Graphics(Color=None, Thickness=None, Shift=None, Size=None)

Arguments

Argument Default Accepted values What it does
Color None Any valid value Color used for drawing or display.
Thickness None Any valid value Line/outline thickness used for drawing.
Shift None Any valid value Shift value used by the operation.
Size None Any valid value Size value used by the operation or widget.

Output

Returns structured data such as a list or dictionary.

X

Runs the X operation for Cross.

X(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Y

Runs the Y operation for Cross.

Y(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Angle

Calculates or applies angle/rotation behavior.

Angle(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns or applies an angle value.

Scale

Scales the object/data by the requested amount.

Scale(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Score

Runs the Score operation for Cross.

Score(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

ID

Runs the ID operation for Cross.

ID(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Label

Runs the Label operation for Cross.

Label(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Class

Runs the Class operation for Cross.

Class(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Translate

Runs the Translate operation for Cross.

Translate(X=None, Y=None)

Arguments

Argument Default Accepted values What it does
X None Any valid value X coordinate or horizontal value.
Y None Any valid value Y coordinate or vertical value.

Output

Runs the operation. Some methods update the object in place.

Transpose

Runs the Transpose operation for Cross.

Transpose(Point, Angle)

Arguments

Argument Default Accepted values What it does
Point Required Any valid value Point value used by the operation.
Angle Required Any valid value Angle in degrees unless the method says otherwise.

Output

Runs the operation. Some methods update the object in place.

Resize

Runs the Resize operation for Cross.

Resize(Percentage=None)

Arguments

Argument Default Accepted values What it does
Percentage None Any valid value Percentage value used by the operation.

Output

Returns the object, so the call can be chained.

Rotate

Rotates the object/data by the requested angle.

Rotate(Value)

Arguments

Argument Default Accepted values What it does
Value Required Any valid value Value to set or process.

Output

Runs the operation. Some methods update the object in place.

Locate

Runs the Locate operation for Cross.

Locate(Cross, Reference)

Arguments

Argument Default Accepted values What it does
Cross Required Any valid value Cross value used by the operation.
Reference Required Any valid value Reference value used by the operation.

Output

Returns the object, so the call can be chained.

Copy

Creates a copy of the object, optionally with supplied data.

Copy()

Arguments

No arguments.

Output

Returns a copy of the object.

To_Tuple

Runs the To_Tuple operation for Cross.

To_Tuple()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

Distance

Calculates distance between features or points.

Distance(P)

Arguments

Argument Default Accepted values What it does
P Required Any valid value P value used by the operation.

Output

Returns a numeric distance.

Line

Line finder and line geometry tool used for edges, gaps, distances, and measurements.

Configuration

This object does not expose a public Config table.

Methods

Create

Creates a new Line instance.

Create(X1=0.0, Y1=0.0, X2=0.0, Y2=0.0, Score=0.0, ID=0, Label=0, Class=None)

Arguments

Argument Default Accepted values What it does
X1 0.0 Any valid value X1 value used by the operation.
Y1 0.0 Any valid value Y1 value used by the operation.
X2 0.0 Any valid value X2 value used by the operation.
Y2 0.0 Any valid value Y2 value used by the operation.
Score 0.0 Any valid value Score value used by the operation.
ID 0 Any valid value ID value used by the operation.
Label 0 Any valid value Label value used by the operation.
Class None Any valid value Class value used by the operation.

Output

Creates a new Line object.

Type

Runs the Type operation for Line.

Type()

Arguments

No arguments.

Output

Returns the calculated result.

Graphics

Runs the Graphics operation for Line.

Graphics(Color=None, Thickness=None, Shift=None, Size=None)

Arguments

Argument Default Accepted values What it does
Color None Any valid value Color used for drawing or display.
Thickness None Any valid value Line/outline thickness used for drawing.
Shift None Any valid value Shift value used by the operation.
Size None Any valid value Size value used by the operation or widget.

Output

Returns structured data such as a list or dictionary.

Points

Runs the Points operation for Line.

Points()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

Length

Runs the Length operation for Line.

Length()

Arguments

No arguments.

Output

Returns the calculated result.

Midpoint

Runs the Midpoint operation for Line.

Midpoint()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

Angle

Calculates or applies angle/rotation behavior.

Angle(Line=None)

Arguments

Argument Default Accepted values What it does
Line None Any valid value Line value used by the operation.

Output

Returns or applies an angle value.

Translate

Runs the Translate operation for Line.

Translate(X=None, Y=None)

Arguments

Argument Default Accepted values What it does
X None Any valid value X coordinate or horizontal value.
Y None Any valid value Y coordinate or vertical value.

Output

Runs the operation. Some methods update the object in place.

Transpose

Runs the Transpose operation for Line.

Transpose(Point, Angle)

Arguments

Argument Default Accepted values What it does
Point Required Any valid value Point value used by the operation.
Angle Required Any valid value Angle in degrees unless the method says otherwise.

Output

Runs the operation. Some methods update the object in place.

Resize

Runs the Resize operation for Line.

Resize(Percentage=None)

Arguments

Argument Default Accepted values What it does
Percentage None Any valid value Percentage value used by the operation.

Output

Returns the object, so the call can be chained.

Locate

Runs the Locate operation for Line.

Locate(Cross, Reference)

Arguments

Argument Default Accepted values What it does
Cross Required Any valid value Cross value used by the operation.
Reference Required Any valid value Reference value used by the operation.

Output

Returns the object, so the call can be chained.

Rotate

Rotates the object/data by the requested angle.

Rotate(Angle, About_Point=None)

Arguments

Argument Default Accepted values What it does
Angle Required Any valid value Angle in degrees unless the method says otherwise.
About_Point None Any valid value About Point value used by the operation.

Output

Runs the operation. Some methods update the object in place.

Copy

Creates a copy of the object, optionally with supplied data.

Copy()

Arguments

No arguments.

Output

Returns a copy of the object.

BBox

Runs the BBox operation for Line.

BBox()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

X1

Runs the X1 operation for Line.

X1(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Y1

Runs the Y1 operation for Line.

Y1(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

X2

Runs the X2 operation for Line.

X2(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Y2

Runs the Y2 operation for Line.

Y2(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Score

Runs the Score operation for Line.

Score(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

ID

Runs the ID operation for Line.

ID(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Label

Runs the Label operation for Line.

Label(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Class

Runs the Class operation for Line.

Class(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Expand

Runs the Expand operation for Line.

Expand(Value)

Arguments

Argument Default Accepted values What it does
Value Required Any valid value Value to set or process.

Output

Returns the object, so the call can be chained.

Shrink

Runs the Shrink operation for Line.

Shrink(Value)

Arguments

Argument Default Accepted values What it does
Value Required Any valid value Value to set or process.

Output

Returns the object, so the call can be chained.

Join

Runs the Join operation for Line.

Join(L, Copy=True)

Arguments

Argument Default Accepted values What it does
L Required Any valid value L value used by the operation.
Copy True Any valid value When True, returns a copied object/result. When False, updates the supplied/current object where supported.

Output

Returns the calculated result.

Midline

Runs the Midline operation for Line.

Midline(L, Copy=True)

Arguments

Argument Default Accepted values What it does
L Required Any valid value L value used by the operation.
Copy True Any valid value When True, returns a copied object/result. When False, updates the supplied/current object where supported.

Output

Returns the object, so the call can be chained.

Distance

Calculates distance between features or points.

Distance(P, Segment=False)

Arguments

Argument Default Accepted values What it does
P Required Any valid value P value used by the operation.
Segment False Any valid value Turns segment on or off.

Output

Returns a numeric distance.

Closest

Runs the Closest operation for Line.

Closest(P, Segment=True)

Arguments

Argument Default Accepted values What it does
P Required Any valid value P value used by the operation.
Segment True Any valid value Turns segment on or off.

Output

Returns structured data such as a list or dictionary.

Intersect

Runs the Intersect operation for Line.

Intersect(L, Segment=False)

Arguments

Argument Default Accepted values What it does
L Required Any valid value L value used by the operation.
Segment False Any valid value Turns segment on or off.

Output

Returns structured data such as a list or dictionary.

Polyline

Polyline API available from the Classic library.

Configuration

This object does not expose a public Config table.

Methods

Create

Creates a new Polyline instance.

Create(Points=None, Score=0.0, ID=0, Label=0, Class=None)

Arguments

Argument Default Accepted values What it does
Points None Any valid value Point data, usually Nx2 or Nx3.
Score 0.0 Any valid value Score value used by the operation.
ID 0 Any valid value ID value used by the operation.
Label 0 Any valid value Label value used by the operation.
Class None Any valid value Class value used by the operation.

Output

Creates a new Polyline object.

Type

Runs the Type operation for Polyline.

Type()

Arguments

No arguments.

Output

Returns the calculated result.

Graphics

Runs the Graphics operation for Polyline.

Graphics(Color=None, Thickness=None, Shift=None, Size=None)

Arguments

Argument Default Accepted values What it does
Color None Any valid value Color used for drawing or display.
Thickness None Any valid value Line/outline thickness used for drawing.
Shift None Any valid value Shift value used by the operation.
Size None Any valid value Size value used by the operation or widget.

Output

Returns structured data such as a list or dictionary.

Add

Adds a new item to the object or UI.

Add(X, Y)

Arguments

Argument Default Accepted values What it does
X Required Any valid value X coordinate or horizontal value.
Y Required Any valid value Y coordinate or vertical value.

Output

Returns the object, so the call can be chained.

Remove

Removes the requested item.

Remove(Index)

Arguments

Argument Default Accepted values What it does
Index Required Any valid value Index value used by the operation.

Output

Returns the object, so the call can be chained.

Remove_Point

Removes the requested item.

Remove_Point(X, Y, Tolerance=1.0)

Arguments

Argument Default Accepted values What it does
X Required Any valid value X coordinate or horizontal value.
Y Required Any valid value Y coordinate or vertical value.
Tolerance 1.0 Any valid value Tolerance value used by the operation.

Output

Returns the object, so the call can be chained.

Points

Runs the Points operation for Polyline.

Points()

Arguments

No arguments.

Output

Returns the calculated result.

Score

Runs the Score operation for Polyline.

Score(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

ID

Runs the ID operation for Polyline.

ID(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Label

Runs the Label operation for Polyline.

Label(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Class

Runs the Class operation for Polyline.

Class(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Count

Runs the Count operation for Polyline.

Count()

Arguments

No arguments.

Output

Returns the calculated result.

Expand

Runs the Expand operation for Polyline.

Expand(Value)

Arguments

Argument Default Accepted values What it does
Value Required Any valid value Value to set or process.

Output

Returns the object, so the call can be chained.

Shrink

Runs the Shrink operation for Polyline.

Shrink(Value)

Arguments

Argument Default Accepted values What it does
Value Required Any valid value Value to set or process.

Output

Returns the object, so the call can be chained.

Translate

Runs the Translate operation for Polyline.

Translate(X=None, Y=None)

Arguments

Argument Default Accepted values What it does
X None Any valid value X coordinate or horizontal value.
Y None Any valid value Y coordinate or vertical value.

Output

Runs the operation. Some methods update the object in place.

Transpose

Runs the Transpose operation for Polyline.

Transpose(Point, Angle)

Arguments

Argument Default Accepted values What it does
Point Required Any valid value Point value used by the operation.
Angle Required Any valid value Angle in degrees unless the method says otherwise.

Output

Runs the operation. Some methods update the object in place.

Resize

Runs the Resize operation for Polyline.

Resize(Percentage=None)

Arguments

Argument Default Accepted values What it does
Percentage None Any valid value Percentage value used by the operation.

Output

Returns the object, so the call can be chained.

Locate

Runs the Locate operation for Polyline.

Locate(Cross, Reference)

Arguments

Argument Default Accepted values What it does
Cross Required Any valid value Cross value used by the operation.
Reference Required Any valid value Reference value used by the operation.

Output

Returns the object, so the call can be chained.

Copy

Creates a copy of the object, optionally with supplied data.

Copy()

Arguments

No arguments.

Output

Returns a copy of the object.

BBox

Runs the BBox operation for Polyline.

BBox()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

Length

Runs the Length operation for Polyline.

Length()

Arguments

No arguments.

Output

Returns the calculated result.

Distance

Calculates distance between features or points.

Distance(P)

Arguments

Argument Default Accepted values What it does
P Required Any valid value P value used by the operation.

Output

Returns a numeric distance.

Contains

Runs the Contains operation for Polyline.

Contains(P, Inclusive=True, Tolerance=1.5)

Arguments

Argument Default Accepted values What it does
P Required Any valid value P value used by the operation.
Inclusive True Any valid value Turns inclusive on or off.
Tolerance 1.5 Any valid value Tolerance value used by the operation.

Output

Returns True/False to indicate success.

Arc

Arc geometry and arc detection helper.

Configuration

This object does not expose a public Config table.

Methods

Create

Creates a new Arc instance.

Create(X=0.0, Y=0.0, Radius=0.0, Start=0.0, End=360.0, Score=0.0, ID=0, Label=0, Class=None)

Arguments

Argument Default Accepted values What it does
X 0.0 Any valid value X coordinate or horizontal value.
Y 0.0 Any valid value Y coordinate or vertical value.
Radius 0.0 Any valid value Radius value.
Start 0.0 Any valid value Start value used by the operation.
End 360.0 Any valid value End value used by the operation.
Score 0.0 Any valid value Score value used by the operation.
ID 0 Any valid value ID value used by the operation.
Label 0 Any valid value Label value used by the operation.
Class None Any valid value Class value used by the operation.

Output

Creates a new Arc object.

Type

Runs the Type operation for Arc.

Type()

Arguments

No arguments.

Output

Returns the calculated result.

Graphics

Runs the Graphics operation for Arc.

Graphics(Color=None, Thickness=None, Shift=None, Size=None)

Arguments

Argument Default Accepted values What it does
Color None Any valid value Color used for drawing or display.
Thickness None Any valid value Line/outline thickness used for drawing.
Shift None Any valid value Shift value used by the operation.
Size None Any valid value Size value used by the operation or widget.

Output

Returns structured data such as a list or dictionary.

X

Runs the X operation for Arc.

X(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Y

Runs the Y operation for Arc.

Y(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Radius

Runs the Radius operation for Arc.

Radius(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Start

Starts the process or connection.

Start(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns success/status or the operation result.

End

Runs the End operation for Arc.

End(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Score

Runs the Score operation for Arc.

Score(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

ID

Runs the ID operation for Arc.

ID(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Label

Runs the Label operation for Arc.

Label(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Class

Runs the Class operation for Arc.

Class(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Translate

Runs the Translate operation for Arc.

Translate(X=None, Y=None)

Arguments

Argument Default Accepted values What it does
X None Any valid value X coordinate or horizontal value.
Y None Any valid value Y coordinate or vertical value.

Output

Runs the operation. Some methods update the object in place.

Transpose

Runs the Transpose operation for Arc.

Transpose(Point, Angle)

Arguments

Argument Default Accepted values What it does
Point Required Any valid value Point value used by the operation.
Angle Required Any valid value Angle in degrees unless the method says otherwise.

Output

Runs the operation. Some methods update the object in place.

Resize

Runs the Resize operation for Arc.

Resize(Percentage=None)

Arguments

Argument Default Accepted values What it does
Percentage None Any valid value Percentage value used by the operation.

Output

Returns the object, so the call can be chained.

Locate

Runs the Locate operation for Arc.

Locate(Cross, Reference)

Arguments

Argument Default Accepted values What it does
Cross Required Any valid value Cross value used by the operation.
Reference Required Any valid value Reference value used by the operation.

Output

Returns the object, so the call can be chained.

Copy

Creates a copy of the object, optionally with supplied data.

Copy()

Arguments

No arguments.

Output

Returns a copy of the object.

Sweep

Runs the Sweep operation for Arc.

Sweep()

Arguments

No arguments.

Output

Returns the calculated result.

Length

Runs the Length operation for Arc.

Length()

Arguments

No arguments.

Output

Returns the calculated result.

Chord

Runs the Chord operation for Arc.

Chord()

Arguments

No arguments.

Output

Returns the calculated result.

Area

Runs the Area operation for Arc.

Area()

Arguments

No arguments.

Output

Returns the calculated result.

BBox

Runs the BBox operation for Arc.

BBox()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

Contains

Runs the Contains operation for Arc.

Contains(P, Inclusive=True, Tolerance=1.5)

Arguments

Argument Default Accepted values What it does
P Required Any valid value P value used by the operation.
Inclusive True Any valid value Turns inclusive on or off.
Tolerance 1.5 Any valid value Tolerance value used by the operation.

Output

Returns True/False to indicate success.

Circle

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

Configuration

This object does not expose a public Config table.

Methods

Create

Creates a new Circle instance.

Create(X=0, Y=0, Radius=0, Score=0.0, ID=0, Label=0, Class=None)

Arguments

Argument Default Accepted values What it does
X 0 Any valid value X coordinate or horizontal value.
Y 0 Any valid value Y coordinate or vertical value.
Radius 0 Any valid value Radius value.
Score 0.0 Any valid value Score value used by the operation.
ID 0 Any valid value ID value used by the operation.
Label 0 Any valid value Label value used by the operation.
Class None Any valid value Class value used by the operation.

Output

Creates a new Circle object.

Type

Runs the Type operation for Circle.

Type()

Arguments

No arguments.

Output

Returns the calculated result.

Graphics

Runs the Graphics operation for Circle.

Graphics(Color=None, Thickness=None, Shift=None, Size=None)

Arguments

Argument Default Accepted values What it does
Color None Any valid value Color used for drawing or display.
Thickness None Any valid value Line/outline thickness used for drawing.
Shift None Any valid value Shift value used by the operation.
Size None Any valid value Size value used by the operation or widget.

Output

Returns structured data such as a list or dictionary.

Area

Runs the Area operation for Circle.

Area()

Arguments

No arguments.

Output

Returns the calculated result.

Circumference

Runs the Circumference operation for Circle.

Circumference()

Arguments

No arguments.

Output

Returns the calculated result.

Diameter

Runs the Diameter operation for Circle.

Diameter()

Arguments

No arguments.

Output

Returns the calculated result.

BBox

Runs the BBox operation for Circle.

BBox()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

Contour

Runs the Contour operation for Circle.

Contour()

Arguments

No arguments.

Output

Returns the calculated result.

Distance

Calculates distance between features or points.

Distance(P)

Arguments

Argument Default Accepted values What it does
P Required Any valid value P value used by the operation.

Output

Returns a numeric distance.

Contains

Runs the Contains operation for Circle.

Contains(P, Inclusive=True)

Arguments

Argument Default Accepted values What it does
P Required Any valid value P value used by the operation.
Inclusive True Any valid value Turns inclusive on or off.

Output

Returns the calculated result.

Score

Runs the Score operation for Circle.

Score(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

ID

Runs the ID operation for Circle.

ID(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Label

Runs the Label operation for Circle.

Label(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Class

Runs the Class operation for Circle.

Class(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

X

Runs the X operation for Circle.

X(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Y

Runs the Y operation for Circle.

Y(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Radius

Runs the Radius operation for Circle.

Radius(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Expand

Runs the Expand operation for Circle.

Expand(Value)

Arguments

Argument Default Accepted values What it does
Value Required Any valid value Value to set or process.

Output

Returns the object, so the call can be chained.

Shrink

Runs the Shrink operation for Circle.

Shrink(Value)

Arguments

Argument Default Accepted values What it does
Value Required Any valid value Value to set or process.

Output

Returns the object, so the call can be chained.

Translate

Runs the Translate operation for Circle.

Translate(X=None, Y=None)

Arguments

Argument Default Accepted values What it does
X None Any valid value X coordinate or horizontal value.
Y None Any valid value Y coordinate or vertical value.

Output

Runs the operation. Some methods update the object in place.

Transpose

Runs the Transpose operation for Circle.

Transpose(Point, Angle)

Arguments

Argument Default Accepted values What it does
Point Required Any valid value Point value used by the operation.
Angle Required Any valid value Angle in degrees unless the method says otherwise.

Output

Runs the operation. Some methods update the object in place.

Resize

Runs the Resize operation for Circle.

Resize(Percentage=None)

Arguments

Argument Default Accepted values What it does
Percentage None Any valid value Percentage value used by the operation.

Output

Returns the object, so the call can be chained.

Locate

Runs the Locate operation for Circle.

Locate(Cross, Reference)

Arguments

Argument Default Accepted values What it does
Cross Required Any valid value Cross value used by the operation.
Reference Required Any valid value Reference value used by the operation.

Output

Returns the object, so the call can be chained.

Copy

Creates a copy of the object, optionally with supplied data.

Copy()

Arguments

No arguments.

Output

Returns a copy of the object.

Polygon

Runs the Polygon operation for Circle.

Polygon(Count=128)

Arguments

Argument Default Accepted values What it does
Count 128 Any valid value Count value used by the operation.

Output

Returns the calculated result.

Intersection

Runs the Intersection operation for Circle.

Intersection(R)

Arguments

Argument Default Accepted values What it does
R Required Circle, Rectangle Mode/value selector for r.

Output

Returns the calculated result.

Annulus

Annulus API available from the Classic library.

Configuration

This object does not expose a public Config table.

Methods

Create

Creates a new Annulus instance.

Create(X=0.0, Y=0.0, Radius1=0.0, Radius2=0.0, Start=0.0, End=360.0, Score=0.0, ID=0, Label=0, Class=None)

Arguments

Argument Default Accepted values What it does
X 0.0 Any valid value X coordinate or horizontal value.
Y 0.0 Any valid value Y coordinate or vertical value.
Radius1 0.0 Any valid value Radius1 value used by the operation.
Radius2 0.0 Any valid value Radius2 value used by the operation.
Start 0.0 Any valid value Start value used by the operation.
End 360.0 Any valid value End value used by the operation.
Score 0.0 Any valid value Score value used by the operation.
ID 0 Any valid value ID value used by the operation.
Label 0 Any valid value Label value used by the operation.
Class None Any valid value Class value used by the operation.

Output

Creates a new Annulus object.

Type

Runs the Type operation for Annulus.

Type()

Arguments

No arguments.

Output

Returns the calculated result.

Graphics

Runs the Graphics operation for Annulus.

Graphics(Color=None, Thickness=None, Shift=None, Size=None)

Arguments

Argument Default Accepted values What it does
Color None Any valid value Color used for drawing or display.
Thickness None Any valid value Line/outline thickness used for drawing.
Shift None Any valid value Shift value used by the operation.
Size None Any valid value Size value used by the operation or widget.

Output

Returns structured data such as a list or dictionary.

X

Runs the X operation for Annulus.

X(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Y

Runs the Y operation for Annulus.

Y(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

R1

Runs the R1 operation for Annulus.

R1(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

R2

Runs the R2 operation for Annulus.

R2(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Start

Starts the process or connection.

Start(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns success/status or the operation result.

End

Runs the End operation for Annulus.

End(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Score

Runs the Score operation for Annulus.

Score(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

ID

Runs the ID operation for Annulus.

ID(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Label

Runs the Label operation for Annulus.

Label(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Class

Runs the Class operation for Annulus.

Class(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Translate

Runs the Translate operation for Annulus.

Translate(X=None, Y=None)

Arguments

Argument Default Accepted values What it does
X None Any valid value X coordinate or horizontal value.
Y None Any valid value Y coordinate or vertical value.

Output

Runs the operation. Some methods update the object in place.

Transpose

Runs the Transpose operation for Annulus.

Transpose(Point, Angle)

Arguments

Argument Default Accepted values What it does
Point Required Any valid value Point value used by the operation.
Angle Required Any valid value Angle in degrees unless the method says otherwise.

Output

Runs the operation. Some methods update the object in place.

Resize

Runs the Resize operation for Annulus.

Resize(Percentage=None)

Arguments

Argument Default Accepted values What it does
Percentage None Any valid value Percentage value used by the operation.

Output

Returns the object, so the call can be chained.

Locate

Runs the Locate operation for Annulus.

Locate(Cross, Reference)

Arguments

Argument Default Accepted values What it does
Cross Required Any valid value Cross value used by the operation.
Reference Required Any valid value Reference value used by the operation.

Output

Returns the object, so the call can be chained.

Copy

Creates a copy of the object, optionally with supplied data.

Copy()

Arguments

No arguments.

Output

Returns a copy of the object.

Sweep

Runs the Sweep operation for Annulus.

Sweep()

Arguments

No arguments.

Output

Returns the calculated result.

Area

Runs the Area operation for Annulus.

Area()

Arguments

No arguments.

Output

Returns the calculated result.

Length

Runs the Length operation for Annulus.

Length()

Arguments

No arguments.

Output

Returns the calculated result.

BBox

Runs the BBox operation for Annulus.

BBox()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

Contour

Runs the Contour operation for Annulus.

Contour()

Arguments

No arguments.

Output

Returns the calculated result.

Contains

Runs the Contains operation for Annulus.

Contains(P, Inclusive=True)

Arguments

Argument Default Accepted values What it does
P Required Any valid value P value used by the operation.
Inclusive True Any valid value Turns inclusive on or off.

Output

Returns True/False to indicate success.

Expand

Runs the Expand operation for Annulus.

Expand(Value)

Arguments

Argument Default Accepted values What it does
Value Required Any valid value Value to set or process.

Output

Returns the object, so the call can be chained.

Shrink

Runs the Shrink operation for Annulus.

Shrink(Value)

Arguments

Argument Default Accepted values What it does
Value Required Any valid value Value to set or process.

Output

Returns the object, so the call can be chained.

Rectangle

Rectangle API available from the Classic library.

Configuration

This object does not expose a public Config table.

Methods

Create

Creates a new Rectangle instance.

Create(X=0, Y=0, Width=0, Height=0, Angle=0.0, Score=0.0, ID=0, Label=0, Class=None)

Arguments

Argument Default Accepted values What it does
X 0 Any valid value X coordinate or horizontal value.
Y 0 Any valid value Y coordinate or vertical value.
Width 0 Any valid value Width in pixels, world units, or widget units depending on the class.
Height 0 Any valid value Height in pixels, world units, or widget units depending on the class.
Angle 0.0 Any valid value Angle in degrees unless the method says otherwise.
Score 0.0 Any valid value Score value used by the operation.
ID 0 Any valid value ID value used by the operation.
Label 0 Any valid value Label value used by the operation.
Class None Any valid value Class value used by the operation.

Output

Creates a new Rectangle object.

Type

Runs the Type operation for Rectangle.

Type()

Arguments

No arguments.

Output

Returns the calculated result.

Graphics

Runs the Graphics operation for Rectangle.

Graphics(Color=None, Thickness=None, Shift=None, Size=None)

Arguments

Argument Default Accepted values What it does
Color None Any valid value Color used for drawing or display.
Thickness None Any valid value Line/outline thickness used for drawing.
Shift None Any valid value Shift value used by the operation.
Size None Any valid value Size value used by the operation or widget.

Output

Returns structured data such as a list or dictionary.

Area

Runs the Area operation for Rectangle.

Area()

Arguments

No arguments.

Output

Returns the calculated result.

Perimeter

Runs the Perimeter operation for Rectangle.

Perimeter()

Arguments

No arguments.

Output

Returns the calculated result.

Diagonal

Runs the Diagonal operation for Rectangle.

Diagonal()

Arguments

No arguments.

Output

Returns the calculated result.

Cos_Sin

Runs the Cos_Sin operation for Rectangle.

Cos_Sin()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

Corners

Runs the Corners operation for Rectangle.

Corners()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

Midpoints

Runs the Midpoints operation for Rectangle.

Midpoints()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

BBox

Runs the BBox operation for Rectangle.

BBox()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

Contour

Runs the Contour operation for Rectangle.

Contour()

Arguments

No arguments.

Output

Returns the calculated result.

Distance

Calculates distance between features or points.

Distance(P)

Arguments

Argument Default Accepted values What it does
P Required Any valid value P value used by the operation.

Output

Returns a numeric distance.

Contains

Runs the Contains operation for Rectangle.

Contains(P, Inclusive=True)

Arguments

Argument Default Accepted values What it does
P Required Any valid value P value used by the operation.
Inclusive True Any valid value Turns inclusive on or off.

Output

Returns the calculated result.

X

Runs the X operation for Rectangle.

X(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Y

Runs the Y operation for Rectangle.

Y(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Width

Runs the Width operation for Rectangle.

Width(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Height

Runs the Height operation for Rectangle.

Height(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Angle

Calculates or applies angle/rotation behavior.

Angle(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns or applies an angle value.

Score

Runs the Score operation for Rectangle.

Score(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

ID

Runs the ID operation for Rectangle.

ID(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Label

Runs the Label operation for Rectangle.

Label(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Class

Runs the Class operation for Rectangle.

Class(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Expand

Runs the Expand operation for Rectangle.

Expand(Value)

Arguments

Argument Default Accepted values What it does
Value Required Any valid value Value to set or process.

Output

Returns the object, so the call can be chained.

Shrink

Runs the Shrink operation for Rectangle.

Shrink(Value)

Arguments

Argument Default Accepted values What it does
Value Required Any valid value Value to set or process.

Output

Returns the object, so the call can be chained.

Square

Runs the Square operation for Rectangle.

Square(Expand=True)

Arguments

Argument Default Accepted values What it does
Expand True Any valid value Turns expand on or off.

Output

Returns the object, so the call can be chained.

Translate

Runs the Translate operation for Rectangle.

Translate(X=None, Y=None)

Arguments

Argument Default Accepted values What it does
X None Any valid value X coordinate or horizontal value.
Y None Any valid value Y coordinate or vertical value.

Output

Runs the operation. Some methods update the object in place.

Transpose

Runs the Transpose operation for Rectangle.

Transpose(Point, Angle)

Arguments

Argument Default Accepted values What it does
Point Required Any valid value Point value used by the operation.
Angle Required Any valid value Angle in degrees unless the method says otherwise.

Output

Runs the operation. Some methods update the object in place.

Resize

Runs the Resize operation for Rectangle.

Resize(Percentage=None)

Arguments

Argument Default Accepted values What it does
Percentage None Any valid value Percentage value used by the operation.

Output

Returns the object, so the call can be chained.

Locate

Runs the Locate operation for Rectangle.

Locate(Cross, Reference)

Arguments

Argument Default Accepted values What it does
Cross Required Any valid value Cross value used by the operation.
Reference Required Any valid value Reference value used by the operation.

Output

Returns the object, so the call can be chained.

Rotate

Rotates the object/data by the requested angle.

Rotate(Value)

Arguments

Argument Default Accepted values What it does
Value Required Any valid value Value to set or process.

Output

Runs the operation. Some methods update the object in place.

Copy

Creates a copy of the object, optionally with supplied data.

Copy()

Arguments

No arguments.

Output

Returns a copy of the object.

Clip_Polygon

Runs the Clip_Polygon operation for Rectangle.

Clip_Polygon(Subject, Edge_P1, Edge_P2)

Arguments

Argument Default Accepted values What it does
Subject Required Any valid value Subject value used by the operation.
Edge_P1 Required Any valid value Edge P1 value used by the operation.
Edge_P2 Required Any valid value Edge P2 value used by the operation.

Output

Returns the calculated result.

Polygon_Area

Runs the Polygon_Area operation for Rectangle.

Polygon_Area(Poly)

Arguments

Argument Default Accepted values What it does
Poly Required Any valid value Poly value used by the operation.

Output

Returns the calculated result.

Intersection

Runs the Intersection operation for Rectangle.

Intersection(R)

Arguments

Argument Default Accepted values What it does
R Required Rectangle, Circle Mode/value selector for r.

Output

Returns the calculated result.

Quadrilateral

Quadrilateral API available from the Classic library.

Configuration

This object does not expose a public Config table.

Methods

Create

Creates a new Quadrilateral instance.

Create(P1=(0.0, 0.0), P2=(0.0, 0.0), P3=(0.0, 0.0), P4=(0.0, 0.0), Score=0.0, ID=0, Label=0, Class=None)

Arguments

Argument Default Accepted values What it does
P1 (0.0, 0.0) Any valid value P1 value used by the operation.
P2 (0.0, 0.0) Any valid value P2 value used by the operation.
P3 (0.0, 0.0) Any valid value P3 value used by the operation.
P4 (0.0, 0.0) Any valid value P4 value used by the operation.
Score 0.0 Any valid value Score value used by the operation.
ID 0 Any valid value ID value used by the operation.
Label 0 Any valid value Label value used by the operation.
Class None Any valid value Class value used by the operation.

Output

Creates a new Quadrilateral object.

Type

Runs the Type operation for Quadrilateral.

Type()

Arguments

No arguments.

Output

Returns the calculated result.

Graphics

Runs the Graphics operation for Quadrilateral.

Graphics(Color=None, Thickness=None, Shift=None, Size=None)

Arguments

Argument Default Accepted values What it does
Color None Any valid value Color used for drawing or display.
Thickness None Any valid value Line/outline thickness used for drawing.
Shift None Any valid value Shift value used by the operation.
Size None Any valid value Size value used by the operation or widget.

Output

Returns structured data such as a list or dictionary.

Corners

Runs the Corners operation for Quadrilateral.

Corners()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

Midpoints

Runs the Midpoints operation for Quadrilateral.

Midpoints()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

BBox

Runs the BBox operation for Quadrilateral.

BBox()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

Contour

Runs the Contour operation for Quadrilateral.

Contour()

Arguments

No arguments.

Output

Returns the calculated result.

Area

Runs the Area operation for Quadrilateral.

Area()

Arguments

No arguments.

Output

Returns the calculated result.

Perimeter

Runs the Perimeter operation for Quadrilateral.

Perimeter()

Arguments

No arguments.

Output

Returns the calculated result.

Contains

Runs the Contains operation for Quadrilateral.

Contains(Pnt, Inclusive=True)

Arguments

Argument Default Accepted values What it does
Pnt Required Any valid value Pnt value used by the operation.
Inclusive True Any valid value Turns inclusive on or off.

Output

Returns True/False to indicate success.

Translate

Runs the Translate operation for Quadrilateral.

Translate(X=None, Y=None)

Arguments

Argument Default Accepted values What it does
X None Any valid value X coordinate or horizontal value.
Y None Any valid value Y coordinate or vertical value.

Output

Runs the operation. Some methods update the object in place.

Transpose

Runs the Transpose operation for Quadrilateral.

Transpose(Point, Angle)

Arguments

Argument Default Accepted values What it does
Point Required Any valid value Point value used by the operation.
Angle Required Any valid value Angle in degrees unless the method says otherwise.

Output

Runs the operation. Some methods update the object in place.

Resize

Runs the Resize operation for Quadrilateral.

Resize(Percentage=None)

Arguments

Argument Default Accepted values What it does
Percentage None Any valid value Percentage value used by the operation.

Output

Returns the object, so the call can be chained.

Locate

Runs the Locate operation for Quadrilateral.

Locate(Cross, Reference)

Arguments

Argument Default Accepted values What it does
Cross Required Any valid value Cross value used by the operation.
Reference Required Any valid value Reference value used by the operation.

Output

Returns the object, so the call can be chained.

Rotate

Rotates the object/data by the requested angle.

Rotate(Angle)

Arguments

Argument Default Accepted values What it does
Angle Required Any valid value Angle in degrees unless the method says otherwise.

Output

Runs the operation. Some methods update the object in place.

P1

Runs the P1 operation for Quadrilateral.

P1(X=None, Y=None)

Arguments

Argument Default Accepted values What it does
X None Any valid value X coordinate or horizontal value.
Y None Any valid value Y coordinate or vertical value.

Output

Returns structured data such as a list or dictionary.

P2

Runs the P2 operation for Quadrilateral.

P2(X=None, Y=None)

Arguments

Argument Default Accepted values What it does
X None Any valid value X coordinate or horizontal value.
Y None Any valid value Y coordinate or vertical value.

Output

Returns structured data such as a list or dictionary.

P3

Runs the P3 operation for Quadrilateral.

P3(X=None, Y=None)

Arguments

Argument Default Accepted values What it does
X None Any valid value X coordinate or horizontal value.
Y None Any valid value Y coordinate or vertical value.

Output

Returns structured data such as a list or dictionary.

P4

Runs the P4 operation for Quadrilateral.

P4(X=None, Y=None)

Arguments

Argument Default Accepted values What it does
X None Any valid value X coordinate or horizontal value.
Y None Any valid value Y coordinate or vertical value.

Output

Returns structured data such as a list or dictionary.

Score

Runs the Score operation for Quadrilateral.

Score(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

ID

Runs the ID operation for Quadrilateral.

ID(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Label

Runs the Label operation for Quadrilateral.

Label(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Class

Runs the Class operation for Quadrilateral.

Class(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Points

Runs the Points operation for Quadrilateral.

Points(Points=None)

Arguments

Argument Default Accepted values What it does
Points None Any valid value Point data, usually Nx2 or Nx3.

Output

Returns structured data such as a list or dictionary.

Expand

Runs the Expand operation for Quadrilateral.

Expand(Value)

Arguments

Argument Default Accepted values What it does
Value Required Any valid value Value to set or process.

Output

Returns the object, so the call can be chained.

Shrink

Runs the Shrink operation for Quadrilateral.

Shrink(Value)

Arguments

Argument Default Accepted values What it does
Value Required Any valid value Value to set or process.

Output

Returns the object, so the call can be chained.

Distance

Calculates distance between features or points.

Distance(Point)

Arguments

Argument Default Accepted values What it does
Point Required Any valid value Point value used by the operation.

Output

Returns a numeric distance.

Copy

Creates a copy of the object, optionally with supplied data.

Copy()

Arguments

No arguments.

Output

Returns a copy of the object.

Polygon

Polygon API available from the Classic library.

Configuration

This object does not expose a public Config table.

Methods

Create

Creates a new Polygon instance.

Create(Points=None, Score=0.0, ID=0, Label=0, Class=None)

Arguments

Argument Default Accepted values What it does
Points None Any valid value Point data, usually Nx2 or Nx3.
Score 0.0 Any valid value Score value used by the operation.
ID 0 Any valid value ID value used by the operation.
Label 0 Any valid value Label value used by the operation.
Class None Any valid value Class value used by the operation.

Output

Creates a new Polygon object.

Type

Runs the Type operation for Polygon.

Type()

Arguments

No arguments.

Output

Returns the calculated result.

Graphics

Runs the Graphics operation for Polygon.

Graphics(Color=None, Thickness=None, Shift=None, Size=None)

Arguments

Argument Default Accepted values What it does
Color None Any valid value Color used for drawing or display.
Thickness None Any valid value Line/outline thickness used for drawing.
Shift None Any valid value Shift value used by the operation.
Size None Any valid value Size value used by the operation or widget.

Output

Returns structured data such as a list or dictionary.

Add

Adds a new item to the object or UI.

Add(X, Y)

Arguments

Argument Default Accepted values What it does
X Required Any valid value X coordinate or horizontal value.
Y Required Any valid value Y coordinate or vertical value.

Output

Returns the object, so the call can be chained.

Remove

Removes the requested item.

Remove(Index)

Arguments

Argument Default Accepted values What it does
Index Required Any valid value Index value used by the operation.

Output

Returns the object, so the call can be chained.

Score

Runs the Score operation for Polygon.

Score(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

ID

Runs the ID operation for Polygon.

ID(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Label

Runs the Label operation for Polygon.

Label(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Class

Runs the Class operation for Polygon.

Class(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Remove_Point

Removes the requested item.

Remove_Point(X, Y, Tolerance=1.0)

Arguments

Argument Default Accepted values What it does
X Required Any valid value X coordinate or horizontal value.
Y Required Any valid value Y coordinate or vertical value.
Tolerance 1.0 Any valid value Tolerance value used by the operation.

Output

Returns the object, so the call can be chained.

Points

Runs the Points operation for Polygon.

Points()

Arguments

No arguments.

Output

Returns the calculated result.

Count

Runs the Count operation for Polygon.

Count()

Arguments

No arguments.

Output

Returns the calculated result.

Expand

Runs the Expand operation for Polygon.

Expand(Value)

Arguments

Argument Default Accepted values What it does
Value Required Any valid value Value to set or process.

Output

Returns the object, so the call can be chained.

Shrink

Runs the Shrink operation for Polygon.

Shrink(Value)

Arguments

Argument Default Accepted values What it does
Value Required Any valid value Value to set or process.

Output

Returns the object, so the call can be chained.

Translate

Runs the Translate operation for Polygon.

Translate(X=None, Y=None)

Arguments

Argument Default Accepted values What it does
X None Any valid value X coordinate or horizontal value.
Y None Any valid value Y coordinate or vertical value.

Output

Runs the operation. Some methods update the object in place.

Transpose

Runs the Transpose operation for Polygon.

Transpose(Point, Angle)

Arguments

Argument Default Accepted values What it does
Point Required Any valid value Point value used by the operation.
Angle Required Any valid value Angle in degrees unless the method says otherwise.

Output

Runs the operation. Some methods update the object in place.

Resize

Runs the Resize operation for Polygon.

Resize(Percentage=None)

Arguments

Argument Default Accepted values What it does
Percentage None Any valid value Percentage value used by the operation.

Output

Returns the object, so the call can be chained.

Locate

Runs the Locate operation for Polygon.

Locate(Cross, Reference)

Arguments

Argument Default Accepted values What it does
Cross Required Any valid value Cross value used by the operation.
Reference Required Any valid value Reference value used by the operation.

Output

Returns the object, so the call can be chained.

Copy

Creates a copy of the object, optionally with supplied data.

Copy()

Arguments

No arguments.

Output

Returns a copy of the object.

BBox

Runs the BBox operation for Polygon.

BBox()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

Contour

Runs the Contour operation for Polygon.

Contour()

Arguments

No arguments.

Output

Returns the calculated result.

Area

Runs the Area operation for Polygon.

Area()

Arguments

No arguments.

Output

Returns the calculated result.

Perimeter

Runs the Perimeter operation for Polygon.

Perimeter()

Arguments

No arguments.

Output

Returns the calculated result.

Distance

Calculates distance between features or points.

Distance(P)

Arguments

Argument Default Accepted values What it does
P Required Any valid value P value used by the operation.

Output

Returns a numeric distance.

Contains

Runs the Contains operation for Polygon.

Contains(P, Inclusive=True)

Arguments

Argument Default Accepted values What it does
P Required Any valid value P value used by the operation.
Inclusive True Any valid value Turns inclusive on or off.

Output

Returns True/False to indicate success.

Contour

Contour extraction and contour measurement helper.

Configuration

This object does not expose a public Config table.

Methods

Create

Creates a new Contour instance.

Create(X=0.0, Y=0.0, Mask=None, Score=0.0, ID=0, Label=0, Class=None)

Arguments

Argument Default Accepted values What it does
X 0.0 Any valid value X coordinate or horizontal value.
Y 0.0 Any valid value Y coordinate or vertical value.
Mask None Any valid value Mask value used by the operation.
Score 0.0 Any valid value Score value used by the operation.
ID 0 Any valid value ID value used by the operation.
Label 0 Any valid value Label value used by the operation.
Class None Any valid value Class value used by the operation.

Output

Creates a new Contour object.

Type

Runs the Type operation for Contour.

Type()

Arguments

No arguments.

Output

Returns the calculated result.

Graphics

Runs the Graphics operation for Contour.

Graphics(Color=None, Thickness=None, Shift=None, Size=None)

Arguments

Argument Default Accepted values What it does
Color None Any valid value Color used for drawing or display.
Thickness None Any valid value Line/outline thickness used for drawing.
Shift None Any valid value Shift value used by the operation.
Size None Any valid value Size value used by the operation or widget.

Output

Returns structured data such as a list or dictionary.

X

Runs the X operation for Contour.

X()

Arguments

No arguments.

Output

Returns the calculated result.

Y

Runs the Y operation for Contour.

Y()

Arguments

No arguments.

Output

Returns the calculated result.

Area

Runs the Area operation for Contour.

Area()

Arguments

No arguments.

Output

Returns the calculated result.

Score

Runs the Score operation for Contour.

Score(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

ID

Runs the ID operation for Contour.

ID(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Label

Runs the Label operation for Contour.

Label(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Class

Runs the Class operation for Contour.

Class(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Perimeter

Runs the Perimeter operation for Contour.

Perimeter()

Arguments

No arguments.

Output

Returns the calculated result.

BBox

Runs the BBox operation for Contour.

BBox()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

HBB

Runs the HBB operation for Contour.

HBB()

Arguments

No arguments.

Output

Returns the calculated result.

OBB

Runs the OBB operation for Contour.

OBB(Orientation='Auto')

Arguments

Argument Default Accepted values What it does
Orientation 'Auto' Any valid value Orientation value used by the operation.

Output

Returns the calculated result.

Contains

Runs the Contains operation for Contour.

Contains(P, Inclusive=True)

Arguments

Argument Default Accepted values What it does
P Required Any valid value P value used by the operation.
Inclusive True Any valid value Turns inclusive on or off.

Output

Returns True/False to indicate success.

Expand

Runs the Expand operation for Contour.

Expand(Value)

Arguments

Argument Default Accepted values What it does
Value Required Any valid value Value to set or process.

Output

Returns the object, so the call can be chained.

Shrink

Runs the Shrink operation for Contour.

Shrink(Value)

Arguments

Argument Default Accepted values What it does
Value Required Any valid value Value to set or process.

Output

Returns the object, so the call can be chained.

Translate

Runs the Translate operation for Contour.

Translate(X=None, Y=None)

Arguments

Argument Default Accepted values What it does
X None Any valid value X coordinate or horizontal value.
Y None Any valid value Y coordinate or vertical value.

Output

Runs the operation. Some methods update the object in place.

Transpose

Runs the Transpose operation for Contour.

Transpose(Point, Angle)

Arguments

Argument Default Accepted values What it does
Point Required Any valid value Point value used by the operation.
Angle Required Any valid value Angle in degrees unless the method says otherwise.

Output

Runs the operation. Some methods update the object in place.

Resize

Runs the Resize operation for Contour.

Resize(Percentage=None)

Arguments

Argument Default Accepted values What it does
Percentage None Any valid value Percentage value used by the operation.

Output

Returns the object, so the call can be chained.

Locate

Runs the Locate operation for Contour.

Locate(Cross, Reference)

Arguments

Argument Default Accepted values What it does
Cross Required Any valid value Cross value used by the operation.
Reference Required Any valid value Reference value used by the operation.

Output

Returns the object, so the call can be chained.

Copy

Creates a copy of the object, optionally with supplied data.

Copy()

Arguments

No arguments.

Output

Returns a copy of the object.

Contours_List

Runs the Contours_List operation for Contour.

Contours_List()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

Contour

Runs the Contour operation for Contour.

Contour()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

Distance

Calculates distance between features or points.

Distance(P)

Arguments

Argument Default Accepted values What it does
P Required Any valid value P value used by the operation.

Output

Returns a numeric distance.

Add

Adds a new item to the object or UI.

Add(R=None, Expand_To_Connect=True, Expansion_Target='Reg', Kernel_Radius=1, Max_Iterations=512)

Arguments

Argument Default Accepted values What it does
R None Any valid value R value used by the operation.
Expand_To_Connect True Any valid value Turns expand to connect on or off.
Expansion_Target 'Reg' Any valid value Expansion Target value used by the operation.
Kernel_Radius 1 Any valid value Kernel Radius value used by the operation.
Max_Iterations 512 Any valid value Maximum iterations allowed by the operation.

Output

Returns the object, so the call can be chained.

Subtract

Runs the Subtract operation for Contour.

Subtract(R=None, Reminder=False)

Arguments

Argument Default Accepted values What it does
R None Any valid value R value used by the operation.
Reminder False Any valid value Turns reminder on or off.

Output

Returns the object, so the call can be chained.

Circularity

Runs the Circularity operation for Contour.

Circularity(Close=1, Open=0)

Arguments

Argument Default Accepted values What it does
Close 1 Any valid value Close value used by the operation.
Open 0 Any valid value Open value used by the operation.

Output

Returns the calculated result.

Rectangularity

Runs the Rectangularity operation for Contour.

Rectangularity(Close=1, Open=0)

Arguments

Argument Default Accepted values What it does
Close 1 Any valid value Close value used by the operation.
Open 0 Any valid value Open value used by the operation.

Output

Returns the calculated result.

Squareness

Runs the Squareness operation for Contour.

Squareness(Close=1, Open=0)

Arguments

Argument Default Accepted values What it does
Close 1 Any valid value Close value used by the operation.
Open 0 Any valid value Open value used by the operation.

Output

Returns the calculated result.

Ellipticity

Runs the Ellipticity operation for Contour.

Ellipticity(Close=1, Open=0)

Arguments

Argument Default Accepted values What it does
Close 1 Any valid value Close value used by the operation.
Open 0 Any valid value Open value used by the operation.

Output

Returns the calculated result.

Polygon_Check

Runs the Polygon_Check operation for Contour.

Polygon_Check(Count=4, Minimum=0.85, Epsilon_Min=0.005, Epsilon_Max=0.08, Steps=24, Close=1, Open=0, Side_Tolerance=0.2, Angle_Tolerance=12.0)

Arguments

Argument Default Accepted values What it does
Count 4 Count Mode/value selector for count.
Minimum 0.85 Score Minimum accepted value.
Epsilon_Min 0.005 Any valid value Epsilon Min value used by the operation.
Epsilon_Max 0.08 Any valid value Epsilon Max value used by the operation.
Steps 24 Any valid value Steps value used by the operation.
Close 1 Any valid value Close value used by the operation.
Open 0 Any valid value Open value used by the operation.
Side_Tolerance 0.2 Any valid value Side Tolerance value used by the operation.
Angle_Tolerance 12.0 Any valid value Angle Tolerance value used by the operation.

Output

Returns the calculated result.

Polygonality

Runs the Polygonality operation for Contour.

Polygonality(Count=4, Epsilon_Min=0.005, Epsilon_Max=0.08, Steps=24, Close=1, Open=0, Side_Tolerance=0.2, Angle_Tolerance=12.0)

Arguments

Argument Default Accepted values What it does
Count 4 Any valid value Count value used by the operation.
Epsilon_Min 0.005 Any valid value Epsilon Min value used by the operation.
Epsilon_Max 0.08 Any valid value Epsilon Max value used by the operation.
Steps 24 Any valid value Steps value used by the operation.
Close 1 Any valid value Close value used by the operation.
Open 0 Any valid value Open value used by the operation.
Side_Tolerance 0.2 Any valid value Side Tolerance value used by the operation.
Angle_Tolerance 12.0 Any valid value Angle Tolerance value used by the operation.

Output

Returns the calculated result.

Is_Polygon

Returns a boolean state.

Is_Polygon(Count=4, Minimum=0.85, Epsilon_Min=0.005, Epsilon_Max=0.08, Steps=24, Close=1, Open=0, Side_Tolerance=0.2, Angle_Tolerance=12.0)

Arguments

Argument Default Accepted values What it does
Count 4 Any valid value Count value used by the operation.
Minimum 0.85 Any valid value Minimum accepted value.
Epsilon_Min 0.005 Any valid value Epsilon Min value used by the operation.
Epsilon_Max 0.08 Any valid value Epsilon Max value used by the operation.
Steps 24 Any valid value Steps value used by the operation.
Close 1 Any valid value Close value used by the operation.
Open 0 Any valid value Open value used by the operation.
Side_Tolerance 0.2 Any valid value Side Tolerance value used by the operation.
Angle_Tolerance 12.0 Any valid value Angle Tolerance value used by the operation.

Output

Returns the calculated result.

Is_Triangle

Calculates or applies angle/rotation behavior.

Is_Triangle(Minimum=0.85)

Arguments

Argument Default Accepted values What it does
Minimum 0.85 Any valid value Minimum accepted value.

Output

Returns or applies an angle value.

Is_Rectangle

Calculates or applies angle/rotation behavior.

Is_Rectangle(Minimum=0.85)

Arguments

Argument Default Accepted values What it does
Minimum 0.85 Minimum Minimum accepted value.

Output

Returns or applies an angle value.

Is_Square

Returns a boolean state.

Is_Square(Minimum=0.85)

Arguments

Argument Default Accepted values What it does
Minimum 0.85 Minimum Minimum accepted value.

Output

Returns the calculated result.

Is_Circle

Returns a boolean state.

Is_Circle(Minimum=0.85)

Arguments

Argument Default Accepted values What it does
Minimum 0.85 Minimum Minimum accepted value.

Output

Returns the calculated result.

Is_Ellipse

Returns a boolean state.

Is_Ellipse(Minimum=0.85)

Arguments

Argument Default Accepted values What it does
Minimum 0.85 Minimum Minimum accepted value.

Output

Returns the calculated result.

Is_Pentagon

Returns a boolean state.

Is_Pentagon(Minimum=0.85)

Arguments

Argument Default Accepted values What it does
Minimum 0.85 Any valid value Minimum accepted value.

Output

Returns the calculated result.

Is_Hexagon

Returns a boolean state.

Is_Hexagon(Minimum=0.85)

Arguments

Argument Default Accepted values What it does
Minimum 0.85 Any valid value Minimum accepted value.

Output

Returns the calculated result.

Is_Heptagon

Returns a boolean state.

Is_Heptagon(Minimum=0.85)

Arguments

Argument Default Accepted values What it does
Minimum 0.85 Any valid value Minimum accepted value.

Output

Returns the calculated result.

Is_Octagon

Returns a boolean state.

Is_Octagon(Minimum=0.85)

Arguments

Argument Default Accepted values What it does
Minimum 0.85 Any valid value Minimum accepted value.

Output

Returns the calculated result.

Diagonal

Runs the Diagonal operation for Contour.

Diagonal(Mode='Both', Hull=True, Max_Points=2048, Close=0, Open=0)

Arguments

Argument Default Accepted values What it does
Mode 'Both' MIN, MAX, BOTH Mode selector for the operation.
Hull True Any valid value Turns hull on or off.
Max_Points 2048 Any valid value Maximum number of points to keep/use.
Close 0 Any valid value Close value used by the operation.
Open 0 Any valid value Open value used by the operation.

Output

Returns structured data such as a list or dictionary.

Text

Text display/editor widget.

Configuration

This object does not expose a public Config table.

Methods

Create

Creates a new Text instance.

Create(X=0.0, Y=0.0, Text='', Angle=0.0, Anchor='CENTER', Vertical=False, Score=0.0, ID=0, Label=0, Class=None)

Arguments

Argument Default Accepted values What it does
X 0.0 Any valid value X coordinate or horizontal value.
Y 0.0 Any valid value Y coordinate or vertical value.
Text '' Any valid value Text value used by the operation.
Angle 0.0 Any valid value Angle in degrees unless the method says otherwise.
Anchor 'CENTER' CENTER, C, LINE, N, S, E, W, NE, NW, SE, SW Mode/value selector for anchor.
Vertical False Any valid value Turns vertical on or off.
Score 0.0 Any valid value Score value used by the operation.
ID 0 Any valid value ID value used by the operation.
Label 0 Any valid value Label value used by the operation.
Class None Any valid value Class value used by the operation.

Output

Creates a new Text object.

Type

Runs the Type operation for Text.

Type()

Arguments

No arguments.

Output

Returns the calculated result.

Graphics

Runs the Graphics operation for Text.

Graphics(Color=None, Thickness=None, Shift=None, Size=None, Background=None)

Arguments

Argument Default Accepted values What it does
Color None Any valid value Color used for drawing or display.
Thickness None Any valid value Line/outline thickness used for drawing.
Shift None Any valid value Shift value used by the operation.
Size None Any valid value Size value used by the operation or widget.
Background None Any valid value Background value used by the operation.

Output

Returns structured data such as a list or dictionary.

X

Runs the X operation for Text.

X(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Y

Runs the Y operation for Text.

Y(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Text

Runs the Text operation for Text.

Text(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Angle

Calculates or applies angle/rotation behavior.

Angle(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns or applies an angle value.

Score

Runs the Score operation for Text.

Score(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

ID

Runs the ID operation for Text.

ID(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Label

Runs the Label operation for Text.

Label(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Class

Runs the Class operation for Text.

Class(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Anchor

Runs the Anchor operation for Text.

Anchor(Value=None)

Arguments

Argument Default Accepted values What it does
Value None CENTER, C, LINE, N, S, E, W, NE, NW, SE, SW Value to set or process.

Output

Returns the calculated result.

Vertical

Runs the Vertical operation for Text.

Vertical(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Translate

Runs the Translate operation for Text.

Translate(X=None, Y=None)

Arguments

Argument Default Accepted values What it does
X None Any valid value X coordinate or horizontal value.
Y None Any valid value Y coordinate or vertical value.

Output

Runs the operation. Some methods update the object in place.

Transpose

Runs the Transpose operation for Text.

Transpose(Point, Angle)

Arguments

Argument Default Accepted values What it does
Point Required Any valid value Point value used by the operation.
Angle Required Any valid value Angle in degrees unless the method says otherwise.

Output

Runs the operation. Some methods update the object in place.

Resize

Runs the Resize operation for Text.

Resize(Percentage=None)

Arguments

Argument Default Accepted values What it does
Percentage None Any valid value Percentage value used by the operation.

Output

Returns the object, so the call can be chained.

Locate

Runs the Locate operation for Text.

Locate(Cross, Reference)

Arguments

Argument Default Accepted values What it does
Cross Required Any valid value Cross value used by the operation.
Reference Required Any valid value Reference value used by the operation.

Output

Returns the object, so the call can be chained.

Copy

Creates a copy of the object, optionally with supplied data.

Copy()

Arguments

No arguments.

Output

Returns a copy of the object.

BBox

Runs the BBox operation for Text.

BBox(Font=FONT_HERSHEY_SIMPLEX, Scale=1.0, Thickness=1, Spacing=0.2)

Arguments

Argument Default Accepted values What it does
Font FONT_HERSHEY_SIMPLEX Any valid value Font value used by the operation.
Scale 1.0 Any valid value Scale value used by the operation.
Thickness 1 Any valid value Line/outline thickness used for drawing.
Spacing 0.2 Any valid value Spacing value used by the operation.

Output

Returns structured data such as a list or dictionary.

Mask

Mask API available from the Classic library.

Configuration

This object does not expose a public Config table.

Methods

Create

Creates a new Mask instance.

Create(Top, Left, Bottom, Right, Mask, Score=0.0, ID=0, Label=0, Class=None)

Arguments

Argument Default Accepted values What it does
Top Required Any valid value Top value used by the operation.
Left Required Any valid value Left value used by the operation.
Bottom Required Any valid value Bottom value used by the operation.
Right Required Any valid value Right value used by the operation.
Mask Required Any valid value Mask value used by the operation.
Score 0.0 Any valid value Score value used by the operation.
ID 0 Any valid value ID value used by the operation.
Label 0 Any valid value Label value used by the operation.
Class None Any valid value Class value used by the operation.

Output

Creates a new Mask object.

Type

Runs the Type operation for Mask.

Type()

Arguments

No arguments.

Output

Returns the calculated result.

Score

Runs the Score operation for Mask.

Score(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

ID

Runs the ID operation for Mask.

ID(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Label

Runs the Label operation for Mask.

Label(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Class

Runs the Class operation for Mask.

Class(Value=None)

Arguments

Argument Default Accepted values What it does
Value None Any valid value Value to set or process.

Output

Returns the calculated result.

Copy

Creates a copy of the object, optionally with supplied data.

Copy()

Arguments

No arguments.

Output

Returns a copy of the object.