From 27a95d8476af7002973d17416c08a8c746068bcf Mon Sep 17 00:00:00 2001 From: "Documenter.jl" Date: Thu, 13 Jun 2024 00:59:19 +0000 Subject: [PATCH] build based on 0ea99f4 --- v0.17.2/api/index.html | 2 +- v0.17.2/index.html | 2 +- v0.17.2/search/index.html | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/v0.17.2/api/index.html b/v0.17.2/api/index.html index 75297c2..145c09f 100644 --- a/v0.17.2/api/index.html +++ b/v0.17.2/api/index.html @@ -22,4 +22,4 @@ 0.2495752009567498 + 0.819163869249041im

While this often works in practice, such a workaround is not officially supported by FITSIO, and care must be taken to ensure the correctness of data.

source
Base.write — Method
write(hdu::ImageHDU, data::StridedArray{<:Real})

Write data to an existing image HDU. The data to be written out must be stored contiguously in memory.

source
FITSIO.fitswrite — Function
fitswrite(filename::AbstractString, data; extendedparser = true, kwargs...)

Convenience function to write the image array data to a file named filename.

Functionally fitswrite(filename, data; extendedparser, kwargs...) is equivalent to

FITS(filename, "w"; extendedparser = extendedparser) do f
     write(f, data; kwargs...)
 end

The keyword argument extendedparser may be used to enable or disable the extended filename parser. If disabled, filename is treated exactly as the name of the file and is not tokenized into parameters.

Warning

Existing files with the same name will be overwritten.

See also: write

source
Base.eltype — Method
eltype(hdu::ImageHDU)

Return the element type of the image in hdu.

source
Base.ndims — Method
ndims(hdu::ImageHDU)

Get number of image dimensions, without reading the image into memory.

source
Base.size — Method
size(hdu::ImageHDU)
-size(hdu::ImageHDU, i)

Get image dimensions (or ith dimension), without reading the image into memory.

source
Base.length — Method
length(hdu::ImageHDU)

Get total number of pixels in image (product of size(hdu)).

source
FITSIO.copy_section — Function
copy_section(hdu, dest, r...)

Copy a rectangular section of an image and write it to a new FITS primary image or image extension in FITS object dest. The new image HDU is appended to the end of dest. All the keywords in the input image will be copied to the output image. The common WCS keywords will be updated if necessary to correspond to the coordinates of the section.

Examples

Copy the lower-left 200 x 200 pixel section of the image in hdu to an open file, f

copy_section(hdu, f, 1:200, 1:200)

Same as above but only copy odd columns in y:

copy_section(hdu, f, 1:200, 1:2:200)
source

Table operations

FITSIO.colnames — Function
colnames(hdu) -> Vector{String}

Return the names of columns in a table HDU.

source
Base.write — Method
write(f::FITS, data::Dict; hdutype=TableHDU, name=nothing, ver=nothing, header=nothing, units=nothing, varcols=nothing)

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. data 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: UInt8, Int8, UInt16, Int16, UInt32, Int32, UInt64, Int64, Float32, Float64, Complex{Float32}, Complex{Float64}, String, Bool.

Optional inputs:

  • hdutype: Type of table extension to create. Can be either TableHDU (binary table) or ASCIITableHDU (ASCII table).
  • name: Name of extension.
  • ver: Version of extension (Int).
  • header: FITSHeader instance to write to new extension.
  • units: Dictionary mapping column name to units (as a string).
  • varcols: An array giving the column names or column indicies to write as "variable-length columns".
Variable length columns

Variable length columns allow a column'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 Vector{String} or types such as Vector{Vector{UInt8}} can be written as variable length columns. In the second case, ensure that the column data type is a leaf type. That is, the type cannot be Vector{Vector{T}}, which would be an array of arrays having potentially non-uniform element types (which would not be writable as a FITS table column).

source
Base.write — Method
write(f::FITS, colnames, coldata; hdutype=TableHDU, name=nothing, ver=nothing, header=nothing, units=nothing, varcols=nothing)

Same as write(f::FITS, data::Dict; ...) 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 Vector{String} and column data must be a vector of arrays.

