Implement time delay plugin #1005
Open
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.
What is the problem / what does the code in this PR do
In simulation plugins (e.g., S2 simulations in
fuse), operations like sampling electron drift time add variable delays to output timestamps. This causes output data to exceed input chunk boundaries, breaking strax's chunking assumptions. This PR addsTimeDelayPlugin, a base class that handles buffering and chunking for plugins with time-delayed output.Can you briefly describe how it works?
TimeDelayPluginbuffers output data and releases it when safe:endtime <= input_chunk.endis output immediatelySubclasses implement
compute_with_delay(**kwargs)(returns delayed output arrays).Can you give a minimal working example (or illustrate with a figure)?
Output times may exceed input chunk boundaries, and the plugin handles buffering and re-sorting automatically.
Checklist:
TimeDelayPluginclassdocs/source/advanced/plugin_dev.rsttests/test_time_delay_plugin.py(6 tests covering constant delay, variable delay, empty chunks, multi-output, chunk continuity, and straddling data)