Split interface of StreamProcessor
into two parts
#175
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 change is motivated by an updated understanding of how we want to use
StreamProcessor
inBeamlime
. In particular, we may want to add chunks "eagerly" (so expensive compute can start) instead of "lazily" (when we want to get an updated result plot). This is to reduce latency and improve throughput.To avoid performing potentially expensive post-accumulation computation with every added chunk, I split
StreamProcessor.add_chunk
into two methods. I also added anallow_bypass
flag. This is a useful feature that was "on" by default in the previous implementation, but during discussion with @YooSunYoung we discovered that it can have unintended consequences and is risky when used without care (see also docstring). Is it thus off by default.