Skip to content
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

Rename fourier_shift #551

Open
wants to merge 3 commits into
base: refactor/deprecation-and-affine-cleanup
Choose a base branch
from

Conversation

waltsims
Copy link
Owner

This pull request introduces several changes to the kwave library, primarily focusing on renaming and improving the functionality of the Fourier shift interpolation method. It also includes updates to the corresponding tests to reflect these changes. The most important changes include renaming the fourier_shift function to phase_shift_interpolate, improving the function's documentation and implementation, and updating the test files accordingly.

Function Renaming and Improvement:

  • Renamed the fourier_shift function to phase_shift_interpolate and updated its implementation to improve precision and clarity. The new implementation includes better handling of dimensions and phase shifts in the Fourier domain.
  • Added a deprecation warning to the old fourier_shift function, advising users to use phase_shift_interpolate instead.

Test Updates:

  • Removed the old test file fourierShift_test.py which tested the fourier_shift function.
  • Added a new test file phase_shift_interpolate_test.py to test the phase_shift_interpolate function and ensure it works as expected. This file also includes a test to check the deprecation warning for the old fourier_shift function.

Import and Utility Updates:

  • Updated imports in kwave/utils/math.py to include necessary modules for the new implementation.

@waltsims waltsims changed the base branch from master to refactor/deprecation-and-affine-cleanup February 10, 2025 01:03
Copy link

codecov bot commented Feb 10, 2025

Codecov Report

Attention: Patch coverage is 77.77778% with 4 lines in your changes missing coverage. Please review.

Project coverage is 73.23%. Comparing base (d6ea904) to head (a7ee788).
Report is 4 commits behind head on refactor/deprecation-and-affine-cleanup.

Files with missing lines Patch % Lines
kwave/utils/math.py 77.77% 2 Missing and 2 partials ⚠️
Additional details and impacted files
@@                             Coverage Diff                             @@
##           refactor/deprecation-and-affine-cleanup     #551      +/-   ##
===========================================================================
- Coverage                                    73.23%   73.23%   -0.01%     
===========================================================================
  Files                                           47       47              
  Lines                                         6857     6856       -1     
  Branches                                      1308     1307       -1     
===========================================================================
- Hits                                          5022     5021       -1     
  Misses                                        1286     1286              
  Partials                                       549      549              
Flag Coverage Δ
3.10 73.23% <77.77%> (-0.01%) ⬇️
3.11 73.23% <77.77%> (-0.01%) ⬇️
3.12 73.23% <77.77%> (-0.01%) ⬇️
3.13 73.23% <77.77%> (-0.01%) ⬇️
macos-latest 73.20% <77.77%> (-0.01%) ⬇️
ubuntu-latest 73.20% <77.77%> (-0.01%) ⬇️
windows-latest 73.22% <77.77%> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant