:orphan:

:mod:`astrohack.beamcut`
========================

.. py:module:: astrohack.beamcut


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


Functions
~~~~~~~~~

.. autoapisummary::

   astrohack.beamcut.beamcut



.. function:: beamcut(holog_name: str, beamcut_name: str = None, ant: Union[str, List[str]] = 'all', ddi: Union[int, List[int], str] = 'all', destination: str = None, lm_unit: str = 'amin', azel_unit: str = 'deg', phase_unit: str = 'deg', phase_scale: Union[List[float], Tuple[float], numpy.array] = None, y_scale: list[float] = None, dpi: int = 300, display: bool = False, parallel: bool = False, overwrite: bool = False)

   Process beamcut data from a .holog.zarr file to produce reports and plots.

   :param holog_name: Name of the .holog.zarr file to use as input.
   :type holog_name: str

   :param beamcut_name: Name for the output .beamcut.zarr file to save data.
   :type beamcut_name: str

   :param ant: List of antennas/antenna to be processed, defaults to "all" when None, ex. ea25.
   :type ant: list or str, optional

   :param ddi: List of ddi to be processed, defaults to "all" when None, ex. 0.
   :type ddi: list or int, optional

   :param destination: Destination directory for plots and reports if not None, defaults to None.
   :type destination: str, optional

   :param lm_unit: Unit for L/M offsets in plots and report, default is "amin".
   :type lm_unit: str, optional

   :param azel_unit: Unit for Az/El information in plots and report, default is "deg".
   :type azel_unit: str, optional

   :param phase_unit: Unit for phase plots, default is "deg".
   :type phase_unit: str, optional

   :param phase_scale: Scale for the phase plots, in phase_unit, default is None, meaning 1 full cycle.
   :type phase_scale: Union[List[float], Tuple[float], np.array], optional

   :param dpi: Resolution in pixels, defaults to 300.
   :type dpi: int, optional

   :param display: Display plots during execution, defaults to False.
   :type display: bool, optional

   :param y_scale: Define amplitude plot Y scale, defaults to None.
   :type y_scale: str, optional

   :param parallel: Process beamcuts in parallel, defaults to False.
   :type parallel: bool, optional

   :param overwrite: Overwrite previously existing beamcut file of same name, defaults to False.
   :type overwrite: bool, optional

   :return: Beamcut mds object
   :rtype: AstrohackBeamcutFile

   .. _Description:
   **AstrohackBeamcutFile**

   The beamcut mds object allows the user to access the underlying xarray datatree using compound keys, which are in     order of depth, `ant` -> `ddi`. This object also provides a `summary()` method to list available data and available     data visualization methods.

     An outline of the beamcut mds data tree is show below:

   .. parsed-literal::
       image_mds =
           {
           ant_0:{
               ddi_0: {
                   cut_0: beamcut_ds
                   ⋮
                   cut_p: beamcut_ds
               },
               ddi_m: …
           },
           ⋮
           ant_n: …
       }

   **Example Usage**

   .. parsed-literal::
       from astrohack import beamcut

       beamcut(
           holog_name="astrohack_observation.holog.zarr",
           beamcut_name="astrohack_observation.beamcut.zarr",
           destination="beamcut_exports",
           display=False,
           ant='ea25',
           overwrite=True,
           parallel=True
       )