Skip to content

Commit

Permalink
build based on 9242686
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Mar 13, 2024
1 parent 07fc883 commit 938631b
Show file tree
Hide file tree
Showing 17 changed files with 1,485 additions and 1,480 deletions.
6 changes: 3 additions & 3 deletions dev/algorithms/api/index.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/algorithms/classic/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Classic · ADI.jl</title><script data-outdated-warner src="../../assets/warner.js"></script><link rel="canonical" href="https://juliahci.github.io/ADI.jl/algorithms/classic/"/><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.039/juliamono-regular.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.11/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><script src="../../../copy.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="../../">ADI.jl</a></span></div><form class="docs-search" action="../../search/"><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="../../">Home</a></li><li><a class="tocitem" href="../../introduction/">Introduction to HCI</a></li><li><a class="tocitem" href="../../gettingstarted/">Getting Started with ADI.jl</a></li><li><span class="tocitem">Algorithms</span><ul><li class="is-active"><a class="tocitem" href>Classic</a><ul class="internal"><li><a class="tocitem" href="#API/Reference"><span>API/Reference</span></a></li></ul></li><li><a class="tocitem" href="../loci/">LOCI</a></li><li><a class="tocitem" href="../pca/">PCA</a></li><li><a class="tocitem" href="../nmf/">NMF</a></li><li><a class="tocitem" href="../greeds/">GreeDS</a></li><li><a class="tocitem" href="../api/">API/Reference</a></li></ul></li><li><a class="tocitem" href="../../framewise/">Framewise</a></li><li><a class="tocitem" href="../../sdi/">SDI</a></li><li><a class="tocitem" href="../../metrics/">Metrics</a></li><li><span class="tocitem">Examples</span><ul><li><a class="tocitem" href="../../examples/betapictoris/">ADI Reduction of <span>$\beta$</span> Pictoris</a></li><li><a class="tocitem" href="../../examples/geometries/">Exploring spatial and temporal filtering</a></li></ul></li><li><a class="tocitem" href="../../benchmarks/">Benchmarks</a></li><li><a class="tocitem" href="../../api/">Index</a></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">Algorithms</a></li><li class="is-active"><a href>Classic</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Classic</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/juliahci/ADI.jl/blob/master/docs/src/algorithms/classic.md#L" 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="classic"><a class="docs-heading-anchor" href="#classic">Classic</a><a id="classic-1"></a><a class="docs-heading-anchor-permalink" href="#classic" title="Permalink"></a></h1><h2 id="API/Reference"><a class="docs-heading-anchor" href="#API/Reference">API/Reference</a><a id="API/Reference-1"></a><a class="docs-heading-anchor-permalink" href="#API/Reference" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-binding" id="ADI.Classic" href="#ADI.Classic"><code>ADI.Classic</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Classic(;method=median)
Classic(method)</code></pre><p>Classic PSF subtraction using the median of entire data cube. If another statistic is desired, like the <code>mean</code>, it can be passed as an argument as long as it supports slicing multi-dimensional arrays.</p><p><strong>References</strong></p><ol><li><a href="http://adsabs.harvard.edu/abs/2006ApJ...641..556M">Marois et al. 2006</a> Angular Differential Imaging: A Powerful High-Contrast Imaging Technique</li></ol></div><a class="docs-sourcelink" target="_blank" href="https://github.com/juliahci/ADI.jl/blob/b28bc4677107c71d4794ed67cd7755e6892c2ff0/src/classic.jl#LL2-L10">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ADI.ClassicDesign" href="#ADI.ClassicDesign"><code>ADI.ClassicDesign</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">ADI.ClassicDesign(n, frame)</code></pre><p>Output for the <a href="#ADI.Classic"><code>Classic</code></a> algorithm which contains the static frame unrolled into a vector (with size <code>Npx</code>). <a href="../api/#ADI.reconstruct"><code>reconstruct</code></a> will tile this vector in a non-allocating way <code>n</code> times to appear like a flattened cube. <a href="../api/#ADI.design"><code>ADI.design</code></a> will return the static frame .</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/juliahci/ADI.jl/blob/b28bc4677107c71d4794ed67cd7755e6892c2ff0/src/classic.jl#LL16-L20">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../gettingstarted/">« Getting Started with ADI.jl</a><a class="docs-footer-nextpage" href="../loci/">LOCI »</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.12 on <span class="colophon-date" title="Friday 23 February 2024 08:11">Friday 23 February 2024</span>. Using Julia version 1.10.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Classic(method)</code></pre><p>Classic PSF subtraction using the median of entire data cube. If another statistic is desired, like the <code>mean</code>, it can be passed as an argument as long as it supports slicing multi-dimensional arrays.</p><p><strong>References</strong></p><ol><li><a href="http://adsabs.harvard.edu/abs/2006ApJ...641..556M">Marois et al. 2006</a> Angular Differential Imaging: A Powerful High-Contrast Imaging Technique</li></ol></div><a class="docs-sourcelink" target="_blank" href="https://github.com/juliahci/ADI.jl/blob/9242686647f1fa138e1310b9c1159514b65adcb0/src/classic.jl#LL2-L10">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ADI.ClassicDesign" href="#ADI.ClassicDesign"><code>ADI.ClassicDesign</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">ADI.ClassicDesign(n, frame)</code></pre><p>Output for the <a href="#ADI.Classic"><code>Classic</code></a> algorithm which contains the static frame unrolled into a vector (with size <code>Npx</code>). <a href="../api/#ADI.reconstruct"><code>reconstruct</code></a> will tile this vector in a non-allocating way <code>n</code> times to appear like a flattened cube. <a href="../api/#ADI.design"><code>ADI.design</code></a> will return the static frame .</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/juliahci/ADI.jl/blob/9242686647f1fa138e1310b9c1159514b65adcb0/src/classic.jl#LL16-L20">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../gettingstarted/">« Getting Started with ADI.jl</a><a class="docs-footer-nextpage" href="../loci/">LOCI »</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.12 on <span class="colophon-date" title="Wednesday 13 March 2024 09:09">Wednesday 13 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 938631b

Please sign in to comment.