Skip to content

Commit

Permalink
build based on a6601c3
Browse files Browse the repository at this point in the history
Documenter.jl committed Nov 14, 2024
1 parent da4343b commit 91aeafd
Showing 2 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-11-14T13:55:16","documenter_version":"1.8.0"}}
{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-11-14T13:55:42","documenter_version":"1.8.0"}}
10 changes: 5 additions & 5 deletions dev/transferfunction.html
Original file line number Diff line number Diff line change
@@ -11,20 +11,20 @@
1001 frequency samples from 0.0 Hz to 1.0e6 Hz</code><br/><code class="language-julia-repl hljs" style="display:block;">julia&gt; RL([0,100e3])</code><code class="nohighlight hljs ansi" style="display:block;">2-element Vector{Unitful.Quantity{ComplexF64, 𝐋^2 𝐌 𝐈^-2 𝐓^-3, Unitful.FreeUnits{(A^-1, V), 𝐋^2 𝐌 𝐈^-2 𝐓^-3, nothing}}}:
(1.0 + 0.0im) V A^-1
(1.0 + 6.283185307179586im) V A^-1</code></pre><h2 id="Saving-and-loading"><a class="docs-heading-anchor" href="#Saving-and-loading">Saving and loading</a><a id="Saving-and-loading-1"></a><a class="docs-heading-anchor-permalink" href="#Saving-and-loading" title="Permalink"></a></h2><p>A <code>TransferFunction</code> object can be saved to and loaded from a .h5 file.</p><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="FileIO.save-Tuple{String, TransferFunction}" href="#FileIO.save-Tuple{String, TransferFunction}"><code>FileIO.save</code></a><span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">save(filename::String, tf::TransferFunction)
</code></pre><p>Save <code>tf</code> as a h5 file to <code>filename</code></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MagneticParticleImaging/MPIFiles.jl/blob/e269eeaed6e0f7fc8ae674e67208fb1dd7a938ce/src/TransferFunction.jl#L152">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="MPIFiles.TransferFunction-Tuple{String}" href="#MPIFiles.TransferFunction-Tuple{String}"><code>MPIFiles.TransferFunction</code></a><span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">TransferFunction(
</code></pre><p>Save <code>tf</code> as a h5 file to <code>filename</code></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MagneticParticleImaging/MPIFiles.jl/blob/a6601c352b8e15fbfef999e7e2ae27e0183aa272/src/TransferFunction.jl#L152">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="MPIFiles.TransferFunction-Tuple{String}" href="#MPIFiles.TransferFunction-Tuple{String}"><code>MPIFiles.TransferFunction</code></a><span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">TransferFunction(
filename::String;
kargs...
) -&gt; TransferFunction
</code></pre><p>Create a <code>TransferFunction</code> from a data file at <code>filename</code>.</p><p>The file can be either a h5-File created with this package. Keyword arguments will be passed to <code>load_tf_fromVNA</code> </p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MagneticParticleImaging/MPIFiles.jl/blob/e269eeaed6e0f7fc8ae674e67208fb1dd7a938ce/src/TransferFunction.jl#L58">source</a></section></article><h2 id="Additional-constructors"><a class="docs-heading-anchor" href="#Additional-constructors">Additional constructors</a><a id="Additional-constructors-1"></a><a class="docs-heading-anchor-permalink" href="#Additional-constructors" title="Permalink"></a></h2><p>In addition to the constructor taking a single (complex) array it is also possible to give two arrays representing amplitude and phase.</p><p>It is also possible to construct a <code>TransferFunction</code> from the transfer function data included in an <code>MPIFile</code>.</p><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="MPIFiles.TransferFunction-Union{Tuple{N}, Tuple{Vector{&lt;:Real}, Array{&lt;:Real, N}, Array{&lt;:Real, N}}} where N" href="#MPIFiles.TransferFunction-Union{Tuple{N}, Tuple{Vector{&lt;:Real}, Array{&lt;:Real, N}, Array{&lt;:Real, N}}} where N"><code>MPIFiles.TransferFunction</code></a><span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">TransferFunction(
</code></pre><p>Create a <code>TransferFunction</code> from a data file at <code>filename</code>.</p><p>The file can be either a h5-File created with this package. Keyword arguments will be passed to <code>load_tf_fromVNA</code> </p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MagneticParticleImaging/MPIFiles.jl/blob/a6601c352b8e15fbfef999e7e2ae27e0183aa272/src/TransferFunction.jl#L58">source</a></section></article><h2 id="Additional-constructors"><a class="docs-heading-anchor" href="#Additional-constructors">Additional constructors</a><a id="Additional-constructors-1"></a><a class="docs-heading-anchor-permalink" href="#Additional-constructors" title="Permalink"></a></h2><p>In addition to the constructor taking a single (complex) array it is also possible to give two arrays representing amplitude and phase.</p><p>It is also possible to construct a <code>TransferFunction</code> from the transfer function data included in an <code>MPIFile</code>.</p><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="MPIFiles.TransferFunction-Union{Tuple{N}, Tuple{Vector{&lt;:Real}, Array{&lt;:Real, N}, Array{&lt;:Real, N}}} where N" href="#MPIFiles.TransferFunction-Union{Tuple{N}, Tuple{Vector{&lt;:Real}, Array{&lt;:Real, N}, Array{&lt;:Real, N}}} where N"><code>MPIFiles.TransferFunction</code></a><span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">TransferFunction(
freq::Vector{&lt;:Real},
ampdata::Array{&lt;:Real, N},
phasedata::Array{&lt;:Real, N};
kwargs...
) -&gt; TransferFunction
</code></pre><p>Create a <code>TransferFunction</code> from separate amplitude and phase arrays at frequencies <code>freq</code>.</p><p><code>ampdata</code> and <code>phasedata</code> should have the following shape: [frequencies, channels]</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MagneticParticleImaging/MPIFiles.jl/blob/e269eeaed6e0f7fc8ae674e67208fb1dd7a938ce/src/TransferFunction.jl#L45">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="MPIFiles.TransferFunction-Tuple{MPIFile}" href="#MPIFiles.TransferFunction-Tuple{MPIFile}"><code>MPIFiles.TransferFunction</code></a><span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">TransferFunction(file::MPIFile) -&gt; TransferFunction
</code></pre><p>Create a <code>TransferFunction</code> from the tf data saved in a MPIFile (see <code>rxTransferFunction</code>)</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MagneticParticleImaging/MPIFiles.jl/blob/e269eeaed6e0f7fc8ae674e67208fb1dd7a938ce/src/TransferFunction.jl#L75">source</a></section></article><h2 id="Other-interesting-functions"><a class="docs-heading-anchor" href="#Other-interesting-functions">Other interesting functions</a><a id="Other-interesting-functions-1"></a><a class="docs-heading-anchor-permalink" href="#Other-interesting-functions" title="Permalink"></a></h2><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="MPIFiles.TransferFunction" href="#MPIFiles.TransferFunction"><code>MPIFiles.TransferFunction</code></a><span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">mutable struct TransferFunction</code></pre><ul><li><p><code>freq::Vector{Float64}</code></p></li><li><p><code>data::Matrix{ComplexF64}</code></p></li><li><p><code>interpolator::Vector{Interpolations.AbstractInterpolation}</code></p></li><li><p><code>inductionFactor::Vector{Float64}</code></p></li><li><p><code>units::Vector{Unitful.FreeUnits}</code></p></li></ul><pre><code class="nohighlight hljs">TransferFunction(freq_::Vector{&lt;:Real}, datain::Array{&lt;:Complex}; inductionFactor::Vector{&lt;:Real}=ones(size(datain, 2)), units::Vector=Unitful.FreeUnits[Unitful.NoUnits for i in 1:size(datain, 2)])</code></pre><p>Create a <code>TransferFunction</code> from a complex data array at frequencies <code>freq_</code>.</p><p><strong>Optional Keyword-Arguments:</strong></p><ul><li><code>inductionFactor::Vector{&lt;:Real}</code>: induction factor for each channel</li><li><code>units::Vector</code>: units for each channel, can be either Unitful.FreeUnits or a string that can be parsed as a Unitful unit </li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MagneticParticleImaging/MPIFiles.jl/blob/e269eeaed6e0f7fc8ae674e67208fb1dd7a938ce/src/TransferFunction.jl#L3">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="MPIFiles.combine-Tuple{TransferFunction, TransferFunction}" href="#MPIFiles.combine-Tuple{TransferFunction, TransferFunction}"><code>MPIFiles.combine</code></a><span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">combine(
</code></pre><p>Create a <code>TransferFunction</code> from separate amplitude and phase arrays at frequencies <code>freq</code>.</p><p><code>ampdata</code> and <code>phasedata</code> should have the following shape: [frequencies, channels]</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MagneticParticleImaging/MPIFiles.jl/blob/a6601c352b8e15fbfef999e7e2ae27e0183aa272/src/TransferFunction.jl#L45">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="MPIFiles.TransferFunction-Tuple{MPIFile}" href="#MPIFiles.TransferFunction-Tuple{MPIFile}"><code>MPIFiles.TransferFunction</code></a><span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">TransferFunction(file::MPIFile) -&gt; TransferFunction
</code></pre><p>Create a <code>TransferFunction</code> from the tf data saved in a MPIFile (see <code>rxTransferFunction</code>)</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MagneticParticleImaging/MPIFiles.jl/blob/a6601c352b8e15fbfef999e7e2ae27e0183aa272/src/TransferFunction.jl#L75">source</a></section></article><h2 id="Other-interesting-functions"><a class="docs-heading-anchor" href="#Other-interesting-functions">Other interesting functions</a><a id="Other-interesting-functions-1"></a><a class="docs-heading-anchor-permalink" href="#Other-interesting-functions" title="Permalink"></a></h2><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="MPIFiles.TransferFunction" href="#MPIFiles.TransferFunction"><code>MPIFiles.TransferFunction</code></a><span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">mutable struct TransferFunction</code></pre><ul><li><p><code>freq::Vector{Float64}</code></p></li><li><p><code>data::Matrix{ComplexF64}</code></p></li><li><p><code>interpolator::Vector{Interpolations.AbstractInterpolation}</code></p></li><li><p><code>inductionFactor::Vector{Float64}</code></p></li><li><p><code>units::Vector{Unitful.FreeUnits}</code></p></li></ul><pre><code class="nohighlight hljs">TransferFunction(freq_::Vector{&lt;:Real}, datain::Array{&lt;:Complex}; inductionFactor::Vector{&lt;:Real}=ones(size(datain, 2)), units::Vector=Unitful.FreeUnits[Unitful.NoUnits for i in 1:size(datain, 2)])</code></pre><p>Create a <code>TransferFunction</code> from a complex data array at frequencies <code>freq_</code>.</p><p><strong>Optional Keyword-Arguments:</strong></p><ul><li><code>inductionFactor::Vector{&lt;:Real}</code>: induction factor for each channel</li><li><code>units::Vector</code>: units for each channel, can be either Unitful.FreeUnits or a string that can be parsed as a Unitful unit </li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MagneticParticleImaging/MPIFiles.jl/blob/a6601c352b8e15fbfef999e7e2ae27e0183aa272/src/TransferFunction.jl#L3">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="MPIFiles.combine-Tuple{TransferFunction, TransferFunction}" href="#MPIFiles.combine-Tuple{TransferFunction, TransferFunction}"><code>MPIFiles.combine</code></a><span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">combine(
tf1::TransferFunction,
tf2::TransferFunction;
interpolate
) -&gt; TransferFunction
</code></pre><p>Combine two <code>TransferFunctions</code> along their channel dimension. If interpolate=false, will only work if the frequency samples are identical.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MagneticParticleImaging/MPIFiles.jl/blob/e269eeaed6e0f7fc8ae674e67208fb1dd7a938ce/src/TransferFunction.jl#L133">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="reconstruction.html">« Reconstruction Results</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="Thursday 14 November 2024 13:55">Thursday 14 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
</code></pre><p>Combine two <code>TransferFunctions</code> along their channel dimension. If interpolate=false, will only work if the frequency samples are identical.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MagneticParticleImaging/MPIFiles.jl/blob/a6601c352b8e15fbfef999e7e2ae27e0183aa272/src/TransferFunction.jl#L133">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="reconstruction.html">« Reconstruction Results</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="Thursday 14 November 2024 13:55">Thursday 14 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

0 comments on commit 91aeafd

Please sign in to comment.