magicclass.ext.napari package

Submodules

magicclass.ext.napari.types module

class magicclass.ext.napari.types.FeatureColumn[source]

Bases: object

class magicclass.ext.napari.types.FeatureInfo(*args, **kwargs)[source]

Bases: object

A type representing a tuple of a DataFrame and its column names.

def func(x: FeatureInfo["x", "y"]): ...

Type annotation FeatureInfo["x", "y"] is essentially equivalent to tuple[pd.DataFrame, tuple[str, str]].

class magicclass.ext.napari.types.Features(*args, **kwargs)[source]

Bases: Protocol

property columns: Iterable[str]

magicclass.ext.napari.utils module

magicclass.ext.napari.utils.process_worker(f: Callable[[magicclass.ext.napari.utils._P], Union[napari._qt.qthreading.FunctionWorker, napari._qt.qthreading.GeneratorWorker]]) Callable[[magicclass.ext.napari.utils._P], None][source]

Process returned worker of napari.qt.threading in a proper way.

Open a progress bar and start worker in a parallel thread if function is called from GUI. Otherwise (if function is called from script), the worker will be executed as if the function is directly called. This function is useful in napari because when you are running workers in tandem the second one does not wait for the first one to finish, which causes inconsistency between operations on GUI and on Python interpreter.

magicclass.ext.napari.utils.to_napari(magic_class: type[BaseGui] | None = None, *, viewer: napari.Viewer | None = None)[source]

Send magic class to current napari viewer. Classes decorated with @magicclass magicmenu and magictoolbar are supported.

magicclass.ext.napari.viewer module

class magicclass.ext.napari.viewer.QtLayerWidget(parent: magicclass.ext.napari.viewer.QtViewerWidget)[source]

Bases: PyQt5.QtWidgets.QSplitter

class magicclass.ext.napari.viewer.QtViewerWidget[source]

Bases: PyQt5.QtWidgets.QSplitter

class magicclass.ext.napari.viewer.ViewerWidget[source]

Bases: magicclass.widgets.utils.FreeWidget

add_image(*args, **kwargs) nl.Image[source]
add_labels(*args, **kwargs) nl.Labels[source]
add_points(*args, **kwargs) nl.Points[source]
add_shapes(*args, **kwargs) nl.Shapes[source]
add_surface(*args, **kwargs) nl.Surface[source]
add_tracks(*args, **kwargs) nl.Tracks[source]
add_vectors(*args, **kwargs) nl.Vectors[source]
property axes
property camera
property cursor
property dims
property grid
property layers
property scale_bar
property text_overlay

magicclass.ext.napari.widgets module

class magicclass.ext.napari.widgets.NapariCanvas(ndisplay=2, order=(), axis_labels=(), **kwargs)[source]

Bases: magicclass.widgets.utils.FreeWidget

Module contents

class magicclass.ext.napari.NapariCanvas(ndisplay=2, order=(), axis_labels=(), **kwargs)[source]

Bases: magicclass.widgets.utils.FreeWidget

class magicclass.ext.napari.ViewerWidget[source]

Bases: magicclass.widgets.utils.FreeWidget

add_image(*args, **kwargs) nl.Image[source]
add_labels(*args, **kwargs) nl.Labels[source]
add_points(*args, **kwargs) nl.Points[source]
add_shapes(*args, **kwargs) nl.Shapes[source]
add_surface(*args, **kwargs) nl.Surface[source]
add_tracks(*args, **kwargs) nl.Tracks[source]
add_vectors(*args, **kwargs) nl.Vectors[source]
property axes
property camera
property cursor
property dims
property grid
property layers
property scale_bar
property text_overlay
magicclass.ext.napari.to_napari(magic_class: type[BaseGui] | None = None, *, viewer: napari.Viewer | None = None)[source]

Send magic class to current napari viewer. Classes decorated with @magicclass magicmenu and magictoolbar are supported.