From f0e1d4bef110a4b9723498e5fd4b33c05e14dfc8 Mon Sep 17 00:00:00 2001 From: KronosTheLate <61620837+KronosTheLate@users.noreply.github.com> Date: Mon, 22 Feb 2021 13:02:36 +0100 Subject: [PATCH 1/3] Added type of frequency clarification 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 --- src/definitions.jl | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/definitions.jl b/src/definitions.jl index 6551747..e9d5274 100644 --- a/src/definitions.jl +++ b/src/definitions.jl @@ -429,6 +429,7 @@ Return the discrete Fourier transform (DFT) sample frequencies for a DFT of leng `Frequencies` object is an `AbstractVector` containing the frequency bin centers at every sample point. `fs` is the sampling rate of the input signal, which is the reciprocal of the sample spacing. +The return values are not to be confused with angular frequency. Given a window of length `n` and a sampling rate `fs`, the frequencies returned are @@ -464,6 +465,7 @@ Return the discrete Fourier transform (DFT) sample frequencies for a real DFT of The returned `Frequencies` object is an `AbstractVector` containing the frequency bin centers at every sample point. `fs` is the sampling rate of the input signal, which is the reciprocal of the sample spacing. +The return values are not to be confused with angular frequency. Given a window of length `n` and a sampling rate `fs`, the frequencies returned are From 24f5ffe9caf80917e400de9981e218edee9de5f1 Mon Sep 17 00:00:00 2001 From: KronosTheLate <61620837+KronosTheLate@users.noreply.github.com> Date: Tue, 27 Jul 2021 13:39:14 +0200 Subject: [PATCH 2/3] Added 2pi suggestion --- src/definitions.jl | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/definitions.jl b/src/definitions.jl index e9d5274..4f2e561 100644 --- a/src/definitions.jl +++ b/src/definitions.jl @@ -429,7 +429,7 @@ Return the discrete Fourier transform (DFT) sample frequencies for a DFT of leng `Frequencies` object is an `AbstractVector` containing the frequency bin centers at every sample point. `fs` is the sampling rate of the input signal, which is the reciprocal of the sample spacing. -The return values are not to be confused with angular frequency. +The return values are not to be confused with angular frequency, which is obtained by multiplying the output with 2pi. Given a window of length `n` and a sampling rate `fs`, the frequencies returned are @@ -465,7 +465,7 @@ Return the discrete Fourier transform (DFT) sample frequencies for a real DFT of The returned `Frequencies` object is an `AbstractVector` containing the frequency bin centers at every sample point. `fs` is the sampling rate of the input signal, which is the reciprocal of the sample spacing. -The return values are not to be confused with angular frequency. +The return values are not to be confused with angular frequency, which is obtained by multiplying the output with 2pi. Given a window of length `n` and a sampling rate `fs`, the frequencies returned are From ac9264ec6c5b1c956c39ce86ffede90ef9bc80cc Mon Sep 17 00:00:00 2001 From: KronosTheLate <61620837+KronosTheLate@users.noreply.github.com> Date: Wed, 28 Jul 2021 09:28:11 +0200 Subject: [PATCH 3/3] Added backticks --- src/definitions.jl | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/definitions.jl b/src/definitions.jl index 4f2e561..7785b98 100644 --- a/src/definitions.jl +++ b/src/definitions.jl @@ -429,7 +429,7 @@ Return the discrete Fourier transform (DFT) sample frequencies for a DFT of leng `Frequencies` object is an `AbstractVector` containing the frequency bin centers at every sample point. `fs` is the sampling rate of the input signal, which is the reciprocal of the sample spacing. -The return values are not to be confused with angular frequency, which is obtained by multiplying the output with 2pi. +The return values are not to be confused with angular frequency, which is obtained by multiplying the output with `2pi`. Given a window of length `n` and a sampling rate `fs`, the frequencies returned are @@ -465,7 +465,7 @@ Return the discrete Fourier transform (DFT) sample frequencies for a real DFT of The returned `Frequencies` object is an `AbstractVector` containing the frequency bin centers at every sample point. `fs` is the sampling rate of the input signal, which is the reciprocal of the sample spacing. -The return values are not to be confused with angular frequency, which is obtained by multiplying the output with 2pi. +The return values are not to be confused with angular frequency, which is obtained by multiplying the output with `2pi`. Given a window of length `n` and a sampling rate `fs`, the frequencies returned are