arrakis.merge_fields
====================

.. py:module:: arrakis.merge_fields

.. autoapi-nested-parse::

   Merge multiple RACS fields

   ..
       !! processed by numpydoc !!


Functions
---------

.. autoapisummary::

   arrakis.merge_fields.cli
   arrakis.merge_fields.copy_singleton
   arrakis.merge_fields.copy_singletons
   arrakis.merge_fields.genparset
   arrakis.merge_fields.main
   arrakis.merge_fields.make_short_name
   arrakis.merge_fields.merge_multiple_field
   arrakis.merge_fields.merge_multiple_fields
   arrakis.merge_fields.merge_parser


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

.. py:function:: cli()

   
   Command-line interface
















   ..
       !! processed by numpydoc !!

.. py:function:: copy_singleton(beam: dict, field_dict: dict[str, str], merge_name: str, data_dir: str) -> list[pymongo.UpdateOne]

   
   Copy an island within a single field to the merged field

   :Parameters: * **beam** (*dict*) -- Beam document
                * **field_dict** (*Dict[str, str]*) -- Field dictionary
                * **merge_name** (*str*) -- Merged field name
                * **data_dir** (*str*) -- Output directory

   :raises KeyError: If ion files not found

   :returns: Database updates
   :rtype: List[pymongo.UpdateOne]















   ..
       !! processed by numpydoc !!

.. py:function:: copy_singletons(field_dict: dict[str, str], data_dir: str, beams_col: pymongo.collection.Collection, merge_name: str) -> list[pymongo.UpdateOne]

   
   Copy islands that don't overlap other fields

   :Parameters: * **field_dict** (*Dict[str, str]*) -- Field dictionary
                * **data_dir** (*str*) -- Data directory
                * **beams_col** (*pymongo.collection.Collection*) -- Beams collection
                * **merge_name** (*str*) -- Merged field name

   :returns: Database updates
   :rtype: List[pymongo.UpdateOne]















   ..
       !! processed by numpydoc !!

.. py:function:: genparset(old_ims: list, stokes: str, new_dir: str) -> str

.. py:function:: main(fields: list[str], field_dirs: list[str], merge_name: str, output_dir: str, host: str, epoch: int, username: str | None = None, password: str | None = None, yanda='1.3.0') -> str

.. py:function:: make_short_name(name: str) -> str

.. py:function:: merge_multiple_field(beam: dict, field_dict: dict, merge_name: str, data_dir: str, image: str) -> list[pymongo.UpdateOne]

   
   Merge an island that overlaps multiple fields

   :Parameters: * **beam** (*dict*) -- Beam document
                * **field_dict** (*dict*) -- Field dictionary
                * **merge_name** (*str*) -- Merged field name
                * **data_dir** (*str*) -- Data directory
                * **image** (*str*) -- Yandasoft image

   :raises KeyError: If ion files not found

   :returns: Database updates
   :rtype: List[pymongo.UpdateOne]















   ..
       !! processed by numpydoc !!

.. py:function:: merge_multiple_fields(field_dict: dict[str, str], data_dir: str, beams_col: pymongo.collection.Collection, merge_name: str, image: str) -> list[pymongo.UpdateOne]

   
   Merge multiple islands that overlap multiple fields

   :Parameters: * **field_dict** (*Dict[str, str]*) -- Field dictionary
                * **data_dir** (*str*) -- Data directory
                * **beams_col** (*pymongo.collection.Collection*) -- Beams collection
                * **merge_name** (*str*) -- Merged field name
                * **image** (*str*) -- Yandasoft image

   :returns: Database updates
   :rtype: List[pymongo.UpdateOne]















   ..
       !! processed by numpydoc !!

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