pysnt.gui.cmds package

This module provides convenient access to SNT’s GUI command classes.

The cmds module contains command classes for SNT’s GUI operations, including figure creation, analysis commands, and other GUI-based functionality.

get_available_classes() → List[str]

Get list of all available classes.

This includes both curated classes (always loaded) and extended classes (loaded on-demand). Extended classes are discovered if not already loaded.

Returns:

List of available class names.

Return type:

List[str]

get_class(class_name: str) → Any

Get a specific class by name.

This method provides access to both curated and extended classes. Extended classes are discovered and loaded on first access.

Supports inner class access using dot notation (e.g., “CircularModels.VonMisesFit”).

Parameters:

class_name (str) – Name of the class to retrieve. Can include inner class notation using dots (e.g., “CircularModels.VonMisesFit”).

Returns:

The requested SNT class or inner class.

Return type:

Java class

Raises:

• KeyError – If the class is not available.

• RuntimeError – If the JVM has not been started.

Examples

>>> # Get a regular class
>>> CircModels = pysnt.analysis.get_class("CircularModels")

>>> # Get an inner class
>>> VonMisesFit = pysnt.analysis.get_class("CircularModels.VonMisesFit")

list_classes()

Print all available classes organized by tier.

get_curated_classes() → List[str]

Get list of curated classes that are always available for direct import.

Returns:

List of curated class names.

Return type:

List[str]

get_extended_classes() → List[str]

Get list of extended classes available via get_class().

This will trigger discovery if not already done.

Returns:

List of extended class names.

Return type:

List[str]

class FigCreatorCmd(*args, **kwargs)

Bases: object

SNT gui.cmds class with method signatures.

Available for direct import after JVM initialization. Call pysnt.initialize() before using this class.

See FigCreatorCmd_javadoc.