:py:mod:`aces.survey.survey_leakage`
====================================

.. py:module:: aces.survey.survey_leakage


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

Classes
~~~~~~~

.. autoapisummary::

   aces.survey.survey_leakage.StokesData




Attributes
~~~~~~~~~~

.. autoapisummary::

   aces.survey.survey_leakage.KEEP_COLUMNS


.. py:data:: KEEP_COLUMNS

   

.. py:class:: StokesData(catalogue_i, image_p, ra_key='ra', dec_key='dec', multiplier=1.0)

   Class to extract and hold Stokes Q, U, or V leakage data.

   .. py:method:: get_isolated(zone=0.0055)

      Get isolated sources. A clipped version of the original catalogue is made.

      Parameters
      ----------
      zone : float, optional
          Sources within `zone` of each other are excluded, in degrees. [Default 0.0055]
          


   .. py:method:: get_compact(ratio=(0.83, 1.2), int_flux='int_flux', peak_flux='peak_flux')

      Get compact sources. A clipped version of the catalogue is made.

      Parameters
      ----------
      ratio : tuple, float, optional
          Tuple of minimum and maximum flux density ratios. [Default (0.83, 1.2)]
      int_flux : str, optional    
          Column name for integrated/total flux density in Stokes I catalogue. [Default 'int_flux']
      peak_flux : str, optional
          Column name for peak flux in Stokes I catalogue. [Default 'peak_flux']


          


   .. py:method:: get_xycoords()

      Get sources coordinates in pixel x, y coordinates.


   .. py:method:: get_leakage(local_rms='local_rms', sigma=0, search_box=1, noise_box=20)

      Get leakage from polarization image.

      Parameters
      ----------
      local_rms : str, optional
          Column name for image rms. [Default 'local_rms']
      sigma : int, optional
          Minimum Stokes I SNR required. [Default 10]
      search_box : int, optional
          Look for peak Stokes Q/U/V in expanded box around Stokes I position. 
          [Default 1]
      noise_box : int, optional
          Use for noise calculations and reject sources <= `noise_box` of a NaN pixel, 
          likely image edge. [Default 20]



   .. py:method:: get_table_leakage(outname=None, remove_cols=True, prefix='', pol='v')

      Add leakage columns to a table, clip NaNs, writeout?

      Parameters
      ----------
      outname : str, optional
          Output filename. If supplied a .csv file is written. [Default None]
      remove_cols : bool, optional
          Remove all columns from the subject catalogue that do not belong to the KEEP_COLUMNs set. [Default True]
      prefic : str, optional
          If this prefix exists for the name of a column, it is ignored when deciding whether to remove columns. [Default ""]