Fits

Description of FITS files

describe_bintable_hdu

describe_bintable_hdu(hdu: BinTableHDU) -> dict

Describe a binary table HDU.

describe_file(fn: str | Path, bucket: Bucket | None = None) -> list[dict]

Describe the HDUs of an individual FITS file

describe_hdu(hdu: SupportedHDU) -> dict

Describe an individual HDU.

describe_image_hdu(hdu: PrimaryHDU | ImageHDU | CompImageHDU) -> dict

Describe an image, primary, or tile-compressed image HDU.

unify_descriptions(descriptions: Collection[FileDescription]) -> tuple[list[dict] | None, str | None]

Attempt to unify a collection of FITS file descriptions into a list of dicts suitable for use as the DataObjects of a Filetype.

Parameters:

descriptions (Collection[FileDescription]) –

collection of FileDescriptions populated with describe_file()

Returns:

objects ( list[dict] | None ) –

if unification succeeded, a list of dicts that can be used to initialize DataObjects; if it didn't, None
failure ( str | None ) –

if unification failed, a string describing the failure; if it succeeded, None