flint.casa
==========

.. py:module:: flint.casa

.. autoapi-nested-parse::

   Utilities related to using casa tasks



Functions
---------

.. autoapisummary::

   flint.casa.applycal
   flint.casa.args_to_casa_task_string
   flint.casa.copy_with_mstranform
   flint.casa.cvel
   flint.casa.gaincal
   flint.casa.mstransform


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

.. py:function:: applycal(**kwargs) -> str

   Generate the CASA applycal command

   :returns: The command to execute
   :rtype: str


.. py:function:: args_to_casa_task_string(task: str, **kwargs) -> str

   Given a set of arguments, convert them to a string that can
   be used to run the corresponding CASA task that can be passed
   via ``casa -c`` for execution

   :param task: The name of the task that will be executed
   :type task: str

   :returns: The formatted string that will be given to CASA for execution
   :rtype: str


.. py:function:: copy_with_mstranform(casa_container: pathlib.Path, ms_path: pathlib.Path) -> pathlib.Path

   Use the casa task mstransform to create `nspw` spectral windows
   in the input measurement set. This is necessary when attempting to
   use gaincal to solve for some frequency-dependent solution.

   :param casa_container: Path to the singularity container with CASA tooling
   :type casa_container: Path
   :param ms_path: The measurement set that should be reformed to have `nspw` spectral windows
   :type ms_path: Path

   :returns: The path to the measurement set that was updated
   :rtype: Path


.. py:function:: cvel(**kwargs) -> str

   Generate the CASA cvel command

   :returns: The command to execute
   :rtype: str


.. py:function:: gaincal(**kwargs) -> str

   Generate the CASA gaincal command

   :returns: The command to execute
   :rtype: str


.. py:function:: mstransform(**kwargs) -> str

   Construct and run CASA's ``mstransform`` task.

   :param casa_container: Container with the CASA tooling
   :type casa_container: Path
   :param ms: Path to the measurement set to transform
   :type ms: str
   :param output_ms: Path of the output measurement set produced by the transform
   :type output_ms: str

   :returns: The ``mstransform`` string
   :rtype: str