hats.pixel_math.pixel_margins
=============================

.. py:module:: hats.pixel_math.pixel_margins

.. autoapi-nested-parse::

   Utilities for find the pixels of higher orders that surround a given healpixel.

   ..
       !! processed by numpydoc !!


Functions
---------

.. autoapisummary::

   hats.pixel_math.pixel_margins.get_margin


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

.. py:function:: get_margin(order, pixel, delta_order)

   
   Get all the pixels at order order+delta_order bordering pixel pixel.


   :Parameters:

       **order** : int
           the healpix order of pixel.

       **pixel** : int
           the healpix pixel to find margin pixels of.

       **delta_order** : int
           the change in order that we wish to find the margins for.



   :Returns:

       list[int]
           one-dimensional numpy array of integers, filled with the healpix pixels
           at order `order+delta_order` that border pixel.











   ..
       !! processed by numpydoc !!