write.fits.image.file: Write FITS Image to File

View source: R/write.fits.image.file.R

write.fits.image.fileR Documentation

Write FITS Image to File

Description

Write an input image to file, using the standard FITS format.

Usage

write.fits.image.file(filename, image, header_in, xsize = NA,
ysize = NA, xcent = NA, ycent = NA, pixeloffset = NA,
nochange = FALSE, verbose = FALSE, diagnostic = FALSE)
make.fits.header(hdr)

Arguments

filename

string; The path to, and filename of, the output image

image

numeric (p,q) array; the image to be output

header_in

list; a FITS header, usually a duplicate of the original header that the new image was derived from.

xsize

numeric; The new x-axis length to be written to the fits header (pixels). Only used if nochange == FALSE

ysize

numeric; The new y-axis size to be written to the fits header (pixels). Only used if nochange == FALSE

xcent

numeric; The new reference pixel for the x-axis, to be written to the fits header (pixel). Only used if nochange == FALSE

ycent

numeric; The new reference pixel for the y-axis, to be written to the fits header (pixel). Only used if nochange == FALSE

pixeloffset

numeric; The magnitude of the offset between the original pixel location paramters (from header_in), and what we wish to output.

nochange

logical; if TRUE, the new image will be output with the header_in header. Otherwise, new values will be added as above.

diagnostic

logical; if TRUE, then perform diagnostic checks and outputs

verbose

logical; if TRUE, then perform verbose outputs

hdr

data.frame; In the form of a fits header, this will be converted to a string which can be output as a binary fits header

Value

NULL; Output is to file character; fits header to be written to file

Author(s)

Angus H Wright ICRAR angus.wright@icrar.org

See Also

measure.fluxes, flux.measurements


AngusWright/LAMBDAR documentation built on May 12, 2022, 1:49 a.m.