Classic

Pattern

Template/pattern matching tool for locating repeated image features.

13 public methods

Import

from Xenonix.Classic import Pattern

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

Create()

Arguments

No arguments.

Output

Creates a new Pattern object.

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 Pattern.

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.

Count

Runs the Count operation for Pattern.

Count(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.

Edge

Runs the Edge operation for Pattern.

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

Homography

Runs the Homography operation for Pattern.

Homography(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.

Train

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

Train(Frame, Region=None, Image_Size=640)

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.
`Image_Size`	`640`	Any valid value	Input image size used by the model/tool.

Output

Returns True/False to indicate success.

Find

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

Find(Frame, Region=None, Pick='All', Index=None)

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.
`Pick`	`'All'`	`ALL`, `FIRST`, `BEST`, `BEST_FIRST`, `BEST_TWO`	Selects which candidate/result should be returned.
`Index`	`None`	Any valid value	Index value used by the operation.

Output

Returns structured data such as a list or dictionary.

Write

Writes the current data to a file path.

Write(Path)

Arguments

Argument	Default	Accepted values	What it does
`Path`	Required	Any valid value	File path used for reading or writing.

Output

Returns success/status or the operation result.

Read

Reads data from a file path.

Read(Path)

Arguments

Argument	Default	Accepted values	What it does
`Path`	Required	Any valid value	File path used for reading or writing.

Output

Returns success/status or the operation result.

Export

Runs the Export operation for Pattern.

Export(Type='BASE64')

Arguments

Argument	Default	Accepted values	What it does
`Type`	`'BASE64'`	`JSON`, `BASE64`	Mode/value selector for type.

Output

Returns True/False to indicate success.

Load

Loads input data into the object.

Load(Data, Type='BASE64')

Arguments

Argument	Default	Accepted values	What it does
`Data`	Required	Any valid value	Dataset path or dataset definition.
`Type`	`'BASE64'`	`JSON`, `BASE64`	Mode/value selector for type.

Output

Returns success/status or the operation result.