orca.wrapper.wsclean
====================

.. py:module:: orca.wrapper.wsclean

.. autoapi-nested-parse::

   WSClean imaging wrapper.

   Provides Python interface to WSClean for radio interferometric imaging.
   Handles common output conventions and error handling.



Attributes
----------

.. autoapisummary::

   orca.wrapper.wsclean.log
   orca.wrapper.wsclean.NEW_ENV


Functions
---------

.. autoapisummary::

   orca.wrapper.wsclean.wsclean


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

.. py:data:: log

.. py:data:: NEW_ENV

.. py:function:: wsclean(ms_list: List[str], out_dir: str, filename_prefix: str, extra_arg_list: List[str], num_threads: int = 1, mem_gb: int = 50) -> None

   Run wsclean with arguments and put output fits files in out_dir.
   wsclean will writes the following files (depending on the options):

   Dirty image: {out_dir}/{filename_prefix}-dirty.fits

   Cleaned image (dirty if -niter 0): {out_dir}/{filename_prefix}-image.fits

   PSF (if -make-psf or cleaning enabled): {out_dir}/{filename_prefix}-psf.fits

   Residual image (if cleaning enabled): {out_dir}/{filename_prefix}-residual.fits

   :param ms_list: List of input measurement sets.
   :param out_dir: Output directory.
   :param filename_prefix: Prefix for output fits files.
   :param extra_arg_list: List of arguments to supply to wsclean in addition to the ones about file names.

   Returns: None. But you can reconstruct the fits file names with the wsclean conventions.