flint.peel.jolly
================

.. py:module:: flint.peel.jolly

.. autoapi-nested-parse::

   Utilities to run the holly-roger sun flagging utilities



Classes
-------

.. autoapisummary::

   flint.peel.jolly.TukeyTractorOptions


Functions
---------

.. autoapisummary::

   flint.peel.jolly._create_jolly_tractor_options
   flint.peel.jolly.cli
   flint.peel.jolly.get_parser
   flint.peel.jolly.jolly_roger_tractor


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

.. py:class:: TukeyTractorOptions(/, **data: Any)

   Bases: :py:obj:`flint.options.BaseOptions`


   Container for the Jolly-Roger tractor operations. These
   options map into the jolly_roger.tractor.TukeyTaperOptions
   class. Exception being that this container omits the usage
   of astropy quantities.


   .. py:attribute:: apply_towards_object
      :type:  bool
      :value: True


      apply the taper using the delay towards the target object. Otherwise delays away from zero are nulled with potential for significant smearing effects.


   .. py:attribute:: chunk_size
      :type:  int
      :value: 1000


      Size of the row-wise chunking iterator


   .. py:attribute:: copy_column_data
      :type:  bool
      :value: False


      Copy the data from the data column to the output column before applying the taper


   .. py:attribute:: data_column
      :type:  str
      :value: 'DATA'


      The visibility column to modify


   .. py:attribute:: dry_run
      :type:  bool
      :value: False


      Indicates whether the data will be written back to the measurement set


   .. py:attribute:: elevation_cut_deg
      :type:  float
      :value: -1


      The elevation cut-off for the target object, in degrees. Defaults to -1.


   .. py:attribute:: ignore_nyquist_zone
      :type:  int
      :value: 2


      Do not apply the tukey taper if object is beyond this Nyquist zone


   .. py:attribute:: make_plots
      :type:  bool
      :value: False


      Create a small set of diagnostic plots. This can be slow.


   .. py:attribute:: outer_width
      :type:  float

      The start of the tapering in frequency space, in radians


   .. py:attribute:: output_column
      :type:  str
      :value: 'CORRECTED_DATA'


      The output column to be created with the modified data


   .. py:attribute:: overwrite
      :type:  bool
      :value: False


      If the output column exists it will be overwritten


   .. py:attribute:: target_object
      :type:  str
      :value: 'Sun'


      The target object to apply the delay towards.


   .. py:attribute:: tukey_width
      :type:  float

      The width of the tapered region in frequency space, in radians


.. py:function:: _create_jolly_tractor_options(ms_path: pathlib.Path, tukey_tractor_options: TukeyTractorOptions) -> jolly_roger.tractor.TukeyTractorOptions

.. py:function:: cli() -> None

.. py:function:: get_parser() -> argparse.ArgumentParser

.. py:function:: jolly_roger_tractor(ms: flint.options.MS | pathlib.Path, tukey_tractor_options: TukeyTractorOptions | None = None, update_tukey_tractor_options: dict[str, Any] | None = None) -> flint.options.MS

   Run the `jolly_roger` tukey tractor method to null towards an object.

   :param ms: The measurement set to modify
   :type ms: MS | Path
   :param tukey_tractor_options: Settings to modify the tukey tractor algorithm. If None defaults are used. Defaults to None.
   :type tukey_tractor_options: TukeyTractorOptions | None, optional
   :param update_tukey_tractor_options: Over-rides the options of `tukey_tractor_options`. Defaults to None.
   :type update_tukey_tractor_options: dict[str, Any] | None, optional

   :returns: Reference to modified measurement set.
   :rtype: MS