Background estimation with a custom callable statistic #263
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 continues the work done in #255 and #253, enabling the user to provide a custom callable for background calculation. The primary changes are:
The
statistic
argument in theBackground
initializer now accepts"average"
,"median"
, or a custom callable. The callable should accept anumpy.ma.MaskedArray
as input and must also support anaxis
argument.The
bkg_statistic
keyword inBackground.bkg_spectrum()
is now deprecated and triggers a warning if used. Instead, thestatistic
argument in theBackground
initializer should be used.I'd prefer to include these changes in a bugfix release (v1.5.2), which is why I've opted to deprecate rather than remove the
bkg_statistic
argument. However, the current implementation ignores thebkg_statistic
argument, meaning that although the API itself hasn't technically changed, the code's behaviour has.Let me know your thoughts on this approach or if you have suggestions for handling this differently.