How commontk/ctk works
Project type and purpose
• CTK is a large C++ “meta-toolkit” / library suite for medical imaging (DICOM), plugin hosting (OSGi‐style), Qt widgets, CLI modules, scripting and visualization.
• It is not a web or full-stack app, but a monorepo containing reusable libraries (Libs/…), example Applications, Plugins/, and CMake-based build orchestration (SuperBuild.cmake, CMakeExternals).
File structure
• Top-level directories:
• Applications/ – sample and test apps that exercise CTK modules
• Libs/ – core libraries subdivided by domain (Core, DICOM, CommandLineModules, PluginFramework, Widgets, Visualization, etc.)
• Plugins/ – OSGi-style service bundles built atop PluginFramework and CTK services
• CMake/, CMakeExternals/ – build scripts, helpers, ExternalProject recipes
• Utilities/ – helper CMake Find modules, graphing tools
• Each Libs subfolder follows an MVC-style layering:
• Core foundation → domain-specific services (DICOM, PluginFramework, Scripting) → frontends (Qt GUI, WebKit, Python) → application examples.
• Build configuration: CMakeLists.txt at root, SuperBuild.cmake drives dependency fetch & build.
README insights
• CTK covers five main topics: DICOM, DICOM Application Hosting, Widgets, Plugin Framework, Command Line Interfaces.
• External dependencies: Qt5, VTK, DCMTK, PythonQt. Built via CMake ExternalProject (Artichoke).
• Emphasis on service-oriented plugin architecture and separation of frontends vs backends.
Main components
a. External Dependencies (third-party):
• Qt5
• VTK (ChartsCore, GUISupportQt, ViewsQt)
• DCMTK
• PythonQt
b. Build System:
• CMake SuperBuild (fetch & configure externals, orchestrate build)
c. CTK Libraries (runtime modules):
• Core – low-level utilities, threading, file I/O
• CommandLineModules – CLI backend/frontends
• PluginFramework – dynamic service registry & module loader
• Widgets – Qt widget collection (UI components, event translators)
• DICOM – PACS query/retrieve, database, thumbnail generation
• Visualization – VTK-based charts & 3D views
• Scripting – Python embedding and console
• Other domains (ImageProcessing, XNAT, QtTesting, etc.)
d. Frontends/Applications:
• Qt GUI Apps (ctkDICOMHost, ctkCommandLineModuleExplorer, ctkPluginBrowser, etc.)
• CLI test apps
• Script shells (ctkSimplePythonShell)
e. Plugins:
• Bundled OSGi plugins (org.commontk.*) that register CTK services
Relationships & interactions
• CTK Core underpins every other Lib; PluginFramework depends on Core, others register services there.
• Domain libraries (e.g. DICOM) depend on Core, may depend on PluginFramework & Qt.
• Widgets and Visualization depend on Core + PluginFramework + Qt + VTK.
• CommandLineModules backends depend on Core; frontends depend on backends + Qt.
• Applications consume CTK Libraries and Plugins; Plugins are loaded at runtime by PluginFramework.
Architectural patterns & design principles
• Layered modular architecture: Core → Domain libraries → Frontends → Apps
• Service-oriented plugin pattern (OSGi-style): dynamic discovery, registration, activation
• Separation of concerns: backends vs frontends, CLI vs GUI vs scripting
• CMake ExternalProject for dependencies, self-contained SuperBuild