MAINT: signal: rename `sosfreqz` to `freqz_sos`
Reference issue
Issue: https://github.com/scipy/scipy/issues/8319 Closes PR https://github.com/scipy/scipy/pull/8213
What does this implement/fix?
Rename sosfreqz to freqz_sos and keeps sosfreqz as an alias.
Additional information
I'd like to discuss three things:
- Should I place
sosfreqzin the signa index? I think that the docs build fails if it's not there. - I also placed a message just like the one at the end of interpolate for
pchip. Is it necessary?
https://github.com/scipy/scipy/blob/776e64056f64bd70b503b7f8deb31fc155ac5c40/scipy/interpolate/init.py#L164-L165
- From #8213:
sosfiltsosfilt_zisosfiltfiltshould also be renamed by the same logic?
As soon as I have some feedback I wrap up the PR for merging.
You can change it from single backticks (linking mode) to double backticks (code mode) in the 0.19 release notes.
Hello! Any updates on this?
You can change it from single backticks (linking mode) to double backticks (code mode) in the 0.19 release notes.
Yes! It is done!
I updated the documentation with your suggestions: https://github.com/scipy/scipy/pull/21025/files#diff-8a209fb35304df0e94887edfc436340479c2202ea7e37f7403e06135f823b093R117-R118
And I added a compatibility test similar to what's been done to other functions: https://github.com/scipy/scipy/pull/21025/files#diff-813f319a7ef4c294752f17de96f110c7e2d8cd6cbddbe3e73f2512917ad51ac7R946-R956
I had one fail from CI but it seems it was a network error: https://github.com/scipy/scipy/actions/runs/10675563135/job/29587743786?pr=21025
Looks good! #8213 already had an approval and but needed a bit of extra work to get it over the finish line and that has now been done (and CIs are green; I restarted the one that had a timeout), so I'll go ahead and merge. Thanks @luxedo !
Given that this is fresh in my head, I'll try to open PRs to standardize sosfilt sosfilt_zi sosfiltfilt as well.
@endolith in https://github.com/scipy/scipy/pull/8213#issuecomment-377970108