lsdb.loaders.hats.hats_loading_config

Contents

lsdb.loaders.hats.hats_loading_config#

Classes#

HatsLoadingConfig

Configuration for loading a HATS catalog in lsdb.

Module Contents#

class HatsLoadingConfig[source]#

Configuration for loading a HATS catalog in lsdb.

Contains all parameters needed for a user to specify how to correctly read a hats-sharded catalog.

search_filter: lsdb.core.search.abstract_search.AbstractSearch | None = None[source]#: The spatial filter to apply to the catalog

columns: list[str] | None = None[source]#: Columns to load from the catalog. If not specified, all columns are loaded

margin_cache: str | pathlib.Path | upath.UPath | None = None[source]#: Path to the margin cache catalog. Defaults to None.

kwargs: dict[source]#: Extra kwargs for the pandas parquet file reader

__post_init__()[source]#

make_query_url_params() → dict[source]#: Generates a dictionary of URL parameters with columns and filters attributes.

get_read_kwargs()[source]#: Clumps existing kwargs and dtype_backend, if specified.