hats.pixel_math.healpix_pixel_function
======================================

.. py:module:: hats.pixel_math.healpix_pixel_function


Functions
---------

.. autoapisummary::

   hats.pixel_math.healpix_pixel_function.get_pixel_argsort
   hats.pixel_math.healpix_pixel_function.sort_pixels
   hats.pixel_math.healpix_pixel_function.get_pixels_from_intervals


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

.. py:function:: get_pixel_argsort(pixels: list[hats.pixel_math.healpix_pixel.HealpixPixel])

   
   Perform an indirect sort of a list of HealpixPixels.

   This will order the pixels according to a breadth-first traversal of the healpix
   pixel hierarchy, not merely by increasing order by Norder/Npix (depth-first ordering).
   This is similar to ordering fully by _healpix_29.

   :Parameters:

       **pixels** : list[HealpixPixel]
           array to sort



   :Returns:

       list[int]
           array of indices that sort the pixels in breadth-first order.











   ..
       !! processed by numpydoc !!

.. py:function:: sort_pixels(pixels: list[hats.pixel_math.healpix_pixel.HealpixPixel])

   
   Perform an sort of a list of HealpixPixels.

   This will order the pixels according to a breadth-first traversal of the healpix
   pixel hierarchy, not merely by increasing order by Norder/Npix (depth-first ordering).
   This is similar to ordering fully by _healpix_29.

   :Parameters:

       **pixels** : list[HealpixPixel]
           array to sort



   :Returns:

       list[HealpixPixel]
           pixels sorted in breadth-first order











   ..
       !! processed by numpydoc !!

.. py:function:: get_pixels_from_intervals(intervals: numpy.ndarray, tree_order: int) -> numpy.ndarray

   
   Computes an array of HEALPix [order, pixel] for an array of intervals


   :Parameters:

       **intervals** : np.ndarray
           Array of intervals of the start and end pixel numbers of HEALPix pixels.
           Must be NESTED numbering scheme.

       **tree_order** : int
           The order of the pixel numbers in the interval array



   :Returns:

       np.ndarray
           An array of [order, pixel] in NESTED numbering scheme for each interval in the array.











   ..
       !! processed by numpydoc !!