lsdb.core.search.abstract_search#
Classes#
Abstract class used to write a reusable search query. |
Module Contents#
- class AbstractSearch(fine: bool = True)[source]#
Bases:
abc.ABCAbstract class used to write a reusable search query.
- These consist of two parts:
partition search - a (usually) coarse method of restricting the search space to just the partitions(/pixels) of interest
point search - a (usally) finer grained method to find individual rows matching the query terms.
- abstract filter_hc_catalog(hc_structure: lsdb.types.HCCatalogTypeVar) lsdb.types.HCCatalogTypeVar[source]#
Determine the target partitions for further filtering.
- abstract search_points(frame: nested_pandas.NestedFrame, metadata: hats.catalog.TableProperties) nested_pandas.NestedFrame[source]#
Determine the search results within a data frame
- plot(projection: str = 'MOL', title: str = '', fov: astropy.units.Quantity | tuple[astropy.units.Quantity, astropy.units.Quantity] | None = None, center: astropy.coordinates.SkyCoord | None = None, wcs: astropy.wcs.WCS | None = None, frame_class: Type[astropy.visualization.wcsaxes.frame.BaseFrame] | None = None, ax: astropy.visualization.wcsaxes.WCSAxes | None = None, fig: matplotlib.figure.Figure | None = None, **kwargs)[source]#
Plot the search region
- Parameters:
projection (str) – The projection to use in the WCS. Available projections listed at https://docs.astropy.org/en/stable/wcs/supported_projections.html
title (str) – The title of the plot
fov (Quantity or Sequence[Quantity, Quantity] | None) – The Field of View of the WCS. Must be an astropy Quantity with an angular unit, or a tuple of quantities for different longitude and latitude FOVs (Default covers the full sky)
center (SkyCoord | None) – The center of the projection in the WCS (Default: SkyCoord(0, 0))
wcs (WCS | None) – The WCS to specify the projection of the plot. If used, all other WCS parameters are ignored and the parameters from the WCS object is used.
frame_class (Type[BaseFrame] | None) – The class of the frame for the WCSAxes to be initialized with. if the ax kwarg is used, this value is ignored (By Default uses EllipticalFrame for full sky projection. If FOV is set, RectangularFrame is used)
ax (WCSAxes | None) – The matplotlib axes to plot onto. If None, an axes will be created to be used. If specified, the axes must be an astropy WCSAxes, and the wcs parameter must be set with the WCS object used in the axes. (Default: None)
fig (Figure | None) – The matplotlib figure to add the axes to. If None, one will be created, unless ax is specified (Default: None)
**kwargs – Additional kwargs to pass to creating the matplotlib patch object for the search region
- Returns:
Tuple[Figure, WCSAxes] - The figure and axes used for the plot