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
Refactor background classes #1232
Merged
Merged
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
larrybradley
force-pushed
the
bkg2d-refactor
branch
from
September 3, 2021 00:27
e664866
to
ffa082b
Compare
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.
This PR is a refactor of the background classes, including
Background2D
, motivated to improve their performance. The original implementation used numpyMaskedArray
, which can be slow. This implementation uses plainndarray
, usingnp.nan
values to represent masked pixels. This is possible due to a change where all non-finite values (i.e, NaN, inf) are automatically masked. This is consistent with the behavior of astropySigmaClip
, which the background classes use heavily.Additional performance gains also now come when the optional
bottleneck
package is installed.Overall, the performance gains can be up to 10-50%, depending on the array size and input parameters.
The
background_mesh_ma
andbackground_rms_mesh_ma
attributes have been renamed tobackground_mesh_masked
andbackground_rms_mesh_masked
and are now deprecated.This PR introduces a backwards-incompatible API change in that the background statistics classes (e.g.,
MeanBackground
) now return andarray
withnp.nan
values at masked pixels instead of aMaskedArray
. Any user-definedbkg_estimator
orbkgrms_estimator
functions/classes input toBackground2D
must also have the same behavior.This PR also adds a
masked
keyword to the background statistic classes to return aMaskedArray
.