overlappogram_fits_wcs#

overlappy.wcs.overlappogram_fits_wcs(data_shape, scale, reference_pixel: Unit('pix') = None, reference_coord=None, pc_matrix=None, observer=None)[source]#

Construct a FITS WCS for an overlappogram.

Parameters:

  • data_shape (tuple) – Dimensions of detector (in row-major ordering), with the leading dimension corresponding to wavelength. Note that the ordering here is opposite that of the other quantities which are in WCS/Cartesian-like ordering.

  • scale (tuple) – The plate scale of the spatial and spectral directions. Each should be a ~astropy.units.Quantity

  • reference_pixel (~astropy.units.Quantity, optional) – Zero-based location of the reference pixel. Defaults to the center of the detector. Should be of length 3.

  • reference_coord (tuple, optional) – Reference coordinate corresponding to longitude, latitute, wavelength. This is effectively the location of the image on the detector at zero wavelength (or in zeroth order). The spatial coordinates are assumed to be in the Helioprojective coordinate system defined by observer.

  • pc_matrix (np.array, optional) – 3-by-3 matrix. If not specified, will not be included in the header, which in the FITS standard means the matrix is assumed to be diagonal. For constructing this matrix, it is easiest to use the pcij_matrix function.

  • observer (~astropy.coordinates.SkyCoord, optional) – Observer coordinate that defines the Helioprojective frame of the observer coordinate. By default will not be included. This also sets the date.

Returns:

wcs – WCS object describing the overlappogram coordinate system.

Return type:

~astropy.wcs.WCS