lsdb.io

lsdb.io#

Submodules#

Functions#

to_hats(catalog, *, base_catalog_path[, catalog_name, ...])

Writes a catalog to disk, in HATS format. The output catalog comprises

Package Contents#

to_hats(catalog: lsdb.catalog.dataset.healpix_dataset.HealpixDataset, *, base_catalog_path: str | pathlib.Path | upath.UPath, catalog_name: str | None = None, default_columns: list[str] | None = None, histogram_order: int = 8, overwrite: bool = False, **kwargs)[source]#

Writes a catalog to disk, in HATS format. The output catalog comprises partition parquet files and respective metadata, as well as JSON files detailing partition, catalog and provenance info.

Parameters:

  • catalog (HealpixDataset) – A catalog to export

  • base_catalog_path (str) – Location where catalog is saved to

  • catalog_name (str) – The name of the output catalog

  • default_columns (list[str]) – A metadata property with the list of the columns in the catalog to be loaded by default. Uses the default columns from the original hats catalogs if they exist.

  • histogram_order (int) – The default order for the count histogram. Defaults to 8.

  • overwrite (bool) – If True existing catalog is overwritten

  • **kwargs – Arguments to pass to the parquet write operations

Contents