aopp_deconv_tool.astropy_helper.fits.header.DictReader

class documentation

class DictReader:

Constructor: DictReader(adict, mode, prefix, pkey_count_start)

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 https://fits.gsfc.nasa.gov/fits_standard.html

Also we should combine dictionaries so that we have a flat structure, one way to do this is to concatenate the keys for member dictionaries with the parent dictionary, i.e:

{"some.key" : {"child_key_1" : X1, "child_key_2": X2}}

becomes: {"some.key.child_key_1" : X1, "some.key.child_key_2": X2}
and is turned into a FITS header like: HIERARCH SOME KEY CHILD_KEY_1 = "X1" HIERARCH SOME KEY CHILD_KEY_2 = "X2"

If we need to we can split header entries into a "name" and "value" format, e.g., the above example would become:

PKEY1 = some.key.child_key_1 PVAL1 = "X1" PKEY2 = some.key.child_key_2 PVAL1 = "X2"

Static Method	`find_max_pkey_n`	Undocumented
Static Method	`remove_pkeys`	Undocumented
Method	`__init__`	Undocumented
Method	`__iter__`	Undocumented
Instance Variable	`adict`	Undocumented
Instance Variable	`fits_dict`	Undocumented
Instance Variable	`key_count`	Undocumented
Instance Variable	`mode`	Undocumented
Instance Variable	`prefix`	Undocumented
Method	`_add_kv_to_fits_dict`	Undocumented
Method	`_to_fits_format`	Undocumented
Method	`_to_fits_hierarch_format`	Undocumented
Instance Variable	`_key_count_start`	Undocumented

@staticmethod
def find_max_pkey_n(hdr, n_max=1000): ¶

Undocumented

@staticmethod
def remove_pkeys(hdr, n_max=1000): ¶

Undocumented

def __init__(self, adict: dict, mode: str = 'standard', prefix: str = None, pkey_count_start: int = 0): ¶

Undocumented

def __iter__(self): ¶

Undocumented

adict = ¶

Undocumented

fits_dict: dict = ¶

Undocumented

key_count = ¶

Undocumented

mode = ¶

Undocumented

prefix = ¶

Undocumented

def _add_kv_to_fits_dict(self, k, v): ¶

Undocumented

def _to_fits_format(self, bdict, prefix=None): ¶

Undocumented

def _to_fits_hierarch_format(self, bdict, prefix=None): ¶

Undocumented

_key_count_start = ¶

Undocumented