eye_patch.naming

Classes

FITSMaskNames

Contains the names of the FITS images created when creating a mask image/

Functions

create_fits_mask_names(→ FITSMaskNames)

Create the names that will be used when generate FITS mask products

Module Contents

class eye_patch.naming.FITSMaskNames

Bases: NamedTuple

Contains the names of the FITS images created when creating a mask image/ These are only the names, and do not mean that they are necessarily created.

mask_fits: pathlib.Path

Name of the mask FITS file

scale_mask_fits: pathlib.Path | None = None

Path to a FITS file that describes per-scale clean masks. Scales are represented with a bit-mapped values,

signal_fits: pathlib.Path | None = None

Name of the signal FITS file

eye_patch.naming.create_fits_mask_names(fits_image: str | pathlib.Path, include_signal_path: bool = False) → FITSMaskNames

Create the names that will be used when generate FITS mask products

Parameters:

• fits_image (Union[str,]Path) – Base name of the output files

• include_signal_path (bool, optional) – If True, also include signal_fits in the output. Defaults to False.

Returns:

collection of names used for the signal and mask FITS images

Return type:

FITSMaskNames