lsdb.core.search.cone_search

Classes

ConeSearch

Perform a cone search to filter the catalog

Functions

cone_filter(data_frame, ra, dec, radius_arcsec, metadata)

Filters a dataframe to only include points within the specified cone

Module Contents

class ConeSearch(ra: float, dec: float, radius_arcsec: float, fine: bool = True)

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.

ra

dec

radius_arcsec

filter_hc_catalog(hc_structure: lsdb.types.HCCatalogTypeVar) → mocpy.MOC

Filters catalog pixels according to the cone

search_points(frame: nested_pandas.NestedFrame, metadata: hats.catalog.TableProperties) → nested_pandas.NestedFrame

Determine the search results within a data frame

_perform_plot(ax: astropy.visualization.wcsaxes.WCSAxes, **kwargs)

Perform the plot of the search region on an initialized WCSAxes

cone_filter(data_frame: nested_pandas.NestedFrame, ra, dec, radius_arcsec, metadata: hats.catalog.TableProperties)

Filters a dataframe to only include points within the specified cone

Parameters:

• data_frame (npd.NestedFrame) – DataFrame containing points in the sky

• ra (float) – Right Ascension of the center of the cone in degrees

• dec (float) – Declination of the center of the cone in degrees

• radius_arcsec (float) – Radius of the cone in arcseconds

• metadata (hc.TableProperties) – hats TableProperties with metadata that matches data_frame

Returns:

A new DataFrame with the rows from data_frame filtered to only the points inside the cone