:orphan:

:mod:`astrohack.extract_pointing`
=================================

.. py:module:: astrohack.extract_pointing


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


Functions
~~~~~~~~~

.. autoapisummary::

   astrohack.extract_pointing.extract_pointing



.. function:: extract_pointing(ms_name: str, point_name: str = None, exclude: Union[str, List[str]] = None, parallel: bool = False, overwrite: bool = False) -> Union[astrohack.io.point_mds.AstrohackPointFile, None]

   Extract pointing data from measurement set.  Creates holography output file.

   :param ms_name: Name of input measurement file name.
   :type ms_name: str

   :param point_name: Name of *<point_name>.point.zarr* file to create. Defaults to measurement set name with     *point.zarr* extension.
   :type point_name: str, optional

   :param exclude: Name of antenna to exclude from extraction.
   :type exclude: str, list, optional

   :param parallel: Boolean for whether to process in parallel. Defaults to False
   :type parallel: bool, optional

   :param overwrite: Overwrite pointing file on disk, defaults to False
   :type overwrite: bool, optional

   :return: Holography point object.
   :rtype: AstrohackPointFile

   .. _Description:

   **Example Usage**
   In this case, the pointing_name is the file name to be created after extraction.

   .. parsed-literal::
       from astrohack.extract_pointing import extract_pointing

       extract_pointing(
           ms_name="astrohack_observation.ms",
           point_name="astrohack_observation.point.zarr"
       )

   **AstrohackPointFile**

   Point object allows the user to access point data via dictionary keys with values `ant`. The point object also
   provides a `summary()` helper function to list available keys for each file.