pysnt.util package#

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

get_available_classes() → List[str][source]#

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[source]#

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()[source]#

Print all available classes organized by tier.

get_curated_classes() → List[str][source]#

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][source]#

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

Bases: object

Defines a Point in an image, a node of a traced Path. Coordinates are always expressed in real-world coordinates.

All Methods and Attributes: See PointInImage detailed documentation.

class SWCPoint(*args, **kwargs)#

Bases: object

Defines a node in an SWC reconstruction. The SWC file format is detailed here.

All Methods and Attributes: See SWCPoint detailed documentation.