arrakis.validate
================

.. py:module:: arrakis.validate

.. autoapi-nested-parse::

   Make validation plots from a catalogue

   ..
       !! processed by numpydoc !!


Classes
-------

.. autoapisummary::

   arrakis.validate.BinnedMap
   arrakis.validate.GriddedMap


Functions
---------

.. autoapisummary::

   arrakis.validate.cli
   arrakis.validate.cross_match
   arrakis.validate.filter_then_median
   arrakis.validate.main
   arrakis.validate.make_binned_map
   arrakis.validate.make_gridded_map
   arrakis.validate.plot_leakage
   arrakis.validate.plot_rm
   arrakis.validate.plot_rms_bkg
   arrakis.validate.validation_parser


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

.. py:class:: BinnedMap

   Bases: :py:obj:`NamedTuple`


   
   Binned catalogue data
















   ..
       !! processed by numpydoc !!

   .. py:attribute:: data
      :type:  numpy.ndarray

      
      Binned data
















      ..
          !! processed by numpydoc !!


   .. py:attribute:: wcs
      :type:  astropy.wcs.WCS

      
      WCS of the binned data
















      ..
          !! processed by numpydoc !!


   .. py:attribute:: xc
      :type:  numpy.ndarray

      
      X bin centres
















      ..
          !! processed by numpydoc !!


   .. py:attribute:: yc
      :type:  numpy.ndarray

      
      Y bin centres
















      ..
          !! processed by numpydoc !!


.. py:class:: GriddedMap

   Bases: :py:obj:`NamedTuple`


   
   Gridded catalogue data
















   ..
       !! processed by numpydoc !!

   .. py:attribute:: data
      :type:  numpy.ndarray

      
      Gridded data
















      ..
          !! processed by numpydoc !!


   .. py:attribute:: wcs
      :type:  astropy.wcs.WCS

      
      WCS of the gridded data
















      ..
          !! processed by numpydoc !!


.. py:function:: cli()

.. py:function:: cross_match(my_tab: astropy.table.Table, other_tab: astropy.table.Table, radius: astropy.units.Quantity = 1 * u.arcsec) -> astropy.table.Table

.. py:function:: filter_then_median(arr: arrakis.utils.typing.T) -> arrakis.utils.typing.T

.. py:function:: main(catalogue_path: pathlib.Path, npix: int = 512, map_size: float = 8, snr_cut: float = 50, bins: int = 11)

.. py:function:: make_binned_map(tab: astropy.table.Table, column: str, bins: int = 15, npix: int = 512, map_size: astropy.units.Quantity = 8 * u.deg) -> BinnedMap

.. py:function:: make_gridded_map(tab: astropy.table.Table, column: str, npix: int = 512, map_size: astropy.units.Quantity = 8 * u.deg) -> GriddedMap

.. py:function:: plot_leakage(tab: astropy.table.Table, snr_cut: float = 50, bins: int = 11, npix: int = 512, map_size: astropy.units.Quantity = 8 * u.deg) -> matplotlib.figure.Figure

.. py:function:: plot_rm(tab: astropy.table.Table, npix: int = 512, map_size: astropy.units.Quantity = 8 * u.deg) -> matplotlib.figure.Figure

.. py:function:: plot_rms_bkg(tab: astropy.table.Table, npix: int = 512, map_size: astropy.units.Quantity = 8 * u.deg) -> matplotlib.figure.Figure

.. py:function:: validation_parser(parent_parser: bool = False) -> argparse.ArgumentParser