orca.transform.averagems
========================

.. py:module:: orca.transform.averagems

.. autoapi-nested-parse::

   Average measurement sets.



Attributes
----------

.. autoapisummary::

   orca.transform.averagems.log


Functions
---------

.. autoapisummary::

   orca.transform.averagems.average_ms
   orca.transform.averagems.average_frequency


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

.. py:data:: log

.. py:function:: average_ms(ms_list: List[str], ref_ms_index: int, out_ms: str, column: str, tolerate_ms_io_error: bool = False) -> str

   Average the list of measurement sets' select column.

   :param ms_list: the list of the measurement set.
   :param ref_ms_index: the index of the measurement set in ``ms_list`` to create the averaged measurement set from.
   :param out_ms: output measurement set path.
   :param column: Name of the column.
   :param tolerate_ms_io_error: Skip a measurement set if an exception was raised while trying to access it.

   Returns: Path to the averaged measurement set.



.. py:function:: average_frequency(vis: str, output_vis: str, chanbin: int = 4) -> str

   Perform frequency averaging on the given measurement set (MS).

   :param vis: Path to the input MS file.
   :type vis: str
   :param output_vis: Path to the output averaged MS file.
   :type output_vis: str
   :param chanbin: Number of channels to average.
   :type chanbin: int

   :returns: Path to the averaged MS file.
   :rtype: str