hats.inspection
===============

.. py:module:: hats.inspection


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/hats/inspection/visualize_catalog/index


Functions
---------

.. autoapisummary::

   hats.inspection.plot_density
   hats.inspection.plot_pixel_list
   hats.inspection.plot_pixels


Package Contents
----------------

.. py:function:: plot_density(catalog: hats.catalog.Catalog, *, plot_title: str | None = None, order=None, unit=None, **kwargs)

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


   :Parameters:

       **catalog: Catalog**
           on-disk catalog object

       **plot_title** : str | None
           Optional title for the plot

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

       **unit** : astropy.units.Unit
           Unit to show for the angle for angular density. (Default value = None)

       **\*\*kwargs**
           Additional args to pass to `plot_healpix_map`







   :Raises:

       ImportError
           if matplotlib is not installed in the current environment.

       ValueError
           if an in-memory-only catalog is provided.







   ..
       !! processed by numpydoc !!

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

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


   :Parameters:

       **pixels** : list[HealpixPixel]
           healpix pixels (order and pixel number) to visualize

       **plot_title** : str
           (Default value = "") heading for the plot

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

       **color_by_order** : bool
           Whether to color the pixels by their order. True by default.

       **\*\*kwargs**
           Additional args to pass to `plot_healpix_map`







   :Raises:

       ImportError
           if matplotlib is not installed in the current environment.







   ..
       !! processed by numpydoc !!

.. py:function:: plot_pixels(catalog: hats.catalog.healpix_dataset.healpix_dataset.HealpixDataset, plot_title: str | None = None, **kwargs)

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


   :Parameters:

       **plot_title** : str | 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`














   ..
       !! processed by numpydoc !!