Ensure freq_axis metadata propagation during NumPy ufunc evaluation#147
Open
vishwas-droid wants to merge 1 commit intosunpy:mainfrom
Open
Ensure freq_axis metadata propagation during NumPy ufunc evaluation#147vishwas-droid wants to merge 1 commit intosunpy:mainfrom
vishwas-droid wants to merge 1 commit intosunpy:mainfrom
Conversation
08b21d4 to
44e0b0f
Compare
This file contains hidden or 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
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.
Spectrumobjects were losing theirfreq_axismetadata when passed through NumPy ufuncs(e.g.,
np.sqrt,np.log, arithmetic operations such asspec + 2).Although the resulting object remained a
Spectruminstance, the associated metadatawas silently dropped, which could lead to incorrect downstream scientific interpretation.
What This PR Does
This PR implements a custom
__array_ufunc__override to:Spectrumfreq_axismetadata (deep copy)Tests
Regression tests have been added to ensure:
freq_axisis preserved after unary ufuncs (e.g.,np.sqrt)freq_axisis preserved after binary operations (e.g.,spec + 5)These tests prevent future silent metadata loss.
Rationale
Preserving metadata integrity is critical in scientific workflows, especially
for radio spectrogram analysis where frequency alignment is essential.