flint.prefect.common.ms
=======================

.. py:module:: flint.prefect.common.ms

.. autoapi-nested-parse::

   Common prefect tasks around interacting with measurement sets



Attributes
----------

.. autoapisummary::

   flint.prefect.common.ms.P
   flint.prefect.common.ms.R
   flint.prefect.common.ms.task_add_model_source_list_to_ms
   flint.prefect.common.ms.task_subtract_model_from_ms


Functions
---------

.. autoapisummary::

   flint.prefect.common.ms.add_model_source_list_to_ms
   flint.prefect.common.ms.task_jolly_roger_tractor
   flint.prefect.common.ms.task_update_ms_tracked_column


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

.. py:function:: add_model_source_list_to_ms(wsclean_command: flint.imager.wsclean.WSCleanResult, calibrate_container: pathlib.Path | None = None) -> flint.imager.wsclean.WSCleanResult

.. py:function:: task_jolly_roger_tractor(ms: flint.options.MS, update_tukey_tractor_options: dict[str, Any] | None = None) -> flint.options.MS

   Run the jolly-rogar tukey tractor operation

   :param ms: The MS to modified. The `column` attribute will be used and modified inplace.
   :type ms: MS
   :param update_tukey_tractor_options: Any additional options to provide the tukey tractor. Column related options are updated based on input `ms.column` attribute. Defaults to None.
   :type update_tukey_tractor_options: dict[str, Any] | None, optional

   :returns: Reference to modified measurement set
   :rtype: MS


.. py:function:: task_update_ms_tracked_column(ms: flint.options.MS, column_name: str) -> flint.options.MS

   Update the tracked column name in an MS

   :param ms: The MS whose tracked column will be updated
   :type ms: MS
   :param column_name: The new column name to be updated
   :type column_name: str

   :returns: The updated MS with new tracked column name
   :rtype: MS


.. py:data:: P

.. py:data:: R

.. py:data:: task_add_model_source_list_to_ms
   :type:  prefect.Task[P, R]
   :value: None


.. py:data:: task_subtract_model_from_ms
   :value: None