How dstl/stone-soup works
Main Components Structure
The system should be organized into these primary layers:
a) Core Framework Layer:
• Base components (/stonesoup/base.py)
• Types system (/stonesoup/types/)
• Configuration system (/stonesoup/config.py)
b) Algorithm Components Layer:
• Trackers (/stonesoup/tracker/)
• Filters (/stonesoup/predictor/, /stonesoup/updater/)
• Data Association (/stonesoup/dataassociator/)
• Metrics (/stonesoup/metricgenerator/)
c) Models Layer:
• Measurement models (/stonesoup/models/measurement/)
• Transition models (/stonesoup/models/transition/)
• Clutter models (/stonesoup/models/clutter/)
d) Input/Output Layer:
• Readers (/stonesoup/reader/)
• Writers (/stonesoup/writer/)
• Serialization (/stonesoup/serialise.py)
Component Relationships
Key interactions:
[Input Sources] → [Readers] → [Trackers/Filters] → [Writers] → [Output]
• ↑ ↑
• [Data Models] → [Algorithms]
• ↑ ↑
• [Base Components] → [Types]
Specific Design Elements
Use these visual elements:
Implementation Details
Key features:
• Component interfaces (shown in /stonesoup/base.py)
• Plugin architecture (/stonesoup/plugins.py)
• Metric generation system
• Simulation capabilities (/stonesoup/simulator/)
┌─────────────────────────────────────────┐
• Applications │
• ┤
• Algorithms & Components │
• ┤
• Models & State Estimation │
• ┤
• Core Framework │
• ┘
Additional Elements
Include:
• Version information
• Key dependencies
• Extension points
• Testing/validation flows
Remember to include the extensive tutorial and example support (/docs/tutorials/ and /docs/examples/) as part of the documentation layer, as these are crucial for understanding the system's usage.
This design should reflect Stone Soup's nature as a flexible, extensible framework for developing and testing tracking and state estimation algorithms, while maintaining clarity about how components interact and can be customized.