build based on 41d1aa0

v0.17.3/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-06-12T19:52:36","documenter_version":"1.4.1"}}
+{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-06-13T01:00:39","documenter_version":"1.4.1"}}

v0.17.3/api/index.html

@@ -26,4 +26,4 @@
       hdutype=TableHDU, name=nothing, ver=nothing,
       header=nothing, units=nothing, varcols=nothing)</code></pre><p>Create a new table extension and write data to it. If the FITS file is currently empty then a dummy primary array will be created before appending the table extension to it. <code>data</code> should be a dictionary with String keys (giving the column names) and Array values (giving data to write to each column). The following types are supported in binary tables: <code>UInt8</code>, <code>Int8</code>, <code>UInt16</code>, <code>Int16</code>, <code>UInt32</code>, <code>Int32</code>, <code>UInt64</code>, <code>Int64</code>, <code>Float32</code>, <code>Float64</code>, <code>Complex{Float32}</code>, <code>Complex{Float64}</code>, <code>String</code>, <code>Bool</code>.</p><p>Optional inputs:</p><ul><li><code>hdutype</code>: Type of table extension to create. Can be either <code>TableHDU</code> (binary table) or <code>ASCIITableHDU</code> (ASCII table).</li><li><code>name</code>: Name of extension.</li><li><code>ver</code>: Version of extension (Int).</li><li><code>header</code>: FITSHeader instance to write to new extension.</li><li><code>units</code>: Dictionary mapping column name to units (as a string).</li><li><code>varcols</code>: An array giving the column names or column indicies to write as &quot;variable-length columns&quot;.</li></ul><div class="admonition is-info"><header class="admonition-header">Variable length columns</header><div class="admonition-body"><p>Variable length columns allow a column&#39;s row entries to contain arrays of different lengths. They can potentially save diskspace when the rows of a column vary greatly in length, as the column data is all written to a contiguous heap area at the end of the table. Only column data of type <code>Vector{String}</code> or types such as <code>Vector{Vector{UInt8}}</code> can be written as variable length columns. In the second case, ensure that the column data type is a <em>leaf type</em>. That is, the type cannot be <code>Vector{Vector{T}}</code>, which would be an array of arrays having potentially non-uniform element types (which would not be writable as a FITS table column).</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaAstro/FITSIO.jl/blob/41d1aa027bcc243abddb519569faa63560d23c54/src/table.jl#L379-L417">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="Base.write-Tuple{FITS, Vector{String}, Vector}" href="#Base.write-Tuple{FITS, Vector{String}, Vector}"><code>Base.write</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">write(f::FITS, colnames, coldata;
       hdutype=TableHDU, name=nothing, ver=nothing,
-      header=nothing, units=nothing, varcols=nothing)</code></pre><p>Same as <code>write(f::FITS, data::Dict; ...)</code> but providing column names and column data as a separate arrays. This is useful for specifying the order of the columns. Column names must be <code>Vector{String}</code> and column data must be a vector of arrays.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaAstro/FITSIO.jl/blob/41d1aa027bcc243abddb519569faa63560d23c54/src/table.jl#L358-L367">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="Base.read-Tuple{TableHDU, String}" href="#Base.read-Tuple{TableHDU, String}"><code>Base.read</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">read(hdu::TableHDU, colname; case_sensitive=true)</code></pre><p>Read a column as an array from the given table HDU.</p><p>The column name may contain wild card characters (<code>*</code>, <code>?</code>, or <code>#</code>). The <code>*</code> wild card character matches any sequence of characters (including zero characters) and the <code>?</code> character matches any single character. The <code>#</code> wildcard will match any consecutive string of decimal digits (0-9). The string must match a unique column.  The optional boolean keyword <code>case_sensitive</code>, <code>true</code> by default, specifies whether the column name is to be considered case sensitive.</p><div class="admonition is-info"><header class="admonition-header">Array order</header><div class="admonition-body"><p>Julia arrays are column-major (like Fortran), not row-major (like C and numpy), so elements of multi-dimensional columns will be the transpose of what you get with astropy.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaAstro/FITSIO.jl/blob/41d1aa027bcc243abddb519569faa63560d23c54/src/table.jl#L500-L519">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Introduction</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.1 on <span class="colophon-date" title="Wednesday 12 June 2024 19:52">Wednesday 12 June 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+      header=nothing, units=nothing, varcols=nothing)</code></pre><p>Same as <code>write(f::FITS, data::Dict; ...)</code> but providing column names and column data as a separate arrays. This is useful for specifying the order of the columns. Column names must be <code>Vector{String}</code> and column data must be a vector of arrays.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaAstro/FITSIO.jl/blob/41d1aa027bcc243abddb519569faa63560d23c54/src/table.jl#L358-L367">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="Base.read-Tuple{TableHDU, String}" href="#Base.read-Tuple{TableHDU, String}"><code>Base.read</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">read(hdu::TableHDU, colname; case_sensitive=true)</code></pre><p>Read a column as an array from the given table HDU.</p><p>The column name may contain wild card characters (<code>*</code>, <code>?</code>, or <code>#</code>). The <code>*</code> wild card character matches any sequence of characters (including zero characters) and the <code>?</code> character matches any single character. The <code>#</code> wildcard will match any consecutive string of decimal digits (0-9). The string must match a unique column.  The optional boolean keyword <code>case_sensitive</code>, <code>true</code> by default, specifies whether the column name is to be considered case sensitive.</p><div class="admonition is-info"><header class="admonition-header">Array order</header><div class="admonition-body"><p>Julia arrays are column-major (like Fortran), not row-major (like C and numpy), so elements of multi-dimensional columns will be the transpose of what you get with astropy.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaAstro/FITSIO.jl/blob/41d1aa027bcc243abddb519569faa63560d23c54/src/table.jl#L500-L519">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Introduction</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.1 on <span class="colophon-date" title="Thursday 13 June 2024 01:00">Thursday 13 June 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

v0.17.3/index.html

@@ -75,4 +75,4 @@
        end
 
 julia> filesize("abc.fits")
-8640</code></pre><div class="admonition is-category-warn"><header class="admonition-header">Warn</header><div class="admonition-body"><p>Compression is &quot;loss-less&quot; for images with integer pixel values, and might be lossy for floating-point images.</p></div></div></div></div></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="api/">API Reference »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.1 on <span class="colophon-date" title="Wednesday 12 June 2024 19:52">Wednesday 12 June 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+8640</code></pre><div class="admonition is-category-warn"><header class="admonition-header">Warn</header><div class="admonition-body"><p>Compression is &quot;loss-less&quot; for images with integer pixel values, and might be lossy for floating-point images.</p></div></div></div></div></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="api/">API Reference »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.1 on <span class="colophon-date" title="Thursday 13 June 2024 01:00">Thursday 13 June 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>