arrakis.rmclean_oncuts
======================

.. py:module:: arrakis.rmclean_oncuts

.. autoapi-nested-parse::

   Run RM-synthesis on cutouts in parallel

   ..
       !! processed by numpydoc !!


Attributes
----------

.. autoapisummary::

   arrakis.rmclean_oncuts.TQDM_OUT


Functions
---------

.. autoapisummary::

   arrakis.rmclean_oncuts.clean_parser
   arrakis.rmclean_oncuts.cli
   arrakis.rmclean_oncuts.main
   arrakis.rmclean_oncuts.rmclean1d
   arrakis.rmclean_oncuts.rmclean3d


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

.. py:function:: clean_parser(parent_parser: bool = False) -> argparse.ArgumentParser

.. py:function:: cli()

   
   Command-line interface
















   ..
       !! processed by numpydoc !!

.. py:function:: main(field: str, outdir: pathlib.Path, host: str, epoch: int, sbid: int | None = None, username: str | None = None, password: str | None = None, dimension='1d', database=False, savePlots=True, limit: int | None = None, cutoff: float = -3, maxIter=10000, gain=0.1, window=None, rm_verbose=False)

   
   Run RM-CLEAN on cutouts flow

   :Parameters: * **field** (*str*) -- RACS field name.
                * **outdir** (*Path*) -- Output directory.
                * **host** (*str*) -- MongoDB host IP.
                * **username** (*str, optional*) -- Mongo username. Defaults to None.
                * **password** (*str, optional*) -- Mongo password. Defaults to None.
                * **dimension** (*str, optional*) -- Which dimension to run RM-CLEAN. Defaults to "1d".
                * **database** (*bool, optional*) -- Update database. Defaults to False.
                * **savePlots** (*bool, optional*) -- Save plots. Defaults to True.
                * **validate** (*bool, optional*) -- Run validation. Defaults to False.
                * **limit** (*int, optional*) -- Limit number of sources processed. Defaults to None.
                * **cutoff** (*float, optional*) -- CLEAN cutoff (in sigma). Defaults to -3.
                * **maxIter** (*int, optional*) -- Max CLEAN iterations. Defaults to 10000.
                * **gain** (*float, optional*) -- Clean gain. Defaults to 0.1.
                * **rm_verbose** (*bool, optional*) -- Verbose output from RM-CLEAN. Defaults to False.















   ..
       !! processed by numpydoc !!

.. py:function:: rmclean1d(field: str, comp: dict, outdir: pathlib.Path, cutoff: float = -3, maxIter=10000, gain=0.1, sbid: int | None = None, savePlots=False, rm_verbose=True, window=None) -> pymongo.UpdateOne

   
   1D RM-CLEAN

   :Parameters: * **field** (*str*) -- RACS field name.
                * **comp** (*dict*) -- Mongo entry for component.
                * **outdir** (*str*) -- Output directory.
                * **cutoff** (*float, optional*) -- CLEAN cutouff (in sigma). Defaults to -3.
                * **maxIter** (*int, optional*) -- Maximum CLEAN iteration. Defaults to 10000.
                * **gain** (*float, optional*) -- CLEAN gain. Defaults to 0.1.
                * **savePlots** (*bool, optional*) -- Save CLEAN plots. Defaults to False.
                * **rm_verbose** (*bool, optional*) -- Verbose RM-CLEAN. Defaults to True.

   :returns: MongoDB update query.
   :rtype: pymongo.UpdateOne















   ..
       !! processed by numpydoc !!

.. py:function:: rmclean3d(field: str, island: dict, outdir: pathlib.Path, sbid: int | None = None, cutoff: float = -3, maxIter=10000, gain=0.1, rm_verbose=False) -> pymongo.UpdateOne

   
   Run RM-CLEAN on 3D cube

   :Parameters: * **island** (*dict*) -- MongoDB island entry.
                * **outdir** (*Path*) -- Output directory.
                * **cutoff** (*float, optional*) -- CLEAN cutoff (in sigma). Defaults to -3.
                * **maxIter** (*int, optional*) -- Max CLEAN iterations. Defaults to 10000.
                * **gain** (*float, optional*) -- CLEAN gain. Defaults to 0.1.
                * **rm_verbose** (*bool, optional*) -- Verbose output. Defaults to False.

   :returns: MongoDB update query.
   :rtype: pymongo.UpdateOne















   ..
       !! processed by numpydoc !!

.. py:data:: TQDM_OUT