ClearMap.gui#

This subpackage contains the graphical user interface for ClearMap.

The GUI is used to run the ClearMap pipelines without much customisation and to visualize the results.

For a more advanced usage, the ClearMap classes can be used directly. See cell_map_new_api and tube_map_new_api for more information.


Sub-packages and modules#

ClearMap.gui.about

ClearMap.gui.app

ClearMap.gui.creator

All the files in the ClearMap/gui/creator directory are static files used to create the GUI for ClearMap.

ClearMap.gui.dialog_helpers

ClearMap.gui.dialogs

All the independent popup dialogs used by the GUI

ClearMap.gui.exception_handler

Centralised GUI exception handling for ClearMap.

ClearMap.gui.gui_logging

Defines the Printer class used to log to file and to the GUI widgets from simple prints

ClearMap.gui.gui_utils_base

Various utility functions specific to the graphical interface

ClearMap.gui.gui_utils_images

ClearMap.gui.params

All the classes that define parameters or group thereof for the tabs of the graphical interface

ClearMap.gui.params_interfaces

ClearMap.gui.params_mixins

Mixins for params classes The OrthoviewerSlicingMixin provides orthoviewer-related functionality.

ClearMap.gui.pipeline_model

ClearMap.gui.pipeline_widgets

ClearMap.gui.preferences

This module handles the preferences of the graphical interface.

ClearMap.gui.pretty_imports

ClearMap.gui.pyuic_utils

Essentially a reimplementation of loadUiType from PyQt5 to allow monkey patching the classes

ClearMap.gui.style

A set of constants for the style of the widgets in the UI (to customise qdarkstyle)

ClearMap.gui.tab_registry

ClearMap.gui.tabs

GUI tabs for ClearMap.

ClearMap.gui.tabs_interfaces

This module contains the interfaces to the different tabs and dialogs in the ClearMap GUI.

ClearMap.gui.widget_monkeypatch_callbacks

A set of functions that will be monkey patched as methods to the graphical widgets, allowing notably compound widgets from QtCreator without defining plugins

ClearMap.gui.widgets

Custom widgets for the ClearMap GUI.