source
Base.read — Method
read(hdu::TableHDU, colname; case_sensitive=true)

Read a column as an array from the given table HDU.

The column name may contain wild card characters (*, ?, or #). The * wild card character matches any sequence of characters (including zero characters) and the ? character matches any single character. The # wildcard will match any consecutive string of decimal digits (0-9). The string must match a unique column. The optional boolean keyword case_sensitive, true by default, specifies whether the column name is to be considered case sensitive.

Array order

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.

source
+size(hdu::ImageHDU, i)

Get image dimensions (or ith dimension), without reading the image into memory.

source
Base.length — Method
length(hdu::ImageHDU)

Get total number of pixels in image (product of size(hdu)).

source
FITSIO.copy_section — Function
copy_section(hdu, dest, r...)

Copy a rectangular section of an image and write it to a new FITS primary image or image extension in FITS object dest. The new image HDU is appended to the end of dest. All the keywords in the input image will be copied to the output image. The common WCS keywords will be updated if necessary to correspond to the coordinates of the section.

Examples

Copy the lower-left 200 x 200 pixel section of the image in hdu to an open file, f

copy_section(hdu, f, 1:200, 1:200)

Same as above but only copy odd columns in y:

copy_section(hdu, f, 1:200, 1:2:200)
source

Table operations

FITSIO.colnames — Function
colnames(hdu) -> Vector{String}

Return the names of columns in a table HDU.

source
Base.write — Method
write(f::FITS, data::Dict; hdutype=TableHDU, name=nothing, ver=nothing, header=nothing, units=nothing, varcols=nothing)

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. data 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: UInt8, Int8, UInt16, Int16, UInt32, Int32, UInt64, Int64, Float32, Float64, Complex{Float32}, Complex{Float64}, String, Bool.

Optional inputs:

  • hdutype: Type of table extension to create. Can be either TableHDU (binary table) or ASCIITableHDU (ASCII table).
  • name: Name of extension.
  • ver: Version of extension (Int).
  • header: FITSHeader instance to write to new extension.
  • units: Dictionary mapping column name to units (as a string).
  • varcols: An array giving the column names or column indicies to write as "variable-length columns".
Variable length columns

Variable length columns allow a column'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 Vector{String} or types such as Vector{Vector{UInt8}} can be written as variable length columns. In the second case, ensure that the column data type is a leaf type. That is, the type cannot be Vector{Vector{T}}, which would be an array of arrays having potentially non-uniform element types (which would not be writable as a FITS table column).

source
Base.write — Method
write(f::FITS, colnames, coldata; hdutype=TableHDU, name=nothing, ver=nothing, header=nothing, units=nothing, varcols=nothing)

Same as write(f::FITS, data::Dict; ...) 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 Vector{String} and column data must be a vector of arrays.

source
Base.read — Method
read(hdu::TableHDU, colname; case_sensitive=true)

Read a column as an array from the given table HDU.

The column name may contain wild card characters (*, ?, or #). The * wild card character matches any sequence of characters (including zero characters) and the ? character matches any single character. The # wildcard will match any consecutive string of decimal digits (0-9). The string must match a unique column. The optional boolean keyword case_sensitive, true by default, specifies whether the column name is to be considered case sensitive.

Array order

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.

source
diff --git a/v0.17.2/index.html b/v0.17.2/index.html index c6556ab..a16f2c6 100644 --- a/v0.17.2/index.html +++ b/v0.17.2/index.html @@ -75,4 +75,4 @@ end julia> filesize("abc.fits") -8640
Warn

Compression is "loss-less" for images with integer pixel values, and might be lossy for floating-point images.

+8640
Warn

Compression is "loss-less" for images with integer pixel values, and might be lossy for floating-point images.

diff --git a/v0.17.2/search/index.html b/v0.17.2/search/index.html index 573d57d..3f98565 100644 --- a/v0.17.2/search/index.html +++ b/v0.17.2/search/index.html @@ -1,2 +1,2 @@ -Search · FITSIO.jl

Loading search...

    +Search · FITSIO.jl

    Loading search...