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] [edit on github]¶

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:

Parameters:	pixel_scale : `Quantity` Angular scale of one pixel spec_pixel_scale : `Quantity` Spectral size of one pixel. Currently must be in equivalent radio velocity units. beamfwhm : `Quantity` Angular size for a circular Gaussian beam. imshape : tuple Shape of the data array. restfreq : `Quantity` Rest frequency of the spectral line. bunit : `Unit` Unit of intensity. v0 : `Unit`, optional The value of the spectral axis at the first pixel in the cube.
Returns:	header : fits.Header FITS Header.

pixel_scale : Quantity: Angular scale of one pixel
spec_pixel_scale : Quantity: Spectral size of one pixel. Currently must be in equivalent radio velocity units.
beamfwhm : Quantity: Angular size for a circular Gaussian beam.
imshape : tuple: Shape of the data array.
restfreq : Quantity: Rest frequency of the spectral line.
bunit : Unit: Unit of intensity.
v0 : Unit, optional: The value of the spectral axis at the first pixel in the cube.

Returns:

header : fits.Header: FITS Header.