API

The public Application Programming Interface (API) of SigimaX provides the building blocks for creating scientific desktop applications.

Module	Purpose
sigimax.app	Application launcher — create() and run() entry points for starting a SigimaX-based application with splash screen support.
sigimax.config	Configuration system — SigimaXOptions singleton (CONF), typed option fields (EnumOptionField, TupleOptionField, FontOptionField), and translation function _().
sigimax.env	Runtime environment — SGMXExecEnv singleton (execenv) for controlling unattended mode, verbosity, demo mode, and screenshots.
sigimax.mainwindow	Generic main window — SGMXMainWindow with customizable menus, toolbars, console, HDF5 workspace, and status bar.
sigimax.widgets	Reusable Qt widgets — scientific dialogs (fitting, peak detection, baseline, cursor, delta-X), HDF5 browser, log viewer, wizard, splash screen, status bar, and dockable plot widgets.
sigimax.h5	HDF5 I/O — import, read, write, and browse HDF5 files with node factory and data extraction utilities.
sigimax.adapters_plotpy	PlotPy adapters — converters between Sigima objects (SignalObj, ImageObj, ROIs) and PlotPy plot/annotation items.
sigimax.utils	Utilities — Qt helpers (log management, signal blocking, progress bars), configuration directory resolution, and callback workers.

Public modules:

• Application launcher
  • create()
  • run()
• SigimaX Configuration Options System (sigimax.config)
  • SigimaXOptions
  • AppOptionsContainer
  • OptionField
  • TypedOptionField
  • ImageIOOptionField
  • EnumOptionField
  • TupleOptionField
  • FontOptionField
  • ConfigPathOptionField
  • WorkingDirOptionField
  • FormatStringOptionField
  • DataSetOptionField
  • get_conf()
  • set_conf()
  • reset_conf()
• SigimaX environment utilities (sigimax.env)
  • VerbosityLevels
  • SGMXExecEnv
• Main window
  • SGMXMainWindow
• sigimax.widgets — Reusable Qt Widgets
  • SigimaX widgets
  • Submodules
• SigimaX HDF5 I/O module (sigimax.h5)
  • H5Importer
  • NodeFactory
  • BaseNode
  • GroupNode
  • RootNode
• Adapters for PlotPy
  • PlotPyAdapterFactory
  • get_adapter_factory()
  • set_adapter_factory()
  • reset_adapter_factory()
  • create_adapter_from_object()
  • SignalObjPlotPyAdapter
  • ImageObjPlotPyAdapter
  • SegmentROIPlotPyAdapter
  • SignalROIPlotPyAdapter
  • RectangularROIPlotPyAdapter
  • CircularROIPlotPyAdapter
  • PolygonalROIPlotPyAdapter
  • items_to_json()
  • json_to_items()
  • plotitem_to_singleroi()
  • singleroi_to_plotitem()
  • configure_roi_item()
• sigimax.utils — Utilities
  • Utilities
  • Submodules