Core

Shared

Shared-memory/state helper.

4 nested API groups

Import

from Xenonix.Core import Shared

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.

Stack

Stack API available from the Core library.

Configuration

This object does not expose a public Config table.

Methods

Create

Creates a new Stack instance.

Create(Name, Directory=None)

Arguments

Argument	Default	Accepted values	What it does
`Name`	Required	Any valid value	Display/name identifier.
`Directory`	`None`	Any valid value	Directory value used by the operation.

Output

Creates a new Stack object.

Create

Runs the Create operation for Stack.

Create(Shape=None, Dtype=uint8)

Arguments

Argument	Default	Accepted values	What it does
`Shape`	`None`	Any valid value	Shape value used by the operation.
`Dtype`	`uint8`	Any valid value	Dtype value used by the operation.

Output

Returns True/False to indicate success.

Write

Writes the current data to a file path.

Write(Data)

Arguments

Argument	Default	Accepted values	What it does
`Data`	Required	Any valid value	Dataset path or dataset definition.

Output

Returns success/status or the operation result.

Read

Reads data from a file path.

Read()

Arguments

No arguments.

Output

Returns success/status or the operation result.

Close

Applies a morphology-style image operation.

Close()

Arguments

No arguments.

Output

Returns success/status or the operation result.

Frame

Layout frame/container widget.

Configuration

This object does not expose a public Config table.

Methods

Create

Creates a new Frame instance.

Create(Name, Directory=None)

Arguments

Argument	Default	Accepted values	What it does
`Name`	Required	Any valid value	Display/name identifier.
`Directory`	`None`	Any valid value	Directory value used by the operation.

Output

Creates a new Frame object.

Create

Runs the Create operation for Frame.

Create(Width=None, Height=None, Channel=None)

Arguments

Argument	Default	Accepted values	What it does
`Width`	`None`	Any valid value	Width in pixels, world units, or widget units depending on the class.
`Height`	`None`	Any valid value	Height in pixels, world units, or widget units depending on the class.
`Channel`	`None`	Any valid value	Channel value used by the operation.

Output

Returns the calculated result.

Byte

Byte API available from the Core library.

Configuration

This object does not expose a public Config table.

Methods

Create

Creates a new Byte instance.

Create(Name, Directory=None)

Arguments

Argument	Default	Accepted values	What it does
`Name`	Required	Any valid value	Display/name identifier.
`Directory`	`None`	Any valid value	Directory value used by the operation.

Output

Creates a new Byte object.

Create

Runs the Create operation for Byte.

Create(Size=None)

Arguments

Argument	Default	Accepted values	What it does
`Size`	`None`	Any valid value	Size value used by the operation or widget.

Output

Returns the calculated result.

Write

Writes the current data to a file path.

Write(Data)

Arguments

Argument	Default	Accepted values	What it does
`Data`	Required	`B`	Dataset path or dataset definition.

Output

Returns success/status or the operation result.

Read

Reads data from a file path.

Read()

Arguments

No arguments.

Output

Returns success/status or the operation result.

Byte_MP

Byte_MP API available from the Core library.

Configuration

This object does not expose a public Config table.

Methods

Create

Creates a new Byte_MP instance.

Create(Name, Directory=None)

Arguments

Argument	Default	Accepted values	What it does
`Name`	Required	Any valid value	Display/name identifier.
`Directory`	`None`	Any valid value	Directory value used by the operation.

Output

Creates a new Byte_MP object.

Create

Runs the Create operation for Byte_MP.

Create(Size=None)

Arguments

Argument	Default	Accepted values	What it does
`Size`	`None`	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(Data)

Arguments

Argument	Default	Accepted values	What it does
`Data`	Required	Any valid value	Dataset path or dataset definition.

Output

Returns success/status or the operation result.

Read

Reads data from a file path.

Read()

Arguments

No arguments.

Output

Returns success/status or the operation result.

Close

Applies a morphology-style image operation.

Close()

Arguments

No arguments.

Output

Returns success/status or the operation result.

Unlink

Runs the Unlink operation for Byte_MP.

Unlink()

Arguments

No arguments.

Output

Returns True/False to indicate success.