flint.prefect.common.predict
============================

.. py:module:: flint.prefect.common.predict

.. autoapi-nested-parse::

   Prefect tasks around model visibility prediction



Functions
---------

.. autoapisummary::

   flint.prefect.common.predict.task_addmodel_to_ms
   flint.prefect.common.predict.task_crystalball_to_ms


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

.. py:function:: task_addmodel_to_ms(ms: flint.ms.MS, addmodel_subtract_options: flint.options.AddModelSubtractFieldOptions) -> flint.ms.MS

.. py:function:: task_crystalball_to_ms(ms: flint.ms.MS, crystalball_options: flint.predict.crystalball.CrystalBallOptions) -> flint.ms.MS

   Predict model visibilities into a measurement set using a previously constructed
   blackboard sky model. See ``wsclean -save-source-list`. This used the ``crystalball``
   python package, which under the hood taps into the same dask task runner running
   this flow.

   Visibilities are predicted into the MS's ``MODEL_DATA`` column.

   :param ms: The measurement set where model visibilities will be predicted into.
   :type ms: MS
   :param crystalball_options: Options around the crystal ball operation
   :type crystalball_options: CrystalBallOptions

   :returns: An updated MS with the model column set
   :rtype: MS