Added type of frequency clarification#53
Added type of frequency clarification#53KronosTheLate wants to merge 5 commits intoJuliaMath:masterfrom
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
Welcome to Codecov 🎉Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests. Thanks for integrating Codecov - We've got you covered ☂️ |
|
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 |
|
Bump, I think this can be merged? |
|
Haha 5 years later xD But yhea, I agree this should be good to go. |
|
😛 
|
Co-authored-by: Steven G. Johnson <stevenj@mit.edu>
4 participants
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 forfftfreqandrfftfreq: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