astrohack.visualization.array_cfg_plot
======================================

.. py:module:: astrohack.visualization.array_cfg_plot


Functions
---------

.. autoapisummary::

   astrohack.visualization.array_cfg_plot.plot_array_configuration
   astrohack.visualization.array_cfg_plot.define_inner_box_size
   astrohack.visualization.array_cfg_plot.plot_one_antenna_position


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

.. py:function:: plot_array_configuration(input_dict, xdtree, caller)

   Plot array configuration with an inner and an outer box.
   :param input_dict: Dictionary of input parameters
   :param xdtree: Xarray xdtree containing the antenna information as attributes.
   :param caller: Who is calling this function

   :returns: None


.. py:function:: define_inner_box_size(user_box_size, antenna_offsets, box_max_size=0.2, threshold=4)

   Compute the inner array box size based on the distribution of the antennas if user_box_size is None
   :param user_box_size: User requested box size
   :param antenna_offsets: Antenna offsets from array center
   :param box_max_size: Fractional maximum box size relative to the maximum array extent
   :param threshold: how big must be the jump between one antenna and the next relative to the previous jump

   :returns: user_box_size when Not None, else returns the heuristically defined box size


.. py:function:: plot_one_antenna_position(outerax, innerax, xpos, ypos, text, box_size, marker='+', color='black')

   Plot an antenna to either the inner or outer array boxes
   :param outerax: Plotting axis for the outer array box
   :param innerax: Plotting axis for the inner array box
   :param xpos: X antenna position (east-west)
   :param ypos: Y antenna position (north-south)
   :param text: Antenna label
   :param box_size: Size of the inner array box
   :param marker: Antenna position marker
   :param color: Color for the antenna position marker