hats.catalog.catalog
====================

.. py:module:: hats.catalog.catalog

.. autoapi-nested-parse::

   Container class to hold catalog metadata and partition iteration

   ..
       !! processed by numpydoc !!


Classes
-------

.. autoapisummary::

   hats.catalog.catalog.Catalog


Module Contents
---------------

.. py:class:: Catalog(catalog_info: hats.catalog.dataset.table_properties.TableProperties, pixels: hats.catalog.partition_info.PartitionInfo | hats.pixel_tree.pixel_tree.PixelTree | list[hats.pixel_math.HealpixPixel], catalog_path: str | pathlib.Path | upath.UPath | None = None, moc: mocpy.MOC | None = None, schema: pyarrow.Schema | None = None, snapshot: hats.catalog.catalog_snapshot.CatalogSnapshot | None = None, generate_snapshot: bool = False)

   Bases: :py:obj:`hats.catalog.healpix_dataset.healpix_dataset.HealpixDataset`


   
   A HATS Catalog with data stored in a HEALPix Hive partitioned structure

   Catalogs of this type are partitioned spatially, contain `partition_info` metadata specifying
   the pixels in Catalog, and on disk conform to the parquet partitioning structure
   `Norder=/Dir=/Npix=.parquet`















   ..
       !! processed by numpydoc !!

   .. py:method:: generate_negative_tree_pixels() -> list[hats.pixel_math.HealpixPixel]

      
      Get the leaf nodes at each healpix order that have zero catalog data.

      For example, if an example catalog only had data points in pixel 0 at
      order 0, then this method would return order 0's pixels 1 through 11.
      Used for getting full coverage on margin caches.




      :Returns:

          list[HealpixPixel]
              List of HealpixPixels representing the 'negative tree' for the catalog.











      ..
          !! processed by numpydoc !!