hats.inspection

hats.inspection#

Submodules#

Functions#

plot_density(catalog, *[, plot_title, order, unit])

Create a visual map of the density of input points of a catalog on-disk.

plot_pixel_list(pixels[, plot_title, projection, ...])

Create a visual map of the pixel density of a list of pixels.

plot_pixels(catalog[, plot_title])

Create a visual map of the pixel density of the catalog.

Package Contents#

plot_density(catalog: hats.catalog.Catalog, *, plot_title: str | None = None, order=None, unit=None, **kwargs)[source]#

Create a visual map of the density of input points of a catalog on-disk.

Parameters:
catalog: Catalog

on-disk catalog object

plot_titlestr | None

Optional title for the plot

orderint

Optionally reduce the display healpix order, and aggregate smaller tiles. (Default value = None)

unitastropy.units.Unit

Unit to show for the angle for angular density. (Default value = None)

**kwargs

Additional args to pass to plot_healpix_map

plot_pixel_list(pixels: list[hats.pixel_math.HealpixPixel], plot_title: str = '', projection='MOL', color_by_order=True, **kwargs)[source]#

Create a visual map of the pixel density of a list of pixels.

Parameters:
pixelslist[HealpixPixel]

healpix pixels (order and pixel number) to visualize

plot_titlestr

(Default value = “”) heading for the plot

projectionstr

The projection to use. Available projections listed at https://docs.astropy.org/en/stable/wcs/supported_projections.html (Default value = “MOL”)

color_by_orderbool

Whether to color the pixels by their order. True by default.

**kwargs

Additional args to pass to plot_healpix_map

plot_pixels(catalog: hats.catalog.healpix_dataset.healpix_dataset.HealpixDataset, plot_title: str | None = None, **kwargs)[source]#

Create a visual map of the pixel density of the catalog.

Parameters:
plot_titlestr | None

Optional title for the plot

catalog: HealpixDataset

on-disk or in-memory catalog, with healpix pixels.

**kwargs

Additional args to pass to plot_healpix_map

Contents