:orphan:

:mod:`astrohack.antenna.telescope`
==================================

.. py:module:: astrohack.antenna.telescope


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

Classes
~~~~~~~

.. autoapisummary::

   astrohack.antenna.telescope.Telescope
   astrohack.antenna.telescope.RingedCassegrain
   astrohack.antenna.telescope.NgvlaPrototype



Functions
~~~~~~~~~

.. autoapisummary::

   astrohack.antenna.telescope.get_proper_telescope



.. class:: Telescope


   Base telescope class containing IO methods and attributes that are common to all telescopes.

   .. method:: read(self, filename)

      Read the telescope object from an X array .zarr telescope configuration file
      :param filename: name of the input file


   .. method:: read_from_distro(self, name)

      Read telescope info from files distributed with astrohack.
      :param name: Name of the telescope to be read.

      :returns: None


   .. method:: write(self, filename)

      Write the telescope object to an X array .zarr telescope configuration file
      :param filename: Name of the output file



.. class:: RingedCassegrain




   Derived class containing description and methods pertaining to telescope whose panels are distributed in concentric
   rings from the dish center.

   .. method:: from_name(cls, name)
      :classmethod:

      Initialize and read from the distro a telescope object.
      :param name: Name of the telescope to be read.

      :returns: RingedCassegrain object


   .. method:: consistency_check(self)

      Make a simple check to test that some of its attributes are
      :returns: None


   .. method:: build_panel_list(self, panel_model, panel_margins)

      Construct a list of panel objects according to the telescope description
      :param panel_model: Type of panel model to be fitted.
      :param panel_margins: how much of the panel

      :returns: List containing RingPanel objects


   .. method:: attribute_pixels_to_panels(self, panel_list, u_axis, v_axis, radius, phi, deviation, mask)

      Attribute pixels in deviation image to the panels in the panel_list
      :param panel_list: The panel list must have been created by build_panel_list for the same instrument
      :param u_axis: Aperture U axis
      :param v_axis: Aperture V axis
      :param radius: Aperture radius map
      :param phi: Aperture phi angle map
      :param deviation: Aperture deviation
      :param mask: Aperture mask

      :returns: map of panel attributions


   .. method:: phase_to_deviation(self, u_axis, v_axis, _, phase, wavelength)

      Transform phase image to physical deviation image based on wavelength.
      :param u_axis: Aperture U axis
      :param v_axis: Aperture V axis
      :param _: dummy argument for interface compatibility
      :param phase: Phase image in Radians
      :param wavelength: Observation wavelength in meters

      :returns: Deviation image.


   .. method:: deviation_to_phase(self, u_axis, v_axis, _, deviation, wavelength)

      "
      Transform deviation image to physical phase image based on wavelength.
      :param u_axis: Aperture U axis
      :param v_axis: Aperture V axis
      :param _: dummy argument for interface compatibility
      :param deviation: Deviation image in meters
      :param wavelength: Observation wavelength in meters

      :returns: Phase image.



.. class:: NgvlaPrototype




   Derived class to contain ngVLA prototype specific methods and attributes.


.. function:: get_proper_telescope(name: str, antenna_name: str = None)

   Retrieve the proper telescope object based on the name
   :param name: Name of the telescope
   :param antenna_name: Name of the antenna, significant for heterogenius arrays.

   :returns: A telescope object of one of the proper subclasses