Integrate useq-schema MDASequence with ImSwitch ExperimentController #145
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR integrates the useq-schema standard for multi-dimensional acquisition protocols with ImSwitch's ExperimentController, providing a modern, software-agnostic interface for designing microscope workflows.
Overview
The useq-schema provides a standardized way to define complex microscopy experiments including time-lapse, Z-stacks, multi-channel imaging, and multi-position acquisitions. This integration allows ImSwitch users to leverage this established standard while maintaining full compatibility with the existing workflow system.
Key Features
MDASequenceManager
useq.MDASequence
objects into ImSwitchWorkflowStep
objectsNew API Endpoints
GET /api/experimentcontroller/get_mda_capabilities
- Check available MDA featuresPOST /api/experimentcontroller/start_mda_experiment
- Execute MDA protocolsPOST /api/experimentcontroller/get_mda_sequence_info
- Preview experiments without executionExample Usage
Implementation Details
Each
MDAEvent
from a useq sequence is converted into multiple workflow steps:This ensures seamless integration with ImSwitch's existing hardware control architecture.
Benefits
Testing
Comprehensive validation includes:
examples/mda_demo.py
)Documentation
docs/mda_integration.md
)This integration addresses the need for a modern, standardized approach to microscopy workflow design while preserving the flexibility and power of ImSwitch's existing experiment system.
Fixes #144.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.