You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: dev/estimation/index.html
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -8,8 +8,8 @@
8
8
julia> esprit(x, M, p, Fs)
9
9
2-element Vector{Float64}:
10
10
2502.2704154274957
11
-
399.8420984461712</code></pre></div><aclass="docs-sourcelink" target="_blank" href="https://github.com/JuliaDSP/DSP.jl/blob/c1c10b3de2127a3db8eb6a5823ddc74c3134621e/src/estimation.jl#L9-L66">source</a></section></details></article><article><detailsclass="docstring" open="true"><summaryid="DSP.Estimation.jacobsen"><aclass="docstring-binding" href="#DSP.Estimation.jacobsen"><code>DSP.Estimation.jacobsen</code></a> — <spanclass="docstring-category">Function</span></summary><section><div><pre><codeclass="language-julia hljs">jacobsen(x::AbstractVector, Fs::Real = 1.0)</code></pre><p>Estimate the largest frequency in the complex signal <code>x</code> using Jacobsen's algorithm <supclass="footnote-reference"><aid="citeref-Jacobsen2007" href="#footnote-Jacobsen2007" class="footnote-ref">[Jacobsen2007]</a><spanclass="footnote-preview" id="fn-Jacobsen2007"></span></sup>. Argument <code>Fs</code> is the sampling frequency. All frequencies are expressed in Hz.</p><p>If the signal <code>x</code> is real, the estimated frequency is guaranteed to be positive, but it may be highly inaccurate (especially for frequencies close to zero or to <code>Fs/2</code>).</p><p>If the sampling frequency <code>Fs</code> is not provided, then it is assumed that <code>Fs = 1.0</code>.</p></div><aclass="docs-sourcelink" target="_blank" href="https://github.com/JuliaDSP/DSP.jl/blob/c1c10b3de2127a3db8eb6a5823ddc74c3134621e/src/estimation.jl#L77-L92">source</a></section></details></article><article><detailsclass="docstring" open="true"><summaryid="DSP.Estimation.quinn"><aclass="docstring-binding" href="#DSP.Estimation.quinn"><code>DSP.Estimation.quinn</code></a> — <spanclass="docstring-category">Function</span></summary><section><div><pre><codeclass="language-julia hljs">quinn(x::Vector, f0::Real, Fs::Real = 1.0 ; tol = 1e-6, maxiters = 20)
11
+
399.8420984461712</code></pre></div><aclass="docs-sourcelink" target="_blank" href="https://github.com/JuliaDSP/DSP.jl/blob/fa3805b11e8d08bc20f2050febb939d903295ab3/src/estimation.jl#L9-L66">source</a></section></details></article><article><detailsclass="docstring" open="true"><summaryid="DSP.Estimation.jacobsen"><aclass="docstring-binding" href="#DSP.Estimation.jacobsen"><code>DSP.Estimation.jacobsen</code></a> — <spanclass="docstring-category">Function</span></summary><section><div><pre><codeclass="language-julia hljs">jacobsen(x::AbstractVector, Fs::Real = 1.0)</code></pre><p>Estimate the largest frequency in the complex signal <code>x</code> using Jacobsen's algorithm <supclass="footnote-reference"><aid="citeref-Jacobsen2007" href="#footnote-Jacobsen2007" class="footnote-ref">[Jacobsen2007]</a><spanclass="footnote-preview" id="fn-Jacobsen2007"></span></sup>. Argument <code>Fs</code> is the sampling frequency. All frequencies are expressed in Hz.</p><p>If the signal <code>x</code> is real, the estimated frequency is guaranteed to be positive, but it may be highly inaccurate (especially for frequencies close to zero or to <code>Fs/2</code>).</p><p>If the sampling frequency <code>Fs</code> is not provided, then it is assumed that <code>Fs = 1.0</code>.</p></div><aclass="docs-sourcelink" target="_blank" href="https://github.com/JuliaDSP/DSP.jl/blob/fa3805b11e8d08bc20f2050febb939d903295ab3/src/estimation.jl#L77-L92">source</a></section></details></article><article><detailsclass="docstring" open="true"><summaryid="DSP.Estimation.quinn"><aclass="docstring-binding" href="#DSP.Estimation.quinn"><code>DSP.Estimation.quinn</code></a> — <spanclass="docstring-category">Function</span></summary><section><div><pre><codeclass="language-julia hljs">quinn(x::Vector, f0::Real, Fs::Real = 1.0 ; tol = 1e-6, maxiters = 20)
12
12
13
13
quinn(x::Vector, Fs::Real = 1.0 ; kwargs...)
14
14
15
-
quinn(x::Vector ; kwargs...)</code></pre><p>Algorithms by Quinn and Quinn & Fernandes for frequency estimation. Given a signal <code>x</code> and an initial guess <code>f0</code>, estimate and return the frequency of the largest sinusoid in <code>x</code>. <code>Fs</code> is the sampling frequency. All frequencies are expressed in Hz.</p><p>If the initial guess <code>f0</code> is not provided, then a guess is calculated using Jacobsen's estimator. If the sampling frequency <code>Fs</code> is not provided, then it is assumed that <code>Fs = 1.0</code>.</p><p>The following keyword arguments control the algorithm's behavior:</p><ul><li><code>tol</code>: the algorithm stops when the absolute value of the difference between two consecutive estimates is less than <code>tol</code>. Defaults to <code>1e-6</code>.</li><li><code>maxiters</code>: the maximum number of iterations to run. Defaults to <code>20</code>.</li></ul><p>Returns a tuple <code>(estimate, reachedmaxiters)</code>, where <code>estimate</code> is the estimated frequency, and <code>reachedmaxiters</code> is <code>true</code> if the algorithm finished after running for <code>maxiters</code> iterations (this may indicate that the algorithm did not converge).</p><p>If the signal <code>x</code> is real, then the algorithm used is <supclass="footnote-reference"><aid="citeref-Quinn1991" href="#footnote-Quinn1991" class="footnote-ref">[Quinn1991]</a><spanclass="footnote-preview" id="fn-Quinn1991"></span></sup>. If the signal is complex, the algorithm is <supclass="footnote-reference"><aid="citeref-Quinn2009" href="#footnote-Quinn2009" class="footnote-ref">[Quinn2009]</a><spanclass="footnote-preview" id="fn-Quinn2009"></span></sup>.</p></div><aclass="docs-sourcelink" target="_blank" href="https://github.com/JuliaDSP/DSP.jl/blob/c1c10b3de2127a3db8eb6a5823ddc74c3134621e/src/estimation.jl#L117-L152">source</a></section></details></article><sectionclass="footnotes is-size-7"><ul><liclass="footnote" id="footnote-Roy1986"><aclass="tag is-link" href="#citeref-Roy1986">Roy1986</a>R Roy, A Paulraj and T Kailath, ESPRIT - A subspace approach to estimation of parameters of cisoids in noise, IEEE Trans. Acoustics, Speech, Signal Process., 34, 1340-1342 (1986). <ahref="http://ieeexplore.ieee.org/abstract/document/1164935/">http://ieeexplore.ieee.org/abstract/document/1164935/</a>.</li><liclass="footnote" id="footnote-Jacobsen2007"><aclass="tag is-link" href="#citeref-Jacobsen2007">Jacobsen2007</a>E Jacobsen and P Kootsookos, "Fast, Accurate Frequency Estimators", Chapter 10 in "Streamlining Digital Signal Processing", edited by R. Lyons, 2007, IEEE Press.</li><liclass="footnote" id="footnote-Quinn1991"><aclass="tag is-link" href="#citeref-Quinn1991">Quinn1991</a>B Quinn and J Fernandes, "A fast efficient technique for the estimation of frequency", Biometrika, Vol. 78 (1991).</li><liclass="footnote" id="footnote-Quinn2009"><aclass="tag is-link" href="#citeref-Quinn2009">Quinn2009</a>B Quinn, "Recent advances in rapid frequency estimation", Digital Signal Processing, Vol. 19 (2009), Elsevier.</li></ul></section></article><navclass="docs-footer"><aclass="docs-footer-prevpage" href="../periodograms/">« <code>Periodograms</code> - periodogram estimation</a><aclass="docs-footer-nextpage" href="../windows/"><code>Windows</code> - window functions »</a><divclass="flexbox-break"></div><pclass="footer-message">Powered by <ahref="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <ahref="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><divclass="modal" id="documenter-settings"><divclass="modal-background"></div><divclass="modal-card"><headerclass="modal-card-head"><pclass="modal-card-title">Settings</p><buttonclass="delete"></button></header><sectionclass="modal-card-body"><p><labelclass="label">Theme</label><divclass="select"><selectid="documenter-themepicker"><optionvalue="auto">Automatic (OS)</option><optionvalue="documenter-light">documenter-light</option><optionvalue="documenter-dark">documenter-dark</option><optionvalue="catppuccin-latte">catppuccin-latte</option><optionvalue="catppuccin-frappe">catppuccin-frappe</option><optionvalue="catppuccin-macchiato">catppuccin-macchiato</option><optionvalue="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <ahref="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.16.1 on <spanclass="colophon-date" title="Monday 2 February 2026 06:52">Monday 2 February 2026</span>. Using Julia version 1.12.4.</p></section><footerclass="modal-card-foot"></footer></div></div></div></body></html>
15
+
quinn(x::Vector ; kwargs...)</code></pre><p>Algorithms by Quinn and Quinn & Fernandes for frequency estimation. Given a signal <code>x</code> and an initial guess <code>f0</code>, estimate and return the frequency of the largest sinusoid in <code>x</code>. <code>Fs</code> is the sampling frequency. All frequencies are expressed in Hz.</p><p>If the initial guess <code>f0</code> is not provided, then a guess is calculated using Jacobsen's estimator. If the sampling frequency <code>Fs</code> is not provided, then it is assumed that <code>Fs = 1.0</code>.</p><p>The following keyword arguments control the algorithm's behavior:</p><ul><li><code>tol</code>: the algorithm stops when the absolute value of the difference between two consecutive estimates is less than <code>tol</code>. Defaults to <code>1e-6</code>.</li><li><code>maxiters</code>: the maximum number of iterations to run. Defaults to <code>20</code>.</li></ul><p>Returns a tuple <code>(estimate, reachedmaxiters)</code>, where <code>estimate</code> is the estimated frequency, and <code>reachedmaxiters</code> is <code>true</code> if the algorithm finished after running for <code>maxiters</code> iterations (this may indicate that the algorithm did not converge).</p><p>If the signal <code>x</code> is real, then the algorithm used is <supclass="footnote-reference"><aid="citeref-Quinn1991" href="#footnote-Quinn1991" class="footnote-ref">[Quinn1991]</a><spanclass="footnote-preview" id="fn-Quinn1991"></span></sup>. If the signal is complex, the algorithm is <supclass="footnote-reference"><aid="citeref-Quinn2009" href="#footnote-Quinn2009" class="footnote-ref">[Quinn2009]</a><spanclass="footnote-preview" id="fn-Quinn2009"></span></sup>.</p></div><aclass="docs-sourcelink" target="_blank" href="https://github.com/JuliaDSP/DSP.jl/blob/fa3805b11e8d08bc20f2050febb939d903295ab3/src/estimation.jl#L117-L152">source</a></section></details></article><sectionclass="footnotes is-size-7"><ul><liclass="footnote" id="footnote-Roy1986"><aclass="tag is-link" href="#citeref-Roy1986">Roy1986</a>R Roy, A Paulraj and T Kailath, ESPRIT - A subspace approach to estimation of parameters of cisoids in noise, IEEE Trans. Acoustics, Speech, Signal Process., 34, 1340-1342 (1986). <ahref="http://ieeexplore.ieee.org/abstract/document/1164935/">http://ieeexplore.ieee.org/abstract/document/1164935/</a>.</li><liclass="footnote" id="footnote-Jacobsen2007"><aclass="tag is-link" href="#citeref-Jacobsen2007">Jacobsen2007</a>E Jacobsen and P Kootsookos, "Fast, Accurate Frequency Estimators", Chapter 10 in "Streamlining Digital Signal Processing", edited by R. Lyons, 2007, IEEE Press.</li><liclass="footnote" id="footnote-Quinn1991"><aclass="tag is-link" href="#citeref-Quinn1991">Quinn1991</a>B Quinn and J Fernandes, "A fast efficient technique for the estimation of frequency", Biometrika, Vol. 78 (1991).</li><liclass="footnote" id="footnote-Quinn2009"><aclass="tag is-link" href="#citeref-Quinn2009">Quinn2009</a>B Quinn, "Recent advances in rapid frequency estimation", Digital Signal Processing, Vol. 19 (2009), Elsevier.</li></ul></section></article><navclass="docs-footer"><aclass="docs-footer-prevpage" href="../periodograms/">« <code>Periodograms</code> - periodogram estimation</a><aclass="docs-footer-nextpage" href="../windows/"><code>Windows</code> - window functions »</a><divclass="flexbox-break"></div><pclass="footer-message">Powered by <ahref="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <ahref="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><divclass="modal" id="documenter-settings"><divclass="modal-background"></div><divclass="modal-card"><headerclass="modal-card-head"><pclass="modal-card-title">Settings</p><buttonclass="delete"></button></header><sectionclass="modal-card-body"><p><labelclass="label">Theme</label><divclass="select"><selectid="documenter-themepicker"><optionvalue="auto">Automatic (OS)</option><optionvalue="documenter-light">documenter-light</option><optionvalue="documenter-dark">documenter-dark</option><optionvalue="catppuccin-latte">catppuccin-latte</option><optionvalue="catppuccin-frappe">catppuccin-frappe</option><optionvalue="catppuccin-macchiato">catppuccin-macchiato</option><optionvalue="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <ahref="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.17.0 on <spanclass="colophon-date" title="Sunday 5 April 2026 09:05">Sunday 5 April 2026</span>. Using Julia version 1.12.5.</p></section><footerclass="modal-card-foot"></footer></div></div></div></body></html>
0 commit comments