pysnt.viewer package

This module provides convenient access to SNT’s viewer classes.

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 Annotation3D(*args, **kwargs)

Bases: object

An Annotation3D is a triangulated surface or a cloud of points (scatter) rendered in Viewer3D that can be used to highlight nodes in a Tree or locations in a mesh.

All Methods and Attributes: See Annotation3D detailed documentation.

class MultiViewer2D(*args, **kwargs)

Bases: object

Class for rendering montages of Trees as 2D plots that can be exported as SVG, PNG or PDF.

All Methods and Attributes: See MultiViewer2D detailed documentation.

class MultiViewer3D(*args, **kwargs)

Bases: object

Class for rendering individual Viewer3Ds as a multi-panel montage.

All Methods and Attributes: See MultiViewer3D detailed documentation.

class Viewer2D(*args, **kwargs)

Bases: object

Class for rendering Trees as 2D plots that can be exported as SVG, PNG or PDF.

All Methods and Attributes: See Viewer2D detailed documentation.

class Viewer3D(*args, **kwargs)

Bases: object

Implements SNT's Reconstruction Viewer. Relies heavily on the org.jzy3d package.

All Methods and Attributes: See Viewer3D detailed documentation.