API Reference

This page is generated automatically from the docstrings of the dbs_annotator package. It is aimed at developers extending or embedding the application; clinicians and researchers should prefer the Quick Start and Complete Workflow guides.

The reference deliberately covers the data, configuration, and control layers of the application. The Qt UI layers (dbs_annotator.ui and dbs_annotator.views) are PySide6 subclasses whose public surface is Qt signals and slots; refer to the PySide6 documentation and the source itself for those.

dbs_annotator.config	Configuration module for DBS Annotator.
dbs_annotator.config_electrode_models	Configuration file for DBS electrode models Based on Lead-DBS repository: https://github.com/netstim/leaddbs/tree/master/templates/electrode_models All measurements in millimeters
dbs_annotator.controllers	Controllers for DBS Annotator.
dbs_annotator.logging_config
dbs_annotator.models	Data models for DBS Annotator.
dbs_annotator.utils	Utility functions for DBS Annotator.
dbs_annotator.version	Version helpers.