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.creator

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

ClearMap.gui.dialogs

All the independent popup dialogs used by the GUI

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

Various utility functions specific to the graphical interface

ClearMap.gui.interfaces

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

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.preferences

This module handles the preferences of the graphical interface.

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.tabs

The different tabs that correspond to different functionalities of the 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

A set of custom widgets for the ClearMap GUI