Allow setting frequency units for psd plots - #32211
Conversation
In psd, allow user to specify the units for the sampling frequency of the analyzed array. psd previously assumed units to be Hz and displayed this on the y-axis label. Users can now specify other units. This change has no effect on the psd calculation.
|
Thank you for opening your first PR into Matplotlib! If you have not heard from us in a week or so, please leave a new comment below and that should bring it to our attention. Most of our reviewers are volunteers and sometimes things fall through the cracks. We also ask that you please finish addressing any review comments on this PR and wait for it to be merged (or closed) before opening a new one, as it can be a valuable learning experience to go through the review process. You can also join us on discourse chat for real-time discussion. For details on testing, writing docs, and our review process, please see the developer guide. We strive to be a welcoming and open project. Please follow our Code of Conduct. |
github-actions
Bot
added
first-contribution
topic: pyplot API
Documentation: examples
scottshambaugh
left a comment
scottshambaugh
left a comment
There was a problem hiding this comment.
One comment to avoid an API break, but I think this looks pretty good and is a nice quality-of-life improvement.
| @_preprocess_data(replace_names=["x"]) | ||
| @_docstring.interpd | ||
| def psd(self, x, NFFT=None, Fs=None, Fc=None, detrend=None, | ||
| def psd(self, x, NFFT=None, Fs=None, Funits=None, Fc=None, detrend=None, |
There was a problem hiding this comment.
This should go right before **kwargs so that it doesn't break current positional arguments. And then update the positions below as well
2 participants
PR summary
This PR allows users to specify the units for the sampling frequency in power spectral density (psd) plots. psd previously assumed units to be Hz and displayed Hz on the y-axis label. Users can now specify other units with the
Funitskeyword. If the keyword is omitted, Hz is assumed by default, so the change is backward compatible. This change has no effect on the psd calculation, only the resulting plot.AI Disclosure
No AI was used
PR quality check