FITSWriter

class pyvisgen.io.FITSWriter(output_path: Path, **kwargs)

Bases: DataWriter

FITS file writer for pyvisgen visibility datasets.

This writer saves visibility data and observation information to FITS (Flexible Image Transport System) files. Each sample is written to a separate .fits file.

Parameters:

output_pathstr or Path

Directory path where FITS files will be written.

Examples

>>> writer = FITSWriter(output_path="./data")
>>> writer.write(vis_data, obs, index=0)

Or as a context manager:

>>> with FITSWriter(output_path="./data") as writer:
...     writer.write(vis_data, obs, index=0)

Methods Summary

write(vis_data, obs, index[, overwrite])

Write visibility data and observation metadata to a FITS file.

Methods Documentation

write(vis_data, obs, index, overwrite=True, **kwargs) → None

Write visibility data and observation metadata to a FITS file.

Creates a new FITS file for each sample with pattern vis_{dataset_type}_{index}.fits.

Parameters:

vis_dataarray-like

Visibility data to be written to the FITS file.

obsobject

Observation metadata object from Observation.

indexint

Sample index used in the output filename.

overwritebool, optional

If True, overwrite the output file if it already exists, otherwise an error is raised. Default: True.

See also

pyvisgen.fits.writer.create_hdu_list

For more information on the parameters.

Examples

>>> writer = FITSWriter(output_path="./data")
>>> writer.write(vis, obs, index=0)
>>> # Creates file: ./data/vis_train_0.fits

>>> writer.write(vis, obs, index=1, overwrite=False)
>>> # Creates file: ./data/vis_train_1.fits (raises error if exists)