Ctrl+K

hipscat.loaders.read_from_hipscat

hipscat.loaders.read_from_hipscat#

Module Contents#

Functions#

read_from_hipscat(→ hipscat.catalog.Dataset)

Reads a HiPSCat Catalog from a HiPSCat directory

_read_dataset_class_from_metadata(...)

_get_loader_from_catalog_type(...)

Attributes#

CATALOG_TYPE_TO_CLASS

CATALOG_TYPE_TO_CLASS[source]#
read_from_hipscat(catalog_path: str, catalog_type: hipscat.catalog.CatalogType | None = None, storage_options: dict | None = None) → hipscat.catalog.Dataset[source]#

Reads a HiPSCat Catalog from a HiPSCat directory

Parameters:

  • catalog_path (str) – path to the root directory of the catalog

  • catalog_type (CatalogType) – Default None. By default, the type of the catalog is loaded from the catalog info and the corresponding object type is returned. Python’s type hints cannot allow a return type specified by a loaded value, so to use the correct return type for type checking, the type of the catalog can be specified here. Use by specifying the hipscat class for that catalog.

  • storage_options (dict) – dictionary that contains abstract filesystem credentials

Returns:

The initialized catalog object

_read_dataset_class_from_metadata(catalog_base_path: str, storage_options: dict | None = None) → hipscat.catalog.CatalogType[source]#
_get_loader_from_catalog_type(catalog_type: hipscat.catalog.CatalogType) → Type[hipscat.catalog.Dataset][source]#
Contents