:orphan:

:mod:`astrohack.io.locit_mds`
=============================

.. py:module:: astrohack.io.locit_mds


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

Classes
~~~~~~~

.. autoapisummary::

   astrohack.io.locit_mds.AstrohackLocitFile




.. class:: AstrohackLocitFile(file: str)




   Data class for locit data.

   Data within an object of this class can be selected for further inspection, plotted or produce a report

   .. method:: print_source_table(self) -> None

      Prints a table with the sources observed for antenna location determination


   .. method:: print_array_configuration(self, relative: bool = True) -> None

      Prints a table containing the array configuration

      :param relative: Print antenna coordinates relative to array center or in geocentric coordinates, default is True
      :type relative: bool, optional

      .. _Description:

      Print arrayx configuration in the dataset. Also marks the reference antenna and the antennas that are
      absent from the dataset. Coordinates of antenna stations can be relative to the array center or Geocentric
      (longitude, latitude and radius)


   .. method:: plot_source_positions(self, destination: str, labels: bool = True, precessed: bool = False, display: bool = False, figure_size: Union[Tuple, List[float], numpy.array] = None, dpi: int = 300) -> None

      Plot source positions in either FK5 or precessed right ascension and declination.

      :param destination: Name of the destination folder to contain plot
      :type destination: str

      :param labels: Add source labels to the plot, defaults to False
      :type labels: bool, optional

      :param precessed: Plot in precessed coordinates? defaults to False (FK5)
      :type precessed: bool, optional

      :param display: Display plots inline or suppress, defaults to True
      :type display: bool, optional

      :param figure_size: 2 element array/list/tuple with the plot sizes in inches
      :type figure_size: numpy.ndarray, list, tuple, optional

      :param dpi: dots per inch to be used in plots, default is 300
      :type dpi: int, optional

      .. _Description:

      Plot the sources on the source list to a full 24 hours 180 degrees flat 2D representation of the full sky.
      If precessed is set to True the coordinates precessd to the midpoint of the observations is plotted, otherwise
      the FK5 coordinates are plotted.
      The source names can be plotted next to their positions if label is True, however plots may become too crowded
      if that is the case.


   .. method:: plot_array_configuration(self, destination: str, stations: bool = True, zoff: bool = False, unit: str = 'm', box_size: Union[int, float] = None, display: bool = False, figure_size: Union[Tuple, List[float], numpy.array] = None, dpi: int = 300) -> None

      Plot antenna positions.

      :param destination: Name of the destination folder to contain plot
      :type destination: str

      :param stations: Add station names to the plot, defaults to True
      :type stations: bool, optional

      :param zoff: Add Elevation offsets to the plots, defaults to False
      :type zoff: bool, optional

      :param unit: Unit for the plot, valid values are length units, default is km
      :type unit: str, optional

      :param box_size: Size of the box for plotting the inner part of the array in unit, when none the box size is         20% of the total size of the array, default is None
      :type box_size: int, float, optional

      :param display: Display plots inline or suppress, defaults to True
      :type display: bool, optional

      :param figure_size: 2 element array/list/tuple with the plot sizes in inches
      :type figure_size: numpy.ndarray, list, tuple, optional

      :param dpi: dots per inch to be used in plots, default is 300
      :type dpi: int, optional

      .. _Description:
      Plot the array configuration from the antenna positions.