Title: [Bug]: Possible problem with parameter `NFFT` and `pad_to` of `mlab._spectral_helper` · Issue #24822 · matplotlib/matplotlib · GitHub
Open Graph Title: [Bug]: Possible problem with parameter `NFFT` and `pad_to` of `mlab._spectral_helper` · Issue #24822 · matplotlib/matplotlib
X Title: [Bug]: Possible problem with parameter `NFFT` and `pad_to` of `mlab._spectral_helper` · Issue #24822 · matplotlib/matplotlib
Description: Bug summary If my understanding is correct: NFFT of mlab._spectral_helper corresponds to nperseg of spectral funtions of scipy.signal. It's the actual length of signal (segment) for DFT. pad_to of mlab._spectral_helper corresponds to nff...
Open Graph Description: Bug summary If my understanding is correct: NFFT of mlab._spectral_helper corresponds to nperseg of spectral funtions of scipy.signal. It's the actual length of signal (segment) for DFT. pad_to of ...
X Description: Bug summary If my understanding is correct: NFFT of mlab._spectral_helper corresponds to nperseg of spectral funtions of scipy.signal. It's the actual length of signal (segment) for DFT. pad_to...
Opengraph URL: https://github.com/matplotlib/matplotlib/issues/24822
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"[Bug]: Possible problem with parameter `NFFT` and `pad_to` of `mlab._spectral_helper`","articleBody":"### Bug summary\r\n\r\nIf my understanding is correct:\r\n- `NFFT` of `mlab._spectral_helper` corresponds to `nperseg` of spectral funtions of `scipy.signal`.\r\n It's the actual length of signal (segment) for DFT.\r\n- `pad_to` of `mlab._spectral_helper` corresponds to `nfft` of spectral funtions of `scipy.signal`.\r\n It's the length of DFT, i.e. parameter `n` of `fft` funtion.\r\n https://github.com/matplotlib/matplotlib/blob/3418bada1c1f44da1f73916c5603e3ae79fe58c1/lib/matplotlib/mlab.py#L385\r\n\r\nBut the implementation of Matplotlib is really confusion:\r\n- If length of signal is less than NFFT, signal will pad to length of NFFT.\r\n https://github.com/matplotlib/matplotlib/blob/3418bada1c1f44da1f73916c5603e3ae79fe58c1/lib/matplotlib/mlab.py#L342-L351\r\n \u003c!--https://github.com/matplotlib/matplotlib/blob/3418bada1c1f44da1f73916c5603e3ae79fe58c1/lib/matplotlib/mlab.py#L316-L318--\u003e\r\n And the window is determined by NFFT instead of actual length of signal. This would cause wrong window correction.\r\n https://github.com/matplotlib/matplotlib/blob/3418bada1c1f44da1f73916c5603e3ae79fe58c1/lib/matplotlib/mlab.py#L376-L380\r\n\r\n- The Nyquist frequency is `NFFT/2` instead of `pad_to/2`.\r\n https://github.com/matplotlib/matplotlib/blob/3418bada1c1f44da1f73916c5603e3ae79fe58c1/lib/matplotlib/mlab.py#L411-L416\r\n\r\n### Code for reproduction\r\n\r\n```python\r\nimport numpy as np\r\nfrom matplotlib import mlab\r\nfs = 1000\r\nt = np.arange(0, 1, 1/fs)\r\nrng = np.random.default_rng(42)\r\ns = np.sin(2 * np.pi * 100 * t) + 0.5 * rng.normal(size=t.shape)\r\n\r\nnfft = 2048\r\nnsignal = len(s) #1000\r\npsd, freqs = mlab.psd(s, NFFT=nfft, Fs=fs, window=mlab.window_none)\r\n\r\nmag = np.abs(np.fft.rfft(s, n=nfft))\r\npsd1 = (mag)**2/nsignal/fs\r\nif not nfft % 2:\r\n psd1[1:-1] *= 2\r\nelse: \r\n psd1[1:] *= 2\r\nrelative_error = np.abs( 2 * (psd-psd1)/(psd + psd1) )\r\nprint(relative_error.max())\r\n```\r\n\r\n### Actual outcome\r\n\r\n0.6876640419947717\r\n\r\n### Expected outcome\r\n\r\n0","author":{"url":"https://github.com/gapplef","@type":"Person","name":"gapplef"},"datePublished":"2022-12-27T05:46:50.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":5},"url":"https://github.com/24822/matplotlib/issues/24822"}
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:86e66ee7-79bc-a2a3-e65f-0d0ba4eabc41 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | D8BA:23AA91:F2FED2:145E561:6A5444BA |
| html-safe-nonce | 66d87c1531a7ceb5f632cfd2d74710a287a1984be1aa31eb88203730d4126938 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJEOEJBOjIzQUE5MTpGMkZFRDI6MTQ1RTU2MTo2QTU0NDRCQSIsInZpc2l0b3JfaWQiOiI1MDE0OTUwOTc5MzUyOTM3NjU4IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | c4754c988455e9b22daca399e92501af064b30666bbc1ab09e373332e3f1c2b2 |
| hovercard-subject-tag | issue:1511457897 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/matplotlib/matplotlib/24822/issue_layout |
| twitter:image | https://opengraph.githubassets.com/16a08a5920ef8f25b06128c045868d2876fbf279394f1cedf1c0fd3c85420890/matplotlib/matplotlib/issues/24822 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/16a08a5920ef8f25b06128c045868d2876fbf279394f1cedf1c0fd3c85420890/matplotlib/matplotlib/issues/24822 |
| og:image:alt | Bug summary If my understanding is correct: NFFT of mlab._spectral_helper corresponds to nperseg of spectral funtions of scipy.signal. It's the actual length of signal (segment) for DFT. pad_to of ... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | gapplef |
| hostname | github.com |
| expected-hostname | github.com |
| None | b9a586c06a05a7a86fc7e3f4dbd03e42f6869085879aa184aa6369456dbd50fb |
| turbo-cache-control | no-preview |
| go-import | github.com/matplotlib/matplotlib git https://github.com/matplotlib/matplotlib.git |
| octolytics-dimension-user_id | 215947 |
| octolytics-dimension-user_login | matplotlib |
| octolytics-dimension-repository_id | 1385122 |
| octolytics-dimension-repository_nwo | matplotlib/matplotlib |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 1385122 |
| octolytics-dimension-repository_network_root_nwo | matplotlib/matplotlib |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 07a982c1d40157c619b364352b704c3ce66bb332 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width