lsdb.catalog.margin_catalog
#
Module Contents#
Classes#
LSDB Catalog DataFrame to contain the "margin" of another HiPSCat catalog. |
- class MarginCatalog(ddf: dask.dataframe.core.DataFrame, ddf_pixel_map: lsdb.types.DaskDFPixelMap, hc_structure: hipscat.catalog.MarginCatalog)[source]#
Bases:
lsdb.catalog.dataset.healpix_dataset.HealpixDataset
LSDB Catalog DataFrame to contain the “margin” of another HiPSCat catalog. spatial operations.
- hc_structure[source]#
hipscat.MarginCatalog object representing the structure and metadata of the HiPSCat catalog
- hc_structure: hipscat.catalog.MarginCatalog[source]#
- _search(metadata: hipscat.catalog.Catalog, search: lsdb.core.search.abstract_search.AbstractSearch, fine: bool = True)[source]#
Find rows by reusable search algorithm.
Filters partitions in the catalog to those that match some rough criteria and their neighbors. Filters to points that match some finer criteria.
- Parameters:
search (AbstractSearch) – Instance of AbstractSearch.
fine (bool) – True if points are to be filtered, False if not. Defaults to True.
- Returns:
A new Catalog containing the points filtered to those matching the search parameters.