Skip to content

Commit 7e59a63

Browse files
author
Documenter.jl
committed
build based on 702607e
1 parent 22c3bf8 commit 7e59a63

17 files changed

+1572
-0
lines changed
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"documenter":{"julia_version":"1.12.2","generation_timestamp":"2025-11-24T04:28:41","documenter_version":"1.16.1"}}
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<!DOCTYPE html>
2+
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>API Reference · Reproject.jl</title><meta name="title" content="API Reference · Reproject.jl"/><meta property="og:title" content="API Reference · Reproject.jl"/><meta property="twitter:title" content="API Reference · Reproject.jl"/><meta name="description" content="Documentation for Reproject.jl."/><meta property="og:description" content="Documentation for Reproject.jl."/><meta property="twitter:description" content="Documentation for Reproject.jl."/><meta property="og:url" content="https://juliaastro.org/Reproject/stable/api-reference/"/><meta property="twitter:url" content="https://juliaastro.org/Reproject/stable/api-reference/"/><link rel="canonical" href="https://juliaastro.org/Reproject/stable/api-reference/"/><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"><div class="docs-package-name"><span class="docs-autofit"><a href="../">Reproject.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><a class="tocitem" href="../">Reproject</a></li><li class="is-active"><a class="tocitem" href>API Reference</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 Reference</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>API Reference</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/https:/" 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/https://blob/master/docs/src/api-reference.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-Reference"><a class="docs-heading-anchor" href="#API-Reference">API Reference</a><a id="API-Reference-1"></a><a class="docs-heading-anchor-permalink" href="#API-Reference" title="Permalink"></a></h1><article><details class="docstring" open="true"><summary id="Reproject.interpolator-Tuple{AbstractArray, Int64}"><a class="docstring-binding" href="#Reproject.interpolator-Tuple{AbstractArray, Int64}"><code>Reproject.interpolator</code></a><span class="docstring-category">Method</span></summary><section><div><pre><code class="language-julia hljs">interpolator(array_in, order::Int)</code></pre><p>Returns an interpolator with the given array and order of interpolation.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/https://blob/702607e771f83c7c18f3b502a318301bacae7715/src/core.jl#L81-L85">source</a></section></details></article><article><details class="docstring" open="true"><summary id="Reproject.pad_edges-Union{Tuple{Matrix{T}}, Tuple{T}} where T"><a class="docstring-binding" href="#Reproject.pad_edges-Union{Tuple{Matrix{T}}, Tuple{T}} where T"><code>Reproject.pad_edges</code></a><span class="docstring-category">Method</span></summary><section><div><pre><code class="language-julia hljs">pad_edges(array_in::Matrix{T}) where {T}</code></pre><p>Pads a given array and creates a border with edge elements.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/https://blob/702607e771f83c7c18f3b502a318301bacae7715/src/utils.jl#L24-L28">source</a></section></details></article><article><details class="docstring" open="true"><summary id="Reproject.parse_input_data-Tuple{FITSIO.ImageHDU}"><a class="docstring-binding" href="#Reproject.parse_input_data-Tuple{FITSIO.ImageHDU}"><code>Reproject.parse_input_data</code></a><span class="docstring-category">Method</span></summary><section><div><pre><code class="language-julia hljs">parse_input_data(input_data::ImageHDU)
3+
parse_input_data(input_data::Tuple{AbstractArray, WCSTransform})
4+
parse_input_data(input_data::String, hdu_in)
5+
parse_input_data(input_data::FITS, hdu_in)</code></pre><p>Parse input data and returns an Array and WCS object.</p><p><strong>Arguments</strong></p><ul><li><code>input_data</code>: image to reproject which can be name of a FITS file, an ImageHDU or a FITS file.</li><li><code>hdu_in</code>: used to set HDU to use when more than one HDU is present.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/https://blob/702607e771f83c7c18f3b502a318301bacae7715/src/parsers.jl#L1-L13">source</a></section></details></article><article><details class="docstring" open="true"><summary id="Reproject.parse_output_projection-Tuple{WCS.WCSTransform, Any}"><a class="docstring-binding" href="#Reproject.parse_output_projection-Tuple{WCS.WCSTransform, Any}"><code>Reproject.parse_output_projection</code></a><span class="docstring-category">Method</span></summary><section><div><pre><code class="language-julia hljs">parse_output_projection(output_projection::WCSTransform, shape_out)
6+
parse_output_projection(output_projection::ImageHDU; shape_out)
7+
parse_output_projection(output_projection::String, hdu_number)
8+
parse_output_projection(output_projection::FITS, hdu_number)</code></pre><p>Parse output projection and returns a WCS object and shape of output.</p><p><strong>Arguments</strong></p><ul><li><code>output_projection</code>: WCS information about the image to be reprojected which can be name of a FITS file, an ImageHDU or WCSTransform.</li><li><code>shape_out</code>: shape of the output image.</li><li><code>hdu_number</code>: specifies HDU number when file name is given as input.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/https://blob/702607e771f83c7c18f3b502a318301bacae7715/src/parsers.jl#L34-L47">source</a></section></details></article><article><details class="docstring" open="true"><summary id="Reproject.reproject-Tuple{Any, Any}"><a class="docstring-binding" href="#Reproject.reproject-Tuple{Any, Any}"><code>Reproject.reproject</code></a><span class="docstring-category">Method</span></summary><section><div><pre><code class="language-julia hljs">reproject(input_data, output_projection; shape_out = nothing, order = 1, hdu_in = 1, hdu_out = 1)</code></pre><p>Reprojects image data to a new projection using interpolation.</p><p><strong>Arguments</strong></p><ul><li><code>input_data</code>: Image data which is being reprojected. It can be an ImageHDU, FITS object, name of a FITS file or a tuple of image matrix and WCSTransform.</li><li><code>output_projection</code>: Frame in which data is reprojected. Frame can be taken from WCSTransform object, ImageHDU, FITS or name of FITS file.</li><li><code>shape_out</code>: Shape of image after reprojection.</li><li><code>order</code>: Order of interpolation. 0: Nearest-neighbor 1: Linear 2: Quadratic</li><li><code>hdu_in</code>: Used to specify HDU number when giving input as FITS or name of FITS file.</li><li><code>hdu_out:</code> Used to specify HDU number when giving output projection as FITS or name of FITS file.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/https://blob/702607e771f83c7c18f3b502a318301bacae7715/src/core.jl#L1-L18">source</a></section></details></article><article><details class="docstring" open="true"><summary id="Reproject.wcs_to_celestial_frame-Tuple{WCS.WCSTransform}"><a class="docstring-binding" href="#Reproject.wcs_to_celestial_frame-Tuple{WCS.WCSTransform}"><code>Reproject.wcs_to_celestial_frame</code></a><span class="docstring-category">Method</span></summary><section><div><pre><code class="language-julia hljs">wcs_to_celestial_frame(wcs::WCSTransform)</code></pre><p>Returns the reference frame of a WCSTransform. The reference frame supported in Julia are FK5, ICRS and Galactic.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/https://blob/702607e771f83c7c18f3b502a318301bacae7715/src/utils.jl#L1-L6">source</a></section></details></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Reproject</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.16.1 on <span class="colophon-date" title="Monday 24 November 2025 04:28">Monday 24 November 2025</span>. Using Julia version 1.12.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

0 commit comments

Comments
 (0)