create_cube_header

turbustat.io.sim_tools.create_cube_header(pixel_scale, spec_pixel_scale, beamfwhm, imshape, restfreq, bunit, v0=<Quantity 0. km / s>)[source]

Create a basic FITS header for a PPV cube.

Only frequency and radio velocity are currently supported for the spectral dimension type.

Adapted from: https://github.com/radio-astro-tools/uvcombine/blob/master/uvcombine/tests/utils.py

Parameters:
pixel_scaleQuantity

Angular scale of one pixel

spec_pixel_scaleQuantity

Spectral size of one pixel. Currently must be in equivalent radio velocity units.

beamfwhmQuantity

Angular size for a circular Gaussian beam.

imshapetuple

Shape of the data array.

restfreqQuantity

Rest frequency of the spectral line.

bunitUnit

Unit of intensity.

v0Unit, optional

The value of the spectral axis at the first pixel in the cube.

Returns:
headerfits.Header

FITS Header.