build based on d01f698

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.6.7","generation_timestamp":"2024-07-29T05:53:15","documenter_version":"1.5.0"}}
+{"documenter":{"julia_version":"1.6.7","generation_timestamp":"2024-07-29T05:53:38","documenter_version":"1.5.0"}}

dev/use/index.html

@@ -3,4 +3,4 @@
 hio = BcdiTrad.HIO(0.9)
 state = BcdiTrad.State(intensities, trues(size(intensities)))
 
-(er * hio^20)^5 * state</code></pre><p>This short script applies 20 HIO iterations and one ER iterations for a total of 5 times. This makes it easy to implement very complex recipes for phase retrieval algorithms.</p><h1 id="API"><a class="docs-heading-anchor" href="#API">API</a><a id="API-1"></a><a class="docs-heading-anchor-permalink" href="#API" title="Permalink"></a></h1><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="Main.DummyDocs.State-Tuple{Any, Any}" href="#Main.DummyDocs.State-Tuple{Any, Any}"><code>Main.DummyDocs.State</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">State(intensities, recSupport)</code></pre><p>Create a reconstruction object. The intensities and a mask over reciprocal space indicating trusted intensities need to be passed in.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/byu-cig/BcdiStrain.jl/blob/e43b4f4d5c9ea5b8b20bfb0dd7e427a5a767b910/docs/DummyDocs.jl#L5-L10">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="Main.DummyDocs.ER-Tuple{}" href="#Main.DummyDocs.ER-Tuple{}"><code>Main.DummyDocs.ER</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">ER()</code></pre><p>Create an object that applies an iteration of ER</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/byu-cig/BcdiStrain.jl/blob/e43b4f4d5c9ea5b8b20bfb0dd7e427a5a767b910/docs/DummyDocs.jl#L14-L18">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="Main.DummyDocs.HIO-Tuple{Any}" href="#Main.DummyDocs.HIO-Tuple{Any}"><code>Main.DummyDocs.HIO</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">HIO(beta)</code></pre><p>Create an object that applies an iteration of HIO</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/byu-cig/BcdiStrain.jl/blob/e43b4f4d5c9ea5b8b20bfb0dd7e427a5a767b910/docs/DummyDocs.jl#L22-L26">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="Main.DummyDocs.Shrink-Tuple{Any, Any, Any}" href="#Main.DummyDocs.Shrink-Tuple{Any, Any, Any}"><code>Main.DummyDocs.Shrink</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">Shrink(threshold, sigma, state)</code></pre><p>Create an object that applies shrinkwrap</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/byu-cig/BcdiStrain.jl/blob/e43b4f4d5c9ea5b8b20bfb0dd7e427a5a767b910/docs/DummyDocs.jl#L30-L34">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="Main.DummyDocs.Center-Tuple{Any}" href="#Main.DummyDocs.Center-Tuple{Any}"><code>Main.DummyDocs.Center</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">Center(state)</code></pre><p>Create an object that centers the current state</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/byu-cig/BcdiStrain.jl/blob/e43b4f4d5c9ea5b8b20bfb0dd7e427a5a767b910/docs/DummyDocs.jl#L38-L42">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="Main.DummyDocs.Mount-Tuple{Any, Any, Any}" href="#Main.DummyDocs.Mount-Tuple{Any, Any, Any}"><code>Main.DummyDocs.Mount</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">Mount(beta, state, primitiveRecipLattice)</code></pre><p>Create an object that switches between peaks.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/byu-cig/BcdiStrain.jl/blob/e43b4f4d5c9ea5b8b20bfb0dd7e427a5a767b910/docs/DummyDocs.jl#L46-L50">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Main</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.5.0 on <span class="colophon-date" title="Monday 29 July 2024 05:53">Monday 29 July 2024</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+(er * hio^20)^5 * state</code></pre><p>This short script applies 20 HIO iterations and one ER iterations for a total of 5 times. This makes it easy to implement very complex recipes for phase retrieval algorithms.</p><h1 id="API"><a class="docs-heading-anchor" href="#API">API</a><a id="API-1"></a><a class="docs-heading-anchor-permalink" href="#API" title="Permalink"></a></h1><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="Main.DummyDocs.State-Tuple{Any, Any}" href="#Main.DummyDocs.State-Tuple{Any, Any}"><code>Main.DummyDocs.State</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">State(intensities, recSupport)</code></pre><p>Create a reconstruction object. The intensities and a mask over reciprocal space indicating trusted intensities need to be passed in.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/byu-cig/BcdiStrain.jl/blob/d01f698be50e1aea19668efe5056f43c1edfa628/docs/DummyDocs.jl#L5-L10">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="Main.DummyDocs.ER-Tuple{}" href="#Main.DummyDocs.ER-Tuple{}"><code>Main.DummyDocs.ER</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">ER()</code></pre><p>Create an object that applies an iteration of ER</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/byu-cig/BcdiStrain.jl/blob/d01f698be50e1aea19668efe5056f43c1edfa628/docs/DummyDocs.jl#L14-L18">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="Main.DummyDocs.HIO-Tuple{Any}" href="#Main.DummyDocs.HIO-Tuple{Any}"><code>Main.DummyDocs.HIO</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">HIO(beta)</code></pre><p>Create an object that applies an iteration of HIO</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/byu-cig/BcdiStrain.jl/blob/d01f698be50e1aea19668efe5056f43c1edfa628/docs/DummyDocs.jl#L22-L26">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="Main.DummyDocs.Shrink-Tuple{Any, Any, Any}" href="#Main.DummyDocs.Shrink-Tuple{Any, Any, Any}"><code>Main.DummyDocs.Shrink</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">Shrink(threshold, sigma, state)</code></pre><p>Create an object that applies shrinkwrap</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/byu-cig/BcdiStrain.jl/blob/d01f698be50e1aea19668efe5056f43c1edfa628/docs/DummyDocs.jl#L30-L34">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="Main.DummyDocs.Center-Tuple{Any}" href="#Main.DummyDocs.Center-Tuple{Any}"><code>Main.DummyDocs.Center</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">Center(state)</code></pre><p>Create an object that centers the current state</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/byu-cig/BcdiStrain.jl/blob/d01f698be50e1aea19668efe5056f43c1edfa628/docs/DummyDocs.jl#L38-L42">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="Main.DummyDocs.Mount-Tuple{Any, Any, Any}" href="#Main.DummyDocs.Mount-Tuple{Any, Any, Any}"><code>Main.DummyDocs.Mount</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">Mount(beta, state, primitiveRecipLattice)</code></pre><p>Create an object that switches between peaks.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/byu-cig/BcdiStrain.jl/blob/d01f698be50e1aea19668efe5056f43c1edfa628/docs/DummyDocs.jl#L46-L50">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Main</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.5.0 on <span class="colophon-date" title="Monday 29 July 2024 05:53">Monday 29 July 2024</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>