Skip to content

Commit

Permalink
build based on 2040e3a
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Dec 26, 2023
1 parent 72339db commit 4c50435
Show file tree
Hide file tree
Showing 4 changed files with 35 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.9.4","generation_timestamp":"2023-12-26T16:18:02","documenter_version":"1.2.1"}}
{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2023-12-26T16:47:01","documenter_version":"1.2.1"}}
41 changes: 31 additions & 10 deletions dev/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,42 @@

julia> fpath = "PhotosplineReader.jl/test/examples/IceCube_data_release_202209013_kdes/E_dec_photospline_v006_3D.fits";

julia> spt = FITS(fpath) do f
SplineTable(f)
end
julia> spt = SplineTable( fpath )
3-dimensional SplineTable of b-spline orders [1, 1, 3],
with extents:
(0.83, 10.21)
(-0.17, 1.00)
(0.57, 4.42)

with extents:
(0.83, 10.21)
(-0.17, 1.00)
(0.57, 4.42)

julia> x = [ 2.8, 0.2, 3.0 ]
3-element Vector{Float64}:
2.8
0.2
3.0

julia> evaluate_simple( x, spt )
0.7973871961087491</code></pre></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="Tuesday 26 December 2023 16:18">Tuesday 26 December 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
julia&gt; spt(x)
0.7973871961087491

julia&gt; spt(x...)
0.7973871961087491</code></pre><h2 id="Interfacing-with-Interpolations.jl"><a class="docs-heading-anchor" href="#Interfacing-with-Interpolations.jl">Interfacing with Interpolations.jl</a><a id="Interfacing-with-Interpolations.jl-1"></a><a class="docs-heading-anchor-permalink" href="#Interfacing-with-Interpolations.jl" title="Permalink"></a></h2><pre><code class="language-julia hljs">julia&gt; using Interpolations

julia&gt; spt = SplineTable( fpath )
3-dimensional SplineTable of b-spline orders [1, 1, 3],
with extents:
(0.83, 10.21)
(-0.17, 1.00)
(0.57, 4.42)

julia&gt; itp = spline_interpolation( spt );

julia&gt; typeof( itp )
Interpolations.FilledExtrapolation{Float64, 3, ScaledInterpolation{Float32, 3, Interpolations.BSplineInterpolation{Float32, 3, Array{Float32, 3}, Tuple{BSpline{Linear{Throw{OnGrid}}}, BSpline{Linear{Throw{OnGrid}}}, BSpline{Cubic{Line{OnGrid}}}}, Tuple{Base.Slice{UnitRange{Int64}}, Base.Slice{UnitRange{Int64}}, Base.Slice{UnitRange{Int64}}}}, Tuple{BSpline{Linear{Throw{OnGrid}}}, BSpline{Linear{Throw{OnGrid}}}, BSpline{Cubic{Line{OnGrid}}}}, Tuple{StepRangeLen{Float64, Base.TwicePrecision{Float64}, Base.TwicePrecision{Float64}, Int64}, StepRangeLen{Float64, Base.TwicePrecision{Float64}, Base.TwicePrecision{Float64}, Int64}, StepRangeLen{Float64, Base.TwicePrecision{Float64}, Base.TwicePrecision{Float64}, Int64}}}, Tuple{BSpline{Linear{Throw{OnGrid}}}, BSpline{Linear{Throw{OnGrid}}}, BSpline{Cubic{Line{OnGrid}}}}, Float64}

julia&gt; itp( x... )
0.7973871961087493

julia&gt; Interpolations.gradient( itp, x... )
3-element StaticArraysCore.SVector{3, Float64} with indices SOneTo(3):
-1.0382749146578347
-0.4631499529505209
0.08274258979323065</code></pre></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="Tuesday 26 December 2023 16:47">Tuesday 26 December 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
4 changes: 2 additions & 2 deletions dev/internalapis/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>APIs · PhotosplineReader.jl</title><meta name="title" content="APIs · PhotosplineReader.jl"/><meta property="og:title" content="APIs · PhotosplineReader.jl"/><meta property="twitter:title" content="APIs · PhotosplineReader.jl"/><meta name="description" content="Documentation for PhotosplineReader.jl."/><meta property="og:description" content="Documentation for PhotosplineReader.jl."/><meta property="twitter:description" content="Documentation for PhotosplineReader.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>PhotosplineReader.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>APIs</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>APIs</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>APIs</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/kcarloni/PhotosplineReader.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/kcarloni/PhotosplineReader.jl/blob/main/docs/src/internalapis.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"><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="PhotosplineReader.SplineTable-Tuple{FITSIO.FITS}" href="#PhotosplineReader.SplineTable-Tuple{FITSIO.FITS}"><code>PhotosplineReader.SplineTable</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">SplineTable( f::FITS )</code></pre><p>read a <code>FITS</code> file into a <code>SplineTable</code> struct.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/kcarloni/PhotosplineReader.jl/blob/60fb63a546e6832ee31fa3c6a487faaed07f18b5/src/_SplineTable.jl#L36-L40">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="PhotosplineReader.evaluate_simple-Tuple{Any, SplineTable}" href="#PhotosplineReader.evaluate_simple-Tuple{Any, SplineTable}"><code>PhotosplineReader.evaluate_simple</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">evaluate_simple( x, spt::SplineTable )</code></pre><p>evalute the spline at <code>x</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/kcarloni/PhotosplineReader.jl/blob/60fb63a546e6832ee31fa3c6a487faaed07f18b5/src/_functions.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="PhotosplineReader.spline_interpolation-Tuple{SplineTable}" href="#PhotosplineReader.spline_interpolation-Tuple{SplineTable}"><code>PhotosplineReader.spline_interpolation</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">spline_interpolation( spt::SplineTable )
spline_interpolation( f::FITS )</code></pre><p>make an Interpolation object from a given SplineTable. note that this method assumes that spline padding knots are symmetric on both sides, and that it Interpolations supports only up to cubic-order B-splines.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/kcarloni/PhotosplineReader.jl/blob/60fb63a546e6832ee31fa3c6a487faaed07f18b5/src/_SplineTable.jl#L77-L84">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="Tuesday 26 December 2023 16:18">Tuesday 26 December 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>APIs · PhotosplineReader.jl</title><meta name="title" content="APIs · PhotosplineReader.jl"/><meta property="og:title" content="APIs · PhotosplineReader.jl"/><meta property="twitter:title" content="APIs · PhotosplineReader.jl"/><meta name="description" content="Documentation for PhotosplineReader.jl."/><meta property="og:description" content="Documentation for PhotosplineReader.jl."/><meta property="twitter:description" content="Documentation for PhotosplineReader.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>PhotosplineReader.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>APIs</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>APIs</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>APIs</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/kcarloni/PhotosplineReader.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/kcarloni/PhotosplineReader.jl/blob/main/docs/src/internalapis.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"><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="PhotosplineReader.SplineTable-Tuple{FITSIO.FITS}" href="#PhotosplineReader.SplineTable-Tuple{FITSIO.FITS}"><code>PhotosplineReader.SplineTable</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">SplineTable( f::FITS )</code></pre><p>read a <code>FITS</code> file into a <code>SplineTable</code> struct.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/kcarloni/PhotosplineReader.jl/blob/2040e3a15c96e40e79a774413c45be45ab39bbe9/src/_SplineTable.jl#L36-L40">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="PhotosplineReader.evaluate_simple-Tuple{Any, SplineTable}" href="#PhotosplineReader.evaluate_simple-Tuple{Any, SplineTable}"><code>PhotosplineReader.evaluate_simple</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">evaluate_simple( x, spt::SplineTable )</code></pre><p>evalute the spline at <code>x</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/kcarloni/PhotosplineReader.jl/blob/2040e3a15c96e40e79a774413c45be45ab39bbe9/src/_functions.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="PhotosplineReader.spline_interpolation-Tuple{SplineTable}" href="#PhotosplineReader.spline_interpolation-Tuple{SplineTable}"><code>PhotosplineReader.spline_interpolation</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">spline_interpolation( spt::SplineTable )
spline_interpolation( f::FITS )</code></pre><p>make an Interpolation object from a given SplineTable. note that this method assumes that spline padding knots are symmetric on both sides, and that it Interpolations supports only up to cubic-order B-splines.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/kcarloni/PhotosplineReader.jl/blob/2040e3a15c96e40e79a774413c45be45ab39bbe9/src/_SplineTable.jl#L77-L84">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="Tuesday 26 December 2023 16:47">Tuesday 26 December 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 4c50435

Please sign in to comment.