Classic

Calibration

Calibration helpers for converting image measurements into world measurements.

3 nested API groups

Import

from Xenonix.Classic import Calibration

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.

Simple

Simple API available from the Classic library.

Configuration

This object does not expose a public Config table.

Methods

Create

Creates a new Simple instance.

Create()

Arguments

No arguments.

Output

Creates a new Simple object.

Calibrate

Runs the Calibrate operation for Simple.

Calibrate(Line1=None, Line2=None, Real_Distance=1.0)

Arguments

Argument	Default	Accepted values	What it does
`Line1`	`None`	Any valid value	Line1 value used by the operation.
`Line2`	`None`	Any valid value	Line2 value used by the operation.
`Real_Distance`	`1.0`	Any valid value	Real Distance value used by the operation.

Output

Returns structured data such as a list or dictionary.

Convert_Value

Converts between supported coordinate/data formats.

Convert_Value(Pixels)

Arguments

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

Output

Returns the calculated result.

Convert

Converts between supported coordinate/data formats.

Convert(Regions)

Arguments

Argument	Default	Accepted values	What it does
`Regions`	Required	Any valid value	One or more regions of interest.

Output

Returns the calculated result.

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

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.

Advance

Advance API available from the Classic library.

Configuration

This object does not expose a public Config table.

Methods

Create

Creates a new Advance instance.

Create()

Arguments

No arguments.

Output

Creates a new Advance object.

Calibrate

Runs the Calibrate operation for Advance.

Calibrate(Frames=None, Rows=9, Cols=6, Square_Size_MM=20.0, Reference=None)

Arguments

Argument	Default	Accepted values	What it does
`Frames`	`None`	Any valid value	Frames value used by the operation.
`Rows`	`9`	Any valid value	Rows value used by the operation.
`Cols`	`6`	Any valid value	Cols value used by the operation.
`Square_Size_MM`	`20.0`	Any valid value	Square Size MM value used by the operation.
`Reference`	`None`	Any valid value	Reference value used by the operation.

Output

Returns True/False to indicate success.

Convert

Converts between supported coordinate/data formats.

Convert(Regions, Frame=None)

Arguments

Argument	Default	Accepted values	What it does
`Regions`	Required	Any valid value	One or more regions of interest.
`Frame`	`None`	Any valid value	Input image/frame data. Can be an image object, array, or frame accepted by this tool.

Output

Returns the calculated result.

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

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.

Camera

Camera acquisition wrapper for image capture workflows.

Configuration

This object does not expose a public Config table.

Methods

Create

Creates a new Camera instance.

Create()

Arguments

No arguments.

Output

Creates a new Camera object.

Calibrate

Runs the Calibrate operation for Camera.

Calibrate(Frames=None, Rows=9, Cols=6, Size=20.0)

Arguments

Argument	Default	Accepted values	What it does
`Frames`	`None`	Any valid value	Frames value used by the operation.
`Rows`	`9`	Any valid value	Rows value used by the operation.
`Cols`	`6`	Any valid value	Cols value used by the operation.
`Size`	`20.0`	Any valid value	Size value used by the operation or widget.

Output

Returns True/False to indicate success.

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

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.