orca.transform.peeling
======================

.. py:module:: orca.transform.peeling

.. autoapi-nested-parse::

   Peeling transforms for bright source subtraction.

   Provides functions for peeling (direction-dependent calibration and
   subtraction) of bright sources like Cygnus A, Cassiopeia A, and RFI
   sources from visibility data. Supports both TTCal-based and CASA-based
   peeling workflows including polarized (ZEST) peeling.



Attributes
----------

.. autoapisummary::

   orca.transform.peeling.log
   orca.transform.peeling.CORRECTED_DATA
   orca.transform.peeling.DATA


Functions
---------

.. autoapisummary::

   orca.transform.peeling.ttcal_peel_from_data_to_corrected_data
   orca.transform.peeling.zest_with_casa


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

.. py:data:: log

.. py:data:: CORRECTED_DATA
   :value: 'CORRECTED_DATA'


.. py:data:: DATA
   :value: 'DATA'


.. py:function:: ttcal_peel_from_data_to_corrected_data(ms: str, utc_time: datetime.datetime, include_rfi_source: bool = True) -> str

   Use TTCal to peel. Read from DATA column and write to CORRECTED_DATA
   If the CORRECTED_DATA column exists, it does not do anything.

   :param ms: Path to measurement set.
   :param utc_time: datetime object to figure out what sources are up.
   :param include_rfi_source: Include near-field generic RFI sources in peel.

   Returns: The output measurement set (which is the same thing as the input measurement set).



.. py:function:: zest_with_casa(ms: str, reverse: bool = False)

   Polarized peeling with CASA.
   Currently, peeling list will only include at most CasA & CygA.
   The peeled visibilities will be placed in CORRECTED_DATA.

   :param ms: The measurement set.
   :param reverse: Reverse the peeling process. Default is False.

   :returns: Path to measurement set that was modified.