module documentation

Helper functions to operate on FITS headers.

Class DictReader Put a dictionary into a format that we can insert into a FITS header file. Make all uppercase, replace dots with spaces, turn everything into a string and hope it's not over 80 characters long. Will need to use HIERARCH keys to have long parameter names, see ...
Function get_all_axes Undocumented
Function get_axes_ordering Undocumented
Function get_axes_unit_string Undocumented
Function get_celestial_axes Undocumented
Function get_iwc_matrix Get intermediate world coordinate matrix (CDi_j or PCi_j matrix with scaling applied)
Function get_key_fmt_max Undocumented
Function get_polarisation_axes Undocumented
Function get_spectral_axes Undocumented
Function get_time_axes Undocumented
Function get_wcs_axis_key_1d Undocumented
Function get_wcs_axis_key_2d Undocumented
Function get_wcs_header_keys Undocumented
Function get_wcs_of_axes Undocumented
Function get_world_coords_of_axis Gets the world coordiates of an axis
Function is_CDi_j_present Undocumented
Function remove_key_fmt Undocumented
Function set_axes_transform Undocumented
Function set_iwc_matrix Undocumented
Variable _lgr Undocumented
def get_all_axes(hdr: ap.io.fits.Header, wcsaxes_label=''):

Undocumented

def get_axes_ordering(hdr, axes, ordering='numpy', wcsaxes_label=''):

Undocumented

def get_axes_unit_string(hdr, axes: tuple[int, ...]):

Undocumented

def get_celestial_axes(hdr: ap.io.fits.Header, wcsaxes_label=''):

Undocumented

def get_iwc_matrix(hdr, wcsaxes_label=''):

Get intermediate world coordinate matrix (CDi_j or PCi_j matrix with scaling applied)

IRAF does things differently, see <https://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.46.2794&rep=rep1&type=pdf>

def get_key_fmt_max(hdr: ap.io.fits.Header, key_fmt, key_fmt_arg_iter) -> str:

Undocumented

def get_polarisation_axes(hdr, wcsaxes_label=''):

Undocumented

def get_spectral_axes(hdr, wcsaxes_label=''):

Undocumented

def get_time_axes(hdr, wcsaxes_label=''):

Undocumented

def get_wcs_axis_key_1d(key: str, axis: int, wcsaxes_label: str = ''):

Undocumented

def get_wcs_axis_key_2d(key: str, axis1: int, axis2: int, wcsaxes_label: str = ''):

Undocumented

def get_wcs_header_keys(hdr, axes=None, wcsaxes_label=''):

Undocumented

def get_wcs_of_axes(hdr, axes=None, wcsaxes_label=''):

Undocumented

def get_world_coords_of_axis(hdr, ax_idx, wcsaxes_label='', squeeze=True, wcs_unit_to_return_value_conversion_factor=1):

Gets the world coordiates of an axis

def is_CDi_j_present(header, wcsaxes_label=''):

Undocumented

def remove_key_fmt(hdr: ap.io.fits.Header, key_fmt, key_fmt_arg_iter):

Undocumented

def set_axes_transform(hdr, axis=None, unit=None, reference_value=None, delta_value=None, n_values=None, reference_pixel=None):

Undocumented

def set_iwc_matrix(hdr, iwc_matrix, wcsaxes_label='', CD_format=None):

Undocumented

_lgr =

Undocumented