Catalogue

catalogue_command(output: Annotated[Path | None, Option('--output', help='Destination .csv, .h5, or .hdf5 file for the archived draw.')] = None, stamp: Annotated[Path | None, Option('--stamp', help='Optional JSON file for the composition stamp beside the draw.')] = None, seed: Annotated[int, Option('--seed', help='Seed of the archived draw.')] = 42, draws: Annotated[int, Option('--draws', min=1, help='Number of draws whose composition spread is reported.')] = _DEFAULT_DRAWS, span_seconds: Annotated[float, Option('--span-seconds', min=0.0, help='Observation span each draw covers, in seconds.')] = _REFERENCE_SPAN_SECONDS, band_detector_frame_chirp_mass: Annotated[float, Option('--band-mc', min=0.0, help='Lower edge of the searched band, detector-frame chirp mass.')] = 5.0, imbh_total_mass_threshold: Annotated[float, Option('--imbh-mass', min=0.0, help='Source-frame total mass at or above which a row is IMBH.')] = 100.0, rate_multiplier: Annotated[float, Option('--rate-multiplier', min=0.0, help="Factor applied to every catalogue's annual rate.")] = 1.0, f_low: Annotated[float, Option('--f-low', min=0.0, help='Observed low-frequency cutoff used for the in-band duration.')] = 5.0, cache_dir: Annotated[Path | None, Option('--cache-dir', help='Cache directory for the on-demand catalogue download.')] = None, refresh: Annotated[bool, Option('--refresh', help='Re-download catalogues even when cached.')] = False, offline: Annotated[bool, Option('--offline', help='Use only a cache entry whose digest matches; never download.')] = False, overwrite: Annotated[bool, Option('--overwrite', help='Replace an existing output file.')] = False, allow_replacement: Annotated[bool, Option('--allow-replacement', help="Sample a class with replacement when its drawn count exceeds the catalogue's rows, instead of refusing. Repeats catalogue rows; recorded in the provenance.")] = False) -> None