Prevent normcorre from failing if shifts are too large relative to patch size #34
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fetch upstream.
Add check magnitude of shifts, and constrain them by size of image/patch to prevent out of bounds errors.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
We have occasional failures when running NoRMCorre on very sparse data or data with occasional very large movements. The error happens in the remove_boundaries function, and this is a proposed workaround to prevent normcorre from aborting.
Sometimes the big movements are only present in a subset of frames and its better to have the corrected result with some frames being suboptimal than spending time debugging and trying to find a better grid size.
I added a warning whenever the shifts are to large relative to the grid_size, but this might mess up the command line, so maybe it should only be displayed once (i.e use a persistent variable to skip showing warning multiple times) or be connected to the verbosity levels.