New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Added normalized_epsilon as a parameter to convolve_fft #5177
Closed
Closed
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -226,8 +226,8 @@ def convolve(array, kernel, boundary='fill', fill_value=0., | |
def convolve_fft(array, kernel, boundary='fill', fill_value=0, crop=True, | ||
return_fft=False, fft_pad=None, psf_pad=None, | ||
interpolate_nan=False, quiet=False, ignore_edge_zeros=False, | ||
min_wt=0.0, normalize_kernel=False, allow_huge=False, | ||
fftn=np.fft.fftn, ifftn=np.fft.ifftn, | ||
min_wt=0.0, normalize_kernel=False, normalized_epsilon=1e-8, | ||
allow_huge=False, fftn=np.fft.fftn, ifftn=np.fft.ifftn, | ||
complex_dtype=np.complex): | ||
""" | ||
Convolve an ndarray with an nd-kernel. Returns a convolved image with | ||
|
@@ -312,6 +312,9 @@ def convolve_fft(array, kernel, boundary='fill', fill_value=0, crop=True, | |
256. | ||
quiet : bool, optional | ||
Silence warning message about NaN interpolation | ||
normalized_epsilon: float, optional | ||
The upper limit on the deviation of the kernel sum with respect to unity. | ||
Will be checked only if ``normalize_kernel`` is False. Default is "1e-8". | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think this should mention somewhere that it is a relative tolerance. Since elsewhere we often use |
||
allow_huge : bool, optional | ||
Allow huge arrays in the FFT? If False, will raise an exception if the | ||
array or kernel size is >1 GB | ||
|
@@ -440,7 +443,7 @@ def convolve_fft(array, kernel, boundary='fill', fill_value=0, crop=True, | |
kernel = kernel / normalize_kernel(kernel) | ||
kernel_is_normalized = True | ||
else: | ||
if np.abs(kernel.sum() - 1) < 1e-8: | ||
if np.abs(kernel.sum() - 1) < normalized_epsilon: | ||
kernel_is_normalized = True | ||
else: | ||
kernel_is_normalized = False | ||
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This line contains a trailing whitespace (at the end of the line). That's why your first build failied during the PEP-8 check.