Skip to content

Commit

Permalink
build based on f9475d3
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Dec 18, 2023
1 parent 12ce9e2 commit 2cd688f
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 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.9.4","generation_timestamp":"2023-12-18T20:51:00","documenter_version":"1.2.1"}}
{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2023-12-18T20:58:47","documenter_version":"1.2.1"}}
4 changes: 2 additions & 2 deletions dev/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · VectorPlotDigitizer.jl</title><meta name="title" content="Home · VectorPlotDigitizer.jl"/><meta property="og:title" content="Home · VectorPlotDigitizer.jl"/><meta property="twitter:title" content="Home · VectorPlotDigitizer.jl"/><meta name="description" content="Documentation for VectorPlotDigitizer.jl."/><meta property="og:description" content="Documentation for VectorPlotDigitizer.jl."/><meta property="twitter:description" content="Documentation for VectorPlotDigitizer.jl."/><meta property="og:url" content="https://pmc4.github.io/VectorPlotDigitizer.jl/"/><meta property="twitter:url" content="https://pmc4.github.io/VectorPlotDigitizer.jl/"/><link rel="canonical" href="https://pmc4.github.io/VectorPlotDigitizer.jl/"/><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/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>VectorPlotDigitizer.jl</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 class="is-active"><a class="tocitem" href>Home</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>Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Home</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/pmc4/VectorPlotDigitizer.jl/blob/main/docs/src/index.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="VectorPlotDigitizer"><a class="docs-heading-anchor" href="#VectorPlotDigitizer">VectorPlotDigitizer</a><a id="VectorPlotDigitizer-1"></a><a class="docs-heading-anchor-permalink" href="#VectorPlotDigitizer" title="Permalink"></a></h1><p>Documentation for <a href="https://github.com/pmc4/VectorPlotDigitizer.jl">VectorPlotDigitizer</a>.</p><ul><li><a href="#VectorPlotDigitizer.binedges_to_bin_midpoints-Tuple{Any}"><code>VectorPlotDigitizer.binedges_to_bin_midpoints</code></a></li><li><a href="#VectorPlotDigitizer.fill_zeros_bins-NTuple{4, Any}"><code>VectorPlotDigitizer.fill_zeros_bins</code></a></li></ul><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="VectorPlotDigitizer.binedges_to_bin_midpoints-Tuple{Any}" href="#VectorPlotDigitizer.binedges_to_bin_midpoints-Tuple{Any}"><code>VectorPlotDigitizer.binedges_to_bin_midpoints</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">binedges_to_bin_midpoints(data; zero_threshold::Real = 0.0, atol::Real= 0.0)</code></pre><p>Transforms a set of points that delimits the vertexes of a binned plot into a set of points for each bin mid point value.</p><p><code>data</code> must be two-column array of numbers that delimit some bin vertexes. The function will detect a bin when two consecutive values of the y axis are not vertical. In such case it will compute the midpoint value of the x axis and take that y axis value.</p><p>If a value of <code>zero_threshold</code> different than <code>0</code> is given, then every detected bin with a y value <code>y &lt; zero_threshold</code> will be considered as <code>0.0</code>.</p><p>If a value of <code>atol</code> is provided, this will be taken as the absolute tolerance in the <code>isapprox</code> method that checks if two points are a straigth vertical line or not. Higher values of <code>atol</code> may give undesired results.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/pmc4/VectorPlotDigitizer.jl/blob/fda6633a9b01513e6cfb9d5d9e1a63f62a533b33/src/helper_functions.jl#L1-L17">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="VectorPlotDigitizer.fill_zeros_bins-NTuple{4, Any}" href="#VectorPlotDigitizer.fill_zeros_bins-NTuple{4, Any}"><code>VectorPlotDigitizer.fill_zeros_bins</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">fill_zeros_bins(real_xs, xs, ys, atol; zero_threshold::Real = 0.0)</code></pre><p>Given some digitized binned data, where <code>xs</code> are the the bins x axis midpoints and <code>ys</code> are the corresponding values on the y axis, this function fills with zeros the missing bins.</p><p>The complete set of bins is given by <code>real_xs</code> and <code>atol</code> is the absolute tolerance to use when comparing whether a given element of <code>xs</code> is inside of <code>ys</code> or not. Smaller values of <code>atol</code> will make less values of <code>xs</code> to be found inside <code>real_xs</code>.</p><p>If a value of <code>zero_threshold</code> different than <code>0</code> is given, then every bin with a y value <code>y &lt; zero_threshold</code> will be considered as <code>0.0</code>.</p><p><strong>Examples</strong></p><p>Given the following <code>real_x</code> bins and the digitized <code>x_bins</code> and <code>y_bins</code>:</p><pre><code class="nohighlight hljs">julia&gt; real_bins = [0.5, 1.5, 2.5, 3.5]
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · VectorPlotDigitizer.jl</title><meta name="title" content="Home · VectorPlotDigitizer.jl"/><meta property="og:title" content="Home · VectorPlotDigitizer.jl"/><meta property="twitter:title" content="Home · VectorPlotDigitizer.jl"/><meta name="description" content="Documentation for VectorPlotDigitizer.jl."/><meta property="og:description" content="Documentation for VectorPlotDigitizer.jl."/><meta property="twitter:description" content="Documentation for VectorPlotDigitizer.jl."/><meta property="og:url" content="https://pmc4.github.io/VectorPlotDigitizer.jl/"/><meta property="twitter:url" content="https://pmc4.github.io/VectorPlotDigitizer.jl/"/><link rel="canonical" href="https://pmc4.github.io/VectorPlotDigitizer.jl/"/><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/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>VectorPlotDigitizer.jl</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 class="is-active"><a class="tocitem" href>Home</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>Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Home</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/pmc4/VectorPlotDigitizer.jl/blob/main/docs/src/index.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="VectorPlotDigitizer"><a class="docs-heading-anchor" href="#VectorPlotDigitizer">VectorPlotDigitizer</a><a id="VectorPlotDigitizer-1"></a><a class="docs-heading-anchor-permalink" href="#VectorPlotDigitizer" title="Permalink"></a></h1><p>Documentation for <a href="https://github.com/pmc4/VectorPlotDigitizer.jl">VectorPlotDigitizer</a>.</p><ul><li><a href="#VectorPlotDigitizer.binedges_to_bin_midpoints-Tuple{Any}"><code>VectorPlotDigitizer.binedges_to_bin_midpoints</code></a></li><li><a href="#VectorPlotDigitizer.fill_zeros_bins-NTuple{4, Any}"><code>VectorPlotDigitizer.fill_zeros_bins</code></a></li></ul><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="VectorPlotDigitizer.binedges_to_bin_midpoints-Tuple{Any}" href="#VectorPlotDigitizer.binedges_to_bin_midpoints-Tuple{Any}"><code>VectorPlotDigitizer.binedges_to_bin_midpoints</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">binedges_to_bin_midpoints(data; zero_threshold::Real = 0.0, atol::Real= 0.0)</code></pre><p>Transforms a set of points that delimits the vertexes of a binned plot into a set of points for each bin mid point value.</p><p><code>data</code> must be two-column array of numbers that delimit some bin vertexes. The function will detect a bin when two consecutive values of the y axis are not vertical. In such case it will compute the midpoint value of the x axis and take that y axis value.</p><p>If a value of <code>zero_threshold</code> different than <code>0</code> is given, then every detected bin with a y value <code>y &lt; zero_threshold</code> will be considered as <code>0.0</code>.</p><p>If a value of <code>atol</code> is provided, this will be taken as the absolute tolerance in the <code>isapprox</code> method that checks if two points are a straigth vertical line or not. Higher values of <code>atol</code> may give undesired results.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/pmc4/VectorPlotDigitizer.jl/blob/f9475d304dd0eb4dfca7c3b61a2685e4a55b7c51/src/helper_functions.jl#L1-L17">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="VectorPlotDigitizer.fill_zeros_bins-NTuple{4, Any}" href="#VectorPlotDigitizer.fill_zeros_bins-NTuple{4, Any}"><code>VectorPlotDigitizer.fill_zeros_bins</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">fill_zeros_bins(real_xs, xs, ys, atol; zero_threshold::Real = 0.0)</code></pre><p>Given some digitized binned data, where <code>xs</code> are the the bins x axis midpoints and <code>ys</code> are the corresponding values on the y axis, this function fills with zeros the missing bins.</p><p>The complete set of bins is given by <code>real_xs</code> and <code>atol</code> is the absolute tolerance to use when comparing whether a given element of <code>xs</code> is inside of <code>ys</code> or not. Smaller values of <code>atol</code> will make less values of <code>xs</code> to be found inside <code>real_xs</code>.</p><p>If a value of <code>zero_threshold</code> different than <code>0</code> is given, then every bin with a y value <code>y &lt; zero_threshold</code> will be considered as <code>0.0</code>.</p><p><strong>Examples</strong></p><p>Given the following <code>real_x</code> bins and the digitized <code>x_bins</code> and <code>y_bins</code>:</p><pre><code class="nohighlight hljs">julia&gt; real_bins = [0.5, 1.5, 2.5, 3.5]
4-element Vector{Float64}:
0.5
1.5
Expand All @@ -24,4 +24,4 @@
34.7
0.0
0.0
0.0</code></pre><p><strong>Notes</strong></p><p>A warning is given if the absolute tolerance is very small. This means that the function is filling with more zeros than needed and some ys values are not taken into account. This warning has nothing to do whether we set a high <code>zero_threshold</code> value or not.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/pmc4/VectorPlotDigitizer.jl/blob/fda6633a9b01513e6cfb9d5d9e1a63f62a533b33/src/helper_functions.jl#L49-L108">source</a></section></article></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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Monday 18 December 2023 20:51">Monday 18 December 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
0.0</code></pre><p><strong>Notes</strong></p><p>A warning is given if the absolute tolerance is very small. This means that the function is filling with more zeros than needed and some ys values are not taken into account. This warning has nothing to do whether we set a high <code>zero_threshold</code> value or not.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/pmc4/VectorPlotDigitizer.jl/blob/f9475d304dd0eb4dfca7c3b61a2685e4a55b7c51/src/helper_functions.jl#L49-L108">source</a></section></article></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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Monday 18 December 2023 20:58">Monday 18 December 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

0 comments on commit 2cd688f

Please sign in to comment.