-
Notifications
You must be signed in to change notification settings - Fork 33
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
Added type of frequency clarification #53
base: master
Are you sure you want to change the base?
Added type of frequency clarification #53
Conversation
In reading the documentation for `fftfreqs`, I did not find what I came there for - a clarification about if the frequencies were measured in oscillations/second, or radians/second. From my background (engineering student), I am used to talking about angular frequencies in most cases, and so the fact that normal frequency is returned was not obvious to me, indication that it might not be to everyone. I have therefore appended the following line in the docs for `fftfreq` and `rfftfreq`: `The return values are not to be confused with angular frequency.` I considered specifying the unit of oscillation/second, but I felt like specifying this without adding "as opposed to..." was weird, and when adding it, it is longer and more trailing than this solution. Other suggestions are very welcome
Codecov Report
@@ Coverage Diff @@
## master #53 +/- ##
==========================================
- Coverage 52.63% 47.87% -4.76%
==========================================
Files 2 2
Lines 95 94 -1
==========================================
- Hits 50 45 -5
- Misses 45 49 +4
Continue to review full report at Codecov.
|
friendly bump |
Perhaps you may also add that the angular frequencies may be obtained by multiplying the output by |
Check. I am on my phone, so I could not find the UTF8 symbol for pi, but feel free to insert it id you can. Otherwise I think that 'pi' ia more reliable to display properly on e.g. phones. |
Yeah |
In reading the documentation for
fftfreqs
, I did not find what I came there for - a clarification about if the frequencies were measured in oscillations/second, or radians/second. From my background (engineering student), I am used to talking about angular frequencies in most cases, and so the fact that normal frequency is returned was not obvious to me, an indication that it might not be to everyone. I have therefore appended the following line in the docs forfftfreq
andrfftfreq
:The return values are not to be confused with angular frequency.
I considered specifying the unit of oscillation/second, but I felt like specifying this without adding "as opposed to..." was weird, and when adding it, it is longer and more trailing than this solution. Other suggestions are very welcome