-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
4 lines (4 loc) · 7.39 KB
/
index.html
1
2
3
4
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>ReconTPCF.jl · ReconTPCF.jl</title><link href="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.0/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.0/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.0/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.11.1/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">ReconTPCF.jl</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 class="is-active"><a class="tocitem" href="index.html">ReconTPCF.jl</a><ul class="internal"><li><a class="tocitem" href="#Installation"><span>Installation</span></a></li><li><a class="tocitem" href="#Using-ReconTPCF-For-Reconstruction"><span>Using ReconTPCF For Reconstruction</span></a></li><li><a class="tocitem" href="#Using-ReconTPCF-for-Computing-The-Two-Point-Correlation-Function"><span>Using ReconTPCF for Computing The Two-Point Correlation Function</span></a></li></ul></li><li><a class="tocitem" href="histrecon.html">Reconstruction</a></li><li><a class="tocitem" href="library.html">API</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 class="is-active"><a href="index.html">ReconTPCF.jl</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href="index.html">ReconTPCF.jl</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/JAgho/ReconTPCF.jl/blob/master/docs/src/index.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="ReconTPCF.jl"><a class="docs-heading-anchor" href="#ReconTPCF.jl">ReconTPCF.jl</a><a id="ReconTPCF.jl-1"></a><a class="docs-heading-anchor-permalink" href="#ReconTPCF.jl" title="Permalink"></a></h1><p>ReconTPCF is a toolbox for the (re)construction of binary images based on the method of <a href="https://doi.org/10.1103/PhysRevE.57.495"><strong>Torquato and Yeong</strong></a>. It also collects a set of efficient functions for computing <span>$S_{2}$</span> and <span>$C_{2}$</span>, the two-point correlation function, and equivalent cluster correlation function. Under specialised conditions, functions exist to update S2 and C2 as pairs or groups of pixels change value.</p><h2 id="Installation"><a class="docs-heading-anchor" href="#Installation">Installation</a><a id="Installation-1"></a><a class="docs-heading-anchor-permalink" href="#Installation" title="Permalink"></a></h2><p>ReconTPCF is a Julia package and hence may be installed simply using the package manager:</p><pre><code class="language-none"> julia> ]
pkg> add https://github.com/JAgho/ReconTPCF.jl</code></pre><p>This will add the package and any dependencies it has.</p><h2 id="Using-ReconTPCF-For-Reconstruction"><a class="docs-heading-anchor" href="#Using-ReconTPCF-For-Reconstruction">Using ReconTPCF For Reconstruction</a><a id="Using-ReconTPCF-For-Reconstruction-1"></a><a class="docs-heading-anchor-permalink" href="#Using-ReconTPCF-For-Reconstruction" title="Permalink"></a></h2><p>Calling <code>using ReconTPCF</code> will give access to its exported functions. This includes <code>get_C2_S2(fname)</code> and <code>histrecon()</code> which are an initialiser and the main reconstruction loop respectively. Histrecon is presently adjusted by modifying its function definition. A typical use of it would look like:</p><pre><code class="language-none"> dims, C2, S2, philen = get_C2_S2(fname)
guess, S2n, C2n, S2_BN1, C2_BN1, SN1 = histrecon((200, 200)), C2, S2, 12000)</code></pre><p>Further detail regarding the algorithm is given in its own page in the sidebar</p><h2 id="Using-ReconTPCF-for-Computing-The-Two-Point-Correlation-Function"><a class="docs-heading-anchor" href="#Using-ReconTPCF-for-Computing-The-Two-Point-Correlation-Function">Using ReconTPCF for Computing The Two-Point Correlation Function</a><a id="Using-ReconTPCF-for-Computing-The-Two-Point-Correlation-Function-1"></a><a class="docs-heading-anchor-permalink" href="#Using-ReconTPCF-for-Computing-The-Two-Point-Correlation-Function" title="Permalink"></a></h2><p>ReconTPCF has fast algorithms for computing S2 for large and small collections in several ways. For long lists of points, a multithreaded implementation is provided; <code>blas_stat5</code>. For shorter lists a single thread function is given; <code>blas_stat_st2</code>. These functions consider all unique pairs in the list and compute the L2 norm for these. These are histogrammed according to the secondary arguments of these functions.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="histrecon.html">Reconstruction »</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> on <span class="colophon-date" title="Thursday 4 February 2021 21:59">Thursday 4 February 2021</span>. Using Julia version 1.5.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>