rm_lite.tools_1d.rmclean
========================

.. py:module:: rm_lite.tools_1d.rmclean

.. autoapi-nested-parse::

   RM-CLEAN on 1D data



Attributes
----------

.. autoapisummary::

   rm_lite.tools_1d.rmclean.rmclean_arrs_schema
   rm_lite.tools_1d.rmclean.rmclean_arrs_schema_df
   rm_lite.tools_1d.rmclean.rmclean_scalar_schema
   rm_lite.tools_1d.rmclean.rmclean_scalar_schema_df


Classes
-------

.. autoapisummary::

   rm_lite.tools_1d.rmclean.RMClean1DResults


Functions
---------

.. autoapisummary::

   rm_lite.tools_1d.rmclean.run_rmclean_from_synth


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

.. py:class:: RMClean1DResults

   Bases: :py:obj:`NamedTuple`


   Resulting arrays from RM-synthesis


   .. py:attribute:: clean_parameters
      :type:  polars.DataFrame

      RMClean parameters


   .. py:attribute:: fdf_arrs
      :type:  polars.DataFrame

      RMClean arrays


   .. py:attribute:: fdf_parameters
      :type:  polars.DataFrame

      FDF parameters


.. py:function:: run_rmclean_from_synth(rm_synth_1d_results: rm_lite.tools_1d.rmsynth.RMSynth1DResults, auto_mask: float = 7, auto_threshold: float = 1, max_iter: int = 10000, gain: float = 0.1, mask_arr: numpy.typing.NDArray[numpy.bool_] | None = None) -> RMClean1DResults

   Run RM-CLEAN on the results of RM-synth.

   :param rm_synth_1d_results: Results from RM-synth.
   :type rm_synth_1d_results: RMSynth1DResults
   :param auto_mask: Masking threshold in SNR. Defaults to 7.
   :type auto_mask: float, optional
   :param auto_threshold: Cleaning threshold in SNR. Defaults to 1.
   :type auto_threshold: float, optional
   :param max_iter: Maximum CLEAN iterations. Defaults to 10_000.
   :type max_iter: int, optional
   :param gain: CLEAN gain. Defaults to 0.1.
   :type gain: float, optional
   :param mask_arr: Optional mask array. Defaults to None.
   :type mask_arr: NDArray[np.bool_] | None, optional

   :returns: RM-CLEAN results: `fdf_parameters`, `fdf_arrs`, `clean_parameters`.
   :rtype: RMClean1DResults


.. py:data:: rmclean_arrs_schema

.. py:data:: rmclean_arrs_schema_df

.. py:data:: rmclean_scalar_schema

.. py:data:: rmclean_scalar_schema_df