hats.catalog.index.index_catalog
================================

.. py:module:: hats.catalog.index.index_catalog


Classes
-------

.. autoapisummary::

   hats.catalog.index.index_catalog.IndexCatalog


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

.. py:class:: IndexCatalog(catalog_info: hats.catalog.dataset.table_properties.TableProperties, catalog_path: str | pathlib.Path | upath.UPath | None = None, schema: pyarrow.Schema | None = None, snapshot: hats.catalog.catalog_snapshot.CatalogSnapshot | None = None, generate_snapshot: bool = False)

   Bases: :py:obj:`hats.catalog.dataset.Dataset`


   
   An index into HATS Catalog for enabling fast lookups on non-spatial values.

   Note that this is not a true "HATS Catalog", as it is not partitioned spatially.















   ..
       !! processed by numpydoc !!

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

      
      Find the set of partitions in the primary catalog for the ids provided.


      :Parameters:

          **ids**
              primary catalog for the ids



      :Returns:

          list[HealpixPixel]
              partitions of leaf parquet files in the primary catalog
              that may contain rows for the id values











      ..
          !! processed by numpydoc !!