Skip to content

Commit

Permalink
build based on fa182dd
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Aug 19, 2023
1 parent 5701c8c commit d8138ae
Show file tree
Hide file tree
Showing 12 changed files with 65 additions and 65 deletions.
8 changes: 4 additions & 4 deletions dev/array.html
View file

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions dev/basic.html
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Basic signal analysis · SignalAnalysis.jl</title><script data-outdated-warner src="assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="index.html">SignalAnalysis.jl</a></span></div><form class="docs-search" action="search.html"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="index.html">Home</a></li><li><span class="tocitem">Manual</span><ul><li><a class="tocitem" href="signals.html">Creating &amp; managing signals</a></li><li><a class="tocitem" href="generate.html">Generating signals</a></li><li class="is-active"><a class="tocitem" href="basic.html">Basic signal analysis</a></li><li><a class="tocitem" href="dsp.html">Signal processing</a></li><li><a class="tocitem" href="tfa.html">Time-frequency analysis</a></li><li><a class="tocitem" href="array.html">Array signal processing</a></li><li><a class="tocitem" href="rand.html">Random noise generation</a></li><li><a class="tocitem" href="plot.html">Plot recipes</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">Manual</a></li><li class="is-active"><a href="basic.html">Basic signal analysis</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href="basic.html">Basic signal analysis</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/org-arl/SignalAnalysis.jl/blob/master/docs/src/basic.md" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="Basic-signal-analysis"><a class="docs-heading-anchor" href="#Basic-signal-analysis">Basic signal analysis</a><a id="Basic-signal-analysis-1"></a><a class="docs-heading-anchor-permalink" href="#Basic-signal-analysis" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-binding" id="SignalAnalysis.energy-Tuple{AbstractVector{T} where T}" href="#SignalAnalysis.energy-Tuple{AbstractVector{T} where T}"><code>SignalAnalysis.energy</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">energy(s; fs)
</code></pre><p>Computes total signal energy.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/org-arl/SignalAnalysis.jl/blob/bfd4b48894ebcdd10c448a62a8e6275b69dd605a/src/basic.jl#L3">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="SignalAnalysis.ifrequency-Tuple{Any}" href="#SignalAnalysis.ifrequency-Tuple{Any}"><code>SignalAnalysis.ifrequency</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">ifrequency(s; fs)
</code></pre><p>Computes instantaneous frequency of the signal.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/org-arl/SignalAnalysis.jl/blob/bfd4b48894ebcdd10c448a62a8e6275b69dd605a/src/basic.jl#L24">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="SignalAnalysis.meanfrequency-Tuple{AbstractMatrix{T} where T}" href="#SignalAnalysis.meanfrequency-Tuple{AbstractMatrix{T} where T}"><code>SignalAnalysis.meanfrequency</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">meanfrequency(s; fs, nfft, window)
</code></pre><p>Computes mean frequency of a signal.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/org-arl/SignalAnalysis.jl/blob/bfd4b48894ebcdd10c448a62a8e6275b69dd605a/src/basic.jl#L38">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="SignalAnalysis.meantime-Tuple{MetaArrays.MetaArray{var&quot;#s2&quot;, SignalAnalysis.SamplingInfo, T, N} where {T, var&quot;#s2&quot;, N}}" href="#SignalAnalysis.meantime-Tuple{MetaArrays.MetaArray{var&quot;#s2&quot;, SignalAnalysis.SamplingInfo, T, N} where {T, var&quot;#s2&quot;, N}}"><code>SignalAnalysis.meantime</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">meantime(s)
</code></pre><p>Computes mean time of the signal.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/org-arl/SignalAnalysis.jl/blob/bfd4b48894ebcdd10c448a62a8e6275b69dd605a/src/basic.jl#L10">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="SignalAnalysis.rmsbandwidth-Tuple{AbstractMatrix{T} where T}" href="#SignalAnalysis.rmsbandwidth-Tuple{AbstractMatrix{T} where T}"><code>SignalAnalysis.rmsbandwidth</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">rmsbandwidth(s; fs, nfft, window)
</code></pre><p>Computes RMS bandwidth of a signal.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/org-arl/SignalAnalysis.jl/blob/bfd4b48894ebcdd10c448a62a8e6275b69dd605a/src/basic.jl#L58">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="SignalAnalysis.rmsduration-Tuple{MetaArrays.MetaArray{var&quot;#s2&quot;, SignalAnalysis.SamplingInfo, T, N} where {T, var&quot;#s2&quot;, N}}" href="#SignalAnalysis.rmsduration-Tuple{MetaArrays.MetaArray{var&quot;#s2&quot;, SignalAnalysis.SamplingInfo, T, N} where {T, var&quot;#s2&quot;, N}}"><code>SignalAnalysis.rmsduration</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">rmsduration(s)
</code></pre><p>Computes RMS duration of the signal.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/org-arl/SignalAnalysis.jl/blob/bfd4b48894ebcdd10c448a62a8e6275b69dd605a/src/basic.jl#L17">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="generate.html">« Generating signals</a><a class="docs-footer-nextpage" href="dsp.html">Signal processing »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Saturday 19 August 2023 15:21">Saturday 19 August 2023</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
</code></pre><p>Computes total signal energy.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/org-arl/SignalAnalysis.jl/blob/fa182dd4c6d63f73d06de96ca6f106cff83d006c/src/basic.jl#L3">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="SignalAnalysis.ifrequency-Tuple{Any}" href="#SignalAnalysis.ifrequency-Tuple{Any}"><code>SignalAnalysis.ifrequency</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">ifrequency(s; fs)
</code></pre><p>Computes instantaneous frequency of the signal.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/org-arl/SignalAnalysis.jl/blob/fa182dd4c6d63f73d06de96ca6f106cff83d006c/src/basic.jl#L24">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="SignalAnalysis.meanfrequency-Tuple{AbstractMatrix{T} where T}" href="#SignalAnalysis.meanfrequency-Tuple{AbstractMatrix{T} where T}"><code>SignalAnalysis.meanfrequency</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">meanfrequency(s; fs, nfft, window)
</code></pre><p>Computes mean frequency of a signal.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/org-arl/SignalAnalysis.jl/blob/fa182dd4c6d63f73d06de96ca6f106cff83d006c/src/basic.jl#L38">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="SignalAnalysis.meantime-Tuple{MetaArrays.MetaArray{var&quot;#s2&quot;, SignalAnalysis.SamplingInfo, T, N} where {T, var&quot;#s2&quot;, N}}" href="#SignalAnalysis.meantime-Tuple{MetaArrays.MetaArray{var&quot;#s2&quot;, SignalAnalysis.SamplingInfo, T, N} where {T, var&quot;#s2&quot;, N}}"><code>SignalAnalysis.meantime</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">meantime(s)
</code></pre><p>Computes mean time of the signal.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/org-arl/SignalAnalysis.jl/blob/fa182dd4c6d63f73d06de96ca6f106cff83d006c/src/basic.jl#L10">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="SignalAnalysis.rmsbandwidth-Tuple{AbstractMatrix{T} where T}" href="#SignalAnalysis.rmsbandwidth-Tuple{AbstractMatrix{T} where T}"><code>SignalAnalysis.rmsbandwidth</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">rmsbandwidth(s; fs, nfft, window)
</code></pre><p>Computes RMS bandwidth of a signal.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/org-arl/SignalAnalysis.jl/blob/fa182dd4c6d63f73d06de96ca6f106cff83d006c/src/basic.jl#L58">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="SignalAnalysis.rmsduration-Tuple{MetaArrays.MetaArray{var&quot;#s2&quot;, SignalAnalysis.SamplingInfo, T, N} where {T, var&quot;#s2&quot;, N}}" href="#SignalAnalysis.rmsduration-Tuple{MetaArrays.MetaArray{var&quot;#s2&quot;, SignalAnalysis.SamplingInfo, T, N} where {T, var&quot;#s2&quot;, N}}"><code>SignalAnalysis.rmsduration</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">rmsduration(s)
</code></pre><p>Computes RMS duration of the signal.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/org-arl/SignalAnalysis.jl/blob/fa182dd4c6d63f73d06de96ca6f106cff83d006c/src/basic.jl#L17">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="generate.html">« Generating signals</a><a class="docs-footer-nextpage" href="dsp.html">Signal processing »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Saturday 19 August 2023 18:10">Saturday 19 August 2023</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit d8138ae

Please sign in to comment.