hats.pixel_tree.moc_filter
==========================

.. py:module:: hats.pixel_tree.moc_filter


Functions
---------

.. autoapisummary::

   hats.pixel_tree.moc_filter.filter_by_moc
   hats.pixel_tree.moc_filter.perform_filter_by_moc


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

.. py:function:: filter_by_moc(tree: hats.pixel_tree.pixel_tree.PixelTree, moc: mocpy.MOC) -> hats.pixel_tree.pixel_tree.PixelTree

   
   Filters a pixel tree to only include the pixels that overlap with the pixels in the moc


   :Parameters:

       **tree: PixelTree**
           The tree to perform the filtering on

       **moc: MOC**
           The moc to use to filter



   :Returns:

       PixelTree
           A new PixelTree object with only the pixels from the input tree that overlap with the moc.











   ..
       !! processed by numpydoc !!

.. py:function:: perform_filter_by_moc(tree: numpy.ndarray, moc: numpy.ndarray) -> numpy.ndarray

   
   Performs filtering with lists of pixel intervals

   Input interval lists must be at the same order.

   :Parameters:

       **tree: np.ndarray**
           Array of pixel intervals to be filtered

       **moc: np.ndarray**
           Array of pixel intervals to be used to filter



   :Returns:

       ndarray
           A boolean array of dimension tree.shape[0] which masks which pixels in tree
           overlap with the pixels in moc











   ..
       !! processed by numpydoc !!