build based on ade83dd

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.11.2","generation_timestamp":"2024-12-03T11:35:53","documenter_version":"1.8.0"}}
+{"documenter":{"julia_version":"1.11.2","generation_timestamp":"2024-12-04T08:44:07","documenter_version":"1.8.0"}}

dev/estimation/index.html

@@ -8,8 +8,8 @@
 julia> esprit(x, M, p, Fs)
 2-element Vector{Float64}:
 2502.2704154274957
-399.8420984461712</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDSP/DSP.jl/blob/710ee46beff620b0034600ba72b210b960699d17/src/estimation.jl#L9-L66">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="DSP.Estimation.jacobsen" href="#DSP.Estimation.jacobsen"><code>DSP.Estimation.jacobsen</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="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&#39;s algorithm <sup class="footnote-reference"><a id="citeref-Jacobsen2007" href="#footnote-Jacobsen2007">[Jacobsen2007]</a></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><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDSP/DSP.jl/blob/710ee46beff620b0034600ba72b210b960699d17/src/estimation.jl#L77-L92">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="DSP.Estimation.quinn" href="#DSP.Estimation.quinn"><code>DSP.Estimation.quinn</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">quinn(x::Vector, f0::Real, Fs::Real = 1.0 ; tol = 1e-6, maxiters = 20)
+399.8420984461712</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDSP/DSP.jl/blob/ade83ddabd6afcfb2c11aa0524d03e35ea139ce3/src/estimation.jl#L9-L66">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="DSP.Estimation.jacobsen" href="#DSP.Estimation.jacobsen"><code>DSP.Estimation.jacobsen</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="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&#39;s algorithm <sup class="footnote-reference"><a id="citeref-Jacobsen2007" href="#footnote-Jacobsen2007">[Jacobsen2007]</a></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><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDSP/DSP.jl/blob/ade83ddabd6afcfb2c11aa0524d03e35ea139ce3/src/estimation.jl#L77-L92">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="DSP.Estimation.quinn" href="#DSP.Estimation.quinn"><code>DSP.Estimation.quinn</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">quinn(x::Vector, f0::Real, Fs::Real = 1.0 ; tol = 1e-6, maxiters = 20)
 
 quinn(x::Vector, Fs::Real = 1.0 ; kwargs...)
 
-quinn(x::Vector ; kwargs...)</code></pre><p>Algorithms by Quinn and Quinn &amp; 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&#39;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&#39;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 <sup class="footnote-reference"><a id="citeref-Quinn1991" href="#footnote-Quinn1991">[Quinn1991]</a></sup>. If the signal is complex, the algorithm is <sup class="footnote-reference"><a id="citeref-Quinn2009" href="#footnote-Quinn2009">[Quinn2009]</a></sup>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDSP/DSP.jl/blob/710ee46beff620b0034600ba72b210b960699d17/src/estimation.jl#L117-L152">source</a></section></article><section class="footnotes is-size-7"><ul><li class="footnote" id="footnote-Roy1986"><a class="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). <a href="http://ieeexplore.ieee.org/abstract/document/1164935/">http://ieeexplore.ieee.org/abstract/document/1164935/</a>.</li><li class="footnote" id="footnote-Jacobsen2007"><a class="tag is-link" href="#citeref-Jacobsen2007">Jacobsen2007</a>E Jacobsen and P Kootsookos, &quot;Fast, Accurate Frequency Estimators&quot;, Chapter 10 in &quot;Streamlining Digital Signal Processing&quot;, edited by R. Lyons, 2007, IEEE Press.</li><li class="footnote" id="footnote-Quinn1991"><a class="tag is-link" href="#citeref-Quinn1991">Quinn1991</a>B Quinn and J Fernandes, &quot;A fast efficient technique for the estimation of frequency&quot;, Biometrika, Vol. 78 (1991).</li><li class="footnote" id="footnote-Quinn2009"><a class="tag is-link" href="#citeref-Quinn2009">Quinn2009</a>B Quinn, &quot;Recent advances in rapid frequency estimation&quot;, Digital Signal Processing, Vol. 19 (2009), Elsevier.</li></ul></section></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../periodograms/">« <code>Periodograms</code> - periodogram estimation</a><a class="docs-footer-nextpage" href="../windows/"><code>Windows</code> - window functions »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Tuesday 3 December 2024 11:35">Tuesday 3 December 2024</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+quinn(x::Vector ; kwargs...)</code></pre><p>Algorithms by Quinn and Quinn &amp; 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&#39;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&#39;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 <sup class="footnote-reference"><a id="citeref-Quinn1991" href="#footnote-Quinn1991">[Quinn1991]</a></sup>. If the signal is complex, the algorithm is <sup class="footnote-reference"><a id="citeref-Quinn2009" href="#footnote-Quinn2009">[Quinn2009]</a></sup>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDSP/DSP.jl/blob/ade83ddabd6afcfb2c11aa0524d03e35ea139ce3/src/estimation.jl#L117-L152">source</a></section></article><section class="footnotes is-size-7"><ul><li class="footnote" id="footnote-Roy1986"><a class="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). <a href="http://ieeexplore.ieee.org/abstract/document/1164935/">http://ieeexplore.ieee.org/abstract/document/1164935/</a>.</li><li class="footnote" id="footnote-Jacobsen2007"><a class="tag is-link" href="#citeref-Jacobsen2007">Jacobsen2007</a>E Jacobsen and P Kootsookos, &quot;Fast, Accurate Frequency Estimators&quot;, Chapter 10 in &quot;Streamlining Digital Signal Processing&quot;, edited by R. Lyons, 2007, IEEE Press.</li><li class="footnote" id="footnote-Quinn1991"><a class="tag is-link" href="#citeref-Quinn1991">Quinn1991</a>B Quinn and J Fernandes, &quot;A fast efficient technique for the estimation of frequency&quot;, Biometrika, Vol. 78 (1991).</li><li class="footnote" id="footnote-Quinn2009"><a class="tag is-link" href="#citeref-Quinn2009">Quinn2009</a>B Quinn, &quot;Recent advances in rapid frequency estimation&quot;, Digital Signal Processing, Vol. 19 (2009), Elsevier.</li></ul></section></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../periodograms/">« <code>Periodograms</code> - periodogram estimation</a><a class="docs-footer-nextpage" href="../windows/"><code>Windows</code> - window functions »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Wednesday 4 December 2024 08:44">Wednesday 4 December 2024</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>