sdhdf.flagging
==============

.. py:module:: sdhdf.flagging

.. autoapi-nested-parse::

   SDHDF flagging utilities



Exceptions
----------

.. autoapisummary::

   sdhdf.flagging.AutoFlagError


Functions
---------

.. autoapisummary::

   sdhdf.flagging.box_filter
   sdhdf.flagging.get_persistent_rfi


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

.. py:exception:: AutoFlagError(msg)

   Bases: :py:obj:`Exception`


   Common base class for all non-exit exceptions.


   .. py:attribute:: msg


.. py:function:: box_filter(spectrum: numpy.ndarray | xarray.DataArray, sigma=3, n_windows=100)

   Filter a spectrum using a box filter.


.. py:function:: get_persistent_rfi(telescope: str = 'Parkes') -> pandas.DataFrame

   Read persistent RFI file
   Returns:
       pd.Dataframe: Persistent RFI data.