Architecture Reference
Technical documentation of OpenHCS’s architecture for developers who need to understand internal implementation details.
Prerequisites: Core Concepts | Integration: Integration Guides
Core System Architecture
Fundamental systems that define OpenHCS architecture.
- Plugin Registry System (AutoRegisterMeta)
- Plugin Registry System - Advanced Topics
- The Function Pattern System
- Function Registry System
- FunctionReference Pattern
- Custom Function Registration System
- Pipeline Compilation System Architecture
- Special I/O System: Cross-Step Communication and Dict Pattern Integration
- Pattern Grouping and Special Output Path Resolution
- ROI Extraction and Streaming System
- Analysis Consolidation System
- Experimental Analysis System
- Dict Pattern Special Outputs: Architectural Case Study
Configuration Systems
Lazy configuration, dual-axis resolution, inheritance detection, and field path systems.
Storage and Memory
File management, memory types, and backend systems.
External Integrations
Integration with external tools and platforms (Napari, OMERO, Fiji).
System Integration
How OpenHCS components work together and integrate with external systems.
Component Systems
Component validation, integration, and processing.
Advanced Processing
GPU management, multiprocessing, and performance optimization.
Metaprogramming and Parsing
Dynamic code generation and parser systems.
User Interface Systems
TUI architecture, UI development patterns, and form management systems.
- TUI System Architecture
- Widget Protocol System
- AbstractManagerWidget Architecture
- AbstractTableBrowser ABC
- List Item Preview System
- Flash Animation System
- Scope Visual Feedback System
- PlateManager Services Architecture
- Batch Workflow Service
- Progress Runtime Projection System
- ZMQ Server Browser System
- Parameter Form Lifecycle Management
- Parameter Form Service Architecture
- UI Services Architecture
- Field Change Dispatcher Architecture
- Parametric Widget Creation
- Code/UI Interconversion System
- Service Layer Architecture
- GUI Performance Patterns
- Cross-Window Update Optimization
- Scope Window Factory System
- Service Registry Integration
Development Tools
Practical tools for OpenHCS development workflows.
Quick Start Paths
New to OpenHCS? Start with The Function Pattern System → Configuration Framework → Storage and Memory System Architecture
Configuration Systems? Focus on Dynamic Dataclass Factory System → Context Management System → Orchestrator Configuration Management
Real-Time Visualization? Begin with Napari Integration Architecture → Napari Streaming System → ROI Extraction and Streaming System → Storage and Memory System Architecture
OMERO Integration? Start with OMERO Backend System → Storage and Memory System Architecture
External Integrations? Start with External Integrations Overview → Napari Integration Architecture → Fiji Streaming System → OMERO Backend System
UI Development? Start with Widget Protocol System → AbstractManagerWidget Architecture → Parametric Widget Creation → Field Change Dispatcher Architecture → UI Services Architecture → Batch Workflow Service → ZMQ Server Browser System → TUI System Architecture
System Integration? Jump to System Integration: VFS, Memory Types, and Compilation → Special I/O System: Cross-Step Communication and Dict Pattern Integration → Microscope Handler Integration
Performance Optimization? Focus on GPU Resource Management System → OpenHCS Pipeline Compilation System - Complete Architecture → Multiprocessing Coordination System
Architecture Quick Start: A short, curated orientation is available at Architecture Quick Start — three recommended reading paths (Core systems, Integrations, UI) to get developers productive quickly.