FITSio (version 2.1-6)

axVec: Generate axis vector for image

Description

axVec generates a vector of axis values from variables contained in a FITS image file header.

Usage

axVec(nax = 1, axDat)

Arguments

nax

index number of the axis.

axDat

data table axis variables produced by readFITSarray (which is also contained in readFITS).

Value

A vector with length equal to the number of pixels along the axis. Vector values \(v[i]\) for \(i = 1:NAXISn\) (\(NAXISn = len\), the vector length, in the axDat data frame) are: $$ v[i] = (i - CRPIXn) CDELTn + CRVALn$$ where \(CRPIXn\), \(CDELTn\), and \(CVALn\) are the reference pixel, pixel increment, and reference pixel value for each axis \(n\), following the FITS standard.

Details

Run once for each axis needed.

References

Hanisch et al., Astron.\ Astrophys. 376, 359-380 (2001)

https://fits.gsfc.nasa.gov/

See Also

readFITS, readFITSarray

Examples

# NOT RUN {
require(FITSio)
Z <- matrix(1:15, ncol = 3)
filename <- paste(tempdir(), "test.fits", sep="")
writeFITSim(Z, file = filename, c1 = 'Test FITS file',
            crpix = c(1,1), crvaln = c(10, 100), cdeltn = c(8, 2),
            ctypen = c('Distance', 'Time'),
            cunitn = c('Furlongs', 'Fortnights'))
X <-  readFITS(filename)
ax1 <- axVec(1, X$axDat)
ax2 <- axVec(2, X$axDat)
xlab <- X$axDat$ctype[1]
ylab <- paste(X$axDat$ctype[2], " [", X$axDat$cunit[2], "]", sep = "")
image(ax1, ax2, X$imDat, xlab = xlab, ylab = ylab)

## Clean up files to avoid clutter
unlink(filename)
# }