orca.utils.calibrationutils
===========================

.. py:module:: orca.utils.calibrationutils

.. autoapi-nested-parse::

   Calibration utilities for source model generation.

   Provides functions for creating calibrator source models, selecting
   calibration time ranges based on source transits, and generating
   CASA component lists for calibration and peeling.



Attributes
----------

.. autoapisummary::

   orca.utils.calibrationutils.SRC_LIST


Functions
---------

.. autoapisummary::

   orca.utils.calibrationutils.calibration_time_range
   orca.utils.calibrationutils.gen_model_ms_stokes
   orca.utils.calibrationutils.gen_model_from_dict
   orca.utils.calibrationutils.parse_filename
   orca.utils.calibrationutils.get_lst_from_filename
   orca.utils.calibrationutils.source_ra_in_hours
   orca.utils.calibrationutils.is_within_transit_window
   orca.utils.calibrationutils.get_relative_path
   orca.utils.calibrationutils.build_output_paths


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

.. py:data:: SRC_LIST

.. py:function:: calibration_time_range(start_time: datetime.datetime, end_time: datetime.datetime, duration_min: float = 20)

   Get dada file names based on Cygnus A transit for calibration.
   Get list of .dada file names to use for calibration. Selects .dada files that
   span {duration_min} centered on transit of Cygnus A.

   :param utc_times_txt_path: Path to utc_times.txt file.
   :param start_time: Start time of data for which to derive calibration tables,
                      datetime format.
   :param end_time: End time of data for which to derive calibration tables,
                    datetime format.
   :param duration_min: In minutes, amount of time used for calibration. Default is 20 min.

   :returns:

             cal_start_time and cal_end_time covering {duration_min} calibration range,
                 in datetime format.


.. py:function:: gen_model_ms_stokes(ms: str, zest: bool = False)

   Generate component lists for calibration / polarized peeling in CASA.

   :param ms: Measurement set to generate model for.
   :param zest: For supplying component lists for polarized peeling. Default is False.

   :returns: Returns path to component list(s). If zest=True, will return a list of paths to
             single-source component lists.


.. py:function:: gen_model_from_dict(ms: str, npzfile: str)

   


.. py:function:: parse_filename(filename)

   Parse a filename of the form YYYYMMDD_HHMMSS_anything.ms and extract the UTC time.


.. py:function:: get_lst_from_filename(filename)

.. py:function:: source_ra_in_hours(position_str)

.. py:function:: is_within_transit_window(filename, window_minutes=4)

.. py:function:: get_relative_path(ms_path)

.. py:function:: build_output_paths(ms_path, base_output_dir='/lustre/pipeline/slow-averaged/')