hats
====

.. py:module:: hats

.. autoapi-nested-parse::

   
   High-level namespace, hats
















   ..
       !! processed by numpydoc !!


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/hats/catalog/index
   /autoapi/hats/inspection/index
   /autoapi/hats/io/index
   /autoapi/hats/loaders/index
   /autoapi/hats/pixel_math/index
   /autoapi/hats/pixel_tree/index
   /autoapi/hats/search/index
   /autoapi/hats/testing/index


Classes
-------

.. autoapisummary::

   hats.HealpixPixel


Functions
---------

.. autoapisummary::

   hats.show_versions


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

.. py:function:: show_versions()

   
   Print runtime versions and system info, useful for bug reports.
















   ..
       !! processed by numpydoc !!

.. py:class:: HealpixPixel

   
   A HEALPix pixel, represented by an order and pixel number in NESTED ordering scheme

   see https://lambda.gsfc.nasa.gov/toolbox/pixelcoords.html for more information















   ..
       !! processed by numpydoc !!

   .. py:attribute:: order
      :type:  int

      
      HEALPix order
















      ..
          !! processed by numpydoc !!


   .. py:attribute:: pixel
      :type:  int

      
      HEALPix pixel number in NESTED ordering scheme
















      ..
          !! processed by numpydoc !!


   .. py:method:: __post_init__() -> None

      
      Initialize a HEALPix pixel
















      ..
          !! processed by numpydoc !!


   .. py:method:: __str__() -> str


   .. py:method:: __repr__()


   .. py:method:: __getitem__(key: int) -> int


   .. py:method:: convert_to_lower_order(delta_order: int) -> HealpixPixel

      
      Returns the HEALPix pixel that contains the pixel at a lower order


      :Parameters:

          **delta_order** : int
              the difference in order to be subtracted from the current order to generate
              the pixel at a lower order. Must be non-negative



      :Returns:

          HealpixPixel
              A new `HealpixPixel` at the current order - `delta_order` which contains the current
              pixel




      :Raises:

          ValueError
              If delta_order is greater than the current order, a pixel cannot be
              generated at a negative order. Or if delta_order is negative







      ..
          !! processed by numpydoc !!


   .. py:method:: convert_to_higher_order(delta_order: int) -> list[HealpixPixel]

      
      Returns a list of HEALPix pixels making up the current pixel at a higher order


      :Parameters:

          **delta_order** : int
              the difference in order to be added to the current order to generate the
              pixels at a higher order. Must be non-negative



      :Returns:

          list[HealpixPixel]
              A new `HealpixPixel` at the current order - `delta_order` which contains the current
              pixel




      :Raises:

          ValueError
              If delta_order + current order is greater than the maximum HEALPix order,
              pixels cannot be  generated. Or if delta_order is negative







      ..
          !! processed by numpydoc !!


   .. py:property:: dir
      :type: int


      
      Directory number for the pixel.

      This is necessary for file systems that limit to 10,000 subdirectories.
      The directory name will take the HiPS standard form of::

          <catalog_base_dir>/Norder=<pixel_order>/Dir=<directory number>

      Where the directory number is calculated using integer division as::

          (pixel_number/10000)*10000















      ..
          !! processed by numpydoc !!