lsdb.core.search

Submodules

• lsdb.core.search.abstract_search
• lsdb.core.search.box_search
• lsdb.core.search.cone_search
• lsdb.core.search.index_search
• lsdb.core.search.order_search
• lsdb.core.search.polygon_search

Package Contents

Classes

BoxSearch	Perform a box search to filter the catalog. This type of search is used for a
ConeSearch	Perform a cone search to filter the catalog
IndexSearch	Find rows by ids (or other value indexed by a catalog index).
OrderSearch	Filter the catalog by HEALPix order.
PolygonSearch	Perform a polygonal search to filter the catalog.

class BoxSearch(ra: Tuple[float, float] | None = None, dec: Tuple[float, float] | None = None)

Bases: lsdb.core.search.abstract_search.AbstractSearch

Perform a box search to filter the catalog. This type of search is used for a range of ra or dec (one or the other). If both, a polygonal search should be used.

Filters to points within the ra / dec region, specified in degrees. Filters partitions in the catalog to those that have some overlap with the region.

search_partitions(pixels: List[hipscat.pixel_math.HealpixPixel]) → List[hipscat.pixel_math.HealpixPixel]

Determine the target partitions for further filtering.

search_points(frame: pandas.DataFrame, metadata: hipscat.catalog.Catalog) → pandas.DataFrame

Determine the search results within a data frame

class ConeSearch(ra, dec, radius_arcsec)

Bases: lsdb.core.search.abstract_search.AbstractSearch

Perform a cone search to filter the catalog

Filters to points within radius great circle distance to the point specified by ra and dec in degrees. Filters partitions in the catalog to those that have some overlap with the cone.

search_partitions(pixels: List[hipscat.pixel_math.HealpixPixel]) → List[hipscat.pixel_math.HealpixPixel]

Determine the target partitions for further filtering.

search_points(frame: pandas.DataFrame, metadata: hipscat.catalog.Catalog) → pandas.DataFrame

Determine the search results within a data frame

class IndexSearch(ids, catalog_index: hipscat.catalog.index.index_catalog.IndexCatalog)

Bases: lsdb.core.search.abstract_search.AbstractSearch

Find rows by ids (or other value indexed by a catalog index).

Filters partitions in the catalog to those that could contain the ids requested. Filters to points that have matching values in the id field.

NB: This requires a previously-computed catalog index table.

search_partitions(_: List[hipscat.pixel_math.HealpixPixel]) → List[hipscat.pixel_math.HealpixPixel]

Determine the target partitions for further filtering.

search_points(frame: pandas.DataFrame, _) → pandas.DataFrame

Determine the search results within a data frame

class OrderSearch(min_order: int = 0, max_order: int | None = None)

Bases: lsdb.core.search.abstract_search.AbstractSearch

Filter the catalog by HEALPix order.

Filters partitions in the catalog to those that are in the orders specified. Does not filter points inside those partitions.

search_partitions(pixels: List[hipscat.pixel_math.HealpixPixel]) → List[hipscat.pixel_math.HealpixPixel]

Determine the target partitions for further filtering.

search_points(frame: pandas.DataFrame, _) → pandas.DataFrame

Determine the search results within a data frame.

class PolygonSearch(vertices: List[hipscat.pixel_math.polygon_filter.SphericalCoordinates])

Bases: lsdb.core.search.abstract_search.AbstractSearch

Perform a polygonal search to filter the catalog.

Filters to points within the polygonal region specified in ra and dec, in degrees. Filters partitions in the catalog to those that have some overlap with the region.

search_partitions(pixels: List[hipscat.pixel_math.HealpixPixel]) → List[hipscat.pixel_math.HealpixPixel]

Determine the target partitions for further filtering.

search_points(frame: pandas.DataFrame, metadata: hipscat.catalog.Catalog) → pandas.DataFrame

Determine the search results within a data frame