Skip to content

Commit

Permalink
build based on 2bf99bf
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Oct 29, 2024
1 parent 07ef2e8 commit 524ec01
Show file tree
Hide file tree
Showing 12 changed files with 52 additions and 14 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-10-28T23:58:26","documenter_version":"1.7.0"}}
{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-10-29T09:09:02","documenter_version":"1.7.0"}}
2 changes: 2 additions & 0 deletions dev/api/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>API · SubPrecisionContactDetection Documentation</title><meta name="title" content="API · SubPrecisionContactDetection Documentation"/><meta property="og:title" content="API · SubPrecisionContactDetection Documentation"/><meta property="twitter:title" content="API · SubPrecisionContactDetection Documentation"/><meta name="description" content="Documentation for SubPrecisionContactDetection Documentation."/><meta property="og:description" content="Documentation for SubPrecisionContactDetection Documentation."/><meta property="twitter:description" content="Documentation for SubPrecisionContactDetection Documentation."/><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.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/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="../search_index.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/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><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"><a class="docs-logo" href="../tutorial/"><img src="../assets/logo.png" alt="SubPrecisionContactDetection Documentation logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../tutorial/">SubPrecisionContactDetection Documentation</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../tutorial/">Tutorial</a></li><li><a class="tocitem" href="../parameters/">Parameter selection and tuning</a></li><li><a class="tocitem" href="../output/">Generated output</a></li><li><a class="tocitem" href="../clustercomputing/">Cluster Usage</a></li><li><a class="tocitem" href="../installation/">Installation</a></li><li><a class="tocitem" href="../postprocessing/">Postprocessing</a></li><li><a class="tocitem" href="../faq/">Help and FAQ</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"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>API</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>API</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/bencardoen/SubPrecisionContactDetection.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/bencardoen/SubPrecisionContactDetection.jl/blob/main/docs/src/api.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><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><p>In order of complexity, we now list the key function calls that compose the pipeline.</p><h2 id="Full-pipeline"><a class="docs-heading-anchor" href="#Full-pipeline">Full pipeline</a><a id="Full-pipeline-1"></a><a class="docs-heading-anchor-permalink" href="#Full-pipeline" title="Permalink"></a></h2><p>The main function that handles the pipeline end-to-end:</p><pre><code class="language-julia hljs">two_channel_contacts(parsed_args, tiffiles=nothing)</code></pre><p>See <a href="../parameters/#Parameter-selection-and-tuning.">Parameter selection and tuning.</a> for configuring the arguments.</p><h2 id="Filtering"><a class="docs-heading-anchor" href="#Filtering">Filtering</a><a id="Filtering-1"></a><a class="docs-heading-anchor-permalink" href="#Filtering" title="Permalink"></a></h2><h3 id="Gradient-Filter"><a class="docs-heading-anchor" href="#Gradient-Filter">Gradient Filter</a><a id="Gradient-Filter-1"></a><a class="docs-heading-anchor-permalink" href="#Gradient-Filter" title="Permalink"></a></h3><p>Due to pixellation you can induce shadowing effects. These have an exact mathematical precondition, so we can filter them out.</p><pre><code class="language-julia hljs">gradientfilter!(correlation, laplacian1 , laplacian2)</code></pre><p>Let the 3rd derivative of the image X be <span>$\delta^3_X$</span>. The filter is then defined as keeping the values where this equation is true:</p><p class="math-container">\[ \neq ((\vert \vert \delta^3_X \vert \vert \times \vert \vert \delta^3_Y \vert \vert)==0 \land \vert \vert \delta^3_X \vert \vert + \vert \vert \delta^3_Y \vert \vert)!=0\]</p><h2 id="Image-correlation"><a class="docs-heading-anchor" href="#Image-correlation">Image correlation</a><a id="Image-correlation-1"></a><a class="docs-heading-anchor-permalink" href="#Image-correlation" title="Permalink"></a></h2><pre><code class="language-julia hljs">sp2d(img1, img2, stride)</code></pre><p>Returns a correlation array, z-values that can be processed into significance, and a stride (<code>windowsize</code>)</p><pre><code class="language-julia hljs">sp3d(img1, img2, stride)</code></pre><p>These run multithreaded, using as many cores as Julia is allowed to use.</p></article><nav class="docs-footer"><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.7.0 on <span class="colophon-date" title="Tuesday 29 October 2024 09:09">Tuesday 29 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 524ec01

Please sign in to comment.