fast_lisa_subtraction.utils.read_catalog module

fast_lisa_subtraction.utils.read_catalog.read_catalog(filepath, verbose=True)[source]

Read a gravitational-wave source catalogue from an HDF5 file.

The function targets LISA LDC Radler-style catalogues, where galactic binaries are stored under /H5LISA/GWSources/GalBinaries. If that path is not present, the file root is treated as the catalogue group.

Parameters:

filepath (str or os.PathLike) – Path to the input HDF5 file.
verbose (bool, optional) – If True, log basic information about the read and the number of sources found.

Returns:

DataFrame where each column corresponds to a dataset (field) in the catalogue group and each row corresponds to a source.

Return type:

pandas.DataFrame

Notes

All datasets within the selected group are assumed to be 1D and of equal length so they can be combined into a tabular structure